工作區規則

工作區規則可用來提取外部依附元件，通常是位於主要存放區外的原始碼。

注意：除了原生工作區規則外，Bazel 也會嵌入各種 Starlark 工作區規則，特別是用來處理網路上託管的 Git 存放區或封存的規則。

規則

• 繫結
• local_repository
• new_local_repository

繫結

bind(name, actual, compatible_with, deprecation, distribs, features, licenses, restricted_to, tags, target_compatible_with, testonly, visibility)

警告：不建議使用 bind()。如要詳細瞭解問題和替代方案，請參閱「考慮移除繫結」。建議您特別考慮使用 repo_mapping 存放區屬性。

警告：select() 無法在 bind() 中使用。詳情請參閱「可設定屬性常見問題」一文。

在 //external 套件中指定目標別名。

//external 套件不是「一般」套件：沒有外部/ 目錄，因此可視為包含所有繫結目標的「虛擬套件」。

範例

如要指定目標別名，請在 WORKSPACE 檔案中bind。舉例來說，假設有一個名為 //third_party/javacc-v2 的 java_library 目標。您可以將以下內容新增至 WORKSPACE 檔案，藉此新增別名：

bind(
    name = "javacc-latest",
    actual = "//third_party/javacc-v2",
)

現在目標可依附於 //external:javacc-latest，而非 //third_party/javacc-v2。如果 javacc-v3 已經發布，bind 規則可以更新，而所有依附於 //external:javacc-latest 的 BUILD 檔案現在都會依附於 javacc-v3，無須進行編輯。

繫結也能用來讓外部存放區中的目標可供工作區使用。舉例來說，如果 WORKSPACE 檔案中已有名為 @my-ssl 的遠端存放區，且該存放區有 cc_library 目標 //src:openssl-lib，您可以使用 bind 為這個目標建立別名：

bind(
    name = "openssl",
    actual = "@my-ssl//src:openssl-lib",
)

接著，在工作區的 BUILD 檔案中，繫結目標可用來：

cc_library(
    name = "sign-in",
    srcs = ["sign_in.cc"],
    hdrs = ["sign_in.h"],
    deps = ["//external:openssl"],
)

在 sign_in.cc 和 sign_in.h 中，//external:openssl 所公開的標頭檔案可使用其存放區根目錄的路徑來參照。舉例來說，如果 @my-ssl//src:openssl-lib 的規則定義如下所示：

cc_library(
    name = "openssl-lib",
    srcs = ["openssl.cc"],
    hdrs = ["openssl.h"],
)

則 sign_in.cc 的內容可能會如下所示：

#include "sign_in.h"
#include "src/openssl.h"

引數

屬性
name	Name; required 這個目標的專屬名稱。
actual	Label; optional 要加上別名的目標。 這個目標必須存在，但可以是任何類型的規則 (包括繫結)。 如果省略這個屬性，//external 中參照這個目標的規則就只會顯示這個依附元件邊緣。請注意，這與完全省略 bind 規則不同：如果 //external 依附元件沒有相關聯的 bind 規則，就會發生錯誤。

local_repository

local_repository(name, path, repo_mapping)

允許從本機目錄繫結目標。也就是說，目前的存放區可以使用此其他目錄中定義的目標。詳情請參閱繫結一節。

範例

假設目前的存放區是即時通訊用戶端，這個用戶端位於位於 ~/chat-app 目錄。想要使用在其他存放區定義的 SSL 程式庫：~/ssl。SSL 程式庫提供目標 //src:openssl-lib。

使用者可將下列幾行指令加入 ~/chat-app/WORKSPACE，為此目標新增依附元件：

local_repository(
    name = "my-ssl",
    path = "/home/user/ssl",
)

目標會將 @my-ssl//src:openssl-lib 指定為依附此程式庫的依附元件。

引數

屬性
name	Name; required 這個目標的專屬名稱。
path	String; required 本機存放區目錄的路徑。 這必須是包含存放區 WORKSPACE 檔案的目錄路徑。路徑可以是絕對路徑或相對於主要存放區的 WORKSPACE 檔案路徑。
repo_mapping	Dictionary: String -> String; optional 從本機存放區名稱到全域存放區名稱的字典。這樣就能控管這個存放區依附元件的工作區依附元件解析作業。 例如，項目 "@foo": "@bar" 宣告每當這個存放區依賴 "@foo" (例如 "@foo//some:target" 的依附元件) 時，實際上應在全域宣告的 "@bar" ("@bar//some:target") 中解析該依附元件。

new_local_repository

new_local_repository(name, build_file, build_file_content, path, repo_mapping, workspace_file, workspace_file_content)

允許將本機目錄轉換成 Bazel 存放區。這表示目前的存放區可以在檔案系統中的任何位置定義及使用目標。

這項規則會建立 Bazel 存放區，當中包含指定 BUILD 檔案和路徑的符號連結的 WORKSPACE 檔案與子目錄。建構檔案應建立相對於 path 的目標。如果目錄已包含 WORKSPACE 檔案和 BUILD 檔案，則可使用 local_repository 規則。

範例

假設目前的存放區是即時通訊用戶端，這個用戶端位於根目錄為 ~/chat-app。它想要使用在不同目錄定義的 SSL 程式庫：~/ssl。

使用者可以為安全資料傳輸層 (SSL) 程式庫 (~/chat-app/BUILD.my-ssl) 建立 BUILD 檔案，藉此新增依附元件：

java_library(
    name = "openssl",
    srcs = glob(['*.java'])
    visibility = ["//visibility:public"],
)

然後他們可以在 ~/chat-app/WORKSPACE 中加入下列指令列：

new_local_repository(
    name = "my-ssl",
    path = "/home/user/ssl",
    build_file = "BUILD.my-ssl",
)

這會建立連結至 /home/user/ssl 的 @my-ssl 存放區。 目標可以透過將 @my-ssl//:openssl 新增至目標依附元件，藉此依附這個程式庫。

您也可以使用 new_local_repository 加入單一檔案，而不只是目錄。舉例來說，假設您的 jar 檔案位於 /home/username/Downloads/piano.jar。只要將下列程式碼新增至 WORKSPACE 檔案，就可以將該檔案新增至建構作業中：

new_local_repository(
    name = "piano",
    path = "/home/username/Downloads/piano.jar",
    build_file = "BUILD.piano",
)

並且建立下列 BUILD.piano 檔案：

java_import(
    name = "play-music",
    jars = ["piano.jar"],
    visibility = ["//visibility:public"],
)

然後，目標即可依附於 @piano//:play-music 來使用 piano.jar。

引數

屬性
name	Name; required 這個目標的專屬名稱。
build_file	String; optional 要做為此目錄的 BUILD 檔案的檔案。 必須指定 build_file 或 build_file_content。 這個屬性是與主要工作區相關的標籤。檔案名稱不必是 BUILD，但也可以。(例如 BUILD.new-repo-name 之類的項目，可能很適合用來與存放區的實際 BUILD 檔案區分)。
build_file_content	String; optional 這個存放區的 BUILD 檔案內容。 必須指定 build_file 或 build_file_content。
path	String; required 本機檔案系統的路徑。 可以是絕對或相對於主要存放區的 WORKSPACE 檔案。
repo_mapping	Dictionary: String -> String; optional 從本機存放區名稱到全域存放區名稱的字典。這樣就能控管這個存放區依附元件的工作區依附元件解析作業。 例如，項目 "@foo": "@bar" 宣告每當這個存放區依賴 "@foo" (例如 "@foo//some:target" 的依附元件) 時，實際上應在全域宣告的 "@bar" ("@bar//some:target") 中解析該依附元件。
workspace_file	String; optional 要做為這個存放區 WORKSPACE 檔案的檔案。 只能指定 workspace_file 或 workspace_file_content，不能兩者並用。 這個屬性是與主要工作區相關的標籤。檔案名稱不一定要是 WORKSPACE，但也可以是。(類似 WORKSPACE.new-repo-name 或許可用於區分存放區與存放區的實際 WORKSPACE 檔案)。
workspace_file_content	String; optional 這個存放區的 WORKSPACE 檔案內容。 只能指定 workspace_file 或 workspace_file_content，不能兩者並用。