Laravel 7 工厂重构至 Laravel 8：新范式与实践指南

laravel 8 对模型工厂进行了重大革新，从基于闭包的全局 $factory-youjiankuohaophpcndefine 转向了独立的类式工厂。本文将详细介绍这两种重构策略：通过引入兼容包快速适配，或全面采用 Laravel 8 的新工厂范式，包括创建工厂类、使用 HasFactory Trait 以及调用关联模型工厂，旨在帮助开发者平滑迁移并优化测试数据生成流程。

laravel 8 引入了全新的模型工厂（model factory）机制，旨在提供更结构化、更易于维护的测试数据生成方式。与 laravel 7 及早期版本中依赖全局 $factory 实例和闭包定义工厂的方式不同，laravel 8 将每个模型的工厂定义封装为独立的 php 类。这一变化要求开发者在升级项目时对现有工厂进行重构。

方法一：使用旧版工厂兼容包（快速适配）

对于时间有限或不希望立即进行大规模重构的项目，Laravel 提供了一个兼容包 laravel/legacy-factories。安装此包后，您可以在 Laravel 8 项目中继续使用 Laravel 7 风格的工厂定义。

composer require laravel/legacy-factories

注意事项：

• 此方法仅为临时解决方案，不推荐作为长期策略。
• 它不会利用 Laravel 8 工厂带来的新特性和优化。
• 未来版本可能不再支持此兼容包。

方法二：全面重构至 Laravel 8 新范式（推荐）

全面重构是拥抱 Laravel 8 新工厂机制的最佳实践。这种方式将工厂定义从全局闭包转变为独立的类，提高了代码的可读性和可维护性。

核心变化：类式工厂

在 Laravel 7 中，工厂通常定义在一个全局的 database/factories/Factory.php 文件中，或分散在多个工厂文件中，通过 $factory->define() 方法将模型与数据生成逻辑关联起来：

Laravel 7 工厂示例

<?php  /** @var IlluminateDatabaseEloquentFactory $factory */  use AppLogin; use FakerGenerator as Faker;  $factory->define(Login::class, function (Faker $faker) {     $randomDateTime = $faker->dateTimeBetween('-6 hours', 'now');     return [         'user_id' => factory(AppUser::class),         'tenant_id' => factory(AppTenant::class),         'created_at' => $randomDateTime,         'updated_at' => $randomDateTime,     ]; });

而在 Laravel 8 中，每个模型都应拥有一个对应的工厂类。这些工厂类通常位于 database/factories 目录下，并遵循 ModelNameFactory.php 的命名约定。它们继承自 IlluminateDatabaseEloquentFactoriesFactory 类，并将数据生成逻辑封装在 definition() 方法中。

Laravel 8 类式工厂示例

<?php  namespace DatabaseFactories;  use AppModelsLogin; // 确保使用正确的模型命名空间 use AppModelsUser; use AppModelsTenant; use IlluminateDatabaseEloquentFactoriesFactory;  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()     {         // 注意这里 $this->faker 的使用方式，而不是闭包参数 $faker         $randomDateTime = $this->faker->dateTimeBetween('-6 hours', 'now');           return [             'user_id' => User::factory(),    // 调用关联模型的工厂             'tenant_id' => Tenant::factory(), // 调用关联模型的工厂             'created_at' => $randomDateTime,             'updated_at' => $randomDateTime,         ];     } }

核心差异总结：

• 结构：从闭包定义转变为独立的 PHP 类。
• 继承：工厂类必须继承 IlluminateDatabaseEloquentFactoriesFactory。
• 方法：数据定义逻辑封装在 definition() 方法中。
• Faker 实例：通过 $this->faker 访问 Faker 实例，而不是通过闭包参数。
• 模型关联：通过 $model 属性明确指定工厂对应的模型，或者 Laravel 会根据工厂类名自动推断。

模型与工厂的关联：HasFactory Trait

为了让 Laravel 能够自动发现并使用模型的工厂，您需要在对应的 Eloquent 模型中引入 IlluminateDatabaseEloquentFactoriesHasFactory Trait。

app/Models/Login.php 模型示例

<?php  namespace AppModels;  use IlluminateDatabaseEloquentFactoriesHasFactory; use IlluminateDatabaseEloquentModel;  class Login extends Model {     use HasFactory; // 引入 HasFactory Trait      // ... 其他模型定义 }

当模型使用了 HasFactory Trait 后，您就可以直接通过 Login::factory() 语法来创建模型实例，而 Laravel 会自动查找 database/factories/LoginFactory.php 文件。

关联模型工厂的调用

在 Laravel 7 中，您可能使用 factory(AppUser::class) 来创建关联模型实例。在 Laravel 8 中，当关联模型也使用了 HasFactory Trait 并有对应的工厂类时，您可以通过 Model::factory() 语法来创建关联实例。

例如，在 LoginFactory 中创建 User 和 Tenant 实例：

// ... 在 LoginFactory 的 definition() 方法中 return [     'user_id' => User::factory(),    // 创建一个 User 实例并获取其 ID     'tenant_id' => Tenant::factory(), // 创建一个 Tenant 实例并获取其 ID     // ... ];

重要提示：

• User 模型和 Tenant 模型也需要引入 HasFactory Trait。
• 您需要为 User 和 Tenant 模型分别创建 database/factories/UserFactory.php 和 database/factories/TenantFactory.php 文件。

重构实战示例

我们将原始的 Laravel 7 Login 模型工厂重构到 Laravel 8。

原始 Laravel 7 工厂 (database/factories/Factory.php 或类似文件)

<?php  /** @var IlluminateDatabaseEloquentFactory $factory */  use AppLogin; use FakerGenerator as Faker;  $factory->define(Login::class, function (Faker $faker) {     $randomDateTime = $faker->dateTimeBetween('-6 hours', 'now');     return [         'user_id' => factory(AppUser::class),         'tenant_id' => factory(AppTenant::class),         'created_at' => $randomDateTime,         'updated_at' => $randomDateTime,     ]; });

重构后的 Laravel 8 工厂 (database/factories/LoginFactory.php)

<?php  namespace DatabaseFactories;  use AppModelsLogin; // 确保模型命名空间正确 use AppModelsTenant; use AppModelsUser; use IlluminateDatabaseEloquentFactoriesFactory;  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');          return [             'user_id' => User::factory(),             'tenant_id' => Tenant::factory(),             'created_at' => $randomDateTime,             'updated_at' => $randomDateTime,         ];     } }

对应的 Login 模型 (app/Models/Login.php)

<?php  namespace AppModels;  use IlluminateDatabaseEloquentFactoriesHasFactory; use IlluminateDatabaseEloquentModel;  class Login extends Model {     use HasFactory;      // ... 其他模型定义 }

此外，您还需要确保：

1. AppModelsUser 和 AppModelsTenant 模型也引入了 HasFactory Trait。
2. 在 database/factories 目录下创建了 UserFactory.php 和 TenantFactory.php 文件，并按照 Laravel 8 的类式工厂范式进行定义。

注意事项

• 命名约定：工厂类应以 ModelNameFactory 命名，并位于 database/factories 目录下。
• 模型命名空间：确保在工厂类中正确引用模型的

以上就是Laravel 7 工厂重构至 Laravel 8：新范式与实践指南的详细内容，更多请关注php中文网其它相关文章！