Laravel自定义Artisan命令_编写生成Service层的命令【操作】

浅辰小哥_5529

浅辰小哥_5529

2026-05-07

414人浏览

原创

要让 php artisan make:service userauth 正确生成 service 类,必须继承 generatorcommand、重写 getstub() 指定 stub 路径、设置匹配的命名空间和目录结构,并确保 autoload 配置生效。

laravel自定义artisan命令_编写生成service层的命令【操作】

要让 php artisan make:service UserAuth 这类命令真正生成 Service 类文件,关键不是“写个命令”,而是让命令继承 GeneratorCommand、配对 getStub()、正确设置命名空间,并确保 stub 文件路径可读——缺一不可。

继承 GeneratorCommand 而非 Command

默认 make:command 生成的类继承 Command,只能执行逻辑,不能生成文件。Service/Repository 这类模板命令必须继承 GeneratorCommand,它自带 handle()、getPath()、buildClass() 等基础设施。

  • 把 use Illuminate\Console\Command; 换成 use Illuminate\Console\GeneratorCommand;
  • 类定义从 class MakeService extends Command 改为 class MakeService extends GeneratorCommand
  • 删掉原有的 handle() 方法(GeneratorCommand 已内置)
  • 不手动实现文件写入逻辑,否则会绕过 Laravel 的路径校验和类名规范化

stub 文件必须存在且路径准确

GeneratorCommand 默认在 resources/stubs/ 下找 stub,但 Laravel 并不自动创建该目录;若你把 stub 放在 app/Console/Commands/Stubs/ 或项目根目录 /stubs/,就必须重写 getStub() 显式返回路径,否则报错 File does not exist at path。

Laravel
Laravel

避免常见的Laravel错误:N+1查询、批量赋值、缓存陷阱及队列序列化陷阱。

下载
  • 推荐做法:在项目根目录建 stubs/ 文件夹,放 service.stub
  • 在命令类中实现:
    protected function getStub()
    {
        return $this->laravel->basePath('stubs/service.stub');
    }
  • stub 内容里用 {{ class }}{{ name }}{{ namespace }} 这类占位符,GeneratorCommand 会自动替换
  • 路径中不要用 __DIR__ 或相对 ../stubs,容易因工作目录不同而失效

$name、$type 和 $signature 的分工要理清

这三个属性看起来相似,但作用完全不同,混用会导致参数解析失败或提示信息错乱:

  • $name = 'make:service':是命令注册名,必须唯一,且不能含空格
  • $signature = 'make:service {name} {--force}':定义参数和选项格式,{name} 是必填参数,{--force} 是布尔开关
  • $type = 'Service':仅用于提示语(如 Service already exists!),不影响逻辑,但建议设,提升可读性
  • 不要把 $signature 写成 make:service {name?}(可选参数),因为 GeneratorCommand 要求类名必须提供,否则 getNameInput() 返回空,生成路径出错

命名空间和生成路径必须匹配 stub 和 getDefaultNamespace()

stub 里写的 namespace App\Services; 和命令中 getDefaultNamespace() 返回值必须一致,否则生成的类会出现在错误命名空间下,甚至 autoload 失败。

  • 在命令类中重写:
    protected function getDefaultNamespace($rootNamespace)
    {
        return $rootNamespace . '\Services';
    }
  • 确保 app/Services/ 目录存在,且已加入 Composer 的 autoload(修改 composer.json 的 "autoload": {"psr-4": {...}} 并运行 composer dump-autoload)
  • 如果 Service 类要放在 app/Domain/User/Services/,则 getDefaultNamespace() 应返回 $rootNamespace . '\Domain\User\Services',stub 中 namespace 也同步改
  • 生成后若报 Class not found,优先检查命名空间拼写和 autoload 是否生效,而不是命令逻辑

最容易被忽略的是 stub 路径权限和 getDefaultNamespace() 与实际目录结构的耦合——哪怕只差一个反斜杠或大小写不一致,生成的文件就会静默落到错误位置,而命令本身不报错。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

laravel

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
php文件怎么打开
php文件怎么打开

打开php文件步骤:1、选择文本编辑器;2、在选择的文本编辑器中,创建一个新的文件,并将其保存为.php文件;3、在创建的PHP文件中,编写PHP代码;4、要在本地计算机上运行PHP文件,需要设置一个服务器环境;5、安装服务器环境后,需要将PHP文件放入服务器目录中;6、一旦将PHP文件放入服务器目录中,就可以通过浏览器来运行它。

2023.09.01

9644

6

php怎么取出数组的前几个元素
php怎么取出数组的前几个元素

取出php数组的前几个元素的方法有使用array_slice()函数、使用array_splice()函数、使用循环遍历、使用array_slice()函数和array_values()函数等。本专题为大家提供php数组相关的文章、下载、课程内容,供大家免费下载体验。

2023.10.11

5781

5

php反序列化失败怎么办
php反序列化失败怎么办

php反序列化失败的解决办法检查序列化数据。检查类定义、检查错误日志、更新PHP版本和应用安全措施等。本专题为大家提供php反序列化相关的文章、下载、课程内容,供大家免费下载体验。

2023.10.11

2055

5

php怎么连接mssql数据库
php怎么连接mssql数据库

连接方法:1、通过mssql_系列函数;2、通过sqlsrv_系列函数;3、通过odbc方式连接;4、通过PDO方式;5、通过COM方式连接。想了解php怎么连接mssql数据库的详细内容,可以访问下面的文章。

2023.10.23

3608

4

php连接mssql数据库的方法
php连接mssql数据库的方法

php连接mssql数据库的方法有使用PHP的MSSQL扩展、使用PDO等。想了解更多php连接mssql数据库相关内容,可以阅读本专题下面的文章。

2023.10.23

4314

6

html怎么上传
html怎么上传

html通过使用HTML表单、JavaScript和PHP上传。更多关于html的问题详细请看本专题下面的文章。php中文网欢迎大家前来学习。

2023.11.03

3371

9

PHP出现乱码怎么解决
PHP出现乱码怎么解决

PHP出现乱码可以通过修改PHP文件头部的字符编码设置、检查PHP文件的编码格式、检查数据库连接设置和检查HTML页面的字符编码设置来解决。更多关于php乱码的问题详情请看本专题下面的文章。php中文网欢迎大家前来学习。

2023.11.09

4797

8

php文件怎么在手机上打开
php文件怎么在手机上打开

php文件在手机上打开需要在手机上搭建一个能够运行php的服务器环境,并将php文件上传到服务器上。再在手机上的浏览器中输入服务器的IP地址或域名,加上php文件的路径,即可打开php文件并查看其内容。更多关于php相关问题,详情请看本专题下面的文章。php中文网欢迎大家前来学习。

2023.11.13

3742

8

sprintf函数用法详解
sprintf函数用法详解

sprintf函数的用法:1、格式化字符串;2、指定输出宽度和精度;3、返回值。更多关于sprintf函数用法详解的内容,大家可以阅读下面的文章。

2023.11.27

11762

4

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
如何安装 Composer
如何安装 Composer

共1课时 | 196人学习

Composer手册
Composer手册

共0课时 | 0人学习