工作區規則

回報問題 查看來源

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

注意：除了原生工作區規則之外，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 套件不是「normal」套件：沒有外部/ 目錄，因此可視為包含所有繫結目標的「虛擬套件」。

示例

如要提供目標別名，請在 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	名稱 (必填) 此目標的專屬名稱。
actual	標籤；預設值為 None 要別名的目標。 這個目標必須存在，但可以是任何類型的規則 (包括繫結)。 如果省略這項屬性，在 //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	名稱 (必填) 此目標的專屬名稱。
path	字串；必填 本機存放區目錄的路徑。 這必須是包含存放區 WORKSPACE 檔案的目錄路徑。路徑可以是絕對路徑，也可以是主要存放區的 WORKSPACE 檔案相對路徑。
repo_mapping	字典：字串 -> 字串；預設值為 {} 從本機存放區名稱到全域存放區名稱的字典。這樣一來，您就能控管這個存放區的依附元件的工作區依附元件解析方式。 舉例來說，項目 "@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 存放區，方法是建立 WORKSPACE 檔案和子目錄，其中包含指定 BUILD 檔案和路徑的符號連結。建構檔案應建立相對於 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，包含單一檔案，而不只是目錄。舉例來說，假設您有 /home/username/Downloads/piano.jar 有 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	名稱 (必填) 此目標的專屬名稱。
build_file	名稱；預設值為 None 要當做這個目錄 BUILD 檔案的檔案。 必須指定 build_file 或 build_file_content。 這個屬性是與主要工作區相關的標籤。檔案不必命名為 BUILD，但也有可能具備。(類似 BUILD.new-repo-name 的名稱可能會很適合用來與存放區的實際 BUILD 檔案區分)。
build_file_content	字串；預設值為 "" 這個存放區的 BUILD 檔案內容。 必須指定 build_file 或 build_file_content。
path	字串；必填 本機檔案系統中的路徑。 可以是絕對值或相對於主要存放區的 WORKSPACE 檔案。
repo_mapping	字典：字串 -> 字串；預設值為 {} 從本機存放區名稱到全域存放區名稱的字典。這樣一來，您就能控管這個存放區的依附元件的工作區依附元件解析方式。 舉例來說，項目 "@foo": "@bar" 宣告只要這個存放區依附 "@foo" (例如 "@foo//some:target" 的依附元件)，實際上應在全域宣告的 "@bar" ("@bar//some:target") 中解析該依附元件。
workspace_file	名稱；預設值為 None 要做為這個存放區 WORKSPACE 檔案的檔案。 可以指定 workspace_file 或 workspace_file_content 屬性，但不能兩者都指定。 這個屬性是與主要工作區相關的標籤。檔案不必命名為 WORKSPACE，但可以符合(例如 WORKSPACE.new-repo-name 的名稱可用來區分該存放區與存放區的實際 WORKSPACE 檔案)。
workspace_file_content	字串；預設值為 "" 這個存放區的 WORKSPACE 檔案內容。 可以指定 workspace_file 或 workspace_file_content 屬性，但不能兩者都指定。