问题描述与原因分析
在laravel的数据库迁移过程中，开发者可能会遇到一个常见的错误：“sqlstate[42s21]: column already exists: 1060 duplicate column name 'id_rso'”。这个错误通常发生在尝试为表添加外键时，特别是在使用php artisan migrate:fresh命令重新运行所有迁移时。
导致此问题的根本原因在于，迁移文件中对同一个列进行了重复定义。例如，在以下代码片段中：
public function up()
{
Schema::enableForeignKeyConstraints();
Schema::create('dso', function (Blueprint $table) {
$table->string('id_dso',30);
$table->unsignedBigInteger('id_rso'); // 第一次尝试创建 'id_rso' 列
$table->foreignId('id_rso')->constrained('rso'); // 第二次尝试创建 'id_rso' 列并添加外键
// ... 其他列定义
$table->primary('id_dso');
});
}这里，$table->unsignedBigInteger('id_rso'); 语句会首先创建名为 id_rso 的无符号大整型列。紧接着，$table->foreignId('id_rso')->constrained('rso'); 语句被执行。foreignId() 是Laravel提供的一个便捷方法，它不仅会创建与Laravel约定（bigIncrements）兼容的无符号大整型列，还会同时为该列添加外键约束。因此，当 foreignId() 尝试创建 id_rso 列时，发现该列已经由前一行代码创建，从而抛出“Duplicate column name”错误。
解决方案
解决此问题的关键在于避免冗余的列定义。由于foreignId()方法已经包含了创建列的功能，我们只需使用它即可。
将有问题的迁移代码：
$table->unsignedBigInteger('id_rso');
$table->foreignId('id_rso')->constrained('rso');修改为：
$table->foreignId('id_rso')->constrained('rso');修改后的完整迁移文件 up 方法示例：
<?php
use Illuminate\Database\Migrations\Migration;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Support\Facades\Schema;
class CreateDsoTable extends Migration
{
/**
* Run the migrations.
*
* @return void
*/
public function up()
{
// 启用外键约束，这通常是默认开启的，但明确声明可增加可读性
Schema::enableForeignKeyConstraints();
Schema::create('dso', function (Blueprint $table) {
$table->string('id_dso', 30);
// 正确地定义外键：foreignId() 会自动创建无符号大整型列并添加外键约束
$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(); // 添加 created_at 和 updated_at 时间戳列
$table->primary('id_dso'); // 定义主键
});
}
/**
* Reverse the migrations.
*
* @return void
*/
public function down()
{
Schema::dropIfExists('dso');
}
}
注意事项与最佳实践
-
foreignId() 方法的优势：
- foreignId() 是Laravel 7+版本引入的便捷方法，它会创建 UNSIGNED BIGINT 类型的列，并将其命名为 foreign_table_id 的约定形式（例如 user_id）。
- 配合 constrained() 方法，它会自动推断被引用的表名（例如 user_id 会自动引用 users 表）。如果被引用的表名与约定不符，可以通过 constrained('custom_table_name') 明确指定。
- 它简化了外键的定义，减少了代码量，并遵循了Laravel的命名约定。
-
外键约束的命名：
- Laravel会自动为外键约束生成一个默认名称。如果需要自定义外键约束的名称，可以使用 constrained()->onUpdate('cascade')->onDelete('cascade')->name('fk_dso_rso_id') 等链式调用。
-
Schema::enableForeignKeyConstraints() 和 Schema::disableForeignKeyConstraints()：
- 在执行可能导致外键约束冲突的操作（如批量删除或重新创建表）时，可以暂时禁用外键约束，操作完成后再启用。但在常规的 Schema::create 操作中，通常无需显式调用 enableForeignKeyConstraints()，因为Laravel默认是启用的。
-
迁移顺序：
- 在定义外键时，被引用的表（例如 rso 表）必须先于引用表（例如 dso 表）创建。确保你的迁移文件命名和时间戳顺序正确，以保证迁移的执行顺序。
通过遵循上述最佳实践，并正确使用 foreignId() 方法，可以有效避免Laravel迁移中因重复定义列而导致的外键错误，确保数据库结构的顺利构建和维护。
