Laravel怎么生成自定义Artisan命令行

雨浩姑娘_9299

雨浩姑娘_9299

2026-08-19

833人浏览

原创

在 laravel 中生成自定义 artisan 命令需四步:1. 用 php artisan make:command 创建命令类;2. 在 $signature 和 $description 中配置签名与描述;3. 在 handle() 中编写逻辑并注入服务;4. 通过 php artisan list 和 php artisan 命令测试运行。

laravel怎么生成自定义artisan命令行

在 Laravel 中生成自定义 Artisan 命令非常简单,核心是使用内置的 make:command 命令创建命令类,再在其中编写逻辑。

1. 创建自定义命令类

运行以下 Artisan 命令生成一个新的命令类(例如叫 SendNewsletter):

php artisan make:command SendNewsletter

这会在 app/Console/Commands/ 目录下生成一个 PHP 类文件,Laravel 会自动注册它(无需手动添加到 Kernel.php,只要类继承 Command 并有 $signature 属性即可)。

2. 配置命令签名与描述

打开刚生成的类,在 $signature 和 $description 属性中定义命令行为:

  • $signature:指定命令名称、参数和选项,支持参数({name})、可选参数({name?})、选项(--force)、带值选项(--limit=10)
  • $description:简短说明,会在 php artisan list 或 php artisan help xxx 中显示

示例:

$signature = 'newsletter:send {--force : 强制发送} {--limit=100 : 最多发送数量}';
$description = '批量发送邮件简报';

Laravel Creem Agent
Laravel Creem Agent

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

下载

3. 编写执行逻辑

在 handle() 方法中写实际业务代码。你可以依赖注入任何服务(如 Mail、DB、自定义 Repository 等):

  • 用 $this->option('force') 获取选项值
  • 用 $this->argument('name') 获取参数值(如果定义了)
  • 用 $this->info()、$this->warn()、$this->error() 输出友好提示
  • 返回 0 表示成功,非 0 表示失败(会触发 shell 错误码)

小技巧:可在 handle() 中调用其他 Service 类或 Eloquent 模型,保持逻辑清晰。

4. 测试与运行

保存后,直接运行命令查看是否注册成功:

php artisan list | grep newsletter

执行命令:

php artisan newsletter:send --force --limit=50

开发阶段建议加 --dry-run 选项模拟执行,避免误操作;上线前可用 if ($this->confirm('确认执行?')) { ... } 加交互确认。

相关文章

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

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

下载

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

相关专题

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

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

2023.09.01

9564

6

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

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

2023.10.11

5761

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

3588

4

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

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

2023.10.23

4274

6

html怎么上传
html怎么上传

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

2023.11.03

3351

9

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

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

2023.11.09

4757

8

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

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

2023.11.13

3722

8

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

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

2023.11.27

11742

4

热门下载

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

精品课程

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

共1课时 | 194人学习

Composer手册
Composer手册

共0课时 | 0人学习