laravel 8引入了全新的Factory机制,将原先基于全局$factory-youjiankuohaophpcndefine的闭包定义转变为独立的类结构。本教程将详细指导如何将Laravel 7风格的Factory重构至Laravel 8的类式Factory,包括核心概念、代码示例、以及在特定场景下的应用,同时提供一个兼容旧版工厂的临时解决方案,确保平滑过渡。
Laravel 8 Factory机制概述
在Laravel 8中,Eloquent模型工厂的设计理念发生了根本性转变,旨在提供更清晰、更可维护的结构。告别了全局$factory对象和闭包定义,Laravel 8采用了独立的php类来表示每个模型的工厂。
Laravel 7 Factory示例
在Laravel 7及更早版本中,模型工厂通常在一个PHP文件中定义,通过$factory->define方法将模型类与一个闭包关联起来,该闭包返回模型属性的数组。
<?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 Factory核心变化
Laravel 8将工厂定义提升为独立的类,每个模型对应一个工厂类。这些工厂类通常位于database/factories目录下,并遵循{ModelName}Factory.php的命名约定。
- 类式结构: 工厂不再是全局闭包,而是继承自IlluminateDatabaseEloquentFactoriesFactory的PHP类。
- definition() 方法: 每个工厂类都必须实现一个definition()方法,该方法返回一个包含模型属性的数组,类似于Laravel 7闭包的返回值。在这个方法内部,可以通过$this->faker访问Faker实例。
- HasFactory Trait: 为了让Laravel能够自动发现并关联模型的工厂,需要在对应的Eloquent模型类中使用IlluminateDatabaseEloquentFactoriesHasFactory Trait。一旦使用此Trait,Laravel将默认查找名为{ModelName}Factory的工厂类。
- 工厂调用方式: 在Laravel 8中,调用工厂创建模型实例的方式也发生了变化,从factory(AppUser::class)变为AppModelsUser::factory()。
Laravel 8 Factory示例
以下是一个典型的Laravel 8 UserFactory示例:
<?php namespace DatabaseFactories; use AppModelsUser; // 假设User模型位于AppModels命名空间 use IlluminateDatabaseEloquentFactoriesFactory; use IlluminateSupportStr; class UserFactory extends Factory { /** * The name of the factory's corresponding model. * * @var string */ protected $model = User::class; // 显式指定关联模型,可选但推荐 /** * Define the model's default state. * * @return array */ public function definition() { return [ 'name' => $this->faker->name(), 'email' => $this->faker->unique()->safeEmail(), 'email_verified_at' => now(), 'password' => '$2y$10$92IXUNpkjO0rOQ5byMi.Ye4oKoEa3Ro9llC/.og/at2.uheWG/igi', // password 'remember_token' => Str::random(10), ]; } }
注意: 这里的$this->faker可以直接访问Faker实例,无需像Laravel 7那样通过闭包参数注入。
重构现有Laravel 7 Factory
现在,我们将根据上述原则,把原始的Laravel 7 Login工厂重构为Laravel 8的类式工厂。
针对LoginFactory的重构
首先,在database/factories目录下创建一个名为LoginFactory.php的文件,并按照Laravel 8的规范进行编写:
<?php namespace DatabaseFactories; use AppModelsLogin; // 确保使用正确的模型命名空间 use AppModelsTenant; // 引入Tenant模型 use AppModelsUser; // 引入User模型 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(): array { $randomDateTime = $this->faker->dateTimeBetween('-6 hours', 'now'); return [ // 使用新的工厂调用方式:Model::factory() 'user_id' => User::factory(), 'tenant_id' => Tenant::factory(), 'created_at' => $randomDateTime, 'updated_at' => $randomDateTime, ]; } }
关键点:
- 文件路径:database/factories/LoginFactory.php。
- 命名空间:DatabaseFactories。
- 继承:extends Factory。
- definition()方法:返回数据数组,并使用$this->faker。
- 关联工厂:User::factory()和Tenant::factory()用于创建关联模型的实例。
关联模型的HasFactory特性
为了让Login::factory()等调用能够正常工作,并且Laravel能够自动发现LoginFactory,你需要在Login模型中引入HasFactory Trait。同样,由于LoginFactory中引用了User::factory()和Tenant::factory(),所以User和Tenant模型也需要各自的工厂类并使用HasFactory Trait。
app/Models/Login.php (示例):
<?php namespace AppModels; use IlluminateDatabaseEloquentFactoriesHasFactory; use IlluminateDatabaseEloquentModel; class Login extends Model { use HasFactory; // 引入HasFactory Trait // ... 其他模型定义 }
你需要对User和Tenant模型也进行同样的操作,并在database/factories目录下创建相应的UserFactory.php和TenantFactory.php。
临时兼容方案:使用旧版Factory
如果你没有足够的时间立即重构所有工厂,Laravel提供了一个兼容包laravel/legacy-factories,允许你在Laravel 8项目中继续使用Laravel 7风格的工厂。
要安装此包,请运行以下composer命令:
composer require laravel/legacy-factories
安装后,你的Laravel 7风格工厂将可以继续工作,但这只是一个临时解决方案,强烈建议最终还是将工厂重构为Laravel 8的类式结构。
总结与注意事项
- 结构化: Laravel 8的工厂机制更加面向对象和结构化,有助于大型项目的维护。
- 命名约定: 遵循{ModelName}Factory.php的命名约定和DatabaseFactories命名空间是自动发现的关键。
- HasFactory Trait: 务必在所有需要工厂支持的Eloquent模型中引入HasFactory Trait。
- 嵌套工厂: 在新的工厂中调用关联工厂时,使用Model::factory()而非factory(Model::class)。
- Faker实例: 在definition()方法中,通过$this->faker访问Faker实例。
- 逐步重构: 如果项目庞大,可以考虑分阶段重构,或者先使用laravel/legacy-factories进行过渡。
通过遵循本指南,你可以顺利地将Laravel 7的工厂迁移到Laravel 8的新机制,从而利用其带来的结构和维护优势。
以上就是Laravel 8 Factory重构指南:从旧版定义到类式结构的详细内容,更多请关注php中文网其它相关文章!
评论(已关闭)
评论已关闭