Skip to content

Artisan 控制台

介绍

Artisan 是 Laravel 附带的命令行接口。Artisan 位于应用程序的根目录,作为 artisan 脚本,提供了一系列有助于您构建应用程序的命令。要查看所有可用的 Artisan 命令列表,您可以使用 list 命令:

shell
php artisan list

每个命令还包括一个“帮助”屏幕,显示并描述命令的可用参数和选项。要查看帮助屏幕,请在命令名称前加上 help

shell
php artisan help migrate

Laravel Sail

如果您使用 Laravel Sail 作为本地开发环境,请记得使用 sail 命令行来调用 Artisan 命令。Sail 将在您的应用程序的 Docker 容器内执行 Artisan 命令:

shell
./vendor/bin/sail artisan list

Tinker (REPL)

Laravel Tinker 是一个强大的 REPL,专为 Laravel 框架设计,由 PsySH 包提供支持。

安装

所有 Laravel 应用程序默认都包含 Tinker。然而,如果您之前从应用程序中删除了它,您可以使用 Composer 安装 Tinker:

shell
composer require laravel/tinker
lightbulb

想要在与 Laravel 应用程序交互时获得热重载、多行代码编辑和自动补全功能?请查看 Tinkerwell!

用法

Tinker 允许您在命令行中与整个 Laravel 应用程序进行交互,包括您的 Eloquent 模型、作业、事件等。要进入 Tinker 环境,请运行 tinker Artisan 命令:

shell
php artisan tinker

您可以使用 vendor:publish 命令发布 Tinker 的配置文件:

shell
php artisan vendor:publish --provider="Laravel\Tinker\TinkerServiceProvider"
exclamation

dispatch 辅助函数和 Dispatchable 类上的 dispatch 方法依赖于垃圾回收将作业放入队列。因此,在使用 tinker 时,您应该使用 Bus::dispatchQueue::push 来调度作业。

命令允许列表

Tinker 使用“允许”列表来确定哪些 Artisan 命令可以在其 shell 中运行。默认情况下,您可以运行 clear-compileddownenvinspiremigratemigrate:installupoptimize 命令。如果您希望允许更多命令,可以将它们添加到 tinker.php 配置文件中的 commands 数组中:

php
'commands' => [
    // App\Console\Commands\ExampleCommand::class,
],

不应别名的类

通常,Tinker 会在您与之交互时自动别名类。然而,您可能希望永远不别名某些类。您可以通过在 tinker.php 配置文件的 dont_alias 数组中列出这些类来实现:

php
'dont_alias' => [
    App\Models\User::class,
],

编写命令

除了 Artisan 提供的命令外,您还可以构建自己的自定义命令。命令通常存储在 app/Console/Commands 目录中;但是,您可以选择自己的存储位置,只要您的命令可以被 Composer 加载。

生成命令

要创建新命令,您可以使用 make:command Artisan 命令。此命令将在 app/Console/Commands 目录中创建一个新的命令类。如果该目录在您的应用程序中不存在,请不要担心 - 它将在您第一次运行 make:command Artisan 命令时创建:

shell
php artisan make:command SendEmails

命令结构

生成命令后,您应该为类的 signaturedescription 属性定义适当的值。这些属性将在 list 屏幕上显示您的命令时使用。signature 属性还允许您定义 命令的输入期望。当执行命令时,将调用 handle 方法。您可以在此方法中放置命令逻辑。

让我们看一个示例命令。请注意,我们可以通过命令的 handle 方法请求所需的任何依赖项。Laravel 服务容器 将自动注入在此方法的签名中类型提示的所有依赖项:

php
<?php

namespace App\Console\Commands;

use App\Models\User;
use App\Support\DripEmailer;
use Illuminate\Console\Command;

class SendEmails extends Command
{
    /**
     * 控制台命令的名称和签名。
     *
     * @var string
     */
    protected $signature = 'mail:send {user}';

    /**
     * 控制台命令描述。
     *
     * @var string
     */
    protected $description = '向用户发送营销电子邮件';

    /**
     * 执行控制台命令。
     */
    public function handle(DripEmailer $drip): void
    {
        $drip->send(User::find($this->argument('user')));
    }
}
lightbulb

为了更好地重用代码,保持控制台命令轻量并让它们委托给应用程序服务来完成任务是一个好习惯。在上面的示例中,请注意我们注入了一个服务类来完成发送电子邮件的“重任”。

退出代码

如果 handle 方法没有返回任何内容并且命令成功执行,则命令将以 0 退出代码退出,表示成功。然而,handle 方法可以选择返回一个整数以手动指定命令的退出代码:

php
$this->error('出现问题。');

return 1;

如果您希望从命令中的任何方法“失败”命令,您可以使用 fail 方法。fail 方法将立即终止命令的执行并返回退出代码 1

php
$this->fail('出现问题。');

闭包命令

基于闭包的命令提供了一种将控制台命令定义为类的替代方法。与路由闭包是控制器的替代方法一样,可以将命令闭包视为命令类的替代方法。

尽管 routes/console.php 文件不定义 HTTP 路由,但它定义了进入您应用程序的基于控制台的入口点(路由)。在此文件中,您可以使用 Artisan::command 方法定义所有基于闭包的控制台命令。command 方法接受两个参数: 命令签名 和一个接收命令参数和选项的闭包:

php
Artisan::command('mail:send {user}', function (string $user) {
    $this->info("正在向: {$user} 发送电子邮件!");
});

闭包绑定到底层命令实例,因此您可以完全访问通常可以在完整命令类上访问的所有辅助方法。

类型提示依赖项

除了接收命令的参数和选项外,命令闭包还可以类型提示您希望从 服务容器 中解析的其他依赖项:

php
use App\Models\User;
use App\Support\DripEmailer;

Artisan::command('mail:send {user}', function (DripEmailer $drip, string $user) {
    $drip->send(User::find($user));
});

闭包命令描述

在定义基于闭包的命令时,您可以使用 purpose 方法为命令添加描述。此描述将在您运行 php artisan listphp artisan help 命令时显示:

php
Artisan::command('mail:send {user}', function (string $user) {
    // ...
})->purpose('向用户发送营销电子邮件');

可隔离命令

exclamation

要利用此功能,您的应用程序必须使用 memcachedredisdynamodbdatabasefilearray 缓存驱动程序作为应用程序的默认缓存驱动程序。此外,所有服务器必须与同一个中央缓存服务器进行通信。

有时,您可能希望确保一次只能运行一个命令。要实现此目的,您可以在命令类上实现 Illuminate\Contracts\Console\Isolatable 接口:

php
<?php

namespace App\Console\Commands;

use Illuminate\Console\Command;
use Illuminate\Contracts\Console\Isolatable;

class SendEmails extends Command implements Isolatable
{
    // ...
}

当命令标记为 Isolatable 时,Laravel 将自动为命令添加一个 --isolated 选项。当使用该选项调用命令时,Laravel 将确保没有其他实例的该命令正在运行。Laravel 通过尝试使用应用程序的默认缓存驱动程序获取原子锁来实现此目的。如果其他实例的命令正在运行,则该命令将不会执行;但是,该命令仍将以成功的退出状态代码退出:

shell
php artisan mail:send 1 --isolated

如果您希望指定命令在无法执行时应返回的退出状态代码,可以通过 isolated 选项提供所需的状态代码:

shell
php artisan mail:send 1 --isolated=12

锁 ID

默认情况下,Laravel 将使用命令的名称生成用于获取原子锁的字符串键。然而,您可以通过在 Artisan 命令类上定义 isolatableId 方法来自定义此键,从而将命令的参数或选项集成到键中:

php
/**
 * 获取命令的可隔离 ID。
 */
public function isolatableId(): string
{
    return $this->argument('user');
}

锁过期时间

默认情况下,隔离锁在命令完成后过期。如果命令被中断且无法完成,则锁将在一小时后过期。然而,您可以通过在命令上定义 isolationLockExpiresAt 方法来调整锁的过期时间:

php
use DateTimeInterface;
use DateInterval;

/**
 * 确定命令的隔离锁何时过期。
 */
public function isolationLockExpiresAt(): DateTimeInterface|DateInterval
{
    return now()->addMinutes(5);
}

定义输入期望

编写控制台命令时,通常需要通过参数或选项从用户收集输入。Laravel 通过命令上的 signature 属性使定义您期望的输入变得非常方便。signature 属性允许您使用单个、富有表现力的、类似路由的语法定义命令的名称、参数和选项。

参数

所有用户提供的参数和选项都用大括号括起来。在以下示例中,命令定义了一个必需的参数:user

php
/**
 * 控制台命令的名称和签名。
 *
 * @var string
 */
protected $signature = 'mail:send {user}';

您还可以使参数可选或定义参数的默认值:

php
// 可选参数...
'mail:send {user?}'

// 带有默认值的可选参数...
'mail:send {user=foo}'

选项

选项与参数一样,是用户输入的另一种形式。选项在命令行中提供时以两个连字符(--)为前缀。选项有两种类型:接收值的选项和不接收值的选项。让我们看一下这种类型的选项的示例:

php
/**
 * 控制台命令的名称和签名。
 *
 * @var string
 */
protected $signature = 'mail:send {user} {--queue}';

在此示例中,可以在调用 Artisan 命令时指定 --queue 开关。如果传递了 --queue 开关,则选项的值将为 true。否则,值将为 false

shell
php artisan mail:send 1 --queue

带值的选项

接下来,让我们看一下一个期望值的选项。如果用户必须为选项指定值,则应在选项名称后加上 = 符号:

php
/**
 * 控制台命令的名称和签名。
 *
 * @var string
 */
protected $signature = 'mail:send {user} {--queue=}';

在此示例中,用户可以像这样为选项传递值。如果在调用命令时未指定选项,则其值将为 null

shell
php artisan mail:send 1 --queue=default

您可以通过在选项名称后指定默认值来为选项分配默认值。如果用户未传递选项值,则将使用默认值:

php
'mail:send {user} {--queue=default}'

选项快捷方式

要在定义选项时分配快捷方式,您可以在选项名称之前指定它,并使用 | 字符作为分隔符来分隔快捷方式和完整选项名称:

php
'mail:send {user} {--Q|queue}'

在终端中调用命令时,选项快捷方式应以单个连字符为前缀,并且在指定选项的值时不应包含 = 字符:

shell
php artisan mail:send 1 -Qdefault

输入数组

如果您希望定义参数或选项以期望多个输入值,则可以使用 * 字符。首先,让我们看一下指定此类参数的示例:

php
'mail:send {user*}'

调用此方法时,user 参数可以按顺序传递到命令行。例如,以下命令将把 user 的值设置为包含 12 的数组:

shell
php artisan mail:send 1 2

* 字符可以与可选参数定义结合使用,以允许零个或多个参数的实例:

php
'mail:send {user?*}'

选项数组

在定义期望多个输入值的选项时,传递给命令的每个选项值应以选项名称为前缀:

php
'mail:send {--id=*}'

这样的命令可以通过传递多个 --id 参数来调用:

shell
php artisan mail:send --id=1 --id=2

输入描述

您可以通过使用冒号分隔参数名称和描述来为输入参数和选项分配描述。如果您需要更多空间来定义命令,请随意将定义分散到多行:

php
/**
 * 控制台命令的名称和签名。
 *
 * @var string
 */
protected $signature = 'mail:send
                        {user : 用户的 ID}
                        {--queue : 是否将作业排入队列}';

提示缺失输入

如果您的命令包含必需的参数,则在未提供时,用户将收到错误消息。或者,您可以通过实现 PromptsForMissingInput 接口来配置命令,以在缺少必需参数时自动提示用户:

php
<?php

namespace App\Console\Commands;

use Illuminate\Console\Command;
use Illuminate\Contracts\Console\PromptsForMissingInput;

class SendEmails extends Command implements PromptsForMissingInput
{
    /**
     * 控制台命令的名称和签名。
     *
     * @var string
     */
    protected $signature = 'mail:send {user}';

    // ...
}

如果 Laravel 需要从用户那里收集必需的参数,它将通过智能地使用参数名称或描述来询问用户。如果您希望自定义用于收集必需参数的问题,可以实现 promptForMissingArgumentsUsing 方法,返回一个以参数名称为键的问题数组:

php
/**
 * 使用返回的问题提示缺失的输入参数。
 *
 * @return array<string, string>
 */
protected function promptForMissingArgumentsUsing(): array
{
    return [
        'user' => '哪个用户 ID 应该接收邮件?',
    ];
}

您还可以通过使用包含问题和占位符的元组提供占位符文本:

php
return [
    'user' => ['哪个用户 ID 应该接收邮件?', '例如 123'],
];

如果您希望完全控制提示,可以提供一个闭包,该闭包应提示用户并返回他们的答案:

php
use App\Models\User;
use function Laravel\Prompts\search;

// ...

return [
    'user' => fn () => search(
        label: '搜索用户:',
        placeholder: '例如 Taylor Otwell',
        options: fn ($value) => strlen($value) > 0
            ? User::where('name', 'like', "%{$value}%")->pluck('name', 'id')->all()
            : []
    ),
];
lightbulb

综合的 Laravel Prompts 文档包括有关可用提示及其用法的更多信息。

如果您希望提示用户选择或输入 选项,您可以在命令的 handle 方法中包含提示。然而,如果您只希望在用户也被自动提示缺失参数时提示用户,则可以实现 afterPromptingForMissingArguments 方法:

php
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;
use function Laravel\Prompts\confirm;

// ...

/**
 * 在用户被提示缺失参数后执行操作。
 */
protected function afterPromptingForMissingArguments(InputInterface $input, OutputInterface $output): void
{
    $input->setOption('queue', confirm(
        label: '您想要将邮件排入队列吗?',
        default: $this->option('queue')
    ));
}

命令 I/O

检索输入

在命令执行时,您可能需要访问命令接受的参数和选项的值。为此,您可以使用 argumentoption 方法。如果参数或选项不存在,将返回 null

php
/**
 * 执行控制台命令。
 */
public function handle(): void
{
    $userId = $this->argument('user');
}

如果您需要将所有参数作为 array 检索,请调用 arguments 方法:

php
$arguments = $this->arguments();

选项可以像参数一样轻松检索,使用 option 方法。要将所有选项作为数组检索,请调用 options 方法:

php
// 检索特定选项...
$queueName = $this->option('queue');

// 将所有选项作为数组检索...
$options = $this->options();

提示输入

lightbulb

Laravel Prompts 是一个 PHP 包,用于为您的命令行应用程序添加美观且用户友好的表单,具有浏览器般的功能,包括占位符文本和验证。

除了显示输出外,您还可以在命令执行期间询问用户提供输入。ask 方法将提示用户给定的问题,接受他们的输入,然后将用户的输入返回给您的命令:

php
/**
 * 执行控制台命令。
 */
public function handle(): void
{
    $name = $this->ask('您的名字是什么?');

    // ...
}

ask 方法还接受一个可选的第二个参数,该参数指定如果未提供用户输入,则应返回的默认值:

php
$name = $this->ask('您的名字是什么?', 'Taylor');

secret 方法与 ask 方法类似,但用户输入时不会在控制台中可见。这种方法在询问敏感信息(如密码)时非常有用:

php
$password = $this->secret('密码是什么?');

询问确认

如果您需要询问用户简单的“是或否”确认,您可以使用 confirm 方法。默认情况下,此方法将返回 false。然而,如果用户在提示中输入 yyes,则该方法将返回 true

php
if ($this->confirm('您希望继续吗?')) {
    // ...
}

如果需要,您可以通过将 true 作为第二个参数传递给 confirm 方法来指定确认提示应默认返回 true

php
if ($this->confirm('您希望继续吗?', true)) {
    // ...
}

自动补全

anticipate 方法可用于为可能的选择提供自动补全。用户仍然可以提供任何答案,而不管自动补全提示:

php
$name = $this->anticipate('您的名字是什么?', ['Taylor', 'Dayle']);

或者,您可以将闭包作为第二个参数传递给 anticipate 方法。每当用户输入字符时,将调用该闭包。闭包应接受一个包含用户迄今为止输入的字符串参数,并返回自动补全的选项数组:

php
$name = $this->anticipate('您的地址是什么?', function (string $input) {
    // 返回自动补全选项...
});

多项选择问题

如果您需要在询问问题时给用户提供一组预定义的选择,您可以使用 choice 方法。您可以通过将要返回的默认值的数组索引作为第三个参数传递给该方法来设置:

php
$name = $this->choice(
    '您的名字是什么?',
    ['Taylor', 'Dayle'],
    $defaultIndex
);

此外,choice 方法接受可选的第四个和第五个参数,用于确定选择有效响应的最大尝试次数以及是否允许多个选择:

php
$name = $this->choice(
    '您的名字是什么?',
    ['Taylor', 'Dayle'],
    $defaultIndex,
    $maxAttempts = null,
    $allowMultipleSelections = false
);

写入输出

要将输出发送到控制台,您可以使用 lineinfocommentquestionwarnerror 方法。每个方法将使用适当的 ANSI 颜色来实现其目的。例如,让我们向用户显示一些一般信息。通常,info 方法将在控制台中以绿色文本显示:

php
/**
 * 执行控制台命令。
 */
public function handle(): void
{
    // ...

    $this->info('命令成功执行!');
}

要显示错误消息,请使用 error 方法。错误消息文本通常以红色显示:

php
$this->error('出现问题!');

您可以使用 line 方法显示普通的、不带颜色的文本:

php
$this->line('在屏幕上显示此内容');

您可以使用 newLine 方法显示空行:

php
// 写入一行空行...
$this->newLine();

// 写入三行空行...
$this->newLine(3);

表格

table 方法使格式化多行/列数据变得简单。您只需提供列名和表格数据,Laravel 将自动计算表格的适当宽度和高度:

php
use App\Models\User;

$this->table(
    ['姓名', '电子邮件'],
    User::all(['name', 'email'])->toArray()
);

进度条

对于长时间运行的任务,显示进度条以告知用户任务完成的程度可能会很有帮助。使用 withProgressBar 方法,Laravel 将显示进度条,并在给定可迭代值的每次迭代中推进其进度:

php
use App\Models\User;

$users = $this->withProgressBar(User::all(), function (User $user) {
    $this->performTask($user);
});

有时,您可能需要更手动地控制进度条的推进。首先,定义过程将迭代的步骤总数。然后,在处理每个项目后推进进度条:

php
$users = App\Models\User::all();

$bar = $this->output->createProgressBar(count($users));

$bar->start();

foreach ($users as $user) {
    $this->performTask($user);

    $bar->advance();
}

$bar->finish();
lightbulb

有关更多高级选项,请查看 Symfony 进度条组件文档

注册命令

默认情况下,Laravel 会自动注册 app/Console/Commands 目录中的所有命令。然而,您可以通过在应用程序的 bootstrap/app.php 文件中使用 withCommands 方法指示 Laravel 扫描其他目录以查找 Artisan 命令:

php
->withCommands([
    __DIR__.'/../app/Domain/Orders/Commands',
])

如果需要,您还可以通过将命令的类名提供给 withCommands 方法手动注册命令:

php
use App\Domain\Orders\Commands\SendEmails;

->withCommands([
    SendEmails::class,
])

当 Artisan 启动时,您应用程序中的所有命令将由 服务容器 解析并注册到 Artisan。

以编程方式执行命令

有时,您可能希望在 CLI 之外执行 Artisan 命令。例如,您可能希望从路由或控制器执行 Artisan 命令。您可以使用 Artisan facade 上的 call 方法来实现此目的。call 方法接受命令的签名名称或类名作为第一个参数,以及命令参数的数组作为第二个参数。将返回退出代码:

php
use Illuminate\Support\Facades\Artisan;

Route::post('/user/{user}/mail', function (string $user) {
    $exitCode = Artisan::call('mail:send', [
        'user' => $user, '--queue' => 'default'
    ]);

    // ...
});

或者,您可以将整个 Artisan 命令作为字符串传递给 call 方法:

php
Artisan::call('mail:send 1 --queue=default');

传递数组值

如果您的命令定义了一个接受数组的选项,您可以将值数组传递给该选项:

php
use Illuminate\Support\Facades\Artisan;

Route::post('/mail', function () {
    $exitCode = Artisan::call('mail:send', [
        '--id' => [5, 13]
    ]);
});

传递布尔值

如果您需要指定不接受字符串值的选项的值,例如 migrate:refresh 命令上的 --force 标志,您应该将 truefalse 作为选项的值传递:

php
$exitCode = Artisan::call('migrate:refresh', [
    '--force' => true,
]);

排队 Artisan 命令

使用 Artisan facade 上的 queue 方法,您甚至可以将 Artisan 命令排队,以便它们由您的 队列工作者 在后台处理。在使用此方法之前,请确保您已配置队列并正在运行队列监听器:

php
use Illuminate\Support\Facades\Artisan;

Route::post('/user/{user}/mail', function (string $user) {
    Artisan::queue('mail:send', [
        'user' => $user, '--queue' => 'default'
    ]);

    // ...
});

使用 onConnectiononQueue 方法,您可以指定 Artisan 命令应调度到的连接或队列:

php
Artisan::queue('mail:send', [
    'user' => 1, '--queue' => 'default'
])->onConnection('redis')->onQueue('commands');

从其他命令调用命令

有时,您可能希望从现有的 Artisan 命令调用其他命令。您可以使用 call 方法来实现。此 call 方法接受命令名称和命令参数/选项的数组:

php
/**
 * 执行控制台命令。
 */
public function handle(): void
{
    $this->call('mail:send', [
        'user' => 1, '--queue' => 'default'
    ]);

    // ...
}

如果您希望调用另一个控制台命令并抑制其所有输出,您可以使用 callSilently 方法。callSilently 方法的签名与 call 方法相同:

php
$this->callSilently('mail:send', [
    'user' => 1, '--queue' => 'default'
]);

信号处理

正如您所知,操作系统允许向正在运行的进程发送信号。例如,SIGTERM 信号是操作系统请求程序终止的方式。如果您希望在 Artisan 控制台命令中监听信号并在发生时执行代码,您可以使用 trap 方法:

php
/**
 * 执行控制台命令。
 */
public function handle(): void
{
    $this->trap(SIGTERM, fn () => $this->shouldKeepRunning = false);

    while ($this->shouldKeepRunning) {
        // ...
    }
}

要同时监听多个信号,您可以向 trap 方法提供信号数组:

php
$this->trap([SIGTERM, SIGQUIT], function (int $signal) {
    $this->shouldKeepRunning = false;

    dump($signal); // SIGTERM / SIGQUIT
});

存根自定义

Artisan 控制台的 make 命令用于创建各种类,例如控制器、作业、迁移和测试。这些类是使用根据您的输入填充的“存根”文件生成的。然而,您可能希望对 Artisan 生成的文件进行小的更改。为此,您可以使用 stub:publish 命令将最常见的存根发布到您的应用程序,以便您可以自定义它们:

shell
php artisan stub:publish

发布的存根将位于应用程序根目录中的 stubs 目录中。您对这些存根所做的任何更改将在使用 Artisan 的 make 命令生成其对应类时反映出来。

事件

Artisan 在运行命令时会调度三个事件:Illuminate\Console\Events\ArtisanStartingIlluminate\Console\Events\CommandStartingIlluminate\Console\Events\CommandFinishedArtisanStarting 事件在 Artisan 开始运行时立即调度。接下来,CommandStarting 事件在命令运行之前立即调度。最后,CommandFinished 事件在命令执行完成后调度。