工作區規則可用來提取外部依附元件,通常是位於主要存放區以外的原始碼。
注意:除了原生工作區規則以外,Bazel 還嵌入了各種 Starlark 工作區規則,尤其是用於處理網路託管 Git 存放區或封存規則的規則。
規則
繫結
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 |
此目標的專屬名稱。 |
actual
|
這個目標必須存在,但可以是任何類型的規則 (包括繫結)。 如果省略這項屬性,在 |
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
|
舉例來說,項目 |
new_local_repository
new_local_repository(name, build_file, build_file_content, path, repo_mapping, workspace_file, workspace_file_content)
允許將本機目錄轉換為 Bazel 存放區。這表示目前的存放區可以從檔案系統中的任何位置定義及使用目標。
這項規則會建立 WORKSPACE 檔案,以及包含指定 BUILD 檔案和路徑的符號連結,來建立 Bazel 存放區。建構檔案應建立相對於 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", )
這項操作會建立 @my-ssl
存放區,其符號連結至 /home/user/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
|
必須指定 build_file 或 build_file_content。 這個屬性是與主要工作區相對的標籤。檔案不必命名為 BUILD,但可以將其命名為。(BUILD.new-repo-name 之類的項目可能適合用於區別它與存放區的實際 BUILD 檔案)。 |
build_file_content
|
必須指定 build_file 或 build_file_content。 |
path
|
這可以是絕對值或相對於主要存放區 WORKSPACE 檔案。 |
repo_mapping
|
舉例來說,項目 |
workspace_file
|
只能指定 workspace_file 或 workspace_file_content 的內容,但只能擇一。 這個屬性是與主要工作區相對的標籤。檔案不必命名為 WORKSPACE,但可以將其命名為。(例如 WORKSPACE.new-repo-name 和其他項目可能就適合用於與存放區實際 WORKSPACE 檔案)。 |
workspace_file_content
|
只能指定 workspace_file 或 workspace_file_content 的內容,但只能擇一。 |