0

0

laravel如何创建自定义的Artisan命令_Laravel自定义Artisan命令教程

穿越時空

穿越時空

发布时间:2025-10-27 11:33:01

|

387人浏览过

|

来源于php中文网

原创

答案:在 Laravel 中创建自定义 Artisan 命令可自动化常用任务,使用 make:command 生成命令类,配置 signature 和 description 属性定义调用方式与描述,于 handle() 方法编写逻辑,通过 argument() 和 option() 获取参数与选项,利用 info() 等方法输出信息,最后在 app/Console/Kernel.php 的 $commands 数组注册命令即可通过 php artisan 运行,结合计划任务可定时执行。

laravel如何创建自定义的artisan命令_laravel自定义artisan命令教程

在 Laravel 中创建自定义 Artisan 命令非常简单,能帮助你将常用任务自动化,比如清理数据、发送邮件、处理队列等。通过 Artisan 命令行工具,你可以像使用内置命令一样运行自己的逻辑。

生成自定义 Artisan 命令

Laravel 提供了 make:command 命令来快速生成一个命令类。打开终端,进入项目根目录,执行以下命令:

php artisan make:command SendDailyReport

这会在 app/Console/Commands 目录下生成一个名为 SendDailyReport.php 的文件。如果该目录不存在,Laravel 会在第一次创建命令时自动创建。

配置命令签名和描述

打开生成的命令文件,你会看到两个关键属性:signature 和 description。

signature 定义了你在终端调用命令时使用的名称和参数格式;description 是命令的简要说明,出现在 php artisan list 中。

示例:

protected $signature = 'report:send {user? : 用户邮箱} {--queue : 是否加入队列}';
protected $description = '发送每日报告';

上面的 signature 中:

  • report:send 是命令名称
  • {user?} 表示可选参数,名字是 user
  • {--queue} 表示可选选项(布尔值)

编写命令逻辑

handle() 方法中编写你的业务逻辑。你可以调用模型、门面、服务类等 Laravel 功能。

Civitai
Civitai

AI艺术分享平台!海量SD资源和开源模型。

下载

示例:

public function handle()
{
    $user = $this->argument('user');
    if ($this->option('queue')) {
        dispatch(new SendReportJob($user));
        $this->info('任务已加入队列');
    } else {
        // 直接发送
        $this->info('报告已发送给 ' . ($user ?? '所有人'));
    }
}

你可以使用 $this->info()$this->error()$this->line() 等方法输出信息到控制台。

注册命令并运行

Laravel 会自动加载 app/Console/Kernel.php$commands 数组里列出的命令。

确保你的命令类被包含进去:

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

然后在终端运行:

php artisan report:send --queue

或带参数:

php artisan report:send john@example.com --queue

基本上就这些。Laravel 自定义 Artisan 命令让你轻松把重复任务脚本化,结合计划任务还能实现定时执行,非常实用。

相关专题

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

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

2687

2023.09.01

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

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

1661

2023.10.11

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

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

1522

2023.10.11

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

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

953

2023.10.23

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

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

1419

2023.10.23

html怎么上传
html怎么上传

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

1235

2023.11.03

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

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

1488

2023.11.09

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

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

1306

2023.11.13

PS使用蒙版相关教程
PS使用蒙版相关教程

本专题整合了ps使用蒙版相关教程,阅读专题下面的文章了解更多详细内容。

23

2026.01.19

热门下载

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

精品课程

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

共137课时 | 8.9万人学习

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

共6课时 | 8.5万人学习

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

共13课时 | 0.9万人学习

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

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