So erstellen Sie benutzerdefinierte Artisan-Konsolenbefehle im Laravel 5.1-Framework

Laravel-Anfänger wissen möglicherweise nicht viel über die benutzerdefinierten Artisan-Konsolenbefehle. Der folgende Artikel zeigt Ihnen ein Beispiel für die Erstellung eines benutzerdefinierten Artisan-Konsolenbefehls im Laravel-Framework.

1. Erste Schritte

Laravel bietet über Artisan leistungsstarke Konsolenbefehle für die Verarbeitung von Nicht-Browser-Geschäftslogik. Um alle Artisan-Befehle in Laravel anzuzeigen, können Sie es im Stammverzeichnis des Projekts ausführen:

php artisan list

Die entsprechende Ausgabe lautet wie folgt (Teil-Screenshot):

Einige davon heißen Wir sind bereits damit vertraut, z. B. das Erstellen einer Migration make:migration und das Ausführen einer Migrationsmigration, das Erstellen eines Modells make:model, das Erstellen eines Controllers make:controller usw.

Wenn Sie die spezifische Verwendung eines bestimmten Befehls überprüfen möchten, beispielsweise wenn wir die spezifische Verwendung des Artisan-Befehls make:console überprüfen möchten, können Sie den folgenden Befehl verwenden:

php artisan help make:console

Die entsprechende Ausgabe lautet wie folgt:

2. Befehle erstellen

Zusätzlich zur Bereitstellung eines umfangreichen Satzes an Konsolenbefehlen Mit Artisan können wir über den Befehl make:console auch eigene Konsolenbefehle erstellen. Oben haben wir den Befehl „help“ verwendet, um die Verwendung von make:console zu überprüfen. Gehen wir diesen Weg und finden es heraus: Erstellen Sie den Befehl und führen Sie ihn aus, um die verschiedenen gewünschten Ergebnisse zu erhalten.

Zuerst erstellen wir den einfachsten Befehl zum Drucken von Hello LaravelAcademy, indem wir den Artisan-Befehl wie folgt verwenden:

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

wobei HelloLaravelAcademy der Befehlsname ist, laravel:academy der von der Konsole ausgeführte Befehl, ähnlich machen: Konsole.

Nach Abschluss der Ausführung wird eine HelloLaravelAcademy.php-Datei im Verzeichnis app/Console/Commands generiert:

<?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()
    {
        //
    }
}

wobei $signature der Name des auf der Konsole ausgeführten Befehls ist und $description ist die Befehlsbeschreibung, die Handle-Methode ist die Methode, die beim Ausführen des Befehls aufgerufen wird.

Als nächstes schreiben wir einfach die Handle-Methode wie folgt:

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

Okay, der einfachste Befehl ist geschrieben, wie führt man ihn aus und druckt „Hello Laravel Academy“ auf der Konsole aus Wolltuch?

3. Führen Sie den Befehl aus

Bevor Sie den Befehl ausführen, müssen Sie ihn im Attribut $commands von AppConsoleKernel registrieren:

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

Als nächstes Sie können den folgenden Artisan-Befehl auf der Konsole ausführen:

php artisan laravel:academy

Das Terminal druckt aus:

Hello LaravelAcademy

Ist das nicht ganz einfach?

4. Vielfältigere Eingabe und Ausgabe

Natürlich ist das Obige der einfachste Fall, ohne Eingabe und fest codierte Ausgabe. In der tatsächlichen Umgebung gibt es komplexere Anforderungen und vielfältigere Ein- und Ausgänge. Lassen Sie uns diese im Folgenden einzeln besprechen.

Eingabe definieren

Wie oben erwähnt, können wir Eingabeparameter und -optionen definieren, indem wir das Attribut $signature ändern. Hier passen wir beispielsweise die Zeichenfolge nach Hello oben an Gesteuert durch Eingabeparameter kann $signature wie folgt geändert werden:

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

Diese Definition bedeutet, dass der Name ein erforderlicher Parameter ist. Natürlich werden auch weitere benutzerdefinierte Parametereingaben unterstützt:

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

zur Verbesserung Wenn wir die Robustheitseigenschaft des Programms verwenden, ändern wir den Namen so, dass er einen Standardwert hat:

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

Manchmal übergeben wir beim Ausführen des Befehls auch einige Optionen, z. B. ob Satzzeichen angezeigt werden sollen (obwohl es geschmacklos klingt, ist dies nur für Zu Testzwecken können wir das Attribut $signature wie folgt ändern:

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

Wenn --mark beim Aufruf des Befehls übergeben wird, bedeutet dies, dass der Wert wahr ist, andernfalls ist er falsch, wenn der Optionswert Wird vom Benutzer bei der Eingabe festgelegt, kann $ definiert werden. Die Signatur lautet wie folgt:

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

Auf diese Weise kann der Benutzer der Option durch = einen Wert zuweisen, wenn er die Option übergibt In den Parametern können wir auch einen Standardwert für die Option angeben:

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

Eingabe abrufen

Wie erhält man nach dem Definieren der Eingabeparameter und -optionen die entsprechenden Werte? Laravel stellt uns die entsprechenden Methoden zur Verfügung.

Sie können Parameterwerte über die Argumentmethode von IlluminateConsoleCommand erhalten:

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

Wenn die Argumentmethode ohne Parameter aufgerufen wird, wird ein Array aller Parameterwerte zurückgegeben.

Sie können den Optionswert über die Optionsmethode von IlluminateConsoleCommand erhalten:

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

In ähnlicher Weise wird beim Aufruf der Optionsmethode ohne Parameter ein Array aller Optionswerte zurückgegeben.

Auf diese Weise können wir die Handle-Methode von HelloLaravelAcademy wie folgt ändern:

public function handle()
{
    $name = $this->argument('name');
    $mark = $this->option('mark');
    $string = 'Hello '.$name;
    if($mark)
        $string .= $mark;
    echo $string."\n";
}

Auf diese Weise geben wir den folgenden Artisan-Befehl in die Konsole ein:

php artisan laravel:academy

Die entsprechende Ausgabe lautet:

Hello LaravelAcademy!

Führen Sie den folgenden Artisan-Befehl erneut aus:

php artisan laravel:academy Laravel --mark=?

Die entsprechende Ausgabe lautet:

Hello Laravel?

Eingabeaufforderung

We Sie können den Benutzer sogar vollständig über die Konsole eingeben, um die Eingabeparameter zu erhalten. Ändern Sie zunächst die Handle-Methode wie folgt:

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

Geben Sie dann php artisan laravel:academy in das Terminal ein.

Wenn Sie ein Passwort eingeben. Für eine Art vertraulicher Informationen kann Secret anstelle der Ask-Methode verwendet werden.
Manchmal entscheiden wir uns je nach Wunsch des Benutzers für Fortfahren oder Abbrechen:

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

Die entsprechende Ausgabe lautet:

除了让用户手动输入外，还可以使用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功能如何实现与客户端实时通信

Das obige ist der detaillierte Inhalt vonSo erstellen Sie benutzerdefinierte Artisan-Konsolenbefehle im Laravel 5.1-Framework. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!