Eloquent：工厂

• 简介
• 定义模型工厂
  • 生成工厂
  • 工厂状态
  • 工厂回调
• 使用工厂创建模型
  • 实例化模型
  • 持久化模型
  • 序列
• 工厂关系
  • 一对多关系
  • 反向一对多关系
  • 多对多关系
  • 多态关系
  • 在工厂内定义关系
  • 为关系复用现有模型

简介

在测试应用程序或填充数据库时，你可能需要向数据库中插入一些记录。与其手动指定每个列的值，Laravel 允许你使用模型工厂为每个 Eloquent 模型定义一组默认属性。

要查看如何编写工厂的示例，请查看应用程序中的 database/factories/UserFactory.php 文件。此工厂包含在所有新的 Laravel 应用程序中，并包含以下工厂定义：

namespace Database\Factories;

use Illuminate\Database\Eloquent\Factories\Factory;
use Illuminate\Support\Facades\Hash;
use Illuminate\Support\Str;

/**
 * @extends \Illuminate\Database\Eloquent\Factories\Factory<\App\Models\User>
 */
class UserFactory extends Factory
{
    /**
     * 工厂当前使用的密码。
     */
    protected static ?string $password;

    /**
     * 定义模型的默认状态。
     *
     * @return array<string, mixed>
     */
    public function definition(): array
    {
        return [
            'name' => fake()->name(),
            'email' => fake()->unique()->safeEmail(),
            'email_verified_at' => now(),
            'password' => static::$password ??= Hash::make('password'),
            'remember_token' => Str::random(10),
        ];
    }

    /**
     * 指示模型的电子邮件地址应为未验证。
     */
    public function unverified(): static
    {
        return $this->state(fn (array $attributes) => [
            'email_verified_at' => null,
        ]);
    }
}

如你所见，在最基本的形式中，工厂是扩展 Laravel 基础工厂类并定义 definition 方法的类。definition 方法返回使用工厂创建模型时应应用的默认属性值集。

通过 fake 辅助函数，工厂可以访问 Faker PHP 库，它允许你方便地为测试和填充生成各种随机数据。

NOTE

你可以通过更新 config/app.php 配置文件中的 faker_locale 选项来更改应用程序的 Faker 区域设置。

定义模型工厂

生成工厂

要创建工厂，请执行 make:factory Artisan 命令：

php artisan make:factory PostFactory

新的工厂类将放置在你的 database/factories 目录中。

模型与工厂发现约定

一旦你定义了工厂，你可以使用由 Illuminate\Database\Eloquent\Factories\HasFactory trait 提供给模型的静态 factory 方法来为该模型实例化一个工厂实例。

HasFactory trait 的 factory 方法将使用约定来确定分配给该模型的正确工厂。具体来说，该方法将在 Database\Factories 命名空间中查找一个类名与模型名称匹配并以 Factory 结尾的工厂。如果这些约定不适用于你的特定应用程序或工厂，你可以向模型添加 UseFactory 属性来手动指定模型的工厂：

use Illuminate\Database\Eloquent\Attributes\UseFactory;
use Database\Factories\Administration\FlightFactory;

#[UseFactory(FlightFactory::class)]
class Flight extends Model
{
    // ...
}

或者，你可以覆盖模型上的 newFactory 方法，直接返回模型对应工厂的实例：

use Database\Factories\Administration\FlightFactory;

/**
 * 为模型创建一个新的工厂实例。
 */
protected static function newFactory()
{
    return FlightFactory::new();
}

然后，在对应的工厂上使用 UseModel 属性来指定模型：

use App\Administration\Flight;
use Illuminate\Database\Eloquent\Factories\Attributes\UseModel;
use Illuminate\Database\Eloquent\Factories\Factory;

#[UseModel(Flight::class)]
class FlightFactory extends Factory
{
    // ...
}

工厂状态

状态操作方法允许你定义可以任意组合应用于模型工厂的离散修改。例如，你的 Database\Factories\UserFactory 工厂可能包含一个 suspended 状态方法，该方法修改其一个默认属性值。

状态转换方法通常调用 Laravel 基础工厂类提供的 state 方法。state 方法接受一个闭包，该闭包将接收为工厂定义的原始属性数组，并应返回要修改的属性数组：

use Illuminate\Database\Eloquent\Factories\Factory;

/**
 * 指示用户已被暂停。
 */
public function suspended(): Factory
{
    return $this->state(function (array $attributes) {
        return [
            'account_status' => 'suspended',
        ];
    });
}

“已软删除”状态

如果你的 Eloquent 模型可以被软删除，你可以调用内置的 trashed 状态方法来指示创建的模型应该已经是“软删除”状态。你不需要手动定义 trashed 状态，因为它自动适用于所有工厂：

use App\Models\User;

$user = User::factory()->trashed()->create();

工厂回调

工厂回调使用 afterMaking 和 afterCreating 方法注册，并允许你在创建或生成模型后执行附加任务。你应该通过在工厂类上定义一个 configure 方法来注册这些回调。当工厂被实例化时，Laravel 将自动调用此方法：

namespace Database\Factories;

use App\Models\User;
use Illuminate\Database\Eloquent\Factories\Factory;

class UserFactory extends Factory
{
    /**
     * 配置模型工厂。
     */
    public function configure(): static
    {
        return $this->afterMaking(function (User $user) {
            // ...
        })->afterCreating(function (User $user) {
            // ...
        });
    }

    // ...
}

你也可以在状态方法中注册工厂回调，以执行特定于给定状态的附加任务：

use App\Models\User;
use Illuminate\Database\Eloquent\Factories\Factory;

/**
 * 指示用户已被暂停。
 */
public function suspended(): Factory
{
    return $this->state(function (array $attributes) {
        return [
            'account_status' => 'suspended',
        ];
    })->afterMaking(function (User $user) {
        // ...
    })->afterCreating(function (User $user) {
        // ...
    });
}

使用工厂创建模型

实例化模型

一旦你定义了工厂，你可以使用由 Illuminate\Database\Eloquent\Factories\HasFactory trait 提供给模型的静态 factory 方法来为该模型实例化一个工厂实例。让我们看一些创建模型的示例。首先，我们将使用 make 方法来创建模型而不将它们持久化到数据库：

use App\Models\User;

$user = User::factory()->make();

你可以使用 count 方法创建多个模型的集合：

$users = User::factory()->count(3)->make();

应用状态

你也可以将任何状态应用于模型。如果你想对模型应用多个状态转换，你可以直接调用状态转换方法：

$users = User::factory()->count(5)->suspended()->make();

覆盖属性

如果你想覆盖模型的一些默认值，你可以向 make 方法传递一个值数组。只有指定的属性将被替换，而其余属性保持工厂指定的默认值：

$user = User::factory()->make([
    'name' => 'Abigail Otwell',
]);

或者，可以直接在工厂实例上调用 state 方法以执行内联状态转换：

$user = User::factory()->state([
    'name' => 'Abigail Otwell',
])->make();

NOTE

使用工厂创建模型时，批量赋值保护会自动禁用。

持久化模型

create 方法实例化模型实例并使用 Eloquent 的 save 方法将它们持久化到数据库：

use App\Models\User;

// 创建一个单独的 App\Models\User 实例...
$user = User::factory()->create();

// 创建三个 App\Models\User 实例...
$users = User::factory()->count(3)->create();

你可以通过向 create 方法传递属性数组来覆盖工厂的默认模型属性：

$user = User::factory()->create([
    'name' => 'Abigail',
]);

序列

有时你可能希望为每个创建的模型交替改变给定模型属性的值。你可以通过将状态转换定义为序列来实现。例如，你可能希望为每个创建的用户在 admin 列的值在 Y 和 N 之间交替：

use App\Models\User;
use Illuminate\Database\Eloquent\Factories\Sequence;

$users = User::factory()
    ->count(10)
    ->state(new Sequence(
        ['admin' => 'Y'],
        ['admin' => 'N'],
    ))
    ->create();

在此示例中，将创建五个 admin 值为 Y 的用户和五个 admin 值为 N 的用户。

如有必要，你可以将闭包作为序列值。每次序列需要新值时都会调用该闭包：

use Illuminate\Database\Eloquent\Factories\Sequence;

$users = User::factory()
    ->count(10)
    ->state(new Sequence(
        fn (Sequence $sequence) => ['role' => UserRoles::all()->random()],
    ))
    ->create();

在序列闭包中，你可以访问注入到闭包中的序列实例的 $index 属性。$index 属性包含到目前为止已发生的序列迭代次数：

$users = User::factory()
    ->count(10)
    ->state(new Sequence(
        fn (Sequence $sequence) => ['name' => 'Name '.$sequence->index],
    ))
    ->create();

为方便起见，也可以使用 sequence 方法应用序列，该方法只是在内部调用 state 方法。sequence 方法接受一个闭包或序列属性的数组：

$users = User::factory()
    ->count(2)
    ->sequence(
        ['name' => 'First User'],
        ['name' => 'Second User'],
    )
    ->create();

工厂关系

一对多关系

接下来，让我们探索使用 Laravel 的流畅工厂方法构建 Eloquent 模型关系。首先，假设我们的应用程序有一个 App\Models\User 模型和一个 App\Models\Post 模型。同时，假设 User 模型定义了与 Post 的 hasMany 关系。我们可以使用 Laravel 工厂提供的 has 方法创建一个拥有三篇文章的用户。has 方法接受一个工厂实例：

use App\Models\Post;
use App\Models\User;

$user = User::factory()
    ->has(Post::factory()->count(3))
    ->create();

按照惯例，当将 Post 模型传递给 has 方法时，Laravel 会假设 User 模型必须有一个定义该关系的 posts 方法。如果需要，你可以显式指定要操作的关系名称：

$user = User::factory()
    ->has(Post::factory()->count(3), 'posts')
    ->create();

当然，你可以对相关模型执行状态操作。此外，如果你的状态更改需要访问父模型，你可以传递一个基于闭包的状态转换：

$user = User::factory()
    ->has(
        Post::factory()
            ->count(3)
            ->state(function (array $attributes, User $user) {
                return ['user_type' => $user->type];
            })
    )
    ->create();

使用魔术方法

为方便起见，你可以使用 Laravel 的魔术工厂关系方法来构建关系。例如，以下示例将使用约定来确定相关模型应通过 User 模型上的 posts 关系方法创建：

$user = User::factory()
    ->hasPosts(3)
    ->create();

当使用魔术方法创建工厂关系时，你可以传递一个属性数组以覆盖相关模型：

$user = User::factory()
    ->hasPosts(3, [
        'published' => false,
    ])
    ->create();

您也可以传递多个属性数组来创建关联模型，并为每个模型指定状态。Laravel 将按顺序应用每个数组：

$user = User::factory()
    ->hasPosts(
        ['title' => 'First Post'],
        ['title' => 'Second Post'],
        ['title' => 'Third Post'],
    )
    ->create();

如果你的状态更改需要访问父模型，你可以提供一个基于闭包的状态转换：

$user = User::factory()
    ->hasPosts(3, function (array $attributes, User $user) {
        return ['user_type' => $user->type];
    })
    ->create();

反向一对多关系

既然我们已经探索了如何使用工厂构建“一对多”关系，让我们探讨该关系的反向关系。for 方法可用于定义工厂创建的模型所属的父模型。例如，我们可以创建三个属于同一用户的 App\Models\Post 模型实例：

use App\Models\Post;
use App\Models\User;

$posts = Post::factory()
    ->count(3)
    ->for(User::factory()->state([
        'name' => 'Jessica Archer',
    ]))
    ->create();

如果你已经有一个父模型实例应该与你正在创建的模型相关联，你可以将该模型实例传递给 for 方法：

$user = User::factory()->create();

$posts = Post::factory()
    ->count(3)
    ->for($user)
    ->create();

使用魔术方法

为方便起见，你可以使用 Laravel 的魔术工厂关系方法来定义“反向一对多”关系。例如，以下示例将使用约定来确定三篇文章应属于 Post 模型上的 user 关系：

$posts = Post::factory()
    ->count(3)
    ->forUser([
        'name' => 'Jessica Archer',
    ])
    ->create();

多对多关系

与一对多关系一样，“多对多”关系也可以使用 has 方法创建：

use App\Models\Role;
use App\Models\User;

$user = User::factory()
    ->has(Role::factory()->count(3))
    ->create();

中间表属性

如果需要定义应在连接模型的中间表上设置的属性，可以使用 hasAttached 方法。此方法接受一个中间表属性名称和值的数组作为其第二个参数：

use App\Models\Role;
use App\Models\User;

$user = User::factory()
    ->hasAttached(
        Role::factory()->count(3),
        ['active' => true]
    )
    ->create();

如果你的状态更改需要访问相关模型，你可以提供一个基于闭包的状态转换：

$user = User::factory()
    ->hasAttached(
        Role::factory()
            ->count(3)
            ->state(function (array $attributes, User $user) {
                return ['name' => $user->name.' Role'];
            }),
        ['active' => true]
    )
    ->create();

如果你已经有一些模型实例想要附加到你正在创建的模型上，你可以将这些模型实例传递给 hasAttached 方法。在此示例中，相同的三个角色将附加到所有三个用户：

$roles = Role::factory()->count(3)->create();

$users = User::factory()
    ->count(3)
    ->hasAttached($roles, ['active' => true])
    ->create();

使用魔术方法

为方便起见，你可以使用 Laravel 的魔术工厂关系方法来定义多对多关系。例如，以下示例将使用约定来确定相关模型应通过 User 模型上的 roles 关系方法创建：

$user = User::factory()
    ->hasRoles(1, [
        'name' => 'Editor'
    ])
    ->create();

多态关系

多态关系也可以使用工厂创建。多态“多态一对多”关系的创建方式与典型的“一对多”关系相同。例如，如果 App\Models\Post 模型与 App\Models\Comment 模型具有 morphMany 关系：

use App\Models\Post;

$post = Post::factory()->hasComments(3)->create();

多态关联

不能使用魔术方法创建 morphTo 关系。相反，必须直接使用 for 方法，并且必须显式提供关系的名称。例如，假设 Comment 模型有一个定义 morphTo 关系的 commentable 方法。在这种情况下，我们可以通过直接使用 for 方法创建属于同一篇文章的三条评论：

$comments = Comment::factory()->count(3)->for(
    Post::factory(), 'commentable'
)->create();

多态多对多关系

多态“多对多”（morphToMany / morphedByMany）关系的创建方式可以与非多态“多对多”关系相同：

use App\Models\Tag;
use App\Models\Video;

$video = Video::factory()
    ->hasAttached(
        Tag::factory()->count(3),
        ['public' => true]
    )
    ->create();

当然，魔术 has 方法也可以用于创建多态“多对多”关系：

$video = Video::factory()
    ->hasTags(3, ['public' => true])
    ->create();

在工厂内定义关系

要在模型工厂内定义关系，通常会将一个新的工厂实例分配给关系的外键。这通常用于“反向”关系，例如 belongsTo 和 morphTo 关系。例如，如果你希望在创建文章时创建一个新用户，你可以这样做：

use App\Models\User;

/**
 * 定义模型的默认状态。
 *
 * @return array<string, mixed>
 */
public function definition(): array
{
    return [
        'user_id' => User::factory(),
        'title' => fake()->title(),
        'content' => fake()->paragraph(),
    ];
}

如果关系的列依赖于定义它的工厂，你可以将一个闭包分配给一个属性。该闭包将接收工厂评估后的属性数组：

/**
 * 定义模型的默认状态。
 *
 * @return array<string, mixed>
 */
public function definition(): array
{
    return [
        'user_id' => User::factory(),
        'user_type' => function (array $attributes) {
            return User::find($attributes['user_id'])->type;
        },
        'title' => fake()->title(),
        'content' => fake()->paragraph(),
    ];
}

为关系复用现有模型

如果你有多个模型与另一个模型共享一个公共关系，你可以使用 recycle 方法来确保工厂创建的所有关系都复用同一个相关模型实例。

例如，假设你有 Airline、Flight 和 Ticket 模型，其中机票属于航空公司和航班，而航班也属于航空公司。在创建机票时，你可能希望机票和航班使用同一个航空公司，因此你可以将航空公司实例传递给 recycle 方法：

Ticket::factory()
    ->recycle(Airline::factory()->create())
    ->create();

如果你有模型属于同一个用户或团队，你会发现 recycle 方法特别有用。

recycle 方法也接受一个现有模型的集合。当向 recycle 方法提供一个集合时，当工厂需要该类型的模型时，将从集合中随机选择一个模型：

Ticket::factory()
    ->recycle($airlines)
    ->create();