Laravel 8 模型工厂重构指南：从闭包到类

Laravel 8 模型工厂的演变

laravel 8对模型工厂（model factories）进行了重大革新，从laravel 7及以前版本基于全局 $factory-youjiankuohaophpcndefine 闭包的定义方式，转向了更具面向对象特性的类式定义。这一改变提升了工厂的可维护性、可测试性和自动发现能力。

Laravel 7 模型工厂示例：

在Laravel 7中，模型工厂通常定义在 database/factories/ 目录下的一个文件中，使用 $factory->define 方法将模型类与一个返回数据数组的闭包关联起来。

<?php

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

use App\Login;
use Faker\Generator as Faker;

$factory->define(Login::class, function (Faker $faker) {
    $randomDateTime = $faker->dateTimeBetween('-6 hours', 'now');
    return [
        'user_id' => factory(App\User::class), // 旧版工厂引用方式
        'tenant_id' => factory(App\Tenant::class), // 旧版工厂引用方式
        'created_at' => $randomDateTime,
        'updated_at' => $randomDateTime,
    ];
});

重构至 Laravel 8 类式工厂

Laravel 8 的模型工厂现在是独立的 PHP 类，通常位于 database/factories 目录下，并遵循 [ModelName]Factory 的命名约定。这些工厂类需要继承自 Illuminate\Database\Eloquent\Factories\Factory。

核心变化点：

1. 类结构： 每个模型都有一个对应的工厂类。
2. definition() 方法： 数据定义逻辑封装在 definition() 方法中，该方法返回一个包含模型属性的数组。
3. $this->faker： 在 definition() 方法内部，可以直接通过 $this->faker 访问 Faker 实例。
4. 模型关联： 引用其他模型工厂时，使用 Model::factory() 静态方法。
5. HasFactory Trait： 模型本身需要使用 Illuminate\Database\Eloquent\Factories\HasFactory Trait，以便Laravel能够自动发现并关联其对应的工厂。

Laravel 8 模型工厂示例：

以下是将上述 Login 模型工厂重构为Laravel 8类式工厂的示例。假设 Login 模型位于 App\Models\Login，并且 User 和 Tenant 模型也已相应更新。

<?php

namespace Database\Factories;

use App\Models\Login; // 确保使用正确的模型命名空间
use App\Models\User;
use App\Models\Tenant;
use Illuminate\Database\Eloquent\Factories\Factory;

class LoginFactory extends Factory
{
    /**
     * The name of the factory's corresponding model.
     *
     * @var string
     */
    protected $model = Login::class;

    /**
     * Define the model's default state.
     *
     * @return array
     */
    public function definition()
    {
        $randomDateTime = $this->faker->dateTimeBetween('-6 hours', 'now'); // 使用 $this->faker

        return [
            'user_id' => User::factory(),    // 新版工厂引用方式
            'tenant_id' => Tenant::factory(), // 新版工厂引用方式
            'created_at' => $randomDateTime,
            'updated_at' => $randomDateTime,
        ];
    }
}

模型中的 HasFactory Trait：

豆绘AI

豆绘AI是国内领先的AI绘图与设计平台，支持照片、设计、绘画的一键生成。

485

查看详情

为了让Laravel能够自动发现并使用 LoginFactory，App\Models\Login 模型需要引入 HasFactory Trait。

<?php

namespace App\Models;

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

class Login extends Model
{
    use HasFactory; // 引入 HasFactory Trait

    // ... 其他模型定义
}

同样，User 和 Tenant 模型也需要引入 HasFactory Trait，并创建相应的 UserFactory 和 TenantFactory。

逐步重构指南

1. 创建新的工厂类文件： 在 database/factories 目录下为每个需要重构的模型创建一个新的 PHP 文件，例如 LoginFactory.php。

2. 定义工厂类结构： 将每个文件定义为一个继承自 Illuminate\Database\Eloquent\Factories\Factory 的类。

   namespace Database\Factories;
   
   use App\Models\YourModel; // 替换为你的模型
   use Illuminate\Database\Eloquent\Factories\Factory;
   
   class YourModelFactory extends Factory
   {
       protected $model = YourModel::class;
   
       public function definition()
       {
           // 返回模型属性数组
           return [
               // ...
           ];
       }
   }

   登录后复制

3. 迁移 definition 逻辑： 将Laravel 7 $factory->define 闭包中的返回数组逻辑，复制到新工厂类的 definition() 方法中。 请注意将 $faker 替换为 $this->faker。

4. 更新工厂关联： 将所有 factory(App\YourOtherModel::class) 的调用替换为 App\Models\YourOtherModel::factory()。确保 YourOtherModel 也已引入 HasFactory Trait 并有对应的工厂类。

5. 在模型中引入 HasFactory Trait： 打开每个对应的 Eloquent 模型文件（例如 app/Models/Login.php），并添加 use HasFactory;。

6. 测试： 运行你的测试或 Seeder，确保新的工厂能够正常工作。

兼容性方案 (临时过渡)

如果你没有足够的时间立即重构所有工厂，Laravel 提供了 laravel/legacy-factories 包，允许你在 Laravel 8 项目中继续使用旧版（Laravel 7 风格）的工厂。

composer require laravel/legacy-factories

安装此包后，你无需立即修改现有的 Laravel 7 工厂文件，它们将继续按预期工作。但这只是一个临时解决方案，强烈建议最终还是将工厂重构为 Laravel 8 的类式风格，以充分利用其带来的优势。

总结

Laravel 8 的模型工厂重构是框架迈向更现代化、更可维护架构的重要一步。通过将工厂定义封装在独立的类中，并利用 HasFactory Trait 进行自动发现，开发者能够更清晰、更高效地管理测试数据和填充逻辑。虽然初期需要一定的迁移工作，但长远来看，这将极大地提升开发体验和代码质量。务必记住在重构过程中，不仅要更新工厂文件本身，还要在相关的 Eloquent 模型中引入 HasFactory Trait。

以上就是Laravel 8 模型工厂重构指南：从闭包到类的详细内容，更多请关注php中文网其它相关文章！