Laravel-Modules 自定义Stub模板使用指南

在Laravel开发中，nWidart/laravel-modules是一个非常流行的模块化开发包。本文将详细介绍如何在该包中自定义Stub模板文件，解决用户自定义模板不生效的问题。

问题背景

许多开发者在使用laravel-modules时，会遇到自定义Stub模板不生效的情况。具体表现为：虽然已经发布了Stub文件并进行了修改，但在生成新模块或模型时，系统仍然使用默认模板而非自定义模板。

解决方案

1. 发布Stub文件

首先需要通过Artisan命令发布Stub文件到项目目录：

php artisan vendor:publish

在发布过程中，选择Nwidart\Modules\LaravelModulesServiceProvider作为提供者。

2. 配置Stub路径

发布完成后，需要修改模块配置文件config/modules.php：

'stubs' => [
    'enabled' => true,
    'path' => base_path('stubs/nwidart-stubs'),
    // 其他配置...
],

确保enabled设置为true，并指定正确的Stub文件路径。

3. 自定义Stub模板

在指定路径下创建或修改需要的Stub文件。例如，对于模型Stub，可以创建model.stub文件：

<?php

namespace $NAMESPACE$;

use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Factories\HasFactory;
use Spatie\MediaLibrary\HasMedia;
use Spatie\MediaLibrary\InteractsWithMedia;
use App\Traits\HasSlugUlid;

class $CLASS$ extends Model implements HasMedia
{
    use HasFactory, HasSlugUlid;
    use InteractsWithMedia;

    protected string $slugFrom = '';

    protected $guarded = [
        'id',
        'created_at',
        'updated_at',
        'deleted_at',
    ];
}

4. 占位符说明

在Stub文件中，可以使用以下占位符变量：

• $NAMESPACE$: 模型的命名空间
• $CLASS$: 模型类名
• $MODULE_NAMESPACE$: 模块的根命名空间
• $MODULE$: 模块名
• $NAME$: 模型名（用于工厂类）

最佳实践

1. 版本控制：建议将自定义Stub文件纳入版本控制，方便团队共享
2. 模板继承：考虑创建基础Stub模板，其他模板继承它以减少重复代码
3. 文档记录：为团队编写Stub使用文档，说明每个模板的用途和可用变量
4. 定期更新：当laravel-modules包更新时，检查是否有新的Stub变量或功能

常见问题排查

如果自定义Stub仍然不生效，可以检查以下几点：

1. 确认config/modules.php中的路径配置正确
2. 确保Stub文件名与包内默认文件名一致
3. 检查文件权限，确保Web服务器有读取权限
4. 清除配置缓存：php artisan config:clear

通过以上步骤，开发者可以轻松实现Stub模板的自定义，提高模块化开发效率和代码一致性。