Skip to content

数据库:填充

简介

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

NOTE

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

编写 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
{
    /**
     * 运行数据库 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 方法的签名中类型提示你需要的任何依赖。它们将通过 Laravel service container 自动解析。

使用模型工厂

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

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

php
use App\Models\User;

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

调用其他 Seeder

DatabaseSeeder 类中,你可以使用 call 方法来执行其他 seed 类。使用 call 方法允许你将数据库填充拆分为多个文件,这样就不会有单个 seeder 类变得太大。call 方法接受一个应该执行的 seeder 类数组:

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

静默模型事件

在运行 seed 时,你可能想阻止模型分发事件。你可以使用 WithoutModelEvents trait 来实现。使用时,WithoutModelEvents trait 确保不会分发任何模型事件,即使通过 call 方法执行了其他 seed 类:

php
<?php

namespace Database\Seeders;

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

class DatabaseSeeder extends Seeder
{
    use WithoutModelEvents;

    /**
     * 运行数据库 seeder。
     */
    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 之前,系统会提示你进行确认。要强制 seeder 在没有提示的情况下运行,请使用 --force 标志:

shell
php artisan db:seed --force