More than 5 years have passed since last update.

Laravel の Eloquent Factory で属性の設定にクロージャを使う意味

Last updated at 2019-08-18Posted at 2019-02-21

Factory では属性の定義にクロージャが使える

Laravel の Eloquent には Factory という機能があって、公式ドキュメントに書いてある使い方の説明を見てみると以下のように書いてあります。

Relations & Attribute Closures

You may also attach relationships to models using Closure attributes in your factory definitions. For example, if you would like to create a new User instance when creating a Post, you may do the following:

$factory->define(App\Post::class, function ($faker) {
    return [
        'title' => $faker->title,
        'content' => $faker->paragraph,
        'user_id' => function () {
            return factory(App\User::class)->create()->id;
        }
    ];
});

These Closures also receive the evaluated attribute array of the factory that defines them:

$factory->define(App\Post::class, function ($faker) {
    return [
        'title' => $faker->title,
        'content' => $faker->paragraph,
        'user_id' => function () {
            return factory(App\User::class)->create()->id;
        },
        'user_type' => function (array $post) {
            return App\User::find($post['user_id'])->type;
        }
    ];
});

ざっくり説明すると「属性の定義にはクロージャを使うこともできて、それを使ってモデルとのリレーションを定義することもできるよ」っていうようなことが書いてあるのですが、なんでクロージャを使う必要があるのかが書かれてません。
Laravel あるあるで、使えないより使える方が便利っていうだけで実装されてる可能性もありますが、わざわざドキュメントに書くくらいなので、何かメリットがありそうです。

ちなみに、属性の定義に使うクロージャーのことを、ドキュメントでは Attribute Closures と呼んだり Closure attributes と呼んだりしています。
英語人の慣習はよくわからないのですが、ここでは仮に「属性クロージャ」と呼ぶことにします。

属性クロージャを使わない場合

ちなみに属性クロージャを使わない場合は以下のようなコードになると思います。

$factory->define(App\Post::class, function ($faker) {
    return [
        'title' => $faker->title,
        'content' => $faker->paragraph,
        'user_id' => factory(App\User::class)->create()->id,
    ];
});

$factory->define(App\Post::class, function ($faker) {
    $user = factory(App\User::class)->create();

    return [
        'title' => $faker->title,
        'content' => $faker->paragraph,
        'user_id' => $user->id,
        'user_type' => $user->type,
    ];
});

うん。わかりやすい。
これと属性クロージャを使った場合で何が違うのか。ソースコードを追って調べてみました。

Factory が Model インスタンスを作るまで

例にも出てきている変数 $factory の中身は Illuminate\Database\Eloquent\Factory クラスのインスタンスです。
この Factory クラスは、Factory の定義をする役割を担っています。

一方、Factory を使う際に使用するヘルパー関数 factory() では、Factory クラスの of() メソッドを呼び出し、Illuminate\Database\Eloquent\FactoryBuilder クラスのインスタンスを生成しています。

vendor/laravel/framework/src/Illuminate/Foundation/helpers.php

    /**
     * Create a model factory builder for a given class, name, and amount.
     *
     * @param  dynamic  class|class,name|class,amount|class,name,amount
     * @return \Illuminate\Database\Eloquent\FactoryBuilder
     */
    function factory()
    {
        $factory = app(EloquentFactory::class);

        $arguments = func_get_args();

        if (isset($arguments[1]) && is_string($arguments[1])) {
            return $factory->of($arguments[0], $arguments[1])->times($arguments[2] ?? null);
        } elseif (isset($arguments[1])) {
            return $factory->of($arguments[0])->times($arguments[1]);
        }

        return $factory->of($arguments[0]);
    }

ということは、この FactoryBuilder の中にいつも使っている make() や create() などのメソッドがあるはずです。