如何重构Laravel 8的模型工厂类

Laravel  /  管理员 发布于 3年前   1128

Laravel 8 引入了新的基于类的模型工厂，如果你有一个现有的项目，你可以使用遗留的工厂包来继续使用旧的工厂。

我倾向于保持工厂原样并继续开发，但在完成了一个新的 Laravel 8 项目并使用基于类的新语法后，我决定返回并更新旧 Laravel 应用程序中的工厂。

这篇文章解释了我如何将工厂重构为类。

在这种情况下，我们有一个 Laravel 应用程序，允许您创建帖子。

帖子具有标题、内容、作者，并且已发布或未发布。

原厂

这是以前格式的 PostFactory。它定义了默认状态，发布值设置为 false。它有一个称为已发布的状态，其中发布值设置为 true。

// database/factories/PostFactory.php
<?php
/** @var \Illuminate\Database\Eloquent\Factory $factory */
use App\Post;
use Faker\Generator as Faker;
$factory->define(Post::class, function (Faker $faker) {
    return [
        'title' => $faker->words(3, true),
        'content' => $faker->text,
        'author_id' => factory(User::class),
        'publish' => false,
    ];
});
$factory->state(Post::class, 'published', function (Faker $faker) {
    return [
        'publish' => true,
    ]
});

这是一个非常基本的示例，显示了在测试中使用的工厂，使用 factory() 辅助方法。

示例中的第二个测试应用了已发布状态。

// tests/Unit/PostTest.php
<?php
namespace Tests\Unit;
use App\Post;
use Tests\TestCase;
class PostTest extends TestCase
{
    public function test_post_is_not_published()
    {
        $post = factory(Post::class)->make();
        $this->assertFalse($post->published);
    }
    public function test_published_post_is_published()
    {
        $post = factory(Post::class)->state('published')->make();
        $this->assertTrue($post->published);
    }
}

重构工厂

重构为新的工厂类需要进行一些更改，因此让我们一一介绍。

命名空间

首先，我们可以删除@var 声明并将其替换为命名空间。

// Remove

/** @var \Illuminate\Database\Eloquent\Factory $factory */

// Add

namespace Database\Factories;

//class

新工厂是类，因此我们需要定义类并使其扩展工厂类。

确保你扩展了 Illuminate\Database\Eloquent\Factories\Factory;

而不是旧工厂 Illuminate\Database\Eloquent\Factory。

这让我不止一次出局。

要定义此工厂与 Post 模型一起使用，我们需要添加受保护的模型属性，将值设置为 Post::class。

<?php
namespace Database\Factories;
use App\Post;
use Faker\Generator as Faker;
use Illuminate\Database\Eloquent\Factories\Factory;
class PostFactory extends Factory
{
    protected $model = Post::class;
}

FakerPHP

如果你有一个较旧的 Laravel 应用程序，你可能在你的 composer.json 文件中使用 fzaninotto/Faker，该文件现已存档。

借此机会更新您的 composer.json 以使用 fakerphp/faker 并运行 composer update。

在旧工厂中，我们将 Faker 传递给函数，

但现在可以使用父 Factory 类中的 $this->faker 来使用 faker。

这意味着我们还可以删除以下行。

// Remove

use Faker\Generator as Faker;

工厂定义

现在我们准备提供我们的工厂定义。

这是通过类上的定义方法完成的。

我们仍然返回一个数组，就像之前的工厂一样，但我们需要将 $faker 更新为 $this->faker。

我们还需要更新 author_id 的关系，使其不再使用 factory() 助手，

从 factory(User::class) 到 User::factory()。

这意味着我们还必须更新 UserFactory.php 以使用新的基于类的方法。

public function definition()
{
    return [
        'title' => $this->faker->words(3, true),
        'content' => $this->faker->text,
        'author_id' => User::factory()),
        'publish' => false,
    ];
}

工厂状态

之前我们使用 $factory->state() 语法定义了我们的发布状态。 

现在我们可以在返回 $this->state() 的类上创建一个新方法。

public function published()
{
    return $this->state(function (array $attributes) {
        return [
            'publish' => true,
        ]
    });
}

更新模型

在我们可以在我们的测试中使用工厂之前，

我们需要更新我们的 Post 模型以告诉它使用 HasFactory trait。 

这有助于将模型连接到新的工厂类。

<?php
namespace App\Post;
use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\Model;
class Post extends Model
{
    use HasFactory;
}

Composer.json 更改

要使用新工厂，您需要将数据库工厂的命名空间添加到 composer.json 的自动加载部分。

"autoload": {
    "psr-4": {
        "App\\": "app/",
        "Database\\Factories\\": "database/factories/",
        "Database\\Seeders\\": "database/seeders/"
    }
},

然后你可以运行 composer dump-autoload 来更新自动加载器。

更新测试

最后，我们准备更新我们的测试以使用新的工厂类。

我们首先删除 factory() 助手并使用 Model::factory() 语法代替。

所以 factory(Post::class) 变成 Post::factory()。

接下来，我们可以通过链接我们创建的已发布状态方法来更新我们设置状态的方式。

所以 factory(Post::class)->state('published') 变成 Post::factory()->published()。

// tests/Unit/PostTest.php
<?php
namespace Tests\Unit;
use App\Post;
use Tests\TestCase;
class PostTest extends TestCase
{
    public function test_post_is_not_published()
    {
        $post = Post::factory()->make();
        $this-assertFalse($post->published);
    }
    public function test_published_post_is_published()
    {
        $post = Post::factory()->published()->make();
        $this-assertTrue($post->published);
    }
}

更新所有测试

我使用 PHP Storm 并发现在文件中替换函数对于在许多文件中用 Post::factory() 替换 factory(Post::class) 非常有用。

更棘手的是当你必须应用状态时，将 ->state('published') 更新为 ->published()。 

老实说，我最终手动更改了状态。

我发现的另一个困难是在创建多个工厂时。 

这个语法从 factory(Post::class, 3) 到 Post::factory()->count(3) 发生了很大变化。

如果您有更新状态和倍数的可靠方法，请在评论中告诉我。

有关模型工厂的更多信息，请查看 Laravel 文档网站。

转：https://dev.to/chrisrhymes/refactoring-to-laravel-8-class-model-factories-20f4