跳转至内容

数据库:数据填充

简介

Laravel 具备使用填充类(seed classes)向数据库填充数据的能力。所有的填充类都存放在 database/seeders 目录中。默认情况下,系统为你定义了一个 DatabaseSeeder 类。在这个类中,你可以使用 call 方法来运行其他填充类,从而控制数据填充的顺序。

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

编写填充器

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

1php artisan make:seeder UserSeeder

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

作为示例,让我们修改默认的 DatabaseSeeder 类,并在 run 方法中添加一个数据库插入语句。

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

你可以在 run 方法的签名中对所需的任何依赖项进行类型提示。它们将自动通过 Laravel 服务容器 进行解析。

使用模型工厂

当然,为每个模型填充手动指定属性是很麻烦的。相反,你可以使用 模型工厂 来便捷地生成大量数据库记录。首先,请查阅 模型工厂文档,了解如何定义你的工厂。

例如,让我们创建 50 个用户,每个用户都关联一篇文章。

1use App\Models\User;
2 
3/**
4 * Run the database seeders.
5 */
6public function run(): void
7{
8 User::factory()
9 ->count(50)
10 ->hasPosts(1)
11 ->create();
12}

调用其他填充器

DatabaseSeeder 类中,你可以使用 call 方法来执行其他的填充类。使用 call 方法可以将数据库填充任务拆分到多个文件中,这样就不会使单个填充类变得过于庞大。call 方法接受一个要执行的填充类数组。

1/**
2 * Run the database seeders.
3 */
4public function run(): void
5{
6 $this->call([
7 UserSeeder::class,
8 PostSeeder::class,
9 CommentSeeder::class,
10 ]);
11}

静默模型事件

在运行填充时,你可能希望防止模型触发事件。你可以通过使用 WithoutModelEvents trait 来实现这一点。使用后,即使通过 call 方法执行了额外的填充类,WithoutModelEvents trait 也能确保模型事件不会被触发。

1<?php
2 
3namespace Database\Seeders;
4 
5use Illuminate\Database\Seeder;
6use Illuminate\Database\Console\Seeds\WithoutModelEvents;
7 
8class DatabaseSeeder extends Seeder
9{
10 use WithoutModelEvents;
11 
12 /**
13 * Run the database seeders.
14 */
15 public function run(): void
16 {
17 $this->call([
18 UserSeeder::class,
19 ]);
20 }
21}

运行填充器

你可以执行 db:seed Artisan 命令来填充数据库。默认情况下,db:seed 命令会运行 Database\Seeders\DatabaseSeeder 类,该类随后可能会调用其他填充类。不过,你可以使用 --class 选项来指定要单独运行的特定填充类。

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

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

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

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

某些填充操作可能会导致数据变更或丢失。为了防止在生产数据库中意外运行填充命令,系统会在 production 环境中执行填充器之前提示你进行确认。若要强制运行填充器而不进行提示,请使用 --force 标志。

1php artisan db:seed --force