如何在Laravel中創(chuàng)建自定義命令

418

在laravel中創(chuàng)建自定義命令的步驟如下：1. 使用php artisan make:command mycustomcommand生成命令骨架；2. 在mycustomcommand.php中設(shè)置$signature定義命令名、參數(shù)和選項(xiàng)，如my:greet {name} {–upper}；3. 設(shè)置$description提供命令描述；4. 在handle()方法中編寫邏輯，通過(guò)$this->argument(‘參數(shù)名’)和option()獲取輸入；5. 運(yùn)行命令如php artisan my:greet john或添加選項(xiàng)；6. 可使用交互方法如ask()、confirm()提升用戶體驗(yàn)；7. 測(cè)試時(shí)使用artisan::call()并斷言輸出，調(diào)試可用dd()、日志或xdebug。

如何在Laravel中創(chuàng)建自定義命令

在laravel里，創(chuàng)建一個(gè)自定義命令其實(shí)很簡(jiǎn)單，核心就是利用Artisan提供的make:command命令，然后填充好命令的簽名（signature）和處理邏輯（handle方法）。這玩意兒，真用起來(lái)你會(huì)發(fā)現(xiàn)，比寫一堆腳本文件管理方便多了。

解決方案

要?jiǎng)?chuàng)建一個(gè)自定義命令，我們通常會(huì)這么做：

  1. 生成命令骨架： 打開你的終端，進(jìn)入Laravel項(xiàng)目根目錄，敲下這行命令：

    php artisan make:command MyCustomCommand

    這會(huì)為你生成一個(gè)位于 app/console/Commands 目錄下的 MyCustomCommand.php 文件。我個(gè)人覺得，這個(gè)文件命名很重要，要能一眼看出它的作用，不然項(xiàng)目大了，找起來(lái)頭都大。

  2. 定義命令簽名與描述： 打開 MyCustomCommand.php 文件，你會(huì)看到兩個(gè)核心屬性：$signature 和 $description。

    • $signature：這是你命令的名字，用戶在終端里會(huì)用它來(lái)調(diào)用你的命令，比如 my:command {argument} {–option}。這里可以定義參數(shù)（arguments）和選項(xiàng)（options）。
    • $description：命令的簡(jiǎn)短描述，當(dāng)用戶運(yùn)行 php artisan list 時(shí)，會(huì)顯示出來(lái)，所以寫得清楚點(diǎn)，對(duì)別人對(duì)自己都好。

    一個(gè)簡(jiǎn)單的例子：

    <?php  namespace AppConsoleCommands;  use IlluminateConsoleCommand;  class MyCustomCommand extends Command {     /**      * The name and signature of the console command.      *      * @var string      */     protected $signature = 'my:greet {name} {--upper : Convert the name to uppercase}';      /**      * The console command description.      *      * @var string      */     protected $description = 'Greets a given name, optionally in uppercase.';      /**      * Execute the console command.      */     public function handle()     {         $name = $this->argument('name');         $shouldUppercase = $this->option('upper');          if ($shouldUppercase) {             $name = strtoupper($name);         }          $this->info("Hello, " . $name . "!");     } }

  3. 編寫命令邏輯： 所有的核心業(yè)務(wù)邏輯，都寫在 handle() 方法里。Laravel 會(huì)在命令被調(diào)用時(shí)自動(dòng)執(zhí)行這個(gè)方法。在這個(gè)方法里，你可以訪問(wèn)通過(guò) $this->argument(‘參數(shù)名’) 獲取參數(shù)，通過(guò) $this->option(‘選項(xiàng)名’) 獲取選項(xiàng)。像上面那個(gè)例子，我們就是這樣拿到 name 和 upper 的。

  4. 運(yùn)行命令： 保存文件后，回到終端，直接運(yùn)行你的命令：

    php artisan my:greet John // 輸出: Hello, John!  php artisan my:greet Jane --upper // 輸出: Hello, JANE!

    是不是感覺挺方便的？

自定義命令的參數(shù)與選項(xiàng)如何使用？

說(shuō)實(shí)話，剛接觸Laravel命令的時(shí)候，我總覺得參數(shù)和選項(xiàng)有點(diǎn)繞，但用多了就發(fā)現(xiàn)，它們是讓命令變得靈活的關(guān)鍵。簡(jiǎn)單來(lái)說(shuō)，參數(shù)通常是命令執(zhí)行所需的核心數(shù)據(jù)，比如你要處理的某個(gè)ID或文件名；而選項(xiàng)則更像是修飾符，用來(lái)改變命令的行為，比如是否強(qiáng)制執(zhí)行、是否靜默模式。

在 $signature 屬性里定義它們的方式有些講究：

  • 參數(shù) (Arguments):

    • 必填參數(shù): 直接寫參數(shù)名，例如 my:command {userId}。用戶調(diào)用時(shí)必須提供。
    • 可選參數(shù): 在參數(shù)名后加問(wèn)號(hào)，例如 my:command {userId?}。用戶可以不提供。
    • 帶默認(rèn)值的可選參數(shù): my:command {userId=1}。如果用戶不提供，就用默認(rèn)值。
    • 數(shù)組參數(shù) (可變數(shù)量): 在參數(shù)名后加星號(hào)，例如 my:command {names*}。這允許用戶傳入多個(gè)值，在 handle 方法里會(huì)得到一個(gè)數(shù)組。

    獲取方式：$this->argument(‘參數(shù)名’)。

  • 選項(xiàng) (Options):

    • 布爾選項(xiàng) (Flag): 選項(xiàng)名后加冒號(hào)，例如 my:command {–force}。這種選項(xiàng)不需要值，只要存在就為 true。
    • 帶值的選項(xiàng): 選項(xiàng)名后加等號(hào)，例如 my:command {–env=local}。用戶可以提供一個(gè)值，也可以有默認(rèn)值 my:command {–env=local}。
    • 帶值的可選選項(xiàng): my:command {–path=?}。用戶可以選擇提供值。
    • 選項(xiàng)的簡(jiǎn)寫: 可以在選項(xiàng)后用管道符 | 定義簡(jiǎn)寫，例如 my:command {–force|f}。

    獲取方式：$this->option(‘選項(xiàng)名’)。

舉個(gè)例子，一個(gè)用于清理舊日志文件的命令：

protected $signature = 'log:clean {days=7 : Number of days to keep logs} {--force : Force deletion without confirmation}';  public function handle() {     $daysToKeep = $this->argument('days');     $forceDelete = $this->option('force');      if (!$forceDelete && !$this->confirm("Are you sure you want to delete logs older than {$daysToKeep} days?")) {         $this->info("Operation cancelled.");         return;     }      $this->info("Cleaning logs older than {$daysToKeep} days...");     // 實(shí)際的清理邏輯     $this->info("Logs cleaned successfully!"); }

你看，通過(guò)參數(shù)和選項(xiàng)，這個(gè)命令就能靈活應(yīng)對(duì)不同的清理需求了。

如何在自定義命令中進(jìn)行交互式操作？

在命令行環(huán)境里，和用戶進(jìn)行交互是很有用的，比如問(wèn)用戶一個(gè)確認(rèn)信息，或者讓用戶輸入一些數(shù)據(jù)。Laravel的Command基類提供了一系列好用的方法，讓這事兒變得簡(jiǎn)單又直觀。我個(gè)人覺得，這些方法在編寫部署腳本或者數(shù)據(jù)遷移工具時(shí)特別有用，能大大提升用戶體驗(yàn)。

以下是一些常用的交互方法：

  • 提問(wèn) (Asking Questions):

    • $this->ask(‘問(wèn)題?’): 獲取用戶輸入的一行文本。
    • $this->secret(‘請(qǐng)輸入密碼:’): 獲取用戶輸入，但不在屏幕上顯示（用于敏感信息）。
    • $this->confirm(‘確定要繼續(xù)嗎?’): 獲取用戶的是/否確認(rèn)，返回布爾值。
    • $this->choice(‘請(qǐng)選擇一個(gè)選項(xiàng):’, [‘選項(xiàng)A’, ‘選項(xiàng)B’]): 讓用戶從給定列表中選擇一個(gè)。

  • 輸出信息 (Outputting Information):

    • $this->info(‘這是提示信息。’): 輸出綠色信息，通常用于成功或重要提示。
    • $this->Error(‘發(fā)生錯(cuò)誤！’): 輸出紅色信息，用于錯(cuò)誤提示。
    • $this->warn(‘這是警告。’): 輸出黃色信息，用于警告。
    • $this->line(‘普通文本輸出。’): 輸出普通白色文本。
    • $this->comment(‘這是注釋或次要信息。’): 輸出黃色信息，比 warn 顏色稍淺。
    • $this->table([‘Header 1’, ‘Header 2’], [[‘Row 1 Col 1’, ‘Row 1 Col 2’], [‘Row 2 Col 1’, ‘Row 2 Col 2’]]): 以表格形式輸出數(shù)據(jù)，非常適合展示結(jié)構(gòu)化信息。

  • 進(jìn)度條 (Progress Bar): 當(dāng)你的命令需要處理大量數(shù)據(jù)時(shí)，顯示一個(gè)進(jìn)度條能讓用戶知道程序還在運(yùn)行，而不是卡住了。

    $users = range(1, 100); // 假設(shè)有一百個(gè)用戶要處理 $bar = $this->output->createProgressBar(count($users)); $bar->start();  foreach ($users as $user) {     // 模擬處理用戶     sleep(0.05);     $bar->advance(); // 推進(jìn)進(jìn)度條 }  $bar->finish(); $this->info("nAll users processed!");

    這些交互方法，用得好，能讓你的自定義命令不僅強(qiáng)大，而且更“人性化”。

自定義命令的測(cè)試與調(diào)試策略有哪些？

寫完自定義命令，最怕的就是上線后出問(wèn)題。所以，測(cè)試和調(diào)試是必不可少的環(huán)節(jié)。和Web請(qǐng)求的測(cè)試不同，命令行的測(cè)試有它自己的特點(diǎn)。我個(gè)人覺得，對(duì)于復(fù)雜的命令，自動(dòng)化測(cè)試比手動(dòng)跑一百遍要靠譜得多。

  • 測(cè)試 (Testing): Laravel為命令測(cè)試提供了非常友好的API。你可以在PHPUnit測(cè)試?yán)铮苯诱{(diào)用Artisan命令，并斷言其輸出和行為。

    1. 調(diào)用命令: 使用 Artisan::call() 方法來(lái)執(zhí)行你的命令。

      use TestsTestCase; use IlluminateSupportFacadesArtisan;  class MyCustomCommandTest extends TestCase {     /** @test */     public function it_greets_the_given_name()     {         Artisan::call('my:greet', ['name' => 'Alice']);         $output = Artisan::output(); // 獲取命令的輸出          $this->assertStringContainsString('Hello, Alice!', $output);     }      /** @test */     public function it_converts_name_to_uppercase_with_option()     {         Artisan::call('my:greet', ['name' => 'bob', '--upper' => true]);         $output = Artisan::output();          $this->assertStringContainsString('Hello, BOB!', $output);     } }

    2. 模擬依賴: 如果你的命令依賴于其他服務(wù)或數(shù)據(jù)庫(kù)，你可以使用Mockery或PHPUnit自帶的Mock功能來(lái)模擬這些依賴，確保測(cè)試的獨(dú)立性和可控性。比如，如果命令要從數(shù)據(jù)庫(kù)讀取數(shù)據(jù)，你可以Mock掉對(duì)應(yīng)的Repository。

    3. 測(cè)試交互: 對(duì)于包含交互的命令（如 confirm），你可以利用 expectsQuestion 和 expectsConfirmation 等方法來(lái)模擬用戶輸入。

  • 調(diào)試 (Debugging): 命令行環(huán)境的調(diào)試和Web環(huán)境有點(diǎn)不一樣，你不能直接在瀏覽器里看輸出。

    1. dd() 或 dump(): 最直接粗暴的方式，在命令的 handle 方法里任何你想檢查變量的地方加上 dd($variable) 或 dump($variable)。它會(huì)直接在終端輸出變量?jī)?nèi)容。不過(guò)，dd() 會(huì)終止命令執(zhí)行，dump() 不會(huì)。

    2. 日志 (Logging): 對(duì)于長(zhǎng)時(shí)間運(yùn)行的命令或者在生產(chǎn)環(huán)境出問(wèn)題的命令，日志是你的好幫手。使用 Log::info(), Log::error() 等方法將關(guān)鍵信息寫入日志文件。

      use IlluminateSupportFacadesLog;  public function handle() {     Log::info('MyCustomCommand started.');     try {         // ... 命令邏輯         Log::info('Processing item: ' . $itemId);     } catch (Exception $e) {         Log::error('Error in MyCustomCommand: ' . $e->getMessage());     }     Log::info('MyCustomCommand finished.'); }

    3. Xdebug: 如果你配置了Xdebug，可以直接在終端運(yùn)行命令時(shí)觸發(fā)斷點(diǎn)。這需要一些配置，但能提供步進(jìn)調(diào)試的強(qiáng)大功能，讓你深入到代碼的每一個(gè)角落。

調(diào)試和測(cè)試是保證命令質(zhì)量的最后一道防線。別偷懶，多花點(diǎn)時(shí)間在這里，后期能省不少心。

? 版權(quán)聲明
THE END
PHP框架
# 工具# 數(shù)據(jù)庫(kù)# php# ai# 瀏覽器# laravel# 自動(dòng)化# 堆# table# Error# console# this# cad# Logging
喜歡就支持一下吧
點(diǎn)贊8 分享