Laravel ER Diagram Generator 快速入门：从安装到生成第一张图的完整教程

Laravel ER Diagram Generator 快速入门：从安装到生成第一张图的完整教程

【免费下载链接】laravel-er-diagram-generatorGenerate entity relation diagrams from your Laravel model files.项目地址: https://gitcode.com/gh_mirrors/la/laravel-er-diagram-generator

Laravel ER Diagram Generator 是一款强大的工具，能够从 Laravel 模型文件自动生成实体关系图（ER Diagram），帮助开发者直观地理解数据库结构和模型间关系。本教程将带你完成从安装到生成第一张 ER 图的全过程，无需复杂配置，轻松上手。

📦 一键安装步骤

安装 Laravel ER Diagram Generator 只需简单几步，确保你的 Laravel 项目已正确配置 Composer。

1. 克隆项目仓库

首先，将项目克隆到本地：

git clone https://gitcode.com/gh_mirrors/la/laravel-er-diagram-generator

2. 安装依赖

进入项目目录，使用 Composer 安装依赖：

cd laravel-er-diagram-generator composer install

3. 配置服务提供者

在 Laravel 项目的config/app.php文件中，添加服务提供者：

'providers' => [ // ... BeyondCode\ErdGenerator\ErdGeneratorServiceProvider::class, ],

⚙️ 最快配置方法

默认情况下，工具会扫描 Laravel 项目的app/Models目录下的模型文件。如果你的模型位于其他目录，可以通过配置文件自定义。

发布配置文件

执行以下命令发布配置文件到config/erd-generator.php：

php artisan vendor:publish --provider="BeyondCode\ErdGenerator\ErdGeneratorServiceProvider"

自定义模型目录

打开config/erd-generator.php文件，修改directories配置项，添加你的模型目录：

'directories' => [ app_path('Models'), // 添加其他模型目录 ],

🚀 生成你的第一张 ER 图

一切准备就绪，现在可以生成 ER 图了！执行以下命令，工具会自动扫描模型并生成图表：

php artisan generate:erd

命令参数说明

• 指定输出文件名：默认生成graph.png，可自定义文件名：

  php artisan generate:erd my_diagram

• 指定输出格式：支持png、svg、pdf等格式：

  php artisan generate:erd --format=svg

• 生成文本格式：如需纯文本格式的 ER 图，使用--text-output选项：

  php artisan generate:erd --text-output

📝 工具核心功能解析

模型关系识别

工具通过src/RelationFinder.php自动识别模型间的关系，包括hasOne、hasMany、belongsTo、belongsToMany等常见关联类型。

图表构建逻辑

src/GraphBuilder.php文件负责将模型和关系转换为 Graphviz 图形，支持自定义节点样式、关系线条等属性。

命令行交互

核心命令逻辑位于src/GenerateDiagramCommand.php，通过 Laravel 控制台命令实现用户交互，支持进度条显示和结果提示。

💡 使用技巧与注意事项

1. 排除不需要的模型：在配置文件中添加exclude选项，排除无需显示的模型：

   'exclude' => [ App\Models\NotAModel::class, ],

2. 模型别名设置：通过aliases配置为模型设置简短别名，使图表更清晰：

   'aliases' => [ App\Models\User::class => '用户', ],

3. 依赖检查：确保系统已安装 Graphviz，否则无法生成图片格式：

   # Ubuntu/Debian sudo apt-get install graphviz # macOS brew install graphviz

🎯 常见问题解决

Q: 生成的图表中缺少某些模型？

A: 检查模型是否继承自Illuminate\Database\Eloquent\Model，并确保模型目录已添加到配置文件中。

Q: 中文显示乱码？

A: 在config/erd-generator.php中配置字体：

'graph' => [ 'fontname' => 'SimHei', ],

通过本教程，你已掌握 Laravel ER Diagram Generator 的基本使用方法。这款工具将帮助你在开发过程中更好地理解数据结构，提升团队协作效率。开始使用它，让数据库设计可视化不再复杂！

【免费下载链接】laravel-er-diagram-generatorGenerate entity relation diagrams from your Laravel model files.项目地址: https://gitcode.com/gh_mirrors/la/laravel-er-diagram-generator