Laradoc

Appearance

Laravel Envoy ​

介紹 ​

Laravel Envoy 是一個用於執行遠端伺服器上常見任務的工具。使用 Blade 風格的語法，您可以輕鬆設定部署、Artisan 命令等任務。目前，Envoy 僅支援 Mac 和 Linux 作業系統。但是，透過 WSL2 也能支援 Windows。

安裝 ​

首先，使用 Composer 套件管理器將 Envoy 安裝到您的專案中：

shell
composer require laravel/envoy --dev

Envoy 安裝完成後，Envoy 二進位檔將會存在於您應用程式的 vendor/bin 目錄中：

shell
php vendor/bin/envoy

編寫任務 ​

定義任務 ​

任務是 Envoy 的基本組成部分。任務定義了在呼叫時應在遠端伺服器上執行的 Shell 命令。例如，您可能定義一個任務，在應用程式的所有佇列工作者伺服器上執行 php artisan queue:restart 命令。

您所有的 Envoy 任務都應該定義在應用程式根目錄下的 Envoy.blade.php 檔案中。以下是一個入門範例：

blade
@servers(['web' => ['[email protected]'], 'workers' => ['[email protected]']])

@task('restart-queues', ['on' => 'workers'])
    cd /home/user/example.com
    php artisan queue:restart
@endtask

如您所見，檔案頂部定義了一個 @servers 陣列，允許您透過任務宣告的 on 選項來引用這些伺服器。@servers 宣告應始終放在單行。在您的 @task 宣告中，您應該放置在呼叫任務時應在伺服器上執行的 Shell 命令。

本地任務 ​

您可以透過將伺服器的 IP 位址指定為 127.0.0.1 來強制腳本在本地電腦上執行：

blade
@servers(['localhost' => '127.0.0.1'])

匯入 Envoy 任務 ​

使用 @import 指令，您可以匯入其他 Envoy 檔案，以便將它們的故事和任務添加到您的檔案中。匯入檔案後，您可以執行其中包含的任務，就像它們是在您自己的 Envoy 檔案中定義的一樣：

blade
@import('vendor/package/Envoy.blade.php')

多個伺服器 ​

Envoy 讓您能輕鬆地在多個伺服器上運行任務。首先，將其他伺服器添加到您的 @servers 宣告中。每個伺服器都應分配一個唯一的名稱。定義了其他伺服器後，您可以將每個伺服器列在任務的 on 陣列中：

blade
@servers(['web-1' => '192.168.1.1', 'web-2' => '192.168.1.2'])

@task('deploy', ['on' => ['web-1', 'web-2']])
    cd /home/user/example.com
    git pull origin {{ $branch }}
    php artisan migrate --force
@endtask

平行執行 ​

預設情況下，任務將在每個伺服器上依序執行。換句話說，任務在第一個伺服器上完成執行後，才會繼續在第二個伺服器上執行。如果您想在多個伺服器上平行執行任務，請將 parallel 選項添加到您的任務宣告中：

blade
@servers(['web-1' => '192.168.1.1', 'web-2' => '192.168.1.2'])

@task('deploy', ['on' => ['web-1', 'web-2'], 'parallel' => true])
    cd /home/user/example.com
    git pull origin {{ $branch }}
    php artisan migrate --force
@endtask

設定 ​

有時，您可能需要在執行 Envoy 任務之前執行任意 PHP 程式碼。您可以使用 @setup 指令定義一個應在任務執行前執行的 PHP 程式碼區塊：

php
@setup
    $now = new DateTime;
@endsetup

如果您需要在執行任務之前引入其他 PHP 檔案，您可以在 Envoy.blade.php 檔案的頂部使用 @include 指令：

blade
@include('vendor/autoload.php')

@task('restart-queues')
    # ...
@endtask

變數 ​

如有需要，您可以在呼叫 Envoy 時，透過在命令列上指定參數來將參數傳遞給 Envoy 任務：

shell
php vendor/bin/envoy run deploy --branch=master

您可以使用 Blade 的「Echo」語法在任務中存取選項。您也可以在任務中定義 Blade 的 if 陳述式和迴圈。例如，讓我們在執行 git pull 命令之前驗證 $branch 變數是否存在：

blade
@servers(['web' => ['[email protected]']])

@task('deploy', ['on' => 'web'])
    cd /home/user/example.com

    @if ($branch)
        git pull origin {{ $branch }}
    @endif

    php artisan migrate --force
@endtask

故事 ​

故事將一組任務歸類到一個方便的名稱下。例如，一個 deploy 故事可以透過在其定義中列出任務名稱來執行 update-code 和 install-dependencies 任務：

blade
@servers(['web' => ['[email protected]']])

@story('deploy')
    update-code
    install-dependencies
@endstory

@task('update-code')
    cd /home/user/example.com
    git pull origin master
@endtask

@task('install-dependencies')
    cd /home/user/example.com
    composer install
@endtask

一旦故事寫好，您可以像呼叫任務一樣呼叫它：

shell
php vendor/bin/envoy run deploy

掛鉤 ​

當任務和故事執行時，會執行許多掛鉤。Envoy 支援的掛鉤類型有 @before、@after、@error、@success 和 @finished。這些掛鉤中的所有程式碼都以 PHP 形式解釋並在本地執行，而不是在您的任務互動的遠端伺服器上執行。

您可以根據需要定義任意數量的這些掛鉤。它們將按照在 Envoy 腳本中出現的順序執行。

@before ​

在每個任務執行之前，Envoy 腳本中註冊的所有 @before 掛鉤都將執行。@before 掛鉤會接收將要執行的任務名稱：

blade
@before
    if ($task === 'deploy') {
        // ...
    }
@endbefore

@after ​

在每個任務執行之後，Envoy 腳本中註冊的所有 @after 掛鉤都將執行。@after 掛鉤會接收已執行的任務名稱：

blade
@after
    if ($task === 'deploy') {
        // ...
    }
@endafter

@error ​

在每個任務失敗（以大於 0 的狀態碼退出）之後，Envoy 腳本中註冊的所有 @error 掛鉤都將執行。@error 掛鉤會接收已執行的任務名稱：

blade
@error
    if ($task === 'deploy') {
        // ...
    }
@enderror

@success ​

如果所有任務都已執行且沒有錯誤，Envoy 腳本中註冊的所有 @success 掛鉤都將執行：

blade
@success
    // ...
@endsuccess

@finished ​

在所有任務執行完畢後（無論退出狀態如何），所有 @finished 掛鉤都將執行。@finished 掛鉤會接收完成任務的狀態碼，該狀態碼可能是 null 或大於或等於 0 的 integer：

blade
@finished
    if ($exitCode > 0) {
        // There were errors in one of the tasks...
    }
@endfinished

運行任務 ​

要運行在應用程式的 Envoy.blade.php 檔案中定義的任務或故事，請執行 Envoy 的 run 命令，並傳入您要執行的任務或故事名稱。Envoy 將會執行該任務，並在任務運行時顯示來自遠端伺服器的輸出：

shell
php vendor/bin/envoy run deploy

確認任務執行 ​

如果您希望在伺服器上運行指定任務之前提示您進行確認，您應該將 confirm 指令添加到您的任務宣告中。此選項對於破壞性操作特別有用：

blade
@task('deploy', ['on' => 'web', 'confirm' => true])
    cd /home/user/example.com
    git pull origin {{ $branch }}
    php artisan migrate
@endtask

通知 ​

Slack ​

Envoy 支援在每個任務執行後發送通知到 Slack。 @slack 指令接受一個 Slack 鉤點 URL 以及頻道 / 使用者名稱。您可以透過在 Slack 控制面板中建立一個「傳入 WebHooks」整合來取得您的鉤點 URL。

您應該將完整的鉤點 URL 作為傳遞給 @slack 指令的第一個參數。傳遞給 @slack 指令的第二個參數應為頻道名稱 (#channel) 或使用者名稱 (@user)：

blade
@finished
    @slack('webhook-url', '#bots')
@endfinished

預設情況下，Envoy 通知會向通知頻道發送一條描述已執行任務的訊息。但是，您可以透過向 @slack 指令傳遞第三個參數來使用您自己的自訂訊息覆寫此訊息：

blade
@finished
    @slack('webhook-url', '#bots', 'Hello, Slack.')
@endfinished

Discord ​

Envoy 也支援在每個任務執行後發送通知到 Discord。 @discord 指令接受一個 Discord 鉤點 URL 和一條訊息。您可以透過在您的伺服器設定中建立一個「Webhook」並選擇 Webhook 應該發布到的頻道來取得您的鉤點 URL。您應該將完整的鉤點 URL 傳入 @discord 指令：

blade
@finished
    @discord('discord-webhook-url')
@endfinished

Telegram ​

Envoy 也支援在每個任務執行後發送通知到 Telegram。 @telegram 指令接受一個 Telegram Bot ID 和一個對話 ID。您可以透過使用 BotFather 建立一個新的 Bot 來取得您的 Bot ID。您可以使用 @username_to_id_bot 取得有效的對話 ID。您應該將完整的 Bot ID 和對話 ID 傳入 @telegram 指令：

blade
@finished
    @telegram('bot-id','chat-id')
@endfinished

Microsoft Teams ​

Envoy 也支援在每個任務執行後發送通知到 Microsoft Teams。 @microsoftTeams 指令接受一個 Teams Webhook (必填)、一條訊息、主題顏色（成功、資訊、警告、錯誤）以及一個選項陣列。您可以透過建立一個新的 傳入 Webhook 來取得您的 Teams Webhook。Teams API 還有許多其他屬性可用於自訂您的訊息框，例如標題、摘要和區段。您可以在 Microsoft Teams 文件 中找到更多資訊。您應該將完整的 Webhook URL 傳入 @microsoftTeams 指令：

blade
@finished
    @microsoftTeams('webhook-url')
@endfinished