laravel
7. 数据库
数据库:填充数据

介绍

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

[!NOTE]
在数据库填充过程中,批量赋值保护会自动禁用。

编写填充器(Seeders)

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

php artisan make:seeder UserSeeder

默认情况下,一个填充器类(seeder class)只包含一个方法: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,
    ]);
} 

禁用模型事件

在运行数据填充(seeds)时,您可能希望阻止模型触发事件。您可以使用 WithoutModelEvents 特征(trait)来实现此目的。当使用时,WithoutModelEvents 特征可确保不会触发任何模型事件,即使通过 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