解决Laravel迁移中外键重复列错误：正确使用foreignId

理解Laravel外键迁移中的常见陷阱

在laravel中进行数据库迁移时，为表添加外键是一个常见操作。然而，不正确的写法可能会导致sqlstate[42s21]: column already exists: 1060 duplicate column name这样的错误，尤其是在执行php artisan migrate:fresh（该命令会删除所有表并重新运行所有迁移）时。

出现此错误的原因通常是开发者在迁移文件中对同一个外键列进行了重复定义。例如，在Laravel 8及更高版本中，foreignId()方法是一个非常便捷的工具，它不仅会创建对应的UNSIGNED BIGINT类型的列，还会自动添加外键约束。如果同时显式地定义了该列，就会造成重复。

错误示例代码：

考虑以下迁移代码片段，它试图为dso表添加一个指向rso表的id_rso外键：

public function up()
{   
    Schema::enableForeignKeyConstraints();
    Schema::create('dso', function (Blueprint $table) {
        $table->string('id_dso',30);
        // 问题所在：此处显式定义了id_rso列
        $table->unsignedBigInteger('id_rso'); 
        // 再次定义id_rso列并添加外键约束，导致重复
        $table->foreignId('id_rso')->constrained('rso'); 
        $table->smallInteger('id_focus');
        $table->smallInteger('id_wilayah');
        $table->smallInteger('id_grup_wilayah');
        $table->string('nama_dso',50);
        $table->string('created_by',50)->nullable();
        $table->timestamp('created_date',$precision = 0);
        $table->string('modified_by',50)->nullable();
        $table->timestamp('modified_date',$precision = 0)->nullable()->default(null);
        $table->boolean('status')->default(true);
        $table->timestamps();
        $table->primary('id_dso');
    });
}

在上述代码中，$table->unsignedBigInteger('id_rso'); 已经创建了一个名为id_rso的UNSIGNED BIGINT列。紧接着，$table->foreignId('id_rso')->constrained('rso'); 再次尝试创建同名的id_rso列，并将其类型设置为UNSIGNED BIGINT，同时添加了外键约束。这种重复操作导致了数据库抛出Duplicate column name 'id_rso'的错误。

正确使用foreignId()方法

解决这个问题的关键在于理解foreignId()方法的全部功能。它是一个复合方法，集成了列定义和外键约束的添加。因此，当使用foreignId()时，无需再单独声明列。

正确示例代码：

只需保留foreignId()这一行即可：

public function up()
{   
    Schema::enableForeignKeyConstraints(); // 确保外键约束已启用
    Schema::create('dso', function (Blueprint $table) {
        $table->string('id_dso',30);
        // 正确用法：foreignId() 会自动创建 unsignedBigInteger 类型的列并添加外键约束
        $table->foreignId('id_rso')->constrained('rso'); 
        $table->smallInteger('id_focus');
        $table->smallInteger('id_wilayah');
        $table->smallInteger('id_grup_wilayah');
        $table->string('nama_dso',50);
        $table->string('created_by',50)->nullable();
        $table->timestamp('created_date',$precision = 0);
        $table->string('modified_by',50)->nullable();
        $table->timestamp('modified_date',$precision = 0)->nullable()->default(null);
        $table->boolean('status')->default(true);
        $table->timestamps();
        $table->primary('id_dso');
    });
}

通过上述修改，id_rso列将只被创建一次，并且正确地附加了指向rso表的外键约束。

迁移外键的最佳实践与注意事项

1. foreignId()的便利性： foreignId('column_name')默认会创建column_name列为UNSIGNED BIGINT类型。constrained('table_name')则会自动推断外键引用的列名（通常是table_name表的id列）。如果引用的列名不是id，则可以使用constrained('table_name', 'custom_column_name')。
2. 外键约束的启用与禁用： Schema::enableForeignKeyConstraints(); 和 Schema::disableForeignKeyConstraints(); 方法用于在需要时临时禁用或启用外键约束。这在批量插入数据或执行某些复杂操作时可能有用，但在常规的up()方法中，通常不需要手动调用enableForeignKeyConstraints()，因为Laravel默认是启用的。不过，在down()方法中，为了正确回滚，禁用外键约束再删除表通常是必要的。
3. 迁移顺序： 在创建外键时，必须确保被引用的表（如本例中的rso表）在引用表（dso表）之前创建。如果顺序颠倒，执行迁移时会因为引用表不存在而报错。
4. 级联操作： 可以为外键添加级联操作，例如：
   • ->onDelete('cascade'): 当父表记录被删除时，子表相关记录也随之删除。
   • ->onUpdate('cascade'): 当父表记录更新时，子表相关记录也随之更新。
   • ->onDelete('set null'): 当父表记录被删除时，子表相关记录的外键列设为NULL。这要求外键列是可空的 (nullable())。
5. 回滚操作（down()方法）： 在down()方法中，需要确保正确地删除表和外键。通常的顺序是先删除外键约束，然后删除表。

   public function down()
   {
       Schema::table('dso', function (Blueprint $table) {
           $table->dropForeign(['id_rso']); // 删除外键约束
       });
       Schema::dropIfExists('dso'); // 删除表
   }

   登录后复制

遵循这些原则，可以有效避免Laravel迁移中常见的重复列和外键相关错误，确保数据库结构的稳定性和正确性。

以上就是解决Laravel迁移中外键重复列错误：正确使用foreignId的详细内容，更多请关注php中文网其它相关文章！