如何通过Laravel控制台命令创建表并将Schema保存到文本文件

一、执行migrate前动态修改迁移文件的方法 #

核心思路是通过自定义Artisan命令，先收集用户输入的表结构信息，再生成基础迁移文件并动态修改其内容，确保包含用户定义的列。

实现步骤： #

1. 创建自定义Artisan命令，用于收集用户输入并处理迁移文件
2. 收集用户输入的表名、列名、类型、是否可空等信息
3. 调用默认的make:migration命令生成基础迁移文件
4. 读取最新生成的迁移文件，替换up()方法中的列定义代码
5. 保存修改后的迁移文件，同时生成Schema详情文件

代码示例： #

// app/Console/Commands/GenerateCustomMigration.php
namespace App\Console\Commands;

use Illuminate\Console\Command;
use Illuminate\Support\Facades\File;

class GenerateCustomMigration extends Command
{
    protected $signature = 'generate:custom-migration';
    protected $description = '生成包含自定义列的迁移文件，并保存Schema详情';

    public function handle()
    {
        // 收集表名
        $tableName = $this->ask('请输入表名');
        $columns = [];

        // 循环收集列信息
        while ($this->confirm('是否添加下一列？')) {
            $columnName = $this->ask('列名');
            $columnType = $this->choice('列类型', ['string', 'integer', 'text', 'datetime', 'boolean', 'decimal']);
            $nullable = $this->confirm('该列是否允许为空？');

            $columns[] = [
                'name' => $columnName,
                'type' => $columnType,
                'nullable' => $nullable
            ];
        }

        // 生成基础迁移文件
        $this->call('make:migration', [
            'name' => "create_{$tableName}_table",
            '--create' => $tableName
        ]);

        // 获取最新迁移文件路径
        $migrationDir = database_path('migrations');
        $files = scandir($migrationDir, SCANDIR_SORT_DESCENDING);
        $latestMigration = $files[0];
        $fullPath = "{$migrationDir}/{$latestMigration}";

        // 读取并修改迁移文件内容
        $content = File::get($fullPath);
        $columnCode = '';

        foreach ($columns as $column) {
            $code = "\$table->{$column['type']}('{$column['name']}')";
            $columnCode .= $column['nullable'] ? "{$code}->nullable();\n            " : "{$code};\n            ";
        }

        // 替换默认的id()之后的内容
        $content = preg_replace(
            '/\$table->id\(\);\n            /',
            "\$table->id();\n            {$columnCode}",
            $content
        );

        File::put($fullPath, $content);

        // 生成Schema详情文件
        $schemaDir = storage_path('schemas');
        if (!File::exists($schemaDir)) {
            File::makeDirectory($schemaDir);
        }

        $schemaContent = "表名: {$tableName}\n";
        $schemaContent .= "列信息:\n";
        foreach ($columns as $index => $col) {
            $schemaContent .= "{$index + 1}. {$col['name']} ({$col['type']})" . ($col['nullable'] ? ' [允许为空]' : '') . "\n";
        }

        File::put("{$schemaDir}/{$tableName}.txt", $schemaContent);

        $this->info('迁移文件和Schema详情已成功生成！');
    }
}

使用方式： #

1. 注册命令：在app/Console/Kernel.php的$commands数组中添加\App\Console\Commands\GenerateCustomMigration::class
2. 运行命令：php artisan generate:custom-migration，按照提示输入信息即可

二、更优的Schema存储方案 #

如果只是存储为TXT文件，后续解析和复用会比较麻烦，推荐以下优化方向：

• 改用JSON格式存储：将列信息序列化为JSON格式，方便后续通过代码读取和解析。比如把上面的$schemaContent替换为json_encode(['table' => $tableName, 'columns' => $columns], JSON_PRETTY_PRINT)，并保存为{$tableName}.json
• 同步记录到数据库：创建一个专门的元数据表（如table_schemas），存储表名、列信息、创建时间等，方便后台管理和查询
• 在迁移文件中添加注释：在生成迁移文件时，自动添加包含Schema详情的注释，确保迁移文件本身就具备可追溯性

内容的提问来源于stack exchange，提问作者Hamza Ameer