Eloquent 工廠

📝 此頁面為 Laravel 官方文檔的繁體中文翻譯。查看原始英文版本

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
     */
    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 方法將使用慣例來確定分配給該 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;

/**
 * 為模型建立一個新的工廠實例。
 */
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',
]);

序列

有時您可能希望為每個建立的模型修改給定模型屬性的值。您可以透過將狀態轉換定義為序列來實現這一點。例如，您可能希望為每個建立的使用者在 Y 和 N 之間交替修改 admin 欄位的值：

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

您還可以傳遞一個中間表陣列陣列來為每個相關模型提供唯一的中間表資料：

$user = User::factory()
    ->hasAttached(
        Role::factory(),
        [
            ['active' => true],
            ['active' => false],
        ]
    )
    ->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
 */
public function definition(): array
{
    return [
        'user_id' => User::factory(),
        'title' => fake()->title(),
        'content' => fake()->paragraph(),
    ];
}

如果關聯的欄位依賴於定義它的工廠，您可以將一個閉包分配給一個屬性。該閉包將接收工廠的評估屬性陣列：

/**
 * 定義模型的預設狀態。
 *
 * @return array
 */
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();