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
{
    /**
     * The current password being used by the factory.
     */
    protected static ?string $password;

    /**
     * Define the model's default state.
     *
     * @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),
        ];
    }

    /**
     * Indicate that the model's email address should be unverified.
     */
    public function unverified(): static
    {
        return $this->state(fn (array $attributes) => [
            'email_verified_at' => null,
        ]);
    }
}

如您所見，在最基本的形態中，工廠是繼承 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 trait 提供給模型的靜態 factory 方法，來為該模型實例化一個工廠實例。

HasFactory trait 的 factory 方法將使用慣例來決定適合該 trait 所屬模型的工廠。具體來說，該方法會在 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;

/**
 * Create a new factory instance for the model.
 */
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;

/**
 * Indicate that the user is suspended.
 */
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 方法進行註冊，允許您在建立（making）或持久化（creating）模型後執行額外任務。您應該透過在工廠類別中定義 configure 方法來註冊這些回呼。當工廠被實例化時，Laravel 會自動呼叫此方法：

namespace Database\Factories;

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

class UserFactory extends Factory
{
    /**
     * Configure the model 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;

/**
 * Indicate that the user is suspended.
 */
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();

📌 備註

使用工廠建立模型時，大量賦值保護(Mass assignment protection) 會自動被停用。

持久化模型

create 方法會實例化模型實例，並使用 Eloquent 的 save 方法將其持久化到資料庫中：

use App\Models\User;

// Create a single App\Models\User instance...
$user = User::factory()->create();

// Create three App\Models\User instances...
$users = User::factory()->count(3)->create();

您可以透過將屬性陣列傳遞給 create 方法，來覆寫工廠的預設模型屬性：

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

序列

有時候您可能希望為每個建立的模型交替變更特定屬性的值。您可以透過將狀態轉換定義為序列 (sequence) 來達成此目的。例如，您可能希望為每個建立的使用者，將 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();

在這個範例中，將建立 5 個 admin 值为 Y 的使用者，以及 5 個 admin 值为 N 的使用者。

如果有必要，您可以將閉包 (closure) 作為序列值。每當序列需要新值時，該閉包就會被呼叫：

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 的流暢 (fluent) 工廠方法來建立 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();

當然，您也可以對相關模型進行狀態操作。此外，如果您的狀態變更需要存取父模型，可以傳遞一個基於閉包 (closure) 的狀態轉換：

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

樞紐表屬性

如果您需要定義應該設定在連結模型之樞紐 (pivot) / 中間表上的屬性，可以使用 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();

多型關聯

多型關聯 也可以使用工廠建立。多型「多型一對多 (morph many)」關聯的建立方式與一般的一對多關聯相同。例如，如果 App\Models\Post 模型與 App\Models\Comment 模型之間具有 morphMany 關聯：

use App\Models\Post;

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

Morph To 關聯

魔術方法不能用於建立 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;

/**
 * Define the model's default state.
 *
 * @return array<string, mixed>
 */
public function definition(): array
{
    return [
        'user_id' => User::factory(),
        'title' => fake()->title(),
        'content' => fake()->paragraph(),
    ];
}

如果關聯的欄位取決於定義它的工廠，您可以將閉包分配給屬性。該閉包將接收工廠已求值的屬性陣列：

/**
 * Define the model's default state.
 *
 * @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();