Laravel Migrations Generator 使用教程：从现有数据库自动生成迁移文件

还在手动编写 Laravel 数据库迁移文件吗？面对复杂的数据库结构，手动创建迁移文件不仅耗时耗力，还容易出错。本文将详细介绍如何使用 Laravel Migrations Generator 工具，从现有数据库自动生成完整的迁移文件，包括表结构、索引、外键约束等。

什么是 Laravel Migrations Generator？

Laravel Migrations Generator 是一个强大的开源工具，能够自动从现有数据库结构生成 Laravel 迁移文件。它支持所有 Laravel 官方支持的数据库类型：

• ✅ MariaDB
• ✅ MySQL
• ✅ PostgreSQL
• ✅ SQL Server
• ✅ SQLite

核心功能特性

mindmap
  root(Laravel Migrations Generator 功能)
    数据库支持
      MySQL/MariaDB
      PostgreSQL
      SQL Server
      SQLite
    生成内容
      表结构迁移
      视图迁移
      存储过程
      索引和外键
    高级特性
      批量生成(squash)
      自定义模板
      多连接支持
      跳过特定类型

安装与配置

环境要求

Laravel 版本	包版本
11.x	7.x
≥ 10.43.x	7.x
10.x | ≤ 10.42.x	6.x
9.x	6.x
8.x	6.x
7.x	6.x
6.x	6.x
5.8.x	6.x
5.7.x	6.x
5.6.x	6.x

安装步骤

通过 Composer 安装开发依赖：

composer require --dev kitloong/laravel-migrations-generator

Laravel 会自动注册服务提供者。对于 Lumen 框架，需要手动在 bootstrap/app.php 中注册：

// 启用 Facade
$app->withFacades();

// 注册服务提供者
$app->register(\KitLoong\MigrationsGenerator\MigrationsGeneratorServiceProvider::class);

基础使用教程

生成所有表的迁移文件

php artisan migrate:generate

这个命令会扫描数据库中的所有表，并为每个表生成对应的迁移文件。

指定特定表生成

php artisan migrate:generate --tables="users,posts,comments"

忽略特定表

php artisan migrate:generate --ignore="migrations,password_resets"

使用特定数据库连接

php artisan migrate:generate --connection="secondary"

高级功能详解

批量生成模式 (Squash)

将所有的迁移文件合并到一个文件中：

php artisan migrate:generate --squash

自定义迁移文件路径

php artisan migrate:generate --path="database/custom_migrations"

使用自定义模板

php artisan migrate:generate --template-path="stubs/custom.migration.stub"

配置选项详解

配置文件结构

<?php
// config/migrations-generator.php

return [
    // 模板文件路径
    'migration_template_path' => __DIR__ . '/../stubs/migration.generate.stub',

    // 生成文件保存路径
    'migration_target_path'   => base_path('database/migrations'),

    // 文件名模式
    'filename_pattern'        => [
        'table'       => '[datetime]_create_[name]_table.php',
        'view'        => '[datetime]_create_[name]_view.php',
        'procedure'   => '[datetime]_create_[name]_proc.php',
        'foreign_key' => '[datetime]_add_foreign_keys_to_[name]_table.php',
    ],
];

完整的命令行选项

选项	描述	示例
-c, --connection	指定数据库连接	--connection="mysql"
-t, --tables	指定要生成的表	--tables="users,posts"
-i, --ignore	忽略指定的表	--ignore="migrations"
-p, --path	自定义迁移文件路径	--path="database/migrations"
--squash	合并所有迁移到一个文件	--squash
--skip-views	跳过视图生成	--skip-views
--skip-proc	跳过存储过程生成	--skip-proc
--default-index-names	不使用数据库索引名	--default-index-names

实际应用场景

场景一：从旧项目迁移到 Laravel

flowchart TD
    A[现有数据库] --> B[运行 migrate:generate]
    B --> C[生成迁移文件]
    C --> D[审查生成的迁移]
    D --> E[运行迁移测试]
    E --> F[部署到生产环境]

场景二：团队协作数据库同步

# 开发人员A生成迁移
php artisan migrate:generate --tables="new_feature_table"

# 提交迁移文件到版本控制
git add database/migrations/*_create_new_feature_table.php
git commit -m "Add migration for new feature table"

# 其他开发人员获取并运行
git pull
php artisan migrate

生成的文件结构示例

表迁移文件示例

<?php

use Illuminate\Database\Migrations\Migration;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Support\Facades\Schema;

return new class extends Migration
{
    public function up(): void
    {
        Schema::create('users', function (Blueprint $table) {
            $table->id();
            $table->string('name');
            $table->string('email')->unique();
            $table->timestamp('email_verified_at')->nullable();
            $table->string('password');
            $table->rememberToken();
            $table->timestamps();
            
            $table->index('email');
        });
    }

    public function down(): void
    {
        Schema::dropIfExists('users');
    }
};

外键迁移文件示例

<?php

use Illuminate\Database\Migrations\Migration;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Support\Facades\Schema;

return new class extends Migration
{
    public function up(): void
    {
        Schema::table('posts', function (Blueprint $table) {
            $table->foreign('user_id')
                  ->references('id')
                  ->on('users')
                  ->onDelete('cascade');
        });
    }

    public function down(): void
    {
        Schema::table('posts', function (Blueprint $table) {
            $table->dropForeign(['user_id']);
        });
    }
};

最佳实践与注意事项

1. 外键约束的处理顺序

sequenceDiagram
    participant G as Generator
    participant D as Database
    
    G->>D: 生成所有表结构
    G->>D: 生成所有索引
    G->>D: 最后生成外键约束
    Note right of D: 确保依赖表已存在

2. SQLite 的特殊处理

SQLite 只在表创建时支持外键，修改表时不支持。虽然工具会生成外键迁移文件，但在 SQLite 环境中会被忽略。

3. 用户自定义类型列

对于 PostgreSQL 和 SQL Server 的用户自定义类型，工具会生成特殊的迁移语句：

DB::statement("ALTER TABLE table ADD column custom_type NOT NULL");

4. 批量号管理

建议使用 --log-with-batch=0 选项，使生成的迁移成为第一批迁移：

php artisan migrate:generate --log-with-batch=0

常见问题解决

问题1：表不存在错误

症状：运行迁移时提示表已存在 解决方案：确保先删除现有表，或使用 php artisan migrate:fresh

问题2：外键约束失败

症状：外键迁移执行失败 解决方案：检查依赖表是否已正确生成，确保迁移顺序正确

问题3：自定义类型不支持

症状：某些数据库特定类型无法识别 解决方案：手动修改生成的迁移文件，或使用 DB::statement

性能优化建议

大型数据库处理

对于包含大量表的数据集，建议分批次生成：

# 第一次生成核心表
php artisan migrate:generate --tables="users,roles,permissions"

# 第二次生成业务表
php artisan migrate:generate --tables="orders,products,customers" --ignore="users,roles,permissions"

使用 Squash 模式减少文件数量

php artisan migrate:generate --squash

总结

Laravel Migrations Generator 是一个极其强大的工具，能够显著提高从现有数据库迁移到 Laravel 项目的效率。通过本文的详细教程，你应该能够：

1. ✅ 正确安装和配置工具
2. ✅ 掌握基础和高阶使用方法
3. ✅ 理解各种配置选项的作用
4. ✅ 处理常见的迁移场景
5. ✅ 解决可能遇到的问题

记住，虽然自动化工具能够处理大部分情况，但始终建议审查生成的迁移文件，确保它们符合项目的具体需求和编码标准。

现在就开始使用 Laravel Migrations Generator，让你的数据库迁移工作变得更加高效和准确！