【Laravel】ファクトリーとは：Factoryの使い方やテストデータの生成

ファクトリー（Factory）とはテストデータやダミーデータ、シードデータを簡単に生成できる機能です。

Webアプリケーションでは必ずテストを行い、問題がないことを確認してから実際の運用という流れになります。テスト時には多くのテストデータが登録されていることが望ましいです。

手動でテストデータを入れるのは時間がかかるため、Laravelに備わっているファクトリーを利用するのが通常です。

シーダーとは

ファクトリーと共に利用される機能にシーダー（Seeder）があります。シーダーとはデータベースのテーブルにデータの初期値を登録、テスト用のダミーデータを登録する機能です。

シーダーはファクトリーと異なり、一つずつレコードを指定します。シーダーについては以下記事をご参照ください。

【Laravel】シーダーとは：データベースへテストデータや初期値の登録

ファクトリー機能を利用するためのファクトリーファイルはartisanコマンドで生成することができます。以下構文に沿ってコマンドを実行します。

例えばBookingモデルのファクトリーを作成する場合は以下コマンドを実行します。

php artisan make:factory BookingFactory

上記コマンドを実行すると「database/factories」内にBookingFactory.phpというファクトリーファイルが作成されます。

ファイルの中身は以下のようになっています。

<?php

namespace Database\Factories;

use Illuminate\Database\Eloquent\Factories\Factory;

/**
 * @extends \Illuminate\Database\Eloquent\Factories\Factory<\App\Models\Booking>
 */
class BookingFactory extends Factory
{
    /**
     * Define the model's default state.
     *
     * @return array<string, mixed>
     */
    public function definition(): array
    {
        return [
            //
        ];
    }
}

Factoryクラスは「Database\Factories」名前空間に配置され、
「Illuminate\Database\Eloquent\Factories\Factory」を継承していることがわかります。

ファクトリーファイルを生成したら、次はFactoryクラスにどのようなデータを生成するかを定義します。

注意点

ここではすでにモデルが作成されており、かつマイグレーションが実行されてテーブルが作成されていることを前提としています。モデル作成やマイグレーションの実行がまだしていない方は以下記事を参考にしてください。

【Laravel】モデルとは：Modelの概要や作成方法について

【Laravel】マイグレーションとは（migration）：テーブル作成について

作成したファクトリーファイル（ここではBookingFactory.php）を開いて、Factoryクラスにデータを定義していきます。

データ定義はクラス内のdefinitionメソッド内に記入します。

public function definition(): array
{
    return [
        // ここにデータ定義を記入する
    ];
}

例えばdefinitionメソッドへのデータ定義は以下のように記述します。

public function definition(): array
{
    return [
        'name'=>fake()->name(),
        'address'=>fake()->address(),
        'email'=>fake()->email(),
        'title'=>fake()->text(30),
        'body'=>fake()->text(100),
    ];
}

• nameフィールドにはランダム生成された人名が入る
• addressフィールドにはランダム生成された住所が入る
• emailフィールドにはランダム生成されたメールアドレスが入る
• titleフィールドにはランダム生成された30字以内のテキストが入る
• bodyフィールドにはランダム生成された100字以内のテキストが入る

fake()ではFakerライブラリを利用しており、人名や住所、メールアドレス、テキストなどをランダム生成します。Fakerでデータのランダム生成で利用できるメソッドは以下の通りです。

もしテーブル（モデル）にリレーションがある場合、リレーションについても考慮する必要があります。例えばBookingモデルがUserモデルにリレーションがある場合はファクトリーのデータ定義にUserモデルへのリレーションを定義する必要があります。

public function definition(): array
{
    return [
        'name'=>fake()->name(),
        'address'=>fake()->address(),
        'email'=>fake()->email(),
        'title'=>fake()->text(30),
        'body'=>fake()->text(100),
        'user_id'=>\App\Models\User::factory(), // 追記
    ];
}

追記コードによりファクトリー実行時に新しいuserを作成され、そのuserのidがuser_idに入ります。

設定ファイル「config/app.php」内の「faker_locale」を日本語設定しておくと、日本語対応のデータタイプでは日本語のデータを入れます。

// config/app.php
'faker_locale' => 'ja_JP',

ファクトリーではFakerライブラリを利用することでリアルなテストデータを作成できるので積極的に利用してください。

ファクトリーファイルにデータ定義できたら、「database/seeders/DatabaseSeeder.php」を開いてrunメソッド内にファクトリーを実行するコードを記述します。

public function run(): void
{
    \App\Models\Booking::factory(10)->create(); //追記
}

追記したコードではファクトリーを使ってテストデータを10個作成します。

またファクトリーに関連するモデルクラスに以下コードが記述されていることを確認してください。記述されてなければ記述してください。

<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\Model;

class Booking extends Model
{
    use HasFactory; // この記述が必要
}

以下コマンドでDatabaseSeeder.phpのrunメソッドが実行されます。

php artisan db:seed

上記コマンドを実行後にデータベースを確認すると、テストデータが追加されていることが確認できます。

またはDatabaseSeeder.phpに記述するのではなく、作成したシーダーファイルのrunメソッド内に記述してシーダーを実行しても同様の結果が得られます。

php artisan make:seeder BookingSeeder

// database/seeders/BookingSeeder.php
public function run(): void
{
    \App\Models\Booking::factory(10)->create(); //追記
}