0

0

Laravel如何创建自定义Artisan命令_Laravel命令行工具开发与参数选项定义【实战】

冰火之心

冰火之心

发布时间:2026-01-03 17:45:09

|

785人浏览过

|

来源于php中文网

原创

运行 php artisan make:command SendWeeklyReport 生成命令类并自动注册;在 configure() 中用 signature 定义参数与选项,在 handle() 中通过 argument()、option() 获取值,用 ask() 等交互方法;推荐用 line() 替代 info() 保证兼容性;Eloquent 和队列可用,但需注意事务、分块查询与环境隔离。

laravel如何创建自定义artisan命令_laravel命令行工具开发与参数选项定义【实战】

如何生成并注册一个自定义 Artisan 命令

运行 php artisan make:command SendWeeklyReport 即可生成命令类,它会自动放在 app/Console/Commands/SendWeeklyReport.php。Laravel 8+ 默认已启用命令自动发现(ConsoleServiceProvider 中的 commands() 方法扫描 app/Console/Commands 目录),无需手动在 app/Console/Kernel.php$commands 数组中注册——除非你把命令放到了非标准路径。

若需手动注册,确保 Kernel.php 中包含该类引用,并将其添加到 $commands 数组:

protected $commands = [
    \App\Console\Commands\SendWeeklyReport::class,
];

如何定义参数、选项及交互式输入

在命令类的 configure() 方法中用 signature 定义命令结构;参数用花括号 {},选项用两短横 --,布尔型选项默认不带值,带值选项加等号 =

  • name 是必填位置参数:{name : The name of the user}
  • --force 是布尔开关:--force : Force the operation to run
  • --limit 是带值选项:--limit=5 : Maximum number of items to process
  • --env 支持多选值:--env=production|staging : Target environment

handle() 中通过 $this->argument('name')$this->option('limit') 获取值;交互式提问用 $this->ask()$this->confirm()$this->choice() 等方法。

为什么 handle() 中不能直接用 $this->info() 但能用 $this->line()

$this->info()$this->error()$this->comment() 等方法依赖于 Symfony 的 OutputInterface 实现,它们在 Laravel 9+ 中默认可用,但在某些低版本或自定义输出对象场景下可能未被正确代理。更稳妥的方式是使用底层的 $this->line()$this->writeln(),它们直接调用 OutputInterface 的原生方法,兼容性更强。

  • 推荐统一用 $this->line('Done.', 'fg=green') 控制颜色
  • 避免在 handle() 外部(如构造函数)调用输出方法,此时输出对象尚未初始化
  • 批量输出建议用 $this->withProgressBar($items, function ($item) { ... }),它自动处理进度与换行

如何在命令中安全调用 Eloquent 或队列任务

Artisan 命令默认运行在 console 环境下,Eloquent 模型和队列驱动都可用,但要注意两点:事务边界和连接复用。

  • 数据库操作建议包裹在 DB::transaction() 中,尤其涉及多表写入时
  • 队列任务请用 dispatch(new ProcessReport($data))->onQueue('reports') 显式指定队列名,避免混入 web 请求队列
  • 避免在循环中频繁 new Model(),改用 User::query()->where(...)->chunkById(100, function ($users) { ... }) 防止内存溢出
  • 如果命令需长时间运行(如导出百万条记录),记得在循环中调用 gc_collect_cycles()unset($var) 主动释放变量

真正容易被忽略的是环境隔离:APP_ENV=local php artisan send:report 不会自动切换数据库配置,必须靠 .envconfig/database.php 中的 env() 判断逻辑来区分连接——别假设命令一定走测试库。

相关专题

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

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

2211

2023.09.01

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

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

1465

2023.10.11

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

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

1371

2023.10.11

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

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

951

2023.10.23

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

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

1412

2023.10.23

html怎么上传
html怎么上传

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

1233

2023.11.03

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

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

1443

2023.11.09

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

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

1303

2023.11.13

漫蛙2入口地址合集
漫蛙2入口地址合集

本专题整合了漫蛙2入口汇总,阅读专题下面的文章了解更多详细内容。

13

2026.01.06

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
PHP课程
PHP课程

共137课时 | 8.3万人学习

JavaScript ES5基础线上课程教学
JavaScript ES5基础线上课程教学

共6课时 | 6.9万人学习

PHP新手语法线上课程教学
PHP新手语法线上课程教学

共13课时 | 0.8万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号