Skip to content
全部文档

数据库:数据填充

简介

Laravel 支持使用 seed 类向数据库填充数据。所有 seed 类都存放在 database/seeders 目录中。默认会为你定义一个 DatabaseSeeder 类。你可以在该类中使用 call 方法运行其他 seed 类,从而控制填充顺序。

INFO

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

编写 Seeder

要生成 seeder,请执行 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
{
    /**
     * Run the database seeders.
     */
    public function run(): void
    {
        DB::table('users')->insert([
            'name' => Str::random(10),
            'email' => Str::random(10).'@example.com',
            'password' => Hash::make('password'),
        ]);
    }
}

INFO

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

使用模型工厂

当然,为每条模型种子数据手动指定属性很繁琐。你可以使用模型工厂方便地生成大量数据库记录。请先阅读模型工厂文档,了解如何定义工厂。

例如,我们来创建 50 个用户,每人关联一篇文章:

php
use App\Models\User;

/**
 * Run the database seeders.
 */
public function run(): void
{
    User::factory()
        ->count(50)
        ->hasPosts(1)
        ->create();
}

调用其他 Seeder

DatabaseSeeder 类中,你可以使用 call 方法执行其他 seed 类。使用 call 可将数据库填充拆分到多个文件中,避免单个 seeder 类过于庞大。call 方法接受应执行的 seeder 类数组:

php
/**
 * Run the database seeders.
 */
public function run(): void
{
    $this->call([
        UserSeeder::class,
        PostSeeder::class,
        CommentSeeder::class,
    ]);
}

静默模型事件

运行填充时,你可能希望阻止模型派发事件。可使用 WithoutModelEvents trait 实现。使用后,即使通过 call 方法执行了其他 seed 类,WithoutModelEvents 也会确保不派发任何模型事件:

php
<?php

namespace Database\Seeders;

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

class DatabaseSeeder extends Seeder
{
    use WithoutModelEvents;

    /**
     * Run the database seeders.
     */
    public function run(): void
    {
        $this->call([
            UserSeeder::class,
        ]);
    }
}

运行 Seeder

你可以执行 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

在生产环境强制运行 Seeder

某些填充操作可能导致数据被修改或丢失。为防止你对生产数据库误跑填充命令,在 production 环境中执行 seeder 前会要求确认。若要跳过提示强制运行,请使用 --force 标志:

shell
php artisan db:seed --force