Laravel 中的数据迁移和数据填充

本文首发于 https://jaychen.cc
作者 JayChen

这是一篇基础教程，对标 Laravel 文档中的数据迁移和数据填充。

migration

Laravel 中提供了数据库迁移的方式来管理数据库，想象一个场景：在一个多人开发的项目中，你的同事修改了某个数据库结构并修改了代码，通过 git 你可以即时的同步同事修改的代码，但是数据库结构，你只能通过手工的方式来复制同事修改的 SQL 语句，执行以保证数据库的结构一致。那么，Laravel 中的数据库迁移概念，就是用于解决团队中保证数据库结构一致的方案。

migration 使用非常简单，编写一定的 php 代码并执行，那么 Laravel 就会自动的更新数据库。假设你的同事要修改数据库某个字段，那么只要编写 php 代码，接着你通过 git 更新了代码，执行 migrate 操作之后，你的数据库结构就和他的同步了。下面我们就来看具体的使用方法。

migrate

Laravel 把编写数据库改动的 php 代码称为迁移，可以通过 php artisan make:migration filename 的方式来创建迁移文件。假设你需要创建一张新的 user 表，那么你可以通过执行 php artisan make:migration create_user_table --create=user 来创建一个迁移文件，执行命令会在 database/migrations/ 目录下建立一个 文件创建时间_filename 的 php 文件，那么这个文件就是我们接下来用来编写数据库结构变化的文件了。这里要提一点，虽然说创建迁移文件的名称可以随意，但是为了管理方便，最好文件名可以体现要执行的数据库操作，比如这里我们要创建一张 user 表，所以文件名称为 create_user_table。

php artisan make:migration filename 有两个可选参数

• --create=tablename 表明该迁移是用来创建表。
• --table=tablename 表明该迁移是用来对 tablename 这张表进行操作。

我们创建出来的迁移文件 create_user_table 会包含两个方法。

public function up()
{
    Schema::create('user', function (Blueprint $table) {
        $table->increments('id');
        $table->timestamps();
    });
}


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

这两个方法是互逆的操作，比如我们可以再 up 方法中编写我们要创建的 user 表的相关信息，而 down 方法中则是删除 user 表的操作。这样，我们就可以做到回滚操作，当我们创建 user 表之后发现某个字段名写错了，就可以通过 down 来删除 user 表，进而重新建立 user 表。

假设 user 表有 id,username,email 三个字段，那么可以再 up 方法中写

public function up()
{
    Schema::create('user', function (Blueprint $table) {
        $table->increments('id')->index()->comment('用户id');
        $table->string('name')->default('')->comment('用户名');
        $table->string('email')->nullable()->comment('用户邮箱');
        $table->timestamps();
    });
}

一般，我们的逻辑会在闭包函数中写。上面的代码，即时不能完全明白，也可以大概猜出以下几点：

• 我们操作的表是 user 表。
• user 表中定义了 id 字段，因为调用了 increments 方法，所以 id 为 auto_increment，调用了 index 方法说明给 id 添加了索引，最后 comment 等同于注释。
• 有了 id 的经验，那么 name 字段也很好理解了，string 方法说明 name 是 varchar/char 类型的，default 定义了 name 字段的默认值。
• email 字段 调用了 nullable 方法说明运行 email 字段为空。
• 定义字段结构的时候可以使用链式调用的方式。

Laravel 中的方法是满足你对 sql 语句的所有操作，如果你需要定义一个类型为 text 的字段，那么可以调用 text() 方法，更多的方法说明可以参见文档 Laravel 数据库结构构造器。

我们已经编写好了 user 表的结构，接下来执行 php artisan migrate，Laravel 会根据 create 方法自动为我们创建 user 表。至此，我们已经成功的通过 Larvel 的迁移功能来实现创建表。

Rollback

使用 Laravel 的迁移功能可以有后悔药吃。

执行 php artisan migrate 创建 user 表之后，觉得不行，不要 user 这张表，于是你打算删除这张表。那么这时候我们就要使用刚刚说到的 down 方法了。

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

这里 Laarvel 已经为我们写好逻辑了，dropIfExists 函数就是用来删除表，我们只需要执行 php artisan migrate :rollback 就可以回滚到执行 php artisan migrate 之前的状态。

重命名表

除了创建表，也可以用迁移记录表的其他任何操作，包括修改表属性，修改字段等等操作。这里再举个例子说明如何用迁移来对表进行重命名。

• 假设有表 user，我们需要对它重命名为 users。首先要执行 php artisan make:migration rename_user_to_users --table user 来创建迁移文件。
• 在 up 方法中写我们要重命名表的逻辑。

public function up()
{
    Schema::table('user', function (Blueprint $table) {
        Schema::rename('user','users');
    });
}

• 为了可以 rollback 可以顺利执行，我们还需要在 down 方法中编写撤销重命名操作的逻辑。

public function up()
{
    Schema::table('user', function (Blueprint $table) {
        //
        Schema::rename('users','user');
    });
}

• 最后执行 php artisan migrate 就就可以完成对 user 表的重命名操作。如果需要回滚，只要执行 php artisan migrate:rollback。

你会发现，如果执行一次迁移之后，如果执行第二次迁移是不会重复执行的，这是因为 Laravel 会在数据库中建立一张 migrations 的表来记录哪些已经进行过迁移。

基本的 migration 介绍就到这里，以上的内容可以应对大部分的需求，如果需要更详细的介绍，可能需要阅读 Laravel 那不知所云的文档了。:)

Seeder

Laravel 中除了 migration 之外，还有一个 seeder 的东西，这个东西用于做数据填充。假设项目开发中需要有一些测试数据，那么同样可以通过编写 php 代码来填充测试数据，那么通过 git 同步代码，所有的人都可以拥有一份同样的测试数据。

同样，数据填充在 Laravel 中被称为 Seeder，如果需要对某张表填充数据，需要先建立一个 seeder。通过执行 php artisan make:seeder UserTableSeeder 来生成一个 seeder 类。这里我们希望填充数据的表示 test 表，所以名字为 UserTableSeeder。当然这个名字不是强制性的，只是为了做到见名知意。

创建 UserTableSeeder 之后会在 database/seeders 目录下生成一个 UserTableSeeder 类，这个类只有一个 run 方法。你可以在 run 方法中写插入数据库的代码。假设我们使用 DB facade 来向 test 表插入数据。

class UserTableSeeder extends Seeder
{

    public function run()
    {
        DB::table('users')->insert($insertData);
    }
}

编写完代码之后，执行 php artsian db:seeder --class= UserTableSeeder 来进行数据填充。执行完毕之后查看数据库已经有数据了。

如果我们有多个表要进行数据填充，那么不可能在编写完 php 代码之后，逐个的执行 php artisan db:seeder --class=xxxx 来进行填充。有一个简便的方法。在 DatabaseSeeder 的 run 方法中添加一行 $this->call(UserTableSeeder::class);，然后执行 php artisan db:seeder，那么 Laravel 就会执行 DatabaseSeeder 中的 run 方法，然后逐个执行迁移。

和 migration 不同，如果多次执行 php artisan db:seeder 就会进行多次数据填充。

加入你想一次性插入大量的测试数据 ，那么在 run 方法中使用 DB facade 来逐个插入显然不是一个好的方法。Laravel 中提供了一种模型工厂的方式来创建创建大量的数据。

模型工厂

模型工厂，意味着本质其实是一个工厂模式。那么，在使用模型工厂创建数据需要做两件事情

1. 创建工厂，定义好工厂要返回的数据。
2. 调用工厂获取数据。

Laravel 中通过执行 php artisan make:factory UserFactory --model=User 来为 User Model 创建一个工厂类，该文件会放在 database/factory 目录下。打开该文件可以看到如下代码：

$factory->define(App\User::class, function (Faker $faker) {
    return [
        //
    ];
});

这里， return 的值就是我们第 2 步调用工厂获取到的数据。生成数据的逻辑也只需要写在闭包函数中就可以。这里需要提一下 Faker 这个类。这是一个第三方库，Laravel 集成了这个第三方库。这个库的作用很好玩：用于生成假数据。假设 User 表需要插入 100 个用户，那么就需要 100 个 username，那么你就不必自己写逻辑生成大量的 test01，test02 这样子幼稚的假数据，直接使用 Faker 类，会替你生成大量逼真的 username。(我也不知道这个算不算无聊了 :)。。。)。

现在假设 User 表有 id, email, username 三个字段，那么我要生成 100 个用户，首先在工厂类中实现逻辑。

$factory->define(App\Models\User::class, function (Faker $faker) {
    return [
        // 直接调用 faker API 生成假数据，更多 faker 相关查看 文档。
        'username' => $faker->name,
        'email' => $faker->unique()->safeEmail,
    ];
});

现在，我们已经定义好了工厂，现在我们就要在 UserSeeder@run 函数中使用模型工厂来生成测试数据。

class UserTableSeeder extends Seeder
{

    public function run()
    {
        factory(App\User::class)->times(10)->make()->each(function($user,$index){
            $user->save();
        });
    }
}

run 函数中这一波行云流水的链式调用在我刚刚开始接触 Laravel 的时候也是一脸黑线，不过习惯之后感觉这代码可读性确实很强

• factory(App\User::class) 指明返回哪个工厂，参数 App\User::class 就是工厂的唯一标识。这里我们在定义工厂的时候 define 的第一个参数已经指明了。
• ->times(10) 指明需要工厂模式生成 10 个 User 数据。即会调用 10 次 define 函数的第二个参数。
• ->make() 把生成的 10 个 User 数据封装成 Laravel 中的集合对象。
• ->each() 是 Laravel 集合中的函数，each 函数会针对集合中的每个元素进行操作。这里直接把数据保存到数据库。

好了，数据迁移和数据填充的基本操作也就这些了。更多复杂的用法。。。。也不一定能用上。