Artisan 控制台
介绍
Artisan 是 Laravel 附带的命令行界面。Artisan 位于应用程序根目录下的 artisan 脚本中,提供了许多有用的命令,可以在构建应用程序时为您提供帮助。要查看所有可用的 Artisan 命令列表,可以使用 list 命令:
php artisan list每个命令还包括一个“帮助”屏幕,显示并描述命令的可用参数和选项。要查看帮助屏幕,请在命令名称前加上 help:
php artisan help migrateLaravel Sail
如果您使用 Laravel Sail 作为本地开发环境,请记得使用 sail 命令行来调用 Artisan 命令。Sail 将在应用程序的 Docker 容器中执行您的 Artisan 命令:
./vendor/bin/sail artisan listTinker (REPL)
Laravel Tinker 是一个功能强大的 Laravel 框架 REPL,由 PsySH 包提供支持。
安装
所有 Laravel 应用程序默认包含 Tinker。但是,如果您之前从应用程序中删除了它,可以使用 Composer 安装 Tinker:
composer require laravel/tinkerNOTE
想要在与 Laravel 应用程序交互时实现热重载、多行代码编辑和自动补全?请查看 Tinkerwell!
使用
Tinker 允许您在命令行上与整个 Laravel 应用程序交互,包括您的 Eloquent 模型、作业、事件等。要进入 Tinker 环境,请运行 tinker Artisan 命令:
php artisan tinker您可以使用 vendor:publish 命令发布 Tinker 的配置文件:
php artisan vendor:publish --provider="Laravel\Tinker\TinkerServiceProvider"WARNING
dispatch 辅助函数和 Dispatchable 类上的 dispatch 方法依赖垃圾回收机制将任务放入队列。因此,在使用 Tinker 时,应使用 Bus::dispatch 或 Queue::push 来分发任务。
命令允许列表
Tinker 使用“允许”列表来确定哪些 Artisan 命令可以在其 shell 中运行。默认情况下,您可以运行 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 目录中;不过,只要你告知 Laravel 扫描其他目录以查找 Artisan 命令,你也可以自由选择存储位置。
生成命令
要创建新命令,可以使用 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
{
/**
* 控制台命令的名称和签名。
*
* @var string
*/
protected $signature = 'mail:send {user}';
/**
* 控制台命令描述。
*
* @var string
*/
protected $description = '向用户发送营销电子邮件';
/**
* 执行控制台命令。
*/
public function handle(DripEmailer $drip): void
{
$drip->send(User::find($this->argument('user')));
}
}NOTE
为了更好地重用代码,最好保持控制台命令轻量化,并让它们委托给应用程序服务来完成任务。在上面的示例中,请注意我们注入了一个服务类来完成发送电子邮件的“繁重工作”。
退出代码
如果handle方法没有返回任何内容且命令执行成功,该命令将以0退出码结束,表示操作成功。不过,handle方法也可以选择返回一个整数,以手动指定命令的退出码:
$this->error('出了点问题。');
return 1;如果您希望从命令中的任何方法“失败”命令,可以使用 fail 方法。fail 方法将立即终止命令的执行并返回退出代码 1:
$this->fail('出了点问题。');闭包命令
基于闭包的命令为定义控制台命令提供了一种替代方式。就像路由闭包是控制器的替代方案一样,可以将命令闭包视为命令类的另一种选择。
尽管 routes/console.php 文件并不定义 HTTP 路由,但它定义了应用程序中基于控制台的入口点(路由)。在此文件中,您可以使用 Artisan::command 方法定义所有基于闭包的控制台命令。command 方法接受两个参数:命令签名 和一个接收命令参数与选项的闭包:
Artisan::command('mail:send {user}', function (string $user) {
$this->info("正在发送电子邮件给:{$user}!");
});闭包绑定到底层命令实例,因此您可以完全访问通常可以在完整命令类上访问的所有辅助方法。
类型提示依赖项
除了接收命令的参数和选项外,命令闭包还可以类型提示您希望从服务容器中解析的其他依赖项:
use App\Models\User;
use App\Support\DripEmailer;
use Illuminate\Support\Facades\Artisan;
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('向用户发送营销电子邮件');可隔离命令
WARNING
要使用此功能,您的应用程序必须使用 memcached、redis、dynamodb、database、file 或 array 缓存驱动程序作为应用程序的默认缓存驱动程序。此外,所有服务器必须与同一个中央缓存服务器通信。
有时您可能希望确保一次只能运行一个命令实例。为此,您可以在命令类上实现 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 方法来自定义此键,从而将命令的参数或选项集成到键中:
/**
* 获取命令的可隔离 ID。
*/
public function isolatableId(): string
{
return $this->argument('user');
}锁定过期时间
默认情况下,隔离锁会在命令执行完毕后过期。或者,如果命令被中断而无法完成,锁将在一小时后过期。不过,您可以通过在命令中定义 isolationLockExpiresAt 方法来调整锁的过期时间:
use DateTimeInterface;
use DateInterval;
/**
* 确定命令的隔离锁何时过期。
*/
public function isolationLockExpiresAt(): DateTimeInterface|DateInterval
{
return now()->addMinutes(5);
}定义输入期望
在编写控制台命令时,通常需要通过参数或选项从用户那里收集输入。Laravel 使您可以非常方便地使用命令上的 signature 属性定义您期望用户提供的输入。signature 属性允许您以一种表达式、类似路由的语法定义命令的名称、参数和选项。
参数
所有用户提供的参数和选项都用大括号括起来。在以下示例中,命令定义了一个必需参数:user:
/**
* 控制台命令的名称和签名。
*
* @var string
*/
protected $signature = 'mail:send {user}';您还可以将参数设为可选或为参数定义默认值:
// 可选参数...
'mail:send {user?}'
// 带默认值的可选参数...
'mail:send {user=foo}'选项
选项与参数一样,是另一种形式的用户输入。选项在命令行中提供时以两个连字符(--)为前缀。选项有两种类型:接收值的选项和不接收值的选项。不接收值的选项用作布尔“开关”。让我们看一个这种类型选项的示例:
/**
* 控制台命令的名称和签名。
*
* @var string
*/
protected $signature = 'mail:send {user} {--queue}';在此示例中,可以在调用 Artisan 命令时指定 --queue 开关。如果传递了 --queue 开关,选项的值将为 true。否则,值将为 false:
php artisan mail:send 1 --queue带值的选项
接下来,让我们看一个期望值的选项。如果用户必须为选项指定一个值,则应在选项名称后加上 = 符号:
/**
* 控制台命令的名称和签名。
*
* @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输入描述
您可以通过使用冒号将参数名称与描述分开来为输入参数和选项分配描述。如果您需要更多空间来定义命令,请随意将定义分布在多行上:
/**
* 控制台命令的名称和签名。
*
* @var string
*/
protected $signature = 'mail:send
{user : 用户的 ID}
{--queue : 是否应将作业排队}';提示缺失输入
如果命令包含必需参数,当未提供时,用户将收到错误消息。或者,您可以通过实现 PromptsForMissingInput 接口配置命令以在缺少必需参数时自动提示用户:
<?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 方法,返回一个以参数名称为键的问题数组:
/**
* 使用返回的问题提示缺失的输入参数。
*
* @return array<string, string>
*/
protected function promptForMissingArgumentsUsing(): array
{
return [
'user' => '哪个用户 ID 应该接收邮件?',
];
}您还可以通过使用包含问题和占位符的元组来提供占位符文本:
return [
'user' => ['哪个用户 ID 应该接收邮件?', '例如 123'],
];如果您希望完全控制提示,可以提供一个应提示用户并返回其答案的闭包:
use App\Models\User;
use function Laravel\Prompts\search;
// ...
return [
'user' => fn () => search(
label: '搜索用户:',
placeholder: '例如 Taylor Otwell',
options: fn ($value) => strlen($value) > 0
? User::whereLike('name', "%{$value}%")->pluck('name', 'id')->all()
: []
),
];NOTE
有关可用提示及其用法的更多信息,请参阅综合的 Laravel Prompts 文档。
如果您希望提示用户选择或输入选项,可以在命令的 handle 方法中包含提示。但是,如果您只希望在用户也被自动提示缺失参数时提示用户,则可以实现 afterPromptingForMissingArguments 方法:
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
检索输入
在命令执行期间,您可能需要访问命令接受的参数和选项的值。为此,您可以使用 argument 和 option 方法。如果参数或选项不存在,将返回 null:
/**
* 执行控制台命令。
*/
public function handle(): void
{
$userId = $this->argument('user');
}如果需要将所有参数作为 array 检索,请调用 arguments 方法:
$arguments = $this->arguments();选项可以像参数一样轻松检索,使用 option 方法。要将所有选项作为数组检索,请调用 options 方法:
// 检索特定选项...
$queueName = $this->option('queue');
// 将所有选项作为数组检索...
$options = $this->options();提示输入
NOTE
Laravel Prompts 是一个 PHP 包,用于向命令行应用程序添加美观且用户友好的表单,具有包括占位符文本和验证在内的浏览器样功能。
除了显示输出外,您还可以在命令执行期间要求用户提供输入。ask 方法将使用给定问题提示用户,接受其输入,然后将用户的输入返回给命令:
/**
* 执行控制台命令。
*/
public function handle(): void
{
$name = $this->ask('你叫什么名字?');
// ...
}ask 方法还接受一个可选的第二个参数,该参数指定如果未提供用户输入时应返回的默认值:
$name = $this->ask('你叫什么名字?', 'Taylor');secret 方法类似于 ask,但用户的输入在控制台中输入时对他们不可见。此方法在询问密码等敏感信息时很有用:
$password = $this->secret('密码是什么?');请求确认
如果您需要询问用户一个简单的“是或否”确认,可以使用 confirm 方法。默认情况下,此方法将返回 false。但是,如果用户在提示中输入 y 或 yes,该方法将返回 true。
if ($this->confirm('您希望继续吗?')) {
// ...
}如果需要,可以通过将 true 作为第二个参数传递给 confirm 方法来指定确认提示应默认返回 true:
if ($this->confirm('您希望继续吗?', true)) {
// ...
}自动补全
anticipate 方法可用于为可能的选择提供自动补全。用户仍然可以提供任何答案,而不管自动补全提示如何:
$name = $this->anticipate('你叫什么名字?', ['Taylor', 'Dayle']);或者,您可以将闭包作为第二个参数传递给 anticipate 方法。每次用户输入字符时都会调用闭包。闭包应接受一个包含用户输入的字符串参数,并返回一个用于自动补全的选项数组:
use App\Models\Address;
$name = $this->anticipate('你的地址是什么?', function (string $input) {
return Address::whereLike('name', "{$input}%")
->limit(5)
->pluck('name')
->all();
});多项选择问题
如果您需要在询问问题时为用户提供一组预定义的选择,可以使用 choice 方法。您可以通过将索引作为方法的第三个参数传递来设置默认值的数组索引,以便在未选择选项时返回:
$name = $this->choice(
'你叫什么名字?',
['Taylor', 'Dayle'],
$defaultIndex
);此外,choice 方法接受可选的第四个和第五个参数,用于确定选择有效响应的最大尝试次数以及是否允许多重选择:
$name = $this->choice(
'你叫什么名字?',
['Taylor', 'Dayle'],
$defaultIndex,
$maxAttempts = null,
$allowMultipleSelections = false
);写入输出
要向控制台发送输出,你可以使用 line、newLine、info、comment、question、warn、alert 和 error 方法。这些方法中的每一个都将为其目的使用适当的 ANSI 颜色。例如,让我们向用户显示一些一般信息。通常,info 方法将在控制台中显示为绿色文本:
/**
* 执行控制台命令。
*/
public function handle(): void
{
// ...
$this->info('命令成功!');
}要显示错误消息,请使用 error 方法。错误消息文本通常以红色显示:
$this->error('出了点问题!');您可以使用 line 方法显示普通的、无颜色的文本:
$this->line('在屏幕上显示此内容');您可以使用 newLine 方法显示空行:
// 写入单个空行...
$this->newLine();
// 写入三个空行...
$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();NOTE
有关更高级选项,请查看 Symfony Progress Bar 组件文档。
注册命令
默认情况下,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;
use Illuminate\Support\Facades\Route;
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;
use Illuminate\Support\Facades\Route;
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 facade 上的 queue 方法,您甚至可以将 Artisan 命令排队,以便它们由队列工作者在后台处理。在使用此方法之前,请确保已配置队列并正在运行队列监听器:
use Illuminate\Support\Facades\Artisan;
use Illuminate\Support\Facades\Route;
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 方法接受命令名称和命令参数/选项数组:
/**
* 执行控制台命令。
*/
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 方法:
/**
* 执行控制台命令。
*/
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 事件在命令执行完成后调度。