外部依附元件的進階主題

回報問題 查看來源

WORKSPACE 中的影子依附元件

請盡可能在專案中設定單一版本政策,這對於您依據最終二進位檔進行編譯和最終的依附元件來說都需要政策。在其他情況下,您可以遮蔽依附元件:

我的專案/工作區

workspace(name = "myproject")

local_repository(
    name = "A",
    path = "../A",
)
local_repository(
    name = "B",
    path = "../B",
)

A/WORKSPACE

workspace(name = "A")

load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")
http_archive(
    name = "testrunner",
    urls = ["https://github.com/testrunner/v1.zip"],
    sha256 = "...",
)

B/工作區

workspace(name = "B")

load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")
http_archive(
    name = "testrunner",
    urls = ["https://github.com/testrunner/v2.zip"],
    sha256 = "..."
)

AB 都依附於 testrunner 的不同版本。在 myproject 中納入這兩個類別,而不發生衝突,也就是在 myproject/WORKSPACE 中使用不同名稱:

workspace(name = "myproject")

load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")
http_archive(
    name = "testrunner-v1",
    urls = ["https://github.com/testrunner/v1.zip"],
    sha256 = "..."
)
http_archive(
    name = "testrunner-v2",
    urls = ["https://github.com/testrunner/v2.zip"],
    sha256 = "..."
)
local_repository(
    name = "A",
    path = "../A",
    repo_mapping = {"@testrunner" : "@testrunner-v1"}
)
local_repository(
    name = "B",
    path = "../B",
    repo_mapping = {"@testrunner" : "@testrunner-v2"}
)

你也可以使用這個機制加入鑽石。舉例來說,如果 AB 具有相同的依附元件,但以不同的名稱呼叫,請在 myproject/WORKSPACE 中加入這些依附元件。

透過指令列覆寫存放區

如要透過指令列使用本機存放區覆寫宣告的存放區,請使用 --override_repository 標記。使用此旗標會變更外部存放區的內容,而不會變更原始碼。

舉例來說,如要將 @foo 覆寫至本機目錄 /path/to/local/foo,請傳遞 --override_repository=foo=/path/to/local/foo 標記。

用途包括:

  • 偵錯。舉例來說,如要將 http_archive 存放區覆寫為本機目錄,方便您輕鬆進行變更。
  • 供應商。如果您所在環境無法發出網路呼叫,請覆寫以網路為基礎的存放區規則,改為指向本機目錄。

使用 Proxy

Bazel 會從 HTTPS_PROXYHTTP_PROXY 環境變數中挑選 Proxy 位址,並用於下載 HTTPHTTPS 檔案 (如有指定)。

支援 IPv6

在僅限 IPv6 的機器上,Bazel 可以下載依附元件,無須進行任何變更。不過,在雙重堆疊 IPv4/IPv6 機器上,Bazel 遵循與 Java 相同的慣例,因此會優先使用 IPv4 (如果已啟用的話)。在某些情況下,例如當 IPv4 網路無法解析/連線至外部位址時,這可能會造成 Network unreachable 例外狀況和建構失敗。在這類情況下,您可以使用 java.net.preferIPv6Addresses=true 系統屬性覆寫 Bazel 的行為,使其優先使用 IPv6。詳細說明:

  • 請使用 --host_jvm_args=-Djava.net.preferIPv6Addresses=true 啟動選項,例如在 .bazelrc 檔案中加入下列程式碼:

    startup --host_jvm_args=-Djava.net.preferIPv6Addresses=true

  • 執行需要連上網際網路 (例如整合測試) 的 Java 建構目標時,請使用 --jvmopt=-Djava.net.preferIPv6Addresses=true 工具標記。例如,請納入 .bazelrc 檔案

    build --jvmopt=-Djava.net.preferIPv6Addresses

  • 如果您使用 rules_jvm_external 取得依附元件版本解析,請一併將 -Djava.net.preferIPv6Addresses=true 新增至 COURSIER_OPTS 環境變數,為 Coursier 提供 JVM 選項

離線版本

有時候,您可能會想離線執行建構,例如在飛機上旅遊時。針對這類簡易用途,請使用 bazel fetchbazel sync 預先擷取所需的存放區。如要在建構期間停止擷取其他存放區,請使用 --nofetch 選項。

以真正的離線建構作業來說,由不同的實體提供所有必要檔案,Bazel 可支援 --distdir 選項。當存放區規則要求 Bazel 使用 ctx.downloadctx.download_and_extract 擷取檔案時,這個標記會指示 Bazel 先查看該選項指定的目錄。Bazel 會透過提供所需檔案的雜湊總和,尋找與第一個網址基準名稱相符的檔案,並在雜湊符合時使用本機副本。

Bazel 本身會使用這項技術從發布成果離線啟動。方法是在內部 distdir_tar收集所有必要的外部依附元件

Bazel 允許在存放區規則中執行任意指令,而無需知道這些指令是否會呼叫網路,因此無法強制執行完全離線的建構作業。如要測試建構作業能否在離線狀態下正常運作,請手動封鎖網路 (因為 Bazel 在啟動測試中執行時)。