数据库：数据填充

• 简介
• 编写填充器
  • 使用模型工厂
  • 调用其他填充器
  • 静默模型事件
• 运行填充器

简介

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

NOTE

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

编写填充器

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

php artisan make:seeder UserSeeder

一个填充器类默认只包含一个方法：run。当执行 db:seed Artisan 命令时，会调用此方法。在 run 方法中，你可以按照自己的意愿将数据插入数据库。你可以使用 查询构建器 手动插入数据，也可以使用 Eloquent 模型工厂。

例如，让我们修改默认的 DatabaseSeeder 类，并在 run 方法中添加一个数据库插入语句：

<?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 方法的签名中类型提示你需要的任何依赖项。它们将通过 Laravel 服务容器 自动解析。

使用模型工厂

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

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

use App\Models\User;

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

调用其他填充器

在 DatabaseSeeder 类中，你可以使用 call 方法来执行其他的填充类。使用 call 方法可以将数据库填充分解到多个文件中，这样单个填充器类就不会变得太大。call 方法接受一个应被执行的填充器类数组：

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

静默模型事件

在运行数据填充时，你可能希望阻止模型分发事件。你可以使用 WithoutModelEvents trait 来实现这一点。使用该 trait 时，WithoutModelEvents trait 确保即使通过 call 方法执行了其他填充类，也不会分发任何模型事件：

<?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 类，该类可能会依次调用其他填充类。但是，你可以使用 --class 选项来指定要单独运行的特定填充器类：

php artisan db:seed

php artisan db:seed --class=UserSeeder

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

php artisan migrate:fresh --seed

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

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

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

php artisan db:seed --force