この記事にはプロモーションが含まれています。

【Laravel11】シーダとファクトリでテストデータを一括作成する方法

2024-10-182024-12-04

Webアプリ開発をするときは、実際の画面表示やデータ処理の動きなどを確認するためにテストデータを作成する必要があります。

テストデータは手作業で入力していっても問題ありませんが、それではあまりに非効率です。

そこで今回は、Laravel11で

シーダとファクトリを用いて
テストデータを自動で一括作成する方法

をご紹介します。

この記事を読むとわかること

Laravel11でテストデータを自動で一括作成する方法
シーダとファクトリとは？

ケケンタ

シーダとファクトリを活用するといつでも簡単にテストデータの登作成できるようになるため、効率的なアプリ開発が可能になります！

シーダとファクトリ

Laravelにはテストデータを自動作成する仕組みとして「シーダ」と「ファクトリ」の２つが用意されています。

まずは、これら２つについて簡単に解説をします。

シーダ（Seeder）とは？

シーダ（Seeder）とは、英語で「種をまく人」という意味です。

文字通りデータベースに種（テストデータ）をまくというイメージです。

シーダーを用意することで、コマンドを打つだけでテストデータを簡単に追加可能です。

シーダだけでもテストデータを自動追加することは可能です。
ただし、その場合は「テストデータひとつにつき、コマンドを１回実行する必要がある」ため、非常に手間がかかります。
※このあとご紹介するファクトリと組み合わせて使用することで、複数のデータを一括作成することが可能です。

公式ドキュメント（日本語）：シーディング
https://readouble.com/laravel/11.x/ja/seeding.html

ファクトリ（Factory）とは？

ファクトリ（Factory）は、データベースにテストデータを追加する際、各カラムのデフォルト値を自動設定するための仕組みです。

前節でご紹介したシーダと組み合わせることで、下記のような実装ができます。

シーダ　　　→　モデルインスタンスを生成＋データベースへ追加
ファクトリ　→　シーダーで生成されたモデルインスタンスにデフォルト値を設定

シーダとファクトリを組み合わせることで複数のテストデータを一括作成できる

公式ドキュメント（日本語）：ファクトリ
https://readouble.com/laravel/11.x/ja/eloquent-factories.html

【手順】シーダとファクトリでテストデータを一括作成する

本章では、シーダとファクトリを利用して、実際に複数のテストデータを一括作成する手順を解説します。

ケケンタ

大まかな手順は以下のとおりです！

テストデータを一括作成する流れ

ファクトリを作成する
シーダを作成する
モデルを修正する
シーダを実行する

なお、解説をするにあたっては、以下のテーブル構造を持ったTODOアプリを例に用います。

（例）TODOアプリのテーブル構造

カラム名	説明
title	タスクのタイトル
status	タスクの状態（１: 未着手、２:着手中、３:完了）
due_date	タスクの期限

TODOアプリのテーブル構造

実際に手を動かしたい方は、上記構造のTaskモデルとtasksテーブルを事前にご準備下さい

STEP１　ファクトリを作成する

以下のコマンドでファクトリを作成します。

php make:factory TaskFactory

ファクトリファイル名は「モデル名+Factory」の形式にすることを推奨します。
※理由は「STEP２　シーダを作成する」で解説します。

続いて、生成されたTaskFactory.phpのdefinition()メソッドを以下のように編集します。

use Carbon\Carbon;
use Illuminate\Support\Str;

public function definition(): array
{
    return [
        'title' => Str::random(20),  // タスクタイトル
        'status' => 1,               // タスクの状態
        'due_date' => Carbon::now(), // 期限日
    ];
}

ポイントは、テーブルの各カラムに対して、以下のようにデフォルト値を設定している点です。

title …… Strファサードのrandom()メソッドで「20文字のランダムな文字列」を生成
status …… 固定値「１」＝「未着手」を指定
due_date …… Carbonライブラリを使用して「今日の日付」を生成

このあと作成するシーダを実行してモデルインスタンスがデータベースへ追加されるときに、上記で設定したデフォルト値が自動設定されます。

STEP２　シーダを作成する

以下のコマンドでシーダを作成します。

php make:seeder TaskSeeder

シーダファイルの名前は任意です。
※ここではわかりやすく「TaskSeeder」としています。

続いて、生成されたTaskSeeder.phpのrun()メソッドを編集します。

use App\Models\Task;

public function run(): void
{
    // テストデータを「10件」作成する
    Task::factory()->count(10)->create();
}

ここで重要になってくるのが、先ほど作成したファクトリファイル名が「モデル名＋Factory」の形式になっていることです。

これにより、TaskモデルとTaskFactoryファクトリがLaravelによって自動的に紐づけされます。

逆に、ファクトリ名が「モデル名＋Factory」の形式になっていない場合、モデルに対応するファクトリをLaravelが見つけだせず、Task::factory()が上手く実行できなくなります。

※もし任意のモデルとファクトリを紐づけたい場合は、「【補足】任意のモデルとファクトリを紐づける」をご覧ください。

STEP３　モデルを修正する

テストデータを自動作成する最後の準備として、モデルファイルに以下の２行を追加します。
※場合によってはすでに自動的に追加されているかもしれません。

use Illuminate\Database\Eloquent\Factories\HasFactory;

class Task extends Model
{
    use HasFactory; // 追加

    // ~ 省略 ~

}

ケケンタ

ここまでの手順で、テストデータを一括作成する準備が整いました！

STEP４　シーダを実行する

以下のコマンドを実行することで、指定したシーダが実行され、「STEP１　ファクトリを作成する」で設定したデフォルト値がテストデータとしてデータベースへ自動追加されます。

php artisan db:seed --class=TaskSeeder

実行結果

なお、作成済みの複数のシーダを一括実行したい場合は、「–class」オプションを除外します。

php artisan db:seed

【補足】任意のモデルとファクトリを紐づける

「STEP２　シーダを作成する」でお伝えしたように、ファクトリファイル名を「モデル名+Factory」の形式にしなかった場合、Laravelが「どのモデルとどのファクトリが対応しているか」を判断できず、自動的な紐づけが行われません。

もしも任意のモデルとファクトリを紐づけたい場合は、以下のように手動でモデルファイルとファクトリファイルを編集する必要があります。

※以下は、SampleモデルとSampleTableFactoryファクトリを手動で紐づける例です。

Sample.php（モデル）

use Database\Factories\Administration\SampleTableFactory;

/**
 * モデルの新ファクトリ・インスタンスの生成
 */
protected static function newFactory()
{
    return SampleTableFactory::new();
}

SampleTableFactory.php（ファクトリ）

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

class SampleFactory extends Factory
{
    /**
     * このファクトリに対応するモデル名
     */
    protected $model = Sample::class;
}