本文旨在探讨如何在laravel应用中，无需手动创建并继承自定义基类，即可为所有新生成的模型自动注入如 created_at 和 updated_at 等属性的 get()Attribute 方法。核心解决方案是利用 php artisan stub:publish 命令发布并修改默认的模型 stub 文件，从而在模型创建时即强制包含所需的通用逻辑，确保代码一致性和开发效率。
在Laravel应用程序开发中，我们经常需要为模型添加一些通用的访问器（Accessors）或修改器（Mutators），例如将 created_at 和 updated_at 字段自动格式化为特定字符串。一种常见的做法是创建一个 BaseModel 类，让所有业务模型继承它。然而，这种方法存在一个潜在问题：如果开发者忘记继承 BaseModel，或者需要强制所有新模型都包含这些方法，手动继承的方式就显得不够自动化和强制性。本文将介绍一种更优雅、更具强制性的方法，通过定制Laravel的默认模型生成模板（stub）来实现这一目标。
理解Laravel的Stub文件
Laravel的Artisan控制台命令（如 make:model、make:controller 等）在生成各类文件时，并非凭空创建，而是基于预定义的“stub”文件。这些stub文件是带有占位符的模板，Artisan会根据用户输入和上下文信息填充这些占位符，最终生成我们所需的代码文件。Laravel允许开发者发布并定制这些默认的stub文件，以满足特定的项目需求。
定制默认模型Stub文件
要实现为所有新模型自动注入通用方法，我们需要修改Laravel用于生成模型的 model.stub 文件。
1. 发布默认Stub文件
首先，使用Artisan命令将Laravel内置的默认stub文件发布到你的应用程序目录中。这将会在 app/stubs 目录下创建一系列可供修改的模板文件。
php artisan stub:publish
执行此命令后，你会在项目根目录下的 app/stubs 文件夹中找到 model.stub 文件。
2. 修改 model.stub 文件
打开 app/stubs/model.stub 文件。默认情况下，它的内容可能类似于：
<?php namespace {{ namespace }}; use IlluminateDatabaseEloquentFactoriesHasFactory; use IlluminateDatabaseEloquentModel; class {{ class }} extends Model { use HasFactory; }
现在，我们可以在 {{ class }} 类中添加我们希望所有模型都包含的通用方法。例如，为了自动格式化 created_at 和 updated_at 字段，我们可以添加如下访问器：
<?php namespace {{ namespace }}; use IlluminateDatabaseEloquentFactoriesHasFactory; use IlluminateDatabaseEloquentModel; use carbonCarbon; // 引入 Carbon 类，用于日期时间处理 class {{ class }} extends Model { use HasFactory; /** * 获取格式化后的 created_at 属性。 * * @param string $value * @return string */ public function getCreatedAtAttribute($value): string { return Carbon::parse($value)->format('Y-m-d H:i:s'); } /** * 获取格式化后的 updated_at 属性。 * * @param string $value * @return string */ public function getUpdatedAtAttribute($value): string { return Carbon::parse($value)->format('Y-m-d H:i:s'); } }
注意： 在上面的示例中，我们引入了 CarbonCarbon 类来处理日期格式化。确保你的项目中已经安装了 Carbon （Laravel默认已集成）。你可以根据实际需求调整日期格式。
3. 验证效果
修改并保存 model.stub 文件后，尝试使用Artisan命令创建一个新的模型：
php artisan make:model NewUser
打开新生成的 app/Models/NewUser.php 文件，你会发现 getCreatedAtAttribute 和 getUpdatedAtAttribute 方法已经自动包含在内。
<?php namespace AppModels; use IlluminateDatabaseEloquentFactoriesHasFactory; use IlluminateDatabaseEloquentModel; use CarbonCarbon; class NewUser extends Model { use HasFactory; /** * 获取格式化后的 created_at 属性。 * * @param string $value * @return string */ public function getCreatedAtAttribute($value): string { return Carbon::parse($value)->format('Y-m-d H:i:s'); } /** * 获取格式化后的 updated_at 属性。 * * @param string $value * @return string */ public function getUpdatedAtAttribute($value): string { return Carbon::parse($value)->format('Y-m-d H:i:s'); } }
优点与注意事项
优点：
- 强制性与一致性： 确保所有通过Artisan生成的模型都包含特定的通用方法，无需人工干预，从而提高代码的一致性。
- 减少重复代码： 避免在每个新模型中手动复制粘贴相同的通用逻辑。
- 提高开发效率： 开发者无需记住继承特定的基类，也无需手动添加常用方法，直接专注于业务逻辑。
注意事项：
- 仅影响新生成文件： 对stub文件的修改只对后续使用Artisan命令生成的文件生效，不会影响已存在的模型文件。对于旧模型，你仍然需要手动添加或通过其他方式（如使用ide的重构功能）来更新。
- 版本控制： app/stubs 目录下的文件是项目的一部分，应该将其纳入版本控制系统（如git），以确保团队成员之间共享相同的生成规则。
- 谨慎修改： 在修改stub文件时务必小心，错误的修改可能导致生成的代码无法运行。
- 与 BaseModel 的权衡：
总结
通过定制Laravel的Artisan stub文件，我们可以有效地自动化模型中的通用代码注入，避免了手动继承 BaseModel 可能带来的遗漏和不一致性问题。这种方法为项目提供了一种强大的机制，以确保新生成的代码遵循统一的规范和包含必要的通用功能，从而提升开发效率和代码质量。在需要为所有新模型强制引入特定行为时，定制stub文件是比传统 BaseModel 继承更为直接和自动化的解决方案。
