Laravel 5.1 프레임워크에서 커스텀 Artisan 콘솔 명령을 생성하는 방법

laravel 초보자의 경우 laravel에서 사용자 정의 Artisan 콘솔 명령을 생성하는 방법에 대해 잘 알지 못할 수도 있습니다. 다음 기사에서는 laravel 프레임워크에서 사용자 정의 Artisan 콘솔 명령을 생성하는 예를 공유합니다.

1. 시작하기

Laravel은 브라우저가 아닌 비즈니스 로직을 처리하기 위해 Artisan을 통해 강력한 콘솔 명령을 제공합니다. Laravel에서 모든 Artisan 명령을 보려면 프로젝트 루트 디렉터리에서 실행할 수 있습니다:

php artisan list

해당 출력은 다음과 같습니다(일부 스크린샷):

우리는 마이그레이션 make:migration 생성 및 마이그레이션 마이그레이션 실행, 모델 make:model 생성, 컨트롤러 make:controller 생성 등과 같은 일부 이름에 이미 익숙합니다.

특정 명령어의 구체적인 사용법을 확인하고 싶다면, 예를 들어 Artisan 명령어 make:console의 구체적인 사용법을 확인하고 싶다면 다음 명령어를 사용할 수 있습니다: #🎜🎜 #

php artisan help make:console

해당 출력은 다음과 같습니다.

2 명령 생성 # 🎜🎜#Artisan은 풍부한 콘솔 명령을 제공하는 것 외에도 make:console 명령을 통해 자체 콘솔 명령을 생성할 수도 있습니다. 위에서 우리는 make:console의 사용법을 확인하기 위해 help 명령을 사용했습니다. 이 경로로 가서 알아봅시다: 명령을 생성하고 실행하여 원하는 다양한 결과를 얻습니다.

먼저 다음과 같이 Artisan 명령을 사용하여 Hello LaravelAcademy를 ​​인쇄하는 가장 간단한 명령을 만듭니다:

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

여기서 HelloLaravelAcademy는 명령 이름이고 laravel:academy는 다음에 의해 실행되는 명령입니다. make:console과 유사한 콘솔입니다.

실행이 완료된 후 HelloLaravelAcademy.php 파일이 app/Console/Commands 디렉터리에 생성됩니다:

<?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 = &#39;laravel:academy&#39;;
    /**
     * The console command description.
     *
     * @var string
     */
    protected $description = &#39;Command description.&#39;;
    /**
     * Create a new command instance.
     *
     * @return void
     */
    public function __construct()
    {
        parent::__construct();
    }
    /**
     * Execute the console command.
     *
     * @return mixed
     */
    public function handle()
    {
        //
    }
}

여기서 $signature는 실행된 명령의 이름입니다. 콘솔에서 $description은 명령 설명이고, 핸들 메서드는 명령을 실행할 때 호출되는 메서드입니다.

다음으로 핸들 메소드를 다음과 같이 작성합니다:

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

좋아요, 가장 간단한 명령이 작성되었습니다. 이를 실행하고 콘솔에 출력하는 방법은 " 안녕하세요 라라벨 아카데미"?

3. 명령 실행

명령을 실행하기 전에 AppConsoleKernel의 $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

프로그램의 견고성을 높이기 위해 이름을 기본값으로 수정했습니다.

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

때때로 다음과 같은 경우 몇 가지 옵션도 전달합니다. 구두점을 표시할지 여부와 같은 명령을 실행하면(쓸모없지만 테스트용일 뿐임) 다음과 같이 $signature 속성을 수정할 수 있습니다.

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

If --mark가 전달됩니다. 명령을 호출하면 값이 true이고 그렇지 않으면 false라는 의미입니다. 입력 시 사용자가 옵션 값을 설정하면 $signature는 다음과 같이 정의할 수 있습니다.

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

이런 식으로 , 사용자는 옵션을 전달할 때 =를 통해 옵션에 값을 할당할 수 있습니다. 물론 매개변수와 마찬가지로 옵션에 대한 기본값을 지정할 수도 있습니다.

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

입력 받기

입력 매개변수와 옵션을 정의한 후 해당 값을 어떻게 얻나요? Laravel은 이에 상응하는 메소드를 제공합니다. IlluminateConsoleCommand의 인수 메서드를 통해 매개변수 값을 얻을 수 있습니다.

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

인수 메서드가 매개변수 없이 호출되면 모든 매개변수 값의 배열이 됩니다. 돌아왔다.

IlluminateConsoleCommand의 옵션 메소드를 통해 옵션 값을 얻을 수 있습니다:

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

마찬가지로 매개변수 없이 옵션 메소드를 호출하면 모든 옵션 값의 배열이 반환됩니다.

이 방법으로 HelloLaravelAcademy의 핸들 메소드를 다음과 같이 수정할 수 있습니다:

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?

#🎜🎜 #Input 프롬프트

#🎜🎜 #

사용자가 콘솔에 이름을 입력하여 입력 매개변수를 얻도록 허용할 수도 있습니다. 먼저 핸들 방법을 다음과 같이 수정합니다.

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

그런 다음 Enter를 입력합니다. php artisan laravel:academy 터미널의 대화형 페이지는 다음과 같습니다.

비밀번호 등 민감한 정보를 입력하는 경우에는 Ask 메소드 대신 secret을 사용할 수 있습니다.

때때로 사용자의 희망에 따라 계속하거나 중단하도록 선택합니다:

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

해당 출력은 다음과 같습니다:

除了让用户手动输入外，还可以使用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);
}

对应交互页面如下：

编写输出

关于输出字符串，上面我们简单使用了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甚至可以输出表格：

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

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

进度条

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

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对应输出为：

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命令你还应该知道的是我们可以在创建的命令类的控制器或方法中注入任何依赖。这就意味着我们可以在命令类中使用注册到服务容器的所有类。

相关推荐：

laravel框架的启动过程分析

Laravel框架内置的Broadcast功能如何实现与客户端实时通信

위 내용은 Laravel 5.1 프레임워크에서 커스텀 Artisan 콘솔 명령을 생성하는 방법의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!