標籤是目標的 ID。完整標準中的一般標籤 表單看起來會像這樣:
@@myrepo//my/app/main:app_binary
標籤的第一個部分是存放區名稱 @@myrepo
。雙重 @
語法表示這是工作區中唯一的標準存放區名稱。無論標籤出現在何種情境下,只要含有標準存放區名稱,就能明確識別目標。
標準存放區名稱通常是混凝土字串,看起來像
@@rules_java~7.1.0~toolchains~local_jdk
。最常見的是
您會看到 apparent 存放區名稱的標籤
如下所示:
@myrepo//my/app/main:app_binary
唯一的差異在於,Repo 名稱的前置字串為 @
而非兩個。這指的是顯示名稱為 myrepo
的存放區,實際名稱可能不同
做出決定
在一般情況下,如果標籤參照的是使用該標籤的相同存放區,則可以省略存放區名稱部分。因此,在 @@myrepo
中的第一個
標籤通常寫成
//my/app/main:app_binary
標籤的第二部分是未限定的套件名稱 my/app/main
,也就是相對於存放區根目錄的套件路徑。存放區名稱
完整套件名稱的格式
@@myrepo//my/app/main
。標籤提及同一標籤時
這個套件所使用的套件名稱,以及套件名稱 (可選擇冒號)
可以省略因此,在 @@myrepo//my/app/main
中,這個標籤可以使用下列任一方式編寫:
app_binary
:app_binary
基於慣例,系統會在檔案中省略冒號。 但基於規則而保留,就不具意義。
在冒號後方標籤中的一部分,app_binary
是不符資格的目標
名稱。如果與套件路徑的最後一個元件相符,則可省略該元件和冒號。因此,這兩個標籤的作用相同:
//my/app/lib
//my/app/lib:lib
套件子目錄中的檔案目標名稱為檔案的路徑
則是相對於套件根目錄 (包含 BUILD
檔案的目錄)。所以
這個檔案位於存放區的 my/app/main/testdata
子目錄中:
//my/app/main:testdata/input.txt
//my/app
和 @@some_repo//my/app
這類字串有兩種含義,取決於使用時的情況:當 Bazel 預期標籤時,分別代表 //my/app:app
和 @@some_repo//my/app:app
。不過當 Bazel
需要有套件 (例如 package_group
規格中的套件),它們會參照
或含有該標籤的套件
BUILD
檔案常見的錯誤是使用 //my/app
參照套件,或參照套件中的「所有」目標,但實際上並非如此。別忘了
相當於 //my/app:app
,所以這會將 app
目標命名為 my/app
目前存放區的套件
不過,建議您使用 //my/app
參照套件,詳情請參閱
package_group
或 .bzl
檔案的規格,因為這顯然
表示套件名稱為絕對名稱,且位於頂層
相對標籤無法用於參照其他套件中的目標;這個
在這種情況下,一律必須指定存放區 ID 和套件名稱。
舉例來說,如果來源樹狀結構包含套件 my/app
和套件 my/app/testdata
(這兩個目錄各自都有 BUILD
檔案),後者套件就會包含名為 testdepot.zip
的檔案。這裡
是兩種錯誤參照方式
//my/app:BUILD
:
錯誤 - testdata
是不同套件,因此您無法使用相對路徑
testdata/testdepot.zip
正確 - 以完整路徑參照 testdata
//my/app/testdata:testdepot.zip
以 @@//
開頭的標籤是主要存放區的參照項目,即使來自外部存放區,仍可正常運作。因此,從外部存放區參照 @@//a/b/c
時,它與 //a/b/c
不同。前者返回主要存放區,後者則是後者
在外部存放區內尋找 //a/b/c
。
在主要存放區中撰寫參照主要存放區中目標的規則時,這一點尤其重要,且會從外部存放區使用。
如需瞭解各種參照目標的方式,請參閱 目標模式。
標籤的語彙規格
標籤語法不建議使用具有特殊意義的中繼字元 殼層這有助於避免不慎引用的問題,並可更輕鬆地建構用於操控標籤的工具和指令碼,例如 Bazel 查詢語言。
請參閱下方允許的目標名稱詳細資料。
目標名稱:package-name:target-name
target-name
是套件中的目標名稱。規則名稱是 BUILD
檔案中規則宣告中 name
屬性的值;檔案名稱是相對於包含 BUILD
檔案的目錄的路徑名稱。
目標名稱必須完全由 a
到 z
集合中的字元組成,
A
–Z
、0
–9
,以及標點符號符號 !%-@^_"#$&'()*-+,;<=>?[]{|}~/.
。
檔案名稱必須是標準格式的相對路徑名稱,也就是說,必須
開頭或結尾不得為斜線 (例如 /foo
和 foo/
是
禁用) 且不得包含多個連續斜線做為路徑分隔符
(例如 foo//bar
)。同樣地,進階參照 (..
) 和
禁止參照目前的目錄參照 (./
)。
錯誤:請勿使用 `..` 參照其他套件中的檔案
正確:使用 `//package-name:filename`
雖然檔案目標名稱使用 /
是很常見的做法,但請避免使用
/
。尤其是當標籤的簡短形式
否則可能會混淆讀者標籤 //foo/bar/wiz
一律是 //foo/bar/wiz:wiz
的簡寫,即使沒有此類套件 foo/bar/wiz
也一樣;即使目標存在,也不會參照 //foo:bar/wiz
。
但在某些情況下,斜線非常方便,或 有時甚至有必要例如,特定規則的名稱必須符合 其主要來源檔案,可能位於套件的子目錄中。
套件名稱 - //package-name:target-name
套件名稱是指包含 BUILD
檔案的目錄名稱,相對於包含的存放區頂層目錄。例如:my/app
。
套件名稱必須完全由模型集中的字元組成
A
-Z
、a
–z
、0
–9
、/
、-
、.
、@
和_
,
開頭是斜線
如果語言具有對其模組系統有意義的目錄結構 (例如 Java),請務必選擇在該語言中有效的識別項做為目錄名稱。
雖然 Bazel 支援工作區根套件中的目標 (例如
//:foo
),建議您保留該套件,以便所有有意義的套件
具有描述性名稱
套件名稱不得包含子字串 //
,結尾不得為斜線。
規則
規則會指定輸入和輸出之間的關係,以及建構輸出的步驟。規則可以是許多不同類型 (有時稱為規則類別) 之一,可產生編譯的執行檔和程式庫、測試執行檔和其他支援的輸出內容,如建構百科全書所述。
BUILD
檔案會透過叫用規則來宣告目標。
在以下範例中,您會看到目標 my_app
的宣告
使用 cc_binary
規則建立政策
cc_binary(
name = "my_app",
srcs = ["my_app.cc"],
deps = [
"//absl/base",
"//absl/strings",
],
)
每個規則叫用都有 name
屬性 (必須是有效的目標名稱),可在 BUILD
檔案的套件中宣告目標。
每項規則都有一組屬性;適用於特定規則的屬性,以及每項屬性的意義和語義,都是規則類型的函式;請參閱Build Encyclopedia,瞭解規則和相應屬性的清單。每個屬性都有名稱和類型。屬性可有的常見類型包括整數、標籤、標籤清單、字串、字串清單、輸出標籤、輸出標籤清單。非 請在每項規則中指定所有屬性因此,屬性會形成字典,從鍵 (名稱) 到選用型別的值。
許多規則中的 srcs
屬性類型為「標籤清單」;如果有值,則為標籤清單,每個標籤都是這個規則的輸入目標名稱。
在某些情況下,規則類型的名稱會有所不同,但更有趣的是規則產生的檔案名稱,這也是 genrules 的情況。詳情請參閱「一般規則:genrule」。
在其他情況下,名稱則具有重要意義:舉例來說,對於 *_binary
和 *_test
規則,規則名稱會決定建構作業產生的可執行檔名稱。
這張含有目標的有向非循環圖稱為「目標圖表」,或 建構依附元件圖表,也是要用來 Bazel Query Tool 就會運作,
目標 | 建構檔案 |