laravel如何创建自定义的Artisan命令_Laravel自定义Artisan命令教程-Laravel-PHP中文网

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

穿越時空

发布： 2025-10-27 11:33:01

原创

364人浏览过

答案：在 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 功能。

通义万相

通义万相，一个不断进化的AI艺术创作大模型

596

查看详情

示例：

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() 等方法输出信息到控制台。