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。但是,如果你之前已从应用程序中移除了 Tinker,可以使用 Composer 安装它:
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 属性定义命令的签名和描述。Signature 属性还允许你定义命令的输入期望。当命令被执行时,将调用 handle 方法。你可以将命令逻辑放在此方法中。
让我们看一个示例命令。注意,我们可以通过命令的 handle 方法请求所需的任何依赖项。Laravel 服务容器 将自动注入此方法签名中类型提示的所有依赖项:
<?php
namespace App\Console\Commands;
use App\Models\User;
use App\Support\DripEmailer;
use Illuminate\Console\Attributes\Description;
use Illuminate\Console\Attributes\Signature;
use Illuminate\Console\Command;
#[Signature('mail:send {user}')]
#[Description('向用户发送营销电子邮件')]
class SendEmails extends Command
{
/**
* 执行控制台命令。
*/
public function handle(DripEmailer $drip): void
{
$drip->send(User::find($this->argument('user')));
}
}NOTE
为了更好的代码复用,最佳实践是让你的控制台命令保持轻量,并让它们委托给应用程序服务来完成其任务。在上面的示例中,注意我们注入了一个服务类来完成发送电子邮件的“繁重工作”。
退出代码
如果 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("正在发送邮件给:{$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()->plus(minutes: 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('是否要继续?')) {
// ...
}如有必要,你可以通过向 confirm 方法传递 true 作为第二个参数来指定确认提示应默认返回 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(
['姓名', '邮箱'],
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 外观上的 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 外观上的 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
});Stub 自定义
Artisan 控制台的 make 命令用于创建各种类,例如控制器、任务、迁移和测试。这些类是使用“stub”文件生成的,这些文件根据你的输入填充值。但是,你可能希望对 Artisan 生成的文件进行小的更改。为此,你可以使用 stub:publish 命令将最常见的 stub 发布到你的应用程序中,以便你可以自定义它们:
php artisan stub:publish已发布的 stub 将位于应用程序根目录的 stubs 目录中。当你使用 Artisan 的 make 命令生成相应的类时,你对这些 stub 所做的任何更改都将反映出来。
事件
Artisan 在运行命令时会分发三个事件:Illuminate\Console\Events\ArtisanStarting、Illuminate\Console\Events\CommandStarting 和 Illuminate\Console\Events\CommandFinished。当 Artisan 开始运行时,会立即分发 ArtisanStarting 事件。接下来,在命令运行之前,会立即分发 CommandStarting 事件。最后,一旦命令完成执行,就会分发 CommandFinished 事件。