Artisan 控制台

• 简介
  • Tinker (REPL)
• 编写命令
  • 生成命令
  • 命令结构
  • 闭包命令
  • 可隔离的命令
• 定义输入期望
  • 参数
  • 选项
  • 输入数组
  • 输入描述
  • 提示输入
• 命令 I/O
  • 检索输入
  • 提示输入
  • 写入输出
• 注册命令
• 以编程方式执行命令
  • 从其他命令调用命令
• 信号处理
• 存根自定义
• 事件

简介

Artisan 是 Laravel 附带的命令行界面。Artisan 作为 artisan 脚本存在于您的应用程序的根目录中，并提供许多有用的命令，可以在您构建应用程序时为您提供帮助。要查看所有可用的 Artisan 命令的列表，您可以使用 list 命令。

php artisan list

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

php artisan help migrate

Laravel Sail

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

./vendor/bin/sail artisan list

Tinker (REPL)

Laravel Tinker 是 Laravel 框架的强大 REPL，由 PsySH 包提供支持。

安装

默认情况下，所有 Laravel 应用程序都包含 Tinker。但是，如果您之前已将其从应用程序中删除，则可以使用 Composer 安装 Tinker。

composer require laravel/tinker

用法

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

php artisan tinker

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

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

命令允许列表

Tinker 使用“允许”列表来确定允许在其 shell 中运行哪些 Artisan 命令。默认情况下，您可以运行 clear-compiled、down、env、inspire、migrate、migrate:install、up 和 optimize 命令。如果您想允许更多命令，您可以将它们添加到 tinker.php 配置文件中的 commands 数组中。

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

不应被别名的类

通常，Tinker 会在您在 Tinker 中与类交互时自动为其创建别名。但是，您可能希望永远不要为某些类创建别名。您可以通过在 tinker.php 配置文件的 dont_alias 数组中列出这些类来实现此目的。

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

编写命令

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

生成命令

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

php artisan make:command SendEmails

命令结构

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

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

<?php
 
namespace App\Console\Commands;
 
use App\Models\User;
use App\Support\DripEmailer;
use Illuminate\Console\Command;
 
class SendEmails extends Command
{
    /**
     * The name and signature of the console command.
     *
     * @var string
     */
    protected $signature = 'mail:send {user}';
 
    /**
     * The console command description.
     *
     * @var string
     */
    protected $description = 'Send a marketing email to a user';
 
    /**
     * Execute the console command.
     */
    public function handle(DripEmailer $drip): void
    {
        $drip->send(User::find($this->argument('user')));
    }
}

退出代码

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

$this->error('Something went wrong.');
 
return 1;

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

$this->fail('Something went wrong.');

闭包命令

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

即使 routes/console.php 文件没有定义 HTTP 路由，它也会定义进入应用程序的基于控制台的入口点（路由）。在此文件中，您可以使用 Artisan::command 方法定义所有基于闭包的控制台命令。command 方法接受两个参数：命令签名 和一个接收命令的参数和选项的闭包。

Artisan::command('mail:send {user}', function (string $user) {
    $this->info("Sending email to: {$user}!");
});

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

类型提示依赖项

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

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 list 或 php artisan help 命令时，将显示此描述。

Artisan::command('mail:send {user}', function (string $user) {
    // ...
})->purpose('Send a marketing email to a user');

可隔离的命令

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

<?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 通过尝试使用应用程序的默认缓存驱动程序获取原子锁来实现此目的。如果命令的其他实例正在运行，则该命令将不会执行；但是，该命令仍将以成功退出状态代码退出。

php artisan mail:send 1 --isolated

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

php artisan mail:send 1 --isolated=12

锁定 ID

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

/**
 * Get the isolatable ID for the command.
 */
public function isolatableId(): string
{
    return $this->argument('user');
}

锁定过期时间

默认情况下，隔离锁会在命令完成后过期。或者，如果命令被中断且无法完成，锁将在一个小时后过期。但是，您可以通过在命令上定义 isolationLockExpiresAt 方法来调整锁定过期时间。

use DateTimeInterface;
use DateInterval;
 
/**
 * Determine when an isolation lock expires for the command.
 */
public function isolationLockExpiresAt(): DateTimeInterface|DateInterval
{
    return now()->addMinutes(5);
}

定义输入期望

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

参数

所有用户提供的参数和选项都包含在花括号中。在以下示例中，该命令定义了一个必需的参数：user。

/**
 * The name and signature of the console command.
 *
 * @var string
 */
protected $signature = 'mail:send {user}';

您还可以使参数可选或为参数定义默认值。

// Optional argument...
'mail:send {user?}'
 
// Optional argument with default value...
'mail:send {user=foo}'

选项

选项，与参数一样，是用户输入的另一种形式。选项在命令行中提供时以两个连字符（--）为前缀。选项有两种类型：接收值的选项和不接收值的选项。不接收值的选项充当布尔值“开关”。让我们看一个这种类型选项的示例。

/**
 * The name and signature of the console command.
 *
 * @var string
 */
protected $signature = 'mail:send {user} {--queue}';

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

php artisan mail:send 1 --queue

带值的选项

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

/**
 * The name and signature of the console command.
 *
 * @var string
 */
protected $signature = 'mail:send {user} {--queue=}';

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

php artisan mail:send 1 --queue=default

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

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

选项快捷方式

要在定义选项时分配快捷方式，您可以在选项名称之前指定它，并使用 | 字符作为分隔符，将快捷方式与完整选项名称分开。

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

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

php artisan mail:send 1 -Qdefault

输入数组

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

'mail:send {user*}'

调用此方法时，可以将 user 参数按顺序传递给命令行。例如，以下命令将 user 的值设置为一个数组，其中 1 和 2 作为其值。

php artisan mail:send 1 2

此 * 字符可以与可选参数定义结合使用，以允许零个或多个参数实例。

'mail:send {user?*}'

选项数组

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

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

可以通过传递多个 --id 参数来调用此类命令。

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

输入描述

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

/**
 * The name and signature of the console command.
 *
 * @var string
 */
protected $signature = 'mail:send
                        {user : The ID of the user}
                        {--queue : Whether the job should be queued}';

提示输入

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

<?php
 
namespace App\Console\Commands;
 
use Illuminate\Console\Command;
use Illuminate\Contracts\Console\PromptsForMissingInput;
 
class SendEmails extends Command implements PromptsForMissingInput
{
    /**
     * The name and signature of the console command.
     *
     * @var string
     */
    protected $signature = 'mail:send {user}';
 
    // ...
}

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

/**
 * Prompt for missing input arguments using the returned questions.
 *
 * @return array<string, string>
 */
protected function promptForMissingArgumentsUsing(): array
{
    return [
        'user' => 'Which user ID should receive the mail?',
    ];
}

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

return [
    'user' => ['Which user ID should receive the mail?', 'E.g. 123'],
];

如果您想完全控制提示，则可以提供一个闭包，该闭包应提示用户并返回他们的答案。

use App\Models\User;
use function Laravel\Prompts\search;
 
// ...
 
return [
    'user' => fn () => search(
        label: 'Search for a user:',
        placeholder: 'E.g. Taylor Otwell',
        options: fn ($value) => strlen($value) > 0
            ? User::where('name', 'like', "%{$value}%")->pluck('name', 'id')->all()
            : []
    ),
];

如果您希望提示用户选择或输入选项，则可以在命令的 handle 方法中包含提示。但是，如果您只想在也自动提示用户缺少参数时才提示用户，则可以实现 afterPromptingForMissingArguments 方法。

use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;
use function Laravel\Prompts\confirm;
 
// ...
 
/**
 * Perform actions after the user was prompted for missing arguments.
 */
protected function afterPromptingForMissingArguments(InputInterface $input, OutputInterface $output): void
{
    $input->setOption('queue', confirm(
        label: 'Would you like to queue the mail?',
        default: $this->option('queue')
    ));
}

命令 I/O

检索输入

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

/**
 * Execute the console command.
 */
public function handle(): void
{
    $userId = $this->argument('user');
}

如果您需要以 array 形式检索所有参数，请调用 arguments 方法。

$arguments = $this->arguments();

可以使用 option 方法轻松检索选项，就像检索参数一样。要以数组形式检索所有选项，请调用 options 方法。

// Retrieve a specific option...
$queueName = $this->option('queue');
 
// Retrieve all options as an array...
$options = $this->options();

提示输入

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

/**
 * Execute the console command.
 */
public function handle(): void
{
    $name = $this->ask('What is your name?');
 
    // ...
}

ask 方法还接受一个可选的第二个参数，该参数指定在未提供任何用户输入时应返回的默认值。

$name = $this->ask('What is your name?', 'Taylor');

secret 方法类似于 ask，但是用户的输入在他们于控制台中键入时将不可见。当要求输入密码等敏感信息时，此方法很有用。

$password = $this->secret('What is the password?');

请求确认

如果您需要询问用户一个简单的“是或否”确认，则可以使用 confirm 方法。默认情况下，此方法将返回 false。但是，如果用户输入 y 或 yes 以响应提示，则该方法将返回 true。

if ($this->confirm('Do you wish to continue?')) {
    // ...
}

如有必要，您可以通过将 true 作为 confirm 方法的第二个参数来指定确认提示应默认返回 true。

if ($this->confirm('Do you wish to continue?', true)) {
    // ...
}

自动完成

anticipate 方法可用于为可能的选择提供自动完成。用户仍然可以提供任何答案，而无需考虑自动完成提示。

$name = $this->anticipate('What is your name?', ['Taylor', 'Dayle']);

或者，您可以将闭包作为 anticipate 方法的第二个参数传递。每次用户键入输入字符时都会调用闭包。闭包应接受一个包含用户目前输入的字符串参数，并返回一个自动完成选项数组。

$name = $this->anticipate('What is your address?', function (string $input) {
    // Return auto-completion options...
});

多项选择题

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

$name = $this->choice(
    'What is your name?',
    ['Taylor', 'Dayle'],
    $defaultIndex
);

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

$name = $this->choice(
    'What is your name?',
    ['Taylor', 'Dayle'],
    $defaultIndex,
    $maxAttempts = null,
    $allowMultipleSelections = false
);

写入输出

要将输出发送到控制台，您可以使用 line、info、comment、question、warn 和 error 方法。这些方法中的每一个都将为其目的使用适当的 ANSI 颜色。例如，让我们向用户显示一些常规信息。通常，info 方法将在控制台中显示为绿色文本。

/**
 * Execute the console command.
 */
public function handle(): void
{
    // ...
 
    $this->info('The command was successful!');
}

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

$this->error('Something went wrong!');

您可以使用 line 方法显示纯文本，不带颜色。

$this->line('Display this on the screen');

您可以使用 newLine 方法显示一个空白行。

// Write a single blank line...
$this->newLine();
 
// Write three blank lines...
$this->newLine(3);

表格

table 方法可以轻松地正确格式化数据的多行/列。您只需提供列名和表格的数据，Laravel 将自动为您计算表格的适当宽度和高度。

use App\Models\User;
 
$this->table(
    ['Name', 'Email'],
    User::all(['name', 'email'])->toArray()
);

进度条

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

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

有时，您可能需要对进度条的推进方式进行更手动的控制。首先，定义进程将迭代的总步骤数。然后，在处理完每个项目后推进进度条。

$users = App\Models\User::all();
 
$bar = $this->output->createProgressBar(count($users));
 
$bar->start();
 
foreach ($users as $user) {
    $this->performTask($user);
 
    $bar->advance();
}
 
$bar->finish();

注册命令

默认情况下，Laravel 会自动注册 app/Console/Commands 目录中的所有命令。但是，您可以使用应用程序 bootstrap/app.php 文件中的 withCommands 方法，指示 Laravel 扫描其他目录中的 Artisan 命令。

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

如有必要，您还可以通过将命令的类名提供给 withCommands 方法来手动注册命令。

use App\Domain\Orders\Commands\SendEmails;
 
->withCommands([
    SendEmails::class,
])

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

以编程方式执行命令

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

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

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

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

传递数组值

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

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

传递布尔值

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

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

排队 Artisan 命令

通过在 Artisan 外观上使用 queue 方法，你甚至可以将 Artisan 命令放入队列中，以便由你的队列工作者在后台处理。在使用此方法之前，请确保你已配置好队列并正在运行队列监听器。

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

使用 onConnection 和 onQueue 方法，你可以指定 Artisan 命令应该被分发到的连接或队列。

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

从其他命令调用命令

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

/**
 * Execute the console command.
 */
public function handle(): void
{
    $this->call('mail:send', [
        'user' => 1, '--queue' => 'default'
    ]);
 
    // ...
}

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

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

信号处理

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

/**
 * Execute the console command.
 */
public function handle(): void
{
    $this->trap(SIGTERM, fn () => $this->shouldKeepRunning = false);
 
    while ($this->shouldKeepRunning) {
        // ...
    }
}

要一次监听多个信号，你可以向 trap 方法提供一个信号数组。

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

存根自定义

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

php artisan stub:publish

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

事件

Artisan 在运行命令时会分发三个事件：Illuminate\Console\Events\ArtisanStarting、Illuminate\Console\Events\CommandStarting 和 Illuminate\Console\Events\CommandFinished。ArtisanStarting 事件在 Artisan 开始运行时立即分发。接下来，CommandStarting 事件在命令运行之前立即分发。最后，CommandFinished 事件在命令完成执行后分发。