Laravel如何自定义Artisan命令_Laravel自定义Artisan命令方法【CLI】

风杰酱_4115

风杰酱_4115

2026-04-18

343人浏览

原创

应使用artisan命令生成器创建命令类:执行php artisan make:command senddailyreport生成骨架文件,编辑$signature定义名称与参数,于handle()中编写逻辑并用$this->info()输出状态。

laravel如何自定义artisan命令_laravel自定义artisan命令方法【cli】

如果您希望在 Laravel 项目中封装重复性任务、自动化数据处理或集成运维脚本,则需要创建可被 php artisan 直接调用的自定义命令。以下是实现该目标的多种可行方法:

一、使用 Artisan 命令生成器创建命令类

此方法利用 Laravel 内置的 make:command 命令快速生成符合框架规范的命令骨架,确保类结构、命名空间和目录位置完全合规,避免手动创建时因路径或继承问题导致命令不可见。

1、打开终端并切换至 Laravel 项目根目录(即包含 artisan 文件的目录)。

2、执行命令生成新命令类:php artisan make:command SendDailyReport。

3、确认文件已生成于 app/Console/Commands/SendDailyReport.php 路径下。

4、编辑该文件,在 $signature 属性中定义命令名称与参数格式,例如:'report:daily {--force} {email?}'。

5、在 handle() 方法中编写业务逻辑,并使用 $this->info() 或 $this->error() 输出状态信息。

二、通过 Shell 脚本批量生成并标准化命名

该方式适用于团队协作场景,通过外部脚本统一控制命令类命名规则、签名格式及生成路径,规避人工输入错误,提升命令注册一致性与可维护性。

1、在项目根目录新建 scripts/make-command.sh 文件。

2、向文件写入以下内容:#!/bin/bash; php artisan make:command "$1" --command="$2"。

3、赋予脚本执行权限:chmod +x scripts/make-command.sh。

4、运行脚本生成命令:./scripts/make-command.sh ProcessUserImport import:users。

5、验证生成文件 app/Console/Commands/ProcessUserImport.php 中的 $signature 是否为 import:users。

三、手动注册未自动发现的命令类

当命令类置于非标准路径(如 app/Console/Commands/Reports/ 子目录)、使用自定义命名空间或 Laravel 版本低于 8.0 时,框架无法自动加载,必须显式注册到内核中才能出现在 php artisan list 输出中。

1、打开 app/Console/Kernel.php 文件。

Laravel Creem Agent
Laravel Creem Agent

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

下载

2、在 $commands 数组中添加全限定类名:\App\Console\Commands\Reports\SendMonthlyReport::class。

3、若此前修改过目录结构或命名空间,先执行 php artisan config:clear 清除配置缓存。

4、再次运行 php artisan list,确认新命令已列出。

四、在 PHP 运行时动态实例化并执行命令

该方法绕过 Artisan 的命令注册机制,直接在控制器、调度任务或测试环境中调用命令实例的 run() 方法,适用于需条件触发、嵌套调用或规避 CLI 环境限制的场景。

1、确保目标命令类已存在且继承 Illuminate\Console\Command。

2、在调用位置引入必要类:use Symfony\Component\Console\Input\ArrayInput; 和 use Symfony\Component\Console\Output\BufferedOutput;。

3、创建命令实例:$command = new \App\Console\Commands\SendDailyReport();。

4、构造输入与输出对象:$input = new ArrayInput(['--force' => true]); $output = new BufferedOutput();。

5、执行命令:$command->run($input, $output);。

五、基于 Composer Script 封装命令生成流程

将 Artisan 命令生成操作集成进 Composer 的 scripts 配置中,使开发者仅需执行 composer make:command 即可完成全部流程,降低 CLI 使用门槛并统一开发入口。

1、编辑项目根目录下的 composer.json 文件。

2、在 "scripts" 段落中添加:"make:command": "php artisan make:command"。

3、保存后执行:composer run make:command SendEmailsCommand。

4、检查 app/Console/Commands/SendEmailsCommand.php 是否已生成。

5、若需指定命令签名,可在执行时追加参数:-- --command=email:send。

相关文章

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

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

下载

相关标签:

laravel

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

相关专题

更多
C语言变量命名
C语言变量命名

c语言变量名规则是:1、变量名以英文字母开头;2、变量名中的字母是区分大小写的;3、变量名不能是关键字;4、变量名中不能包含空格、标点符号和类型说明符。php中文网还提供c语言变量的相关下载、相关课程等内容,供大家免费下载使用。

2023.06.20

2829

3

c语言入门自学零基础
c语言入门自学零基础

C语言是当代人学习及生活中的必备基础知识,应用十分广泛,本专题为大家c语言入门自学零基础的相关文章,以及相关课程,感兴趣的朋友千万不要错过了。

2023.07.25

2188

9

c语言运算符的优先级顺序
c语言运算符的优先级顺序

c语言运算符的优先级顺序是括号运算符 > 一元运算符 > 算术运算符 > 移位运算符 > 关系运算符 > 位运算符 > 逻辑运算符 > 赋值运算符 > 逗号运算符。本专题为大家提供c语言运算符相关的各种文章、以及下载和课程。

2023.08.02

1160

5

c语言数据结构
c语言数据结构

数据结构是指将数据按照一定的方式组织和存储的方法。它是计算机科学中的重要概念,用来描述和解决实际问题中的数据组织和处理问题。数据结构可以分为线性结构和非线性结构。线性结构包括数组、链表、堆栈和队列等,而非线性结构包括树和图等。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.09

1098

4

c语言random函数用法
c语言random函数用法

c语言random函数用法:1、random.random,随机生成(0,1)之间的浮点数;2、random.randint,随机生成在范围之内的整数,两个参数分别表示上限和下限;3、random.randrange,在指定范围内,按指定基数递增的集合中获得一个随机数;4、random.choice,从序列中随机抽选一个数;5、random.shuffle,随机排序。

2023.09.05

1296

5

c语言const用法
c语言const用法

const是关键字,可以用于声明常量、函数参数中的const修饰符、const修饰函数返回值、const修饰指针。详细介绍:1、声明常量,const关键字可用于声明常量,常量的值在程序运行期间不可修改,常量可以是基本数据类型,如整数、浮点数、字符等,也可是自定义的数据类型;2、函数参数中的const修饰符,const关键字可用于函数的参数中,表示该参数在函数内部不可修改等等。

2023.09.20

2018

7

c语言get函数的用法
c语言get函数的用法

get函数是一个用于从输入流中获取字符的函数。可以从键盘、文件或其他输入设备中读取字符,并将其存储在指定的变量中。本文介绍了get函数的用法以及一些相关的注意事项。希望这篇文章能够帮助你更好地理解和使用get函数 。

2023.09.20

3140

8

c数组初始化的方法
c数组初始化的方法

c语言数组初始化的方法有直接赋值法、不完全初始化法、省略数组长度法和二维数组初始化法。详细介绍:1、直接赋值法,这种方法可以直接将数组的值进行初始化;2、不完全初始化法,。这种方法可以在一定程度上节省内存空间;3、省略数组长度法,这种方法可以让编译器自动计算数组的长度;4、二维数组初始化法等等。

2023.09.22

13835

6

c语言中null和NULL的区别
c语言中null和NULL的区别

c语言中null和NULL的区别是:null是C语言中的一个宏定义,通常用来表示一个空指针,可以用于初始化指针变量,或者在条件语句中判断指针是否为空;NULL是C语言中的一个预定义常量,通常用来表示一个空值,用于表示一个空的指针、空的指针数组或者空的结构体指针。

2023.09.22

529

3

热门下载

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

精品课程

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

共1课时 | 197人学习

Composer手册
Composer手册

共0课时 | 0人学习