简介

Laravel 内置了一个可为你的数据库填充测试数据的数据填充类。所有的数据填充类都应该放在 php database/seeds 目录下。Laravel 默认定义了一个 php DatabaseSeeder 类。通过这个类,你可以用 php call 方法来运行其他的 php seed 类,从而控制数据填充的顺序。

注意
在数据库填充期间,批量赋值保护被自动禁用。

编写 Seeders

运行 Artisan 命令 php make:seeder 可以生成 Seeder,生成的 seeders 都放在 php database/seeders 目录下:

  1. php artisan make:seeder UserSeeder

一个数据填充类默认只包含一个方法:php run ,当执行 php db:seed Artisan命令 时,被调用。在 php run 方法中, 可以按需将数据插入数据库中。 也可以使用查询构造器来手动插入数据,或者可以使用 Eloquent 数据工厂。

例如,在默认 php DatabaseSeeder 类的 php run 方法中添加一个数据库插入语句:

  1. <?php
  2. namespace Database\Seeders;
  3. use Illuminate\Database\Seeder;
  4. use Illuminate\Support\Facades\DB;
  5. use Illuminate\Support\Facades\Hash;
  6. use Illuminate\Support\Str;
  7. class DatabaseSeeder extends Seeder
  8. {
  9. /**
  10. * 运行数据填充
  11. */
  12. public function run(): void
  13. {
  14. DB::table('users')->insert([
  15. 'name' => Str::random(10),
  16. 'email' => Str::random(10).'@gmail.com',
  17. 'password' => Hash::make('password'),
  18. ]);
  19. }
  20. }

注意
可以在 php run 方法的参数中键入你需要的任何依赖性,它们将自动通过 Laravel 服务容器注入。

使用模型工厂

当然,手动指定每个模型填充的属性是很麻烦的。因此可以使用 Eloquent 数据工厂来更方便地生成大量的数据库记录。首先,查看 Eloquent 数据工厂,了解如何定义工厂。

例如,创建50个用户,每个用户有一个相关的帖子:

  1. use App\Models\User;
  2. /**
  3. * 运行数据库迁移
  4. */
  5. public function run(): void
  6. {
  7. User::factory()
  8. ->count(50)
  9. ->hasPosts(1)
  10. ->create();
  11. }

调用其他 Seeders

php DatabaseSeeder 类中,可以使用 php call 方法来执行其他的填充类。使用 php call 方法可以将数据库迁移分成多个文件,这样就不会出现单个数据填充类过大。php call 方法接受一个由数据填充类组成的数组:

  1. /**
  2. * 运行数据库迁移
  3. */
  4. public function run(): void
  5. {
  6. $this->call([
  7. UserSeeder::class,
  8. PostSeeder::class,
  9. CommentSeeder::class,
  10. ]);
  11. }

禁用模型事件

在运行时,你可能想阻止模型调用事件,可以使用 php WithoutModelEvents 特性。使用 php WithoutModelEvents trait 可确保不调用模型事件,即使通过 php call 方法执行了额外的 seed 类:

  1. <?php
  2. namespace Database\Seeders;
  3. use Illuminate\Database\Seeder;
  4. use Illuminate\Database\Console\Seeds\WithoutModelEvents;
  5. class DatabaseSeeder extends Seeder
  6. {
  7. use WithoutModelEvents;
  8. /**
  9. * 运行数据库迁移
  10. */
  11. public function run(): void
  12. {
  13. $this->call([
  14. UserSeeder::class,
  15. ]);
  16. }
  17. }

运行 Seeders

执行 php db:seed Artisan 命令来为数据库填充数据。默认情况下,php db:seed 命令会运行 php Database\Seeders\DatabaseSeeder 类来调用其他数据填充类。当然,也可以使用 php --class 选项来指定一个特定的填充类:

  1. php artisan db:seed
  2. php artisan db:seed --class=UserSeeder

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

  1. php artisan migrate:fresh --seed
  2. php artisan migrate:fresh --seed --seeder=UserSeeder

在生产环境中强制运行填充
一些填充操作可能会导致原有数据的更新或丢失。为了保护生产环境数据库的数据,在 php 生产环境 中运行填充命令前会进行确认。可以添加 php --force 选项来强制运行填充命令:

  1. php artisan db:seed --force