0

0

laravel如何创建自定义的 Artisan 命令选项和参数_Laravel自定义Artisan命令选项与参数方法

冰火之心

冰火之心

发布时间:2025-10-14 20:12:01

|

253人浏览过

|

来源于php中文网

原创

答案:通过 php artisan make:command SendEmails 创建命令类,定义 signature 设置参数与选项,如 {user}、{--queue}、{--type=}、{--when=*},在 handle() 中用 argument() 和 option() 获取值,并可结合 ask、confirm 等方法实现交互,最终实现灵活的自动化命令。

laravel如何创建自定义的 artisan 命令选项和参数_laravel自定义artisan命令选项与参数方法

Laravel 的 Artisan 命令工具非常强大,通过自定义命令可以实现自动化任务处理。创建带有选项和参数的自定义 Artisan 命令,能让你更灵活地控制命令行为。

生成自定义 Artisan 命令

使用以下 Artisan 命令生成一个新的命令类:

php artisan make:command SendEmails

这将在 app/Console/Commands 目录下创建 SendEmails.php 文件。确保在 AppServiceProvider 或配置中已注册命令(Laravel 8+ 默认自动发现)。

定义命令的签名与描述

在命令类的 signature 属性中定义命令名称、参数和选项。格式如下:

  • {name}:必需参数
  • {name?}:可选参数
  • {name=default}:带默认值的参数
  • {--option}:布尔选项(开关)
  • {--option=}{--option=value}:接收值的选项
  • {--option=*}:可接收多个值的选项

示例:

protected $signature = 'send:emails {user} {--queue} {--type=} {--when=*}';

该签名表示:

GentleAI
GentleAI

GentleAI是一个高效的AI工作平台,为普通人提供智能计算、简单易用的界面和专业技术支持。让人工智能服务每一个人。

下载
  • user:必须传入的用户标识
  • --queue:是否加入队列(true/false)
  • --type=:指定邮件类型,如 --type=welcome
  • --when=*:可多次传递发送时间点

在命令中获取参数和选项

handle() 方法中使用 $this->argument()$this->option() 获取输入值。

public function handle()
{
    $user = $this->argument('user');
    $queue = $this->option('queue');
    $type = $this->option('type');
    $when = $this->option('when');

    $this->info("发送邮件给: $user");
    $this->info("队列模式: " . ($queue ? '开启' : '关闭'));
    $this->info("邮件类型: $type");
    $this->info("发送时间: " . implode(', ', $when));
}

执行命令示例:

php artisan send:emails zhangsan --queue --type=welcome --when=now --when=later

交互式提示输入

你还可以在命令中动态请求用户输入:

  • $this->ask('问题'):普通输入
  • $this->secret('问题'):隐藏输入(如密码)
  • $this->confirm('确认吗?'):确认对话
  • $this->choice('选择', ['a','b']):选择项

例如:

if ($this->confirm('是否继续?')) {
    $email = $this->ask('请输入邮箱');
}

基本上就这些。定义好签名,使用 argument 和 option 方法取值,再结合交互方法,就能构建出功能完整的自定义 Artisan 命令。不复杂但容易忽略细节,比如选项的等号写法和参数默认值设置。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

WorkBuddy
WorkBuddy

腾讯云推出的AI原生桌面智能体工作台

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
laravel组件介绍
laravel组件介绍

laravel 提供了丰富的组件,包括身份验证、模板引擎、缓存、命令行工具、数据库交互、对象关系映射器、事件处理、文件操作、电子邮件发送、队列管理和数据验证。想了解更多laravel的相关内容,可以阅读本专题下面的文章。

340

2024.04.09

laravel中间件介绍
laravel中间件介绍

laravel 中间件分为五种类型:全局、路由、组、终止和自定。想了解更多laravel中间件的相关内容,可以阅读本专题下面的文章。

294

2024.04.09

laravel使用的设计模式有哪些
laravel使用的设计模式有哪些

laravel使用的设计模式有:1、单例模式;2、工厂方法模式;3、建造者模式;4、适配器模式;5、装饰器模式;6、策略模式;7、观察者模式。想了解更多laravel的相关内容,可以阅读本专题下面的文章。

774

2024.04.09

thinkphp和laravel哪个简单
thinkphp和laravel哪个简单

对于初学者来说,laravel 的入门门槛较低,更易上手,原因包括:1. 更简单的安装和配置;2. 丰富的文档和社区支持;3. 简洁易懂的语法和 api;4. 平缓的学习曲线。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

386

2024.04.10

laravel入门教程
laravel入门教程

本专题整合了laravel入门教程,想了解更多详细内容,请阅读专题下面的文章。

146

2025.08.05

laravel实战教程
laravel实战教程

本专题整合了laravel实战教程,阅读专题下面的文章了解更多详细内容。

85

2025.08.05

laravel面试题
laravel面试题

本专题整合了laravel面试题相关内容,阅读专题下面的文章了解更多详细内容。

81

2025.08.05

PHP高性能API设计与Laravel服务架构实践
PHP高性能API设计与Laravel服务架构实践

本专题围绕 PHP 在现代 Web 后端开发中的高性能实践展开,重点讲解基于 Laravel 框架构建可扩展 API 服务的核心方法。内容涵盖路由与中间件机制、服务容器与依赖注入、接口版本管理、缓存策略设计以及队列异步处理方案。同时结合高并发场景,深入分析性能瓶颈定位与优化思路,帮助开发者构建稳定、高效、易维护的 PHP 后端服务体系。

655

2026.03.04

TypeScript类型系统进阶与大型前端项目实践
TypeScript类型系统进阶与大型前端项目实践

本专题围绕 TypeScript 在大型前端项目中的应用展开,深入讲解类型系统设计与工程化开发方法。内容包括泛型与高级类型、类型推断机制、声明文件编写、模块化结构设计以及代码规范管理。通过真实项目案例分析,帮助开发者构建类型安全、结构清晰、易维护的前端工程体系,提高团队协作效率与代码质量。

49

2026.03.13

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Laravel---API接口
Laravel---API接口

共7课时 | 0.7万人学习

PHP自制框架
PHP自制框架

共8课时 | 0.6万人学习

PHP面向对象基础课程(更新中)
PHP面向对象基础课程(更新中)

共12课时 | 0.7万人学习

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

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