建立永久工作站

永久工作站可加快建構速度。如果您在建構中執行重複動作，且這些動作的啟動成本很高，或可從跨動作快取中獲益，建議您實作自己的持續性工作站來執行這些動作。

Bazel 伺服器會使用 stdin/stdout 與 worker 通訊。它支援使用通訊協定緩衝區或 JSON 字串。

工作站實作項目包含兩個部分：

• worker。
• 使用 worker 的規則。

讓工作站成為工作站

持續性工作站必須符合以下幾項規定：

• 會從其 stdin 讀取 WorkRequests。
• 它會將 WorkResponses (且僅限 WorkResponse) 寫入其 stdout。
• 並接受 --persistent_worker 標記。包裝函式必須辨識 --persistent_worker 指令列標記，並只在傳遞該標記時使其持續存在，否則必須執行一次性編譯並結束。

如果您的程式符合這些規定，即可做為持續性 worker 使用！

工作要求

WorkRequest 包含工作站的引數清單、路徑摘要組合清單，代表工作站可存取的輸入內容 (這並未強制執行，但您可以使用這項資訊進行快取)，以及要求 ID，單一工作站為 0。

注意：雖然通訊協定緩衝區規格使用「蛇形大小寫」(request_id)，但 JSON 通訊協定使用「駝峰式大小寫」(requestId)。本文件在 JSON 範例中使用駝峰式大小寫，但在討論欄位時，無論通訊協定為何，都會使用蛇形大小寫。

{
  "arguments" : ["--some_argument"],
  "inputs" : [
    { "path": "/path/to/my/file/1", "digest": "fdk3e2ml23d"},
    { "path": "/path/to/my/file/2", "digest": "1fwqd4qdd" }
 ],
  "requestId" : 12
}

您可以使用選用的 verbosity 欄位，向 worker 要求額外的偵錯輸出內容。輸出內容和方式完全由 worker 決定。值越高，輸出內容就越詳細。將 --worker_verbose 標記傳遞至 Bazel 會將 verbosity 欄位設為 10，但您可以手動使用較小或較大的值，以便產生不同數量的輸出內容。

選用的 sandbox_dir 欄位僅供支援多重沙箱的工作者使用。

工作回應

WorkResponse 包含要求 ID、零或非零結束代碼，以及描述處理或執行要求時發生的任何錯誤的輸出訊息。工作者應擷取所呼叫工具的 stdout 和 stderr，並透過 WorkResponse 回報。寫入工作站程序的 stdout 並不安全，因為它會幹擾工作站的通訊協定。將檔案寫入工作站程序的 stderr 很安全，但結果會在每個工作站的記錄檔中收集，而非記錄到個別動作。

{
  "exitCode" : 1,
  "output" : "Action failed with the following message:\nCould not find input
    file \"/path/to/my/file/1\"",
  "requestId" : 12
}

根據 protobuf 的規範，所有欄位均為選填欄位。不過，Bazel 要求 WorkRequest 和對應的 WorkResponse 必須具有相同的要求 ID，因此如果要求 ID 非零，就必須指定該 ID。這是有效的 WorkResponse。

{
  "requestId" : 12,
}

request_id 值為 0 表示「單向」要求，當這項要求無法與其他要求並行處理時，就會使用這項值。伺服器會保證特定 worker 收到的要求，只會包含 request_id 0 或 request_id 大於零。單工要求會以序列方式傳送，例如伺服器在收到回應前不會傳送其他要求 (取消要求除外，請參閱下文)。

注意事項

• 每個通訊協定緩衝區前面都會加上其長度，格式為 varint (請參閱 MessageLite.writeDelimitedTo())。
• JSON 要求和回應前方沒有大小指標。
• JSON 要求的結構與 protobuf 相同，但會使用標準 JSON，並為所有欄位名稱使用駝峰式大小寫。
• 為了維持與 protobuf 相同的向前和向後相容性屬性，JSON 工作者必須容許這些訊息中的不明欄位，並使用 protobuf 預設值來處理缺少的值。
• Bazel 會將要求儲存為 protobuf，並使用 protobuf 的 JSON 格式將其轉換為 JSON

取消

工作者可以選擇允許在工作要求完成前取消。這項功能在與動態執行作業連結時特別實用，因為本機執行作業可能會經常因更快速的遠端執行作業而中斷。如要允許取消，請在 execution-requirements 欄位中加入 supports-worker-cancellation: 1 (請見下方說明)，並設定 --experimental_worker_cancellation 標記。

取消要求是設定 cancel 欄位的 WorkRequest (同樣地，取消回應是設定 was_cancelled 欄位的 WorkResponse)。取消要求或取消回應中唯一必須包含的其他欄位是 request_id，用於指出要取消哪項要求。對於單工單線工作站，request_id 欄位會是 0；對於多工單線工作站，則會是先前傳送的 WorkRequest 的非 0 request_id。伺服器可能會針對工作站已回應的要求傳送取消要求，在這種情況下，您必須忽略取消要求。

無論是否已取消，每則非取消 WorkRequest 訊息都必須回覆一次。伺服器傳送取消要求後，工作站可能會回應 WorkResponse，其中 request_id 已設為 request_id，而 was_cancelled 欄位則設為 true。系統也接受傳送一般的 WorkResponse，但系統會忽略 output 和 exit_code 欄位。

一旦針對 WorkRequest 傳送回應，工作者就不得觸碰工作目錄中的檔案。伺服器可自由清除檔案，包括暫存檔案。

建立使用工作站的規則

您也需要建立規則，產生由 worker 執行的動作。建立使用工作站的 Starlark 規則與建立任何其他規則一樣。

此外，規則必須包含對 worker 本身的參照，且產生的動作必須符合某些規定。

參照 worker

使用工作站的規則必須包含一個參照該工作站的欄位，因此您需要建立 \*\_binary 規則的執行個體來定義工作站。如果工作站稱為 MyWorker.Java，則相關規則可能如下：

java_binary(
    name = "worker",
    srcs = ["MyWorker.Java"],
)

這會建立「worker」標籤，指向工作站二進位檔。接著，您將定義使用工作站的規則。這項規則應定義參照 worker 二進位檔的屬性。

"worker": attr.label(
    default = Label("//work:worker"),
    executable = True,
    cfg = "exec",
)

ctx.actions.run(
  inputs=ctx.files.srcs,
  outputs=[ctx.outputs.output],
  executable=ctx.executable.worker,
  mnemonic="someMnemonic",
  execution_requirements={
    "supports-workers" : "1",
    "requires-worker-protocol" : "json"},
  arguments=ctx.attr.args + ["@flagfile"]
 )