本頁面說明如何建立存放區規則,並提供詳細資料範例。
外部存放區是只能在 WORKSPACE
檔案中使用的規則,可在 Bazel 載入階段啟用非密封作業。每個外部存放區規則都會建立自己的工作區,具有專屬的 BUILD
檔案和構件。這些程式庫可用於依附第三方程式庫 (例如 Maven 封裝程式庫),也可產生專門執行 Bazel 主機的專用 BUILD
檔案。
建立存放區規則
在 .bzl
檔案中,使用 repository_rule 函式建立新的存放區規則,並將其儲存在全域變數中。
自訂存放區規則的使用方式與原生存放區規則相同。這類變數具有必要的 name
屬性,而建構檔案中顯示的每個目標都可以稱為 @<name>//package:target
,其中 <name>
是 name
屬性的值。
規則會在您明確建構或建構的依附元件時載入。在這種情況下,Bazel 會執行其 implementation
函式。此函式會說明如何建立存放區、其內容和 BUILD
檔案。
屬性
屬性是規則引數,例如 url
或 sha256
。定義存放區規則時,您必須列出屬性及其類型。
local_repository = repository_rule(
implementation=_impl,
local=True,
attrs={"path": attr.string(mandatory=True)})
如要存取屬性,請使用 repository_ctx.attr.<attribute_name>
。
所有 repository_rule
都有隱含定義的屬性 (就像建構規則一樣)。兩個隱含屬性為 name
(與建構規則相同) 和 repo_mapping
。存放區規則的名稱可透過 repository_ctx.name
存取。repo_mapping
的意義與原生存放區規則 local_repository
和 new_local_repository
的意義相同。
如果屬性名稱的開頭是 _
,此為私人屬性,使用者無法設定。
實作函式
每個存放區規則都需要 implementation
函式。其中包含規則的實際邏輯,且會在「載入階段」中嚴格執行。
這個函式只有一個輸入參數 repository_ctx
。此函式會傳回 None
,表示在使用指定的參數的情況下可以重現規則,或是傳回包含該規則參數的一組參數的字典,該規則會轉變成產生相同存放區的可重現規則。例如,追蹤 Git 存放區的規則可能傳回特定修訂版本 ID,而不是原先指定的浮動分支版本。
輸入參數 repository_ctx
可用來存取屬性值和非密封函式 (尋找二進位檔、執行二進位檔、在存放區建立檔案,或從網際網路下載檔案)。詳情請參閱程式庫。示例:
def _impl(repository_ctx):
repository_ctx.symlink(repository_ctx.attr.path, "")
local_repository = repository_rule(
implementation=_impl,
...)
實作函式何時執行?
如果存放區宣告為 local
,則依附元件圖表中的依附元件變更 (包括 WORKSPACE
檔案本身) 會導致執行實作函式。
如果實作函式要求的依附元件「缺少」,可以重新啟動。依附元件解析完畢後,系統會重新執行實作函式的開頭。為避免不必要的重新啟動 (成本高昂,因為必須重複存取網路存取權),系統會預先擷取標籤引數,前提是所有標籤引數都能解析為現有檔案。請注意,解析僅在函式執行期間建構的字串或標籤路徑,仍可能會導致重新啟動。
最後,針對非 local
存放區,只有下列依附元件的變更可能會導致重新啟動:
- 需要
.bzl
檔案才能定義存放區規則。 WORKSPACE
檔案中的存放區規則宣告。- 任何使用
repository_rule
函式environ
屬性宣告的環境變數值。您可以使用--action_env
標記在指令列中強制執行這些環境變數的值 (但此旗標會使該建構作業的所有動作失效)。 - 標籤使用及參照的任何檔案內容 (例如
//mypkg:label.txt
,而非mypkg/label.txt
)。
強制重新擷取外部存放區
有時候,外部存放區可能會在未變更其定義或依附元件的情況下變得過時。例如,存放區擷取來源可能會遵循第三方存放區的特定分支版本,而該分支版本有可用的新修訂版本。在這種情況下,您可以呼叫 bazel sync
,要求 bazel 以無條件重新擷取所有外部存放區。
此外,有些規則會檢查本機電腦,如果本機電腦升級,資料可能會過時。在這裡,您可以要求 bazel 只重新擷取 repository_rule
定義設有 configure
屬性的外部存放區,並使用 bazel sync --configure
。
示例
C++ 自動設定工具鍊:它會使用存放區規則來尋找本機 C++ 編譯器、環境和 C++ 編譯器支援的標記,藉此自動為 Bazel 建立 C++ 設定檔。
Go 存放區使用多個
repository_rule
來定義使用 Go 規則所需的依附元件清單。根據預設,rules_jvm_external 會建立名為
@maven
的外部存放區,這個存放區會為遞移依附元件樹狀結構中的每個 Maven 構件產生建構目標。