Eloquent：数据工厂

• 介绍
• 定义模型工厂
  • 生成工厂
  • 工厂状态
  • 工厂回调
• 使用工厂创建模型
  • 实例化模型
  • 持久化模型
  • 序列
• 工厂关联
  • 一对多关系
  • 属于关系
  • 多对多关系
  • 多态关系
  • 在工厂中定义关系
  • 重复利用现有的模型建立关系

介绍

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

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

namespace Database\Factories;

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

class UserFactory extends Factory
{
    /**
     * 定义模型的默认状态
     *
     * @return array<string, mixed>
     */
    public function definition(): array
    {
        return [
            'name' => fake()->name(),
            'email' => fake()->unique()->safeEmail(),
            'email_verified_at' => now(),
            'password' => '$2y$10$92IXUNpkjO0rOQ5byMi.Ye4oKoEa3Ro9llC/.og/at2.uheWG/igi', // password
            'remember_token' => Str::random(10),
        ];
    }
}

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

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

注意
你可以通过在 config/app.php 配置文件中添加 faker_locale 选项来设置你应用程序的 Faker 区域设置。

定义模型工厂

创建工厂

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

php artisan make:factory PostFactory

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

模型和工厂的自动发现机制

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

HasFactory 特征的 factory 方法将使用约定来确定适用于特定模型的工厂。具体而言，该方法将在 Database\Factories 命名空间中查找一个工厂，该工厂的类名与模型名称匹配，并以 Factory 为后缀。如果这些约定不适用于你的特定应用程序或工厂，则可以在模型上覆盖 newFactory 方法，以直接返回模型对应的工厂的实例：

use Illuminate\Database\Eloquent\Factories\Factory;
use Database\Factories\Administration\FlightFactory;

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

接下来，定义相应工厂的 model 属性：

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

class FlightFactory extends Factory
{
    /**
     * 工厂对应的模型名称。
     *
     * @var string
     */
    protected $model = Flight::class;
}

工厂状态

状态操作方法可以让你定义离散的修改，这些修改可以在任意组合中应用于你的模型工厂。例如，你的 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',
        ];
    });
}

「Trashed」状态

如果你的 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;
use Illuminate\Support\Str;

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

    // ...
}

使用工厂创建模型

实例化模型

一旦你定义了工厂，你可以使用由 Illuminate\Database\Eloquent\Factories\HasFactory 特征为你的模型提供的静态 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();

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

持久化模型

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 或 $count 属性。 $index 属性包含到目前为止已经进行的序列迭代次数，而 $count 属性包含序列将被调用的总次数：

$users = User::factory()
                ->count(10)
                ->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 的一对多关系。我们可以使用 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();

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

$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();

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

使用魔术方法

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

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

多态关联

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

use App\Models\Post;

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

Morph To 关联

不能使用魔术方法创建 morphTo 关联。必须直接使用 for 方法，并明确提供关联名称。例如，假设 Comment 模型有一个 commentable 方法，该方法定义了一个 morphTo 关联。在这种情况下，我们可以使用 for 方法直接创建属于单个帖子的三个评论：

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

多态多对多关联

多态「many to many」( morphToMany / morphedByMany ) 关联的创建方式与非多态 「many to many」 关联相同：

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

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

当然，魔术方法 has 也可以用于创建多态「many to many」关系：

$videos = 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();

---

原文地址：/cndocs/10.x/el...

译文地址：/cndocs/10.x/el...