Skip to content

数据填充

介绍

Laravel 包括使用种子类为数据库设定数据种子的功能。所有 seed 类都存储在 database/seeders 目录中。默认情况下,为您定义了一个 DatabaseSeeder 类。在这个类中,你可以使用 call 方法来运行其他种子类,从而允许你控制seeder顺序。

NOTE

在数据库填充期间,会自动禁用批量分配保护

编写填充

要生成填充,请执行 make:seeder Artisan 命令。框架生成的所有 seeder 都将放在 database/seeders 目录中:

shell
php artisan make:seeder UserSeeder

默认情况下,seeder 类只包含一个方法:run。执行 db:seed Artisan 命令时调用该方法。在 run 方法中,您可以根据需要将数据插入到数据库中。您可以使用查询构建器手动插入数据,也可以使用 Eloquent 模型工厂。

例如,让我们修改默认的 DatabaseSeeder 类,并向 run 方法添加数据库插入语句:

php
    <?php

    namespace Database\Seeders;

    use Illuminate\Database\Seeder;
    use Illuminate\Support\Facades\DB;
    use Illuminate\Support\Facades\Hash;
    use Illuminate\Support\Str;

    class DatabaseSeeder extends Seeder
    {
        /**
         * 运行数据库填充。
         */
        public function run(): void
        {
            DB::table('users')->insert([
                'name' => Str::random(10),
                'email' => Str::random(10).'@example.com',
                'password' => Hash::make('password'),
            ]);
        }
    }

NOTE

你可以在 run 方法的签名中对你需要的任何依赖项进行 type-hint 操作。它们将通过 Laravel 服务容器自动解析。

使用模型工厂

当然,手动指定每个模型种子的属性很麻烦。相反,您可以使用模型工厂方便地生成大量数据库记录。首先,查看模型工厂文档以了解如何定义工厂。

例如,让我们创建 50 个用户,每个用户都有一个相关文章:

php
    use App\Models\User;

    /**
     * 运行数据库填充
     */
    public function run(): void
    {
        User::factory()
                ->count(50)
                ->hasPosts(1)
                ->create();
    }

调用其他填充

DatabaseSeeder 类中,你可以使用 call 方法来执行其他Seeder类。使用 call 方法可以将数据库种子划分为多个文件,这样就不会有单个 seeder 类变得太大。call 方法接受应执行的 seeder 类数组:

php
    /**
     * 运行数据库填充
     */
    public function run(): void
    {
        $this->call([
            UserSeeder::class,
            PostSeeder::class,
            CommentSeeder::class,
        ]);
    }

禁用模型事件

在运行种子时,您可能希望阻止模型调度事件。您可以使用 WithoutModelEvents trait 来实现这一点。使用时, WithoutModelEvents trait 确保不会调度任何模型事件,即使通过 call 方法执行其他种子类也是如此:

php
    <?php

    namespace Database\Seeders;

    use Illuminate\Database\Seeder;
    use Illuminate\Database\Console\Seeds\WithoutModelEvents;

    class DatabaseSeeder extends Seeder
    {
        use WithoutModelEvents;

        /**
         * 运行数据库填充。
         */
        public function run(): void
        {
            $this->call([
                UserSeeder::class,
            ]);
        }
    }

运行填充

您可以执行 db:seed Artisan 命令来为您的数据库设定种子。默认情况下,db:seed 命令运行该 Database\Seeders\DatabaseSeeder 类,该类反过来可能会调用其他 seed 类。但是,您可以使用 --class 选项来指定要单独运行的特定 seeder 类:

shell
php artisan db:seed

php artisan db:seed --class=UserSeeder

您还可以将 migrate:fresh 命令与 --seed 选项结合使用来设定数据库Seeder,这将删除所有表并重新运行所有迁移。此命令对于完全重建数据库非常有用。--seeder 选项可用于指定要运行的特定填充:

shell
php artisan migrate:fresh --seed

php artisan migrate:fresh --seed --seeder=UserSeeder

强制填充在生产环境中运行

某些种子设定操作可能会导致您更改或丢失数据。为了防止您对生产数据库运行种子设定命令,在生产环境中执行种子设定程序之前,系统将提示您进行确认。要强制填充在没有提示符的情况下运行,请使用 --force 标志:

shell
php artisan db:seed --force