Laravel 中文文档

主题

Eloquent：工厂 ​

简介 ​

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

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

php
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 命令：

shell
php artisan make:factory PostFactory

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

模型和工厂发现约定 ​

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

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

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

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

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

php
use Database\Factories\Administration\FlightFactory;

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

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

php
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 方法接受一个闭包，该闭包将接收为工厂定义的原始属性数组，并应返回要修改的属性数组：

php
use Illuminate\Database\Eloquent\Factories\Factory;

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

"已删除" 状态 ​

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

php
use App\Models\User;

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

工厂回调 ​

工厂回调通过 afterMaking 和 afterCreating 方法注册，允许你在创建或实例化模型后执行额外的任务。你应该通过在工厂类上定义 configure 方法来注册这些回调。Laravel 在实例化工厂时会自动调用该方法：

php
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) {
            // ...
        });
    }

    // ...
}

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

php
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 方法创建模型而不将它们持久化到数据库：

php
use App\Models\User;

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

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

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

应用状态 ​

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

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

覆盖属性 ​

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

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

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

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

NOTE

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

持久化模型 ​

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

php
use App\Models\User;

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

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

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

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

序列 ​

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

php
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 的用户。

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

php
use Illuminate\Database\Eloquent\Factories\Sequence;

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

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

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

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

php
$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 方法接受一个工厂实例：

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

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

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

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

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

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

使用魔术方法 ​

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

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

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

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

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

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

从属关联 ​

现在我们已经探索了如何使用工厂构建「一对多」关联，让我们来探索关联的反向。for 方法可用于定义工厂创建的模型所属的父模型。例如，我们可以创建三个属于单个用户的 App\Models\Post 模型实例：

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

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

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

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

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

使用魔术方法 ​

为方便起见，你可以使用 Laravel 的魔术工厂关联方法来定义「从属」关联。例如，以下示例将使用约定来确定三篇文章应属于 Post 模型上的 user 关联：

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

多对多关联 ​

与一对多关联类似，「多对多」关联也可以使用 has 方法创建：

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

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

中间表属性 ​

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

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

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

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

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

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

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

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

使用魔术方法 ​

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

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

多态关联 ​

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

php
use App\Models\Post;

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

Morph To 关联 ​

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

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

多态多对多关联 ​

多态「多对多」（morphToMany / morphedByMany）关联的创建方式与非多态的「多对多」关联相同：

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

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

当然，魔术 has 方法也可用于创建多态「多对多」关联：

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

在工厂中定义关联 ​

要在模型工厂中定义关联，通常需要将新的工厂实例分配给关联的外键。这通常用于「反向」关联，如 belongsTo 和 morphTo 关联。例如，如果你想在创建文章时创建一个新用户，可以执行以下操作：

php
use App\Models\User;

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

如果关联的列依赖于定义它的工厂，你可以将闭包分配给属性。该闭包将接收工厂已求值的属性数组：

php
/**
 * 定义模型的默认状态。
 *
 * @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 方法：

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

如果你有属于公共用户或团队的模型，recycle 方法会特别有用。

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

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