Laravel 5.1 中创建自定义 Artisan 控制台命令实例教程

1、入门

Laravel通过Artisan提供了强大的控制台命令来处理非浏览器业务逻辑。要查看Laravel中所有的Artisan命令,可以通过在项目根目录运行:

php artisan list

对应输出如下(部分截图):

Laravel Artisan命令列表

其中一些命名我们已经比较熟悉了,比如创建迁移make:migration以及执行迁移migrate,又比如创建模型make:model,创建控制器make:controller等。

如果要查看具体某个命令的使用方法,比如我们要查看创建Artisan命令make:console的具体用法,可以使用如下命令:

php artisan help make:console

对应输出如下:

查看make:console命令用法

2、创建命令

Artisan除了提供丰富的控制台命令之外,还允许我们通过make:console命令创建自己的控制台命令。上面我们已经使用help指令查看了make:console的用法,下面我们就沿着这条路走下去,一探究竟:创建命令并运行起来得到我们想要的各种结果。

首先我们创建一个最简单的命令,打印Hello LaravelAcademy,使用Artisan命令如下:

php artisan make:console HelloLaravelAcademy --command=laravel:academy

其中HelloLaravelAcademy是命令名,laravel:academy是控制台执行的命令,类似make:console

执行完成后,会在app/Console/Commands目录下生成一个HelloLaravelAcademy.php文件:

<?php

namespace App\Console\Commands;

use Illuminate\Console\Command;

class HelloLaravelAcademy extends Command
{
    /**
     * The name and signature of the console command.
     *
     * @var string
     */
    protected $signature = 'laravel:academy';

    /**
     * The console command description.
     *
     * @var string
     */
    protected $description = 'Command description.';

    /**
     * Create a new command instance.
     *
     * @return void
     */
    public function __construct()
    {
        parent::__construct();
    }

    /**
     * Execute the console command.
     *
     * @return mixed
     */
    public function handle()
    {
        //
    }
}

其中$signature即为在控制台执行的命令名,$description为命令描述,handle方法为执行命令时调用的方法。

接下来我们简单编写handle方法如下:

public function handle()
{
    echo "Hello LaravelAcademy\n";
}

好了,一个最简单的命令已经编写好了,接下来要怎么执行并在控制台打印出“Hello LaravelAcademy”呢?

3、运行命令

在运行命令前需要将其注册到App\Console\Kernel$commands属性中:

protected $commands = [
     ...  //其他命令类
     \App\Console\Commands\HelloLaravelAcademy::class
];

接下来我们就可以在控制台运行如下Artisan命令:

php artisan laravel:academy

终端就会打印出:

Hello LaravelAcademy

是不是很简单?

4、更多样的输入输出

当然,上面是最简单的情形,没有输入,写死的输出。实际环境中有更复杂的需求,有更多样的输入输出,下面我们来一一讨论。

定义输入

上面已经提到,我们可以通过修改$signature属性定义输入参数及选项,比如这里我们将上述Hello后面的字符串调整为通过输入参数来控制,可修改$signature如下:

protected $signature = 'laravel:academy {name}';

这样定义意味着name是必选参数,当然还支持更多自定义参数输入:

{name?} //可选参数
{name=LaravelAcademy} //默认name值为LaravelAcademy

为增强程序健壮性,我们将name修改为有默认值:

protected $signature = 'laravel:academy {name=LaravelAcademy}';

有时候我们还会在执行命令时传入一些选项,比如是否显示标点符号(虽然听上去很鸡肋,这里权当测试之用), 那么我们可以修改$signature属性如下:

protected $signature = 'laravel:academy {name=LaravelAcademy} {--mark}';

如果调用命令时传递--mark则代表其值为true,否则为false,如果选项值在输入时通过用户设置,可定义$signature如下:

protected $signature = 'laravel:academy {name=LaravelAcademy} {--mark=}';

这样用户就可以在传入选项时通过=来为选项赋值,当然和参数一样,我们也可以为选项指定默认值:

protected $signature = 'laravel:academy {name=LaravelAcademy} {--mark=!}';

获取输入

定义好输入参数和选项后,又该如何获取其对应值呢?Laravel为我们提供了相应的方法。

获取参数值可以通过Illuminate\Console\Commandargument方法:

$name = $this->argument('name');

如果无参调用argument方法,则返回的是所有参数值数组。

获取选项值可以通过Illuminate\Console\Commandoption方法:

$mark = $this->option('mark');

同理,无参调用option方法会返回所有选项值数组。

这样我们可以修改HelloLaravelAcademyhandle方法如下:

public function handle()
{
    $name = $this->argument('name');
    $mark = $this->option('mark');

    $string = 'Hello '.$name;
    if($mark)
        $string .= $mark;

    echo $string."\n";
}

这样我们在控制台输入如下Artisan命令:

php artisan laravel:academy

对应输出为:

Hello LaravelAcademy!

再运行如下Artisan命令:

php artisan laravel:academy Laravel --mark=?

对应输出为:

Hello Laravel?

输入提示

我们甚至还可以完全让用户通过在控制台输入name来获取输入参数,首先修改handle方法如下:

public function handle()
{
    $name = $this->ask('What do you want to say Hello?');
    echo "Hello ".$name."\n";
}

然后在终端输入php artisan laravel:academy,交互页面如下:

Artisan输入提示-ask

如果是输入密码一类的敏感信息可以用secret替代ask方法。

有时候我们会根据用户的意愿选择继续还是中止:

public function handle()
{
    if($this->confirm('Do you want to continue?[y|n]')){
        $this->info("Continue");
    }else{
        $this->error("Interrupt");
    }
}

对应输出为:

Artisan输入提示-confirm

除了让用户手动输入外,还可以使用anticipate方法实现自动完成功能:

public function handle()
{
    $name = $this->anticipate('What is your name?', ['Laravel', 'Academy']);
    $this->info($name);
}

当然还可以使用choice方法为用户提供选择避免手动输入,用户只需选择对应索引即可:

public function handle()
{
    $name = $this->choice('What is your name?', ['Laravel', 'Academy']);
    $this->info($name);
}

对应交互页面如下:

Artisan输入提示-choice

编写输出

关于输出字符串,上面我们简单使用了echo语句,其实Laravel提供了更为强大和多样化的方法:

public function handle()
{
    $this->info("Successful!");
    $this->error("Something Error!");
    $this->question("What do you want to do?");
    $this->comment("Just Comment it!");
}

执行php artisan laravel:academy对应输出如下:

Artisan输出语句大全

表格

Artisan甚至可以输出表格:

public function handle()
{
    $headers = ['Name', 'Email'];
    $users = \App\User::all(['name', 'email'])->toArray();
    $this->table($headers, $users);
}

执行php artisan laravel:academy对应输出为:

Artisan输出表格

进度条

当然对于复杂耗时的命令,进度条是必不可少的,

public function handle()
{
    $this->output->progressStart(10);

    for ($i = 0; $i < 10; $i++) {
        sleep(1);
        $this->output->progressAdvance();
    }

    $this->output->progressFinish();
}

执行php artisan laravel:academy对应输出为:

Artisan输出进度条

5、从CLI之外调用Artisan

除了在控制台执行Artisan命令之外,还可以通过代码在别处调用Artisan命令,比如其它Artisan命令、控制器、路由或其他。

路由

在路由闭包中我们可以通过Artisan门面的call方法来调用本节创建的命令:

//在路由中调用Artisan命令
Route::get('testArtisan',function(){
    $exitCode = Artisan::call('laravel:academy', [
        'name' => 'Laravel学院', '--mark' => '!'
    ]);
});

其它Artisan命令

在一个Artisan命令中也可以调用另一个Artisan命令,还是通过call方法:

public function handle()
{
    $this->call('inspire');
}

如果想要调用一个Artisan命令并阻止其所有输出,可以使用callSilent方法:

public function handle()
{
    $this->callSilent('inspire');
}

号外:除此之外,关于Artisan命令你还应该知道的是我们可以在创建的命令类的控制器或方法中注入任何依赖。这就意味着我们可以在命令类中使用注册到服务容器的所有类。

学院君

学院君 has written 548 articles

资深PHP工程师,Laravel学院院长