Laravel自定义Artisan命令_编写命令行工具【详解】

陌宇大大_8912

陌宇大大_8912

2026-05-01

839人浏览

原创

最稳妥的起点是用 php artisan make:command 生成命令类,否则因路径、继承或 $signature 格式错误会导致命令不显示;需确保类在 app/console/commands/、继承 illuminate\console\command、$signature 使用单引号且符合 dsl 规则。

laravel自定义artisan命令_编写命令行工具【详解】

直接用 php artisan make:command 生成命令类是最稳妥的起点,手动创建或放错路径大概率导致命令不出现、参数解析失败、依赖注入失效——不是 Laravel 不支持,而是它对类位置、继承关系和签名格式有硬性要求。

为什么新命令在 php artisan list 里不显示

常见原因就三个:类没放在 app/Console/Commands/ 目录下、没继承 Illuminate\Console\Command、或者 $signature 属性缺失或格式非法(比如含空格、以数字开头、用了中文括号)。

检查步骤:

  • 确认文件路径是 app/Console/Commands/SendDailyReport.php,不是 app/Commands/ 或 app/Console/SendDailyReport.php
  • 打开文件,确认 class SendDailyReport extends Command,且顶部 use Illuminate\Console\Command;
  • 确认有 protected $signature = 'report:daily';,不能写成 protected $signature = "report:daily";(双引号在某些 PHP 版本下会触发变量解析)
  • Laravel 9+ 启用自动发现,但若你改过 composer.json 的 PSR-4 配置或运行过 composer install --optimize-autoloader,必须补跑 composer dump-autoload
  • 改完代码后,务必执行 php artisan config:clear —— 自动发现机制依赖 config/console.php 缓存,缓存不清理,新增命令永远“看不见”

$signature 里参数和选项怎么写才不报错

$signature 是 Laravel 解析命令行输入的 DSL,不是自由字符串。写错一个符号,php artisan report:daily --help 就可能直接抛出 Symfony\Component\Console\Exception\LogicException。

关键规则:

Laravel Creem Agent
Laravel Creem Agent

Creem 支付商店助理 — 查询订阅、客户、交易、产品,执行心跳检查,管理本地 Laravel支付商店。

下载
  • 必填参数:用 {user_id},调用时必须传值,如 php artisan report:daily 123
  • 可选参数:用 {user_id?},问号紧贴花括号,不能写成 {user_id ?} 或 {user_id}?
  • 带默认值的可选参数:用 {user_id?=123},值必须是字符串字面量,不能是变量或表达式
  • 布尔选项:用 {--force},用户执行 --force 时返回 true,不传时返回 null(不是 false),判断请用 $this->option('force') !== null
  • 带值的选项:用 {--limit=10},等号必须紧贴选项名,不能写成 {--limit =10};传参时用 --limit=5,不能用 --limit 5
  • 数组参数/选项:必须在 configure() 方法中显式调用 $this->acceptsMultipleValues() 或 ->array(),否则只取第一个值

handle() 里读参和类型转换的坑

$this->argument() 和 $this->option() 返回的永远是字符串,哪怕你在 configure() 里写了 ->type('integer') —— 那只是影响帮助文档和输入校验,不自动转换类型。

典型翻车场景:

  • 用 User::find($this->argument('id')) 查不到记录?因为 '123' 和 123 在 Eloquent 的 casts 或 strict 模式下行为不同,应改为 (int) $this->argument('id') 或 filter_var($val, FILTER_VALIDATE_INT)
  • 判断 --force 是否启用时写 if ($this->option('force')),结果未传参时也进分支?因为 null 在布尔上下文中为 false,但 --force=0 也会被当成字符串 "0",建议统一用 $this->option('force') !== null
  • 想接收多个邮箱:{email*} 写法无效,必须在 configure() 中定义:$this->addArgument('email')->array()->description('收件人邮箱列表');,然后调用 php artisan send:mail a@b.com c@d.com

命令返回值和信号处理容易被忽略

handle() 必须返回 int:0 表示成功,非 0 表示失败。返回字符串(如 return 'done')会导致 Artisan 异常退出,且 shell 脚本无法正确判断状态。

另外,Artisan 命令默认不监听 SIGINT(Ctrl+C)。用户中断时 PHP 进程直接终止,数据库事务不会回滚、临时文件不会清理、锁不会释放。

安全做法:

  • 所有耗时操作前注册信号处理器:pcntl_signal(SIGINT, function () { $this->warn('收到中断信号,正在清理...'); // 清理逻辑 exit(130); }); pcntl_signal_dispatch();
  • 涉及数据库写入时,手动包裹 DB::transaction(),并在 catch 或信号处理器中确保回滚
  • 避免在 handle() 中使用 dd(),改用 $this->comment(json_encode($data, JSON_UNESCAPED_UNICODE)),防止输出破坏终端样式或日志采集

相关文章

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

10244

6

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

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

2023.10.11

6041

5

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

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

2023.10.11

2095

5

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

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

2023.10.23

3808

4

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

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

2023.10.23

4494

6

html怎么上传
html怎么上传

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

2023.11.03

3531

9

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

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

2023.11.09

5037

8

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

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

2023.11.13

3942

8

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

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

2023.11.27

11902

4

热门下载

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

精品课程

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

共1课时 | 201人学习

Composer手册
Composer手册

共0课时 | 0人学习