Eloquent: 工廠

• 簡介
• 定義模型工廠
  • 生成工廠
  • 工廠狀態
  • 工廠回呼
• 使用工廠建立模型
  • 實例化模型
  • 持久化模型
  • 序列
• 工廠關聯
  • Has Many 關聯
  • Belongs To 關聯
  • Many to Many 關聯
  • 多型關聯
  • 在工廠內定義關聯
  • 在關聯中回收現有的模型

簡介

在測試您的應用程式或進行資料庫填充時，您可能需要向資料庫插入一些紀錄。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();
}

接著，在對應的工廠上定義一個 model 屬性：

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

class FlightFactory extends Factory
{
    /**
     * The name of the factory's corresponding model.
     *
     * @var class-string<\Illuminate\Database\Eloquent\Model>
     */
    protected $model = Flight::class;
}

工廠狀態

狀態操作方法允許您定義離散的修改，這些修改可以以任何組合套用到您的模型工廠中。例如，您的 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',
        ];
    });
}

「Trashed」狀態

如果您的 Eloquent 模型可以被 軟刪除，您可以呼叫內建的 trashed 狀態方法，表示建立的模型應該已經是「軟刪除」狀態。您不需要手動定義 trashed 狀態，因為它會自動提供給所有工廠：

use App\Models\User;

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

工廠回呼

工廠回呼是使用 afterMaking 和 afterCreating 方法註冊的，允許您在製作 (make) 或建立 (create) 模型後執行額外任務。您應該透過在工廠類別上定義 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) 保護會自動被禁用。

持久化模型

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

在此範例中，將建立五個 admin 值為 Y 的使用者，以及五個 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();

工廠關聯

Has Many 關聯

接下來，讓我們探索如何使用 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();

如果您的狀態更改需要訪問父模型，您可以提供一個基於閉包的狀態轉換：

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

Belongs To 關聯

現在我們已經探索了如何使用工廠建立「has many」關聯，讓我們來探索其反向關聯。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 的魔術工廠關聯方法來定義「belongs to」關聯。例如，以下範例將使用慣例來確定這三篇文章應屬於 Post 模型上的 user 關聯：

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

Many to Many 關聯

與 Has Many 關聯 一樣，「many to many」關聯可以使用 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 的魔術工廠關聯方法來定義 many to many 關聯。例如，以下範例將使用慣例來確定關聯模型應透過 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 模型有一個定義 morphTo 關聯的 commentable 方法。在這種情況下，我們可以透過直接使用 for 方法來建立三個屬於單一文章的留言：

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

多型 Many to Many 關聯

多型「many to many」 (morphToMany / morphedByMany) 關聯可以像非多型「many to many」關聯一樣建立：

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

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

當然，魔術 has 方法也可以用於建立多型「many to many」關聯：

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

在工廠內定義關聯

若要在模型工廠中定義關聯，通常會將新的工廠實例指派給該關聯的外鍵 (Foreign Key)。這通常用於「反向」關聯，例如 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(),
    ];
}

如果關聯的欄位取決於定義它的工廠，您可以將閉包 (Closure) 指派給屬性。該閉包將接收工廠已解析出的屬性陣列：

/**
 * 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 方法，以確保在工廠建立的所有關聯中都回收 (Recycle) 單一的相關模型實例。

例如，想像您有 Airline、Flight 和 Ticket 模型，其中機票 (Ticket) 屬於航空公司 (Airline) 和航班 (Flight)，而航班也屬於航空公司。在建立機票時，您可能希望機票和航班使用同一家航空公司，因此您可以將航空公司實例傳遞給 recycle 方法：

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

如果您有屬於共同使用者或團隊的模型，您會發現 recycle 方法特別有用。

recycle 方法也接受現有模型的集合 (Collection)。當向 recycle 方法提供集合時，當工廠需要該類型的模型時，將從該集合中隨機選擇一個模型：

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