工作區、套件和目標

7.3 · 7.2 · 7.1 · 7.0 · 6.5

Bazel 會根據在名為工作區的目錄樹狀結構中排序的原始碼建構軟體。工作區中的來源檔案會以套件巢狀階層的方式排序,其中每個套件都是一個目錄,內含一組相關來源檔案和一個 BUILD 檔案。BUILD 檔案會指定可從來源建立哪些軟體輸出內容。

工作區

工作區是檔案系統中的目錄樹狀結構,內含要建構的軟體來源檔案。每個工作區都有一個名為 WORKSPACE 的文字檔案,可能為空白,也可能包含建構輸出內容所需的外部依附元件參照。

包含名為 WORKSPACE 的檔案的目錄會視為工作區的根目錄。因此,Bazel 會忽略在包含 WORKSPACE 檔案的子目錄中,以根目錄為根目錄的工作區中的任何目錄樹狀結構,因為這些目錄會形成另一個工作區。

Bazel 也支援 WORKSPACE.bazel 檔案做為 WORKSPACE 檔案的別名。如果兩個檔案都存在,系統會使用 WORKSPACE.bazel

存放區

程式碼會整理在存放區中。包含 WORKSPACE 檔案的目錄是主要存放區的根目錄,也稱為 @。其他 (外部) 存放區則是在 WORKSPACE 檔案中使用工作區規則定義。

與 Bazel 一起提供的工作區規則已記錄在Build Encyclopedia的「Workspace Rules」一節,以及內嵌 Starlark 存放區規則的說明文件中。

由於外部存放區本身就是存放區,因此通常也會包含 WORKSPACE 檔案。不過,Bazel 會忽略這些額外的 WORKSPACE 檔案。請特別注意,系統不會自動新增間接依附的存放區。

套件

存放區中程式碼組織的主要單位是套件。套件是一組相關檔案,以及如何使用這些檔案產生輸出項目的規格。

套件的定義為包含 BUILD (或 BUILD.bazel) 檔案的目錄。套件包含其目錄中的所有檔案,以及位於其下的所有子目錄,除了本身包含 BUILD 檔案的子目錄以外。根據這個定義,任何檔案或目錄都不能同時屬於兩個不同的套件。

舉例來說,在下列目錄樹狀結構中,有兩個套件 my/app 和子套件 my/app/tests。請注意,my/app/data 不是套件,而是屬於套件 my/app 的資料夾。

src/my/app/BUILD
src/my/app/app.cc
src/my/app/data/input.txt
src/my/app/tests/BUILD
src/my/app/tests/test.cc

目標

套件是目標的容器,這些目標是在套件的 BUILD 檔案中定義。大多數的目標都屬於兩種主要類型之一:檔案規則

檔案可進一步分為兩種。原始檔案通常是由人手寫入,並提交至存放區。產生的檔案 (有時稱為衍生檔案或輸出檔案) 不會簽入,而是由來源檔案產生。

第二種目標會使用規則宣告。每個規則執行個體都會指定一組輸入與一組輸出檔案之間的關係。規則的輸入內容可能是來源檔案,但也可能是其他規則的輸出內容。

在大部分情況下,規則的輸入內容是來源檔案或產生的檔案,不會有任何影響;重要的只是該檔案的內容。因此,您可以輕鬆將複雜的原始檔案,替換為規則產生的檔案,例如當手動維護高度結構化的檔案變得太過繁重,而有人編寫程式來衍生檔案時。這個檔案的使用者無須進行任何變更。反之,產生的檔案很容易被僅有本機變更的來源檔案取代。

規則的輸入內容也可能包含其他規則。這類關係的精確意義通常十分複雜且與語言或規則有關,但直覺上很簡單:C++ 程式庫規則 A 可能有另一個 C++ 程式庫規則 B 用於輸入。這個依附元件的效果是,A 在編譯期間可使用 B 的標頭檔案、B 的符號可在連結期間供 A 使用,而 B 的執行階段資料可在執行期間供 A 使用。

所有規則的變異數是,由規則產生的檔案一律會與規則本身屬於相同的套件;無法將檔案產生至其他套件。不過,規則的輸入內容來自其他套件並不少見。

套件群組是一組套件,目的是限制特定規則的存取權。套件群組是由 package_group 函式定義。它們有三個屬性:所含套件清單、名稱和所含其他套件群組。參照這些規則的唯一方法,只能從規則的 visibility 屬性或 package 函式的 default_visibility 屬性取得;它們不會產生或使用檔案。詳情請參閱 package_group 說明文件

標籤