Java 規則

Nightly · 8.4 · 8.3 · 8.2 · 8.1 · 8.0 · 7.6

規則

java_binary

查看規則來源 
java_binary(name, deps, srcs, data, resources, args, classpath_resources, compatible_with, create_executable, deploy_env, deploy_manifest_lines, deprecation, distribs, env, exec_compatible_with, exec_properties, features, javacopts, jvm_flags, launcher, licenses, main_class, output_licenses, plugins, resource_jars, resource_strip_prefix, restricted_to, runtime_deps, stamp, tags, target_compatible_with, testonly, toolchains, use_launcher, use_testrunner, visibility)

建構 Java 封存檔 (「jar 檔案」)，以及與規則同名的包裝函式殼層指令碼。 包裝函式殼層指令碼使用的類別路徑包含二進位檔所依附的每個程式庫的 JAR 檔案。執行包裝函式殼層指令碼時，任何非空白的 JAVABIN 環境變數都會優先於透過 Bazel 的 --java_runtime_version 旗標指定的版本。

包裝函式指令碼接受多個專屬標記。如需包裝函式可接受的可設定旗標和環境變數清單，請參閱 //src/main/java/com/google/devtools/build/lib/bazel/rules/java/java_stub_template.txt。

隱含輸出目標

  • name.jar：Java 封存檔，內含與二進位檔直接依附元件對應的類別檔案和其他資源。
  • name-src.jar：包含來源的封存檔 (「source jar」)。
  • name_deploy.jar：適合部署的 Java 封存檔 (僅在明確要求時建構)。

    為規則建構 <name>_deploy.jar 目標會建立含有資訊清單的獨立 JAR 檔案，可透過 java -jar 指令或包裝函式指令碼的 --singlejar 選項執行。建議使用包裝函式指令碼，而非 java -jar，因為包裝函式指令碼也會將 JVM 旗標和選項傳遞至要載入的原生程式庫。

    部署 JAR 包含類別載入器找到的所有類別，該載入器會從頭到尾搜尋二進位的包裝函式指令碼路徑。此外，其中也包含依附元件所需的原生程式庫。這些檔案會在執行階段自動載入到 JVM 中。

    如果目標指定 launcher 屬性，_deploy.jar 就會是原生二進位檔，而非一般 JAR 檔案。這會包含啟動器，以及規則的所有原生 (C++) 依附元件，全部連結至靜態二進位檔。實際的 JAR 檔案位元組會附加至該原生二進位檔，建立包含可執行檔和 Java 程式碼的單一二進位檔 Blob。您可以直接執行產生的 JAR 檔案，就像執行任何原生二進位檔一樣。

  • name_deploy-src.jar：封存檔，內含從目標的遞移閉包收集的來源。這些類別會與 deploy.jar 中的類別相符，但如果 JAR 沒有相符的來源 JAR，則不在此限。

在沒有 srcs 的情況下，java_binary 規則不允許使用 deps 屬性；這類規則需要 runtime_deps 提供的 main_class。

以下程式碼片段說明常見錯誤：

java_binary(
    name = "DontDoThis",
    srcs = [
        ...,
        "GeneratedJavaFile.java",  # a generated .java file
    ],
    deps = [":generating_rule",],  # rule that generates that file
)

建議改用下列做法：

java_binary(
    name = "DoThisInstead",
    srcs = [
        ...,
        ":generating_rule",
    ],
)

引數

屬性
name

名稱：必填

這個目標的專屬名稱。


建議使用應用程式主要進入點的來源檔案名稱 (不含副檔名)。舉例來說，如果您的進入點名為 Main.java，則名稱可以是 Main。
deps

標籤清單；預設值為 []

要連結至目標的其他程式庫清單。 請參閱deps的一般註解，瞭解大多數建構規則定義的典型屬性。
srcs

標籤清單；預設值為 []

系統會處理來源檔案清單，然後建立目標。 這項屬性幾乎一律為必填，詳情請參閱下方的例外狀況。

編譯 .java 類型的來源檔案。如果是產生的 .java 檔案，建議您在此處放置產生規則的名稱，而非檔案本身的名稱。這不僅能提升可讀性，還能讓規則更能因應日後的變更：如果產生規則日後產生不同的檔案，您只需要修正一個位置，也就是產生規則的 outs。您不應在 deps 中列出產生規則，因為這是無運算。

系統會解壓縮並編譯 .srcjar 類型的來源檔案。(如果您需要使用 genrule 產生一組 .java 檔案，這就非常實用)。

規則：如果規則 (通常是 genrule 或 filegroup) 會產生上述任何檔案，這些檔案的使用方式與來源檔案相同。

除非 main_class 屬性在執行階段類別路徑中指定類別，或您指定 runtime_deps 引數，否則幾乎一律需要這個引數。
resources

標籤清單；預設值為 []

要納入 Java JAR 的資料檔案清單。

如果指定資源，這些資源會與編譯產生的檔案一起封裝在 JAR 中。.classjar 檔案內資源的位置取決於專案結構。Bazel 會先尋找 Maven 的標準目錄版面配置 (「src」目錄，後面接著「resources」目錄的孫子目錄)。如果找不到，Bazel 會尋找名為「java」或「javatests」的最上層目錄 (舉例來說，如果資源位於 <workspace root>/x/java/y/java/z，資源路徑會是 y/java/z)。這項啟發式方法無法覆寫，但 resource_strip_prefix 屬性可用於指定資源檔案的特定替代目錄。

資源可以是來源檔案或產生的檔案。

classpath_resources

標籤清單；預設值為 []

(除非別無他法，否則請勿使用這個選項)

必須位於 Java 樹狀結構根目錄的資源清單。這個屬性的唯一用途是支援第三方程式庫，這些程式庫要求其資源必須在類別路徑上找到，且完全是 "myconfig.xml"。由於命名空間衝突的風險，這項功能僅適用於二進位檔，不適用於程式庫。
create_executable

布林值；無法設定；預設值為 True

已淘汰，請改用 java_single_jar。
deploy_env

標籤清單；預設值為 []

其他 java_binary 目標的清單，代表這個二進位的部署環境。建構將由其他 java_binary 載入的外掛程式時，請設定這項屬性。
設定這個屬性會從這個二進位的執行階段類別路徑 (和部署 JAR) 中，排除這個二進位與 deploy_env 中指定目標之間共用的所有依附元件。
deploy_manifest_lines

字串清單；預設值為 []

要新增至為 *_deploy.jar 目標產生的 META-INF/manifest.mf 檔案的行清單。這個屬性的內容不會受到「建立變數」替代作業影響。
javacopts

字串清單；預設值為 []

這個程式庫的額外編譯器選項。 須遵守「製作變數」替代和 Bourne Shell 權杖化。

這些編譯器選項會在全域編譯器選項之後傳遞至 javac。
jvm_flags

字串清單；預設值為 []

要嵌入為執行這個二進位檔產生的包裝函式指令碼中的標記清單。 須遵守 $(location) 和「Make variable」替代，以及 Bourne shell 權杖化。

Java 二進位檔的包裝函式指令碼包含 CLASSPATH 定義 (可找出所有依附 JAR)，並叫用正確的 Java 解譯器。包裝函式指令碼產生的指令列包含主要類別的名稱，後方加上 "$@"，因此您可以在類別名稱後方傳遞其他引數。不過，如要讓 JVM 剖析引數，必須在指令列的類別名稱之前指定引數。系統會在列出類別名稱前，將 jvm_flags 的內容新增至包裝函式指令碼。

請注意，這個屬性不會影響 *_deploy.jar 輸出內容。
launcher

標籤；預設值為 None

指定用於執行 Java 程式的二進位檔，而非 JDK 隨附的一般 bin/java 程式。目標必須是 cc_binary。實作 Java Invocation API 的任何 cc_binary 都可以指定為這個屬性的值。

根據預設，Bazel 會使用正常的 JDK 啟動器 (bin/java 或 java.exe)。

相關的 --java_launcher Bazel 標記只會影響 和  目標，這些目標未指定 launcher 屬性。java_binaryjava_test

請注意，視您使用的是 JDK 啟動器或其他啟動器而定，系統會以不同方式建構原生 (C++、SWIG、JNI) 依附元件：

  • 如果您使用一般 JDK 啟動器 (預設)，系統會將原生依附元件建構為名為 {name}_nativedeps.so 的共用程式庫，其中 {name} 是這個 java_binary 規則的 name 屬性。在此設定中，連結器不會移除未使用的程式碼。
  • 如果您使用任何其他啟動器，原生 (C++) 依附元件會靜態連結至名為 {name}_nativedeps 的二進位檔，其中 {name} 是這個 java_binary 規則的 name 屬性。在這種情況下，連結器會從產生的二進位檔中移除任何認為未使用的程式碼，這表示除非 cc_library 目標指定 alwayslink = 1，否則僅透過 JNI 存取的任何 C++ 程式碼可能不會連結。

使用預設 JDK 啟動器以外的任何啟動器時，*_deploy.jar 輸出內容的格式會變更。詳情請參閱主要的 java_binary 文件。
main_class

字串；預設值為 ""

要用做進入點的 main() 方法所屬類別名稱。 如果規則使用這個選項，就不需要 srcs=[...] 清單。 因此，只要使用這個屬性，就能從已包含一或多個 main() 方法的 Java 程式庫建立可執行檔。

這項屬性的值是類別名稱，而非來源檔案。類別必須在執行階段提供：可由這項規則 (從 srcs) 編譯，或由直接或遞移依附元件 (透過 runtime_deps 或 deps) 提供。如果類別無法使用，二進位檔會在執行階段失敗；沒有建構時間檢查。

plugins

標籤清單；預設值為 []

在編譯時執行的 Java 編譯器外掛程式。每當建構這項規則時，系統就會執行這個屬性中指定的所有 java_plugin。程式庫也可能從使用 exported_plugins 的依附元件繼承外掛程式。外掛程式產生的資源會納入這項規則產生的 JAR 中。
resource_jars

標籤清單；預設值為 []

已淘汰：請改用 java_import 和 deps 或 runtime_deps。
resource_strip_prefix

字串；預設值為 ""

要從 Java 資源中移除的路徑前置字串。

如有指定，系統會從 resources 屬性中的每個檔案移除這個路徑前置字串。如果資源檔案不在這個目錄下，就會發生錯誤。如未指定 (預設)，資源檔案的路徑會根據與來源檔案的 Java 套件相同的邏輯決定。舉例來說，位於 stuff/java/foo/bar/a.txt 的來源檔案會位於 foo/bar/a.txt。
runtime_deps

標籤清單；預設值為 []

僅在執行階段提供給最終二進位檔或測試的程式庫。 與一般 deps 類似，這些項目會出現在執行階段類別路徑中，但與一般 deps 不同，這些項目不會出現在編譯階段類別路徑中。這裡應列出僅在執行階段需要的依附元件。出現在 runtime_deps 和 deps 中的目標應由依附元件分析工具忽略。
stamp

整數；預設值為 -1

是否要將建構資訊編碼為二進位檔。可能的值包括：
  • stamp = 1：一律將建構資訊蓋印到二進位檔中，即使是 --nostamp 建構作業也一樣。應避免使用這項設定，因為這可能會終止二進位檔的遠端快取，以及任何依附於該二進位檔的下游動作。
  • stamp = 0：一律以常數值取代建構資訊。這可提供良好的建構結果快取。
  • stamp = -1：建構資訊的嵌入作業由 --[no]stamp 標記控管。

除非依附元件有所變更，否則系統不會重建蓋章的二進位檔。
use_launcher

布林值；預設值為 True

二進位檔是否應使用自訂啟動器。

如果將這項屬性設為 false，系統會忽略這個目標的 launcher 屬性和相關的 --java_launcher 旗標。

use_testrunner

布林值；預設值為 False

使用測試執行器 (預設為 com.google.testing.junit.runner.BazelTestRunner) 類別做為 Java 程式的主要進入點，並將測試類別提供給測試執行器，做為 bazel.test_suite 系統屬性的值。您可以藉此覆寫預設行為，也就是針對 java_test 規則使用測試執行器，但不要針對 java_binary 規則使用。您可能不會想這麼做。其中一個用途是針對由其他規則叫用的 AllTest 規則 (例如在執行測試前設定資料庫)。AllTest 規則必須宣告為 java_binary，但仍應使用測試執行器做為主要進入點。 測試執行器類別的名稱可使用 main_class 屬性覆寫。

java_import

查看規則來源 
java_import(name, deps, data, compatible_with, constraints, deprecation, distribs, exec_compatible_with, exec_properties, exports, features, jars, licenses, neverlink, proguard_specs, restricted_to, runtime_deps, srcjar, tags, target_compatible_with, testonly, visibility)

這項規則允許使用預先編譯的 .jar 檔案做為 java_library 和 java_binary 規則的程式庫。

範例

    java_import(
        name = "maven_model",
        jars = [
            "maven_model/maven-aether-provider-3.2.3.jar",
            "maven_model/maven-model-3.2.3.jar",
            "maven_model/maven-model-builder-3.2.3.jar",
        ],
    )

引數

屬性
name

名稱：必填

這個目標的專屬名稱。
deps

標籤清單；預設值為 []

要連結至目標的其他程式庫清單。 請參閱 java_library.deps。
constraints

字串清單；無法設定；預設值為 []

以 Java 程式庫形式對這項規則施加的額外限制。
exports

標籤清單；預設值為 []

可供這項規則使用者存取的目標。 請參閱 java_library.exports。
jars

標籤清單 (必要)

提供給依附於這個目標的 Java 目標的 JAR 檔案清單。

布林值；預設值為 False

這個程式庫只能用於編譯，不能在執行階段使用。 如果程式庫會在執行期間由執行階段環境提供，這個選項就非常實用。這類程式庫的範例包括 IDE 外掛程式適用的 IDE API，或是標準 JDK 上執行的任何項目適用的 tools.jar。
proguard_specs

標籤清單；預設值為 []

用來做為 Proguard 規格的檔案。 這些檔案會說明 Proguard 要使用的規格集。如果指定，系統會將這些項目加入依附於這個程式庫的任何 android_binary 目標。這裡包含的檔案只能有等冪規則，也就是 -dontnote、-dontwarn、assumenosideeffects，以及以 -keep 開頭的規則。其他選項只能顯示在 android_binary 的 proguard_specs 中，確保合併作業不會出現同義反覆的情況。
runtime_deps

標籤清單；預設值為 []

僅在執行階段提供給最終二進位檔或測試的程式庫。 請參閱 java_library.runtime_deps。
srcjar

標籤；預設值為 None

包含已編譯 JAR 檔案原始碼的 JAR 檔案。

java_library

查看規則來源 
java_library(name, deps, srcs, data, resources, compatible_with, deprecation, distribs, exec_compatible_with, exec_properties, exported_plugins, exports, features, javacopts, licenses, neverlink, plugins, proguard_specs, resource_jars, resource_strip_prefix, restricted_to, runtime_deps, tags, target_compatible_with, testonly, visibility)

這項規則會將來源編譯並連結至 .jar 檔案。

隱含輸出目標

  • libname.jar：包含類別檔案的 Java 封存檔。
  • libname-src.jar：包含來源的封存檔 (「source jar」)。

引數

屬性
name

名稱：必填

這個目標的專屬名稱。
deps

標籤清單；預設值為 []

要連結至這個程式庫的程式庫清單。 如要查看一般註解，請參閱「deps」的「大多數建構規則定義的典型屬性」。

deps 中列出的 java_library 規則所建構的 JAR 會位於這項規則的編譯時間類路徑中。此外，系統也會將 deps、runtime_deps 和 exports 的遞移閉包放在執行階段類別路徑中。

相較之下，data 屬性中的目標會納入執行檔，但不會納入編譯時間或執行階段類別路徑。
srcs

標籤清單；預設值為 []

系統會處理來源檔案清單，然後建立目標。 這項屬性幾乎一律為必填，詳情請參閱下方的例外狀況。

編譯 .java 類型的來源檔案。如果是產生的 .java 檔案，建議您在此處放置產生規則的名稱，而非檔案本身的名稱。這不僅能提升可讀性，還能讓規則更能因應日後的變更：如果產生規則日後產生不同的檔案，您只需要修正一個位置，也就是產生規則的 outs。您不應在 deps 中列出產生規則，因為這是無運算。

系統會解壓縮並編譯 .srcjar 類型的來源檔案。(如果您需要使用 genrule 產生一組 .java 檔案，這就非常實用)。

規則：如果規則 (通常是 genrule 或 filegroup) 會產生上述任何檔案，這些檔案的使用方式與來源檔案相同。

除非 main_class 屬性在執行階段類別路徑中指定類別，或您指定 runtime_deps 引數，否則幾乎一律需要這個引數。
data

標籤清單；預設值為 []

這個程式庫在執行階段所需的檔案清單。 如要查看一般註解，請參閱「data」的「大多數建構規則定義的典型屬性」。

建構 java_library 時，Bazel 不會將這些檔案放在任何位置；如果 data 檔案是產生的檔案，Bazel 就會產生這些檔案。建構依附於此 java_library 的測試時，Bazel 會將 data 檔案複製或連結到執行檔案區域。
resources

標籤清單；預設值為 []

要納入 Java JAR 的資料檔案清單。

如果指定資源，這些資源會與編譯產生的檔案一起封裝在 JAR 中。.classjar 檔案內資源的位置取決於專案結構。Bazel 會先尋找 Maven 的標準目錄版面配置 (「src」目錄，後面接著「resources」目錄的孫子目錄)。如果找不到，Bazel 會尋找名為「java」或「javatests」的最上層目錄 (舉例來說，如果資源位於 <workspace root>/x/java/y/java/z，資源路徑會是 y/java/z)。這項啟發式方法無法覆寫，但 resource_strip_prefix 屬性可用於指定資源檔案的特定替代目錄。

資源可以是來源檔案或產生的檔案。

exported_plugins

標籤清單；預設值為 []

要匯出至直接依附於這個程式庫的程式庫的 java_plugin 清單 (例如註解處理器)。

指定的 java_plugin 清單會套用至直接依附這個程式庫的任何程式庫，就像該程式庫已在 plugins 中明確宣告這些標籤一樣。

exports

標籤清單；預設值為 []

匯出的程式庫。

在此列出規則後，父項規則就能使用這些規則，就像父項明確依附於這些規則一樣。這不適用於一般 (非匯出) deps。

摘要：如果規則 X 可以存取 Y 中的程式碼。以下舉例說明。

假設 A 依附於 B，而 B 依附於 C。在本例中，C 是 A 的遞移依附元件，因此變更 C 的來源並重建 A 時，系統會正確重建所有項目。不過，A 無法在 C 中使用類別。如要允許這種情況，A 必須在 deps 中宣告 C，或者 B 可以在其 (B 的) exports 屬性中宣告 C，讓 A (和可能依附於 A 的任何項目) 更輕鬆地執行這項操作。

所有直接上層規則都可使用匯出程式庫的結尾。舉例來說，A 依附於 B，B 依附於 C 和 D，且會匯出 C 但不會匯出 D。現在 A 可以存取 C，但無法存取 D。現在，如果 C 和 D 匯出一些程式庫 (分別為 C' 和 D')，A 只能存取 C'，無法存取 D'。

重要事項：匯出的規則並非一般依附元件。延續先前的例子，如果 B 匯出 C 並想使用 C，也必須在自己的 deps 中列出 C。
javacopts

字串清單；預設值為 []

這個程式庫的額外編譯器選項。 須遵守「製作變數」替代和 Bourne Shell 權杖化。

這些編譯器選項會在全域編譯器選項之後傳遞至 javac。

布林值；預設值為 False

這個程式庫是否只應用於編譯，而不應在執行階段使用。 如果程式庫會在執行期間由執行階段環境提供，這個選項就非常實用。這類程式庫的範例包括 IDE 外掛程式的 IDE API，或是標準 JDK 上執行的任何項目適用的 tools.jar。

請注意，根據 Java 語言規格 (例如 neverlink = 1static final 常數 (String 或基本型別)。因此，執行階段程式庫與編譯程式庫完全相同時，是較好的使用情境。

如果執行階段程式庫與編譯程式庫不同，您必須確保只有在 JLS 禁止編譯器內嵌的位置不同 (且必須適用於所有未來版本的 JLS)。
plugins

標籤清單；預設值為 []

在編譯時執行的 Java 編譯器外掛程式。每當建構這項規則時，系統就會執行這個屬性中指定的所有 java_plugin。程式庫也可能從使用 exported_plugins 的依附元件繼承外掛程式。外掛程式產生的資源會納入這項規則產生的 JAR 中。
proguard_specs

標籤清單；預設值為 []

用來做為 Proguard 規格的檔案。 這些檔案會說明 Proguard 要使用的規格集。如果指定，系統會將這些項目加入依附於這個程式庫的任何 android_binary 目標。這裡包含的檔案只能有等冪規則，也就是 -dontnote、-dontwarn、assumenosideeffects，以及以 -keep 開頭的規則。其他選項只能顯示在 android_binary 的 proguard_specs 中，確保合併作業不會出現同義反覆的情況。
resource_jars

標籤清單；預設值為 []

已淘汰：請改用 java_import 和 deps 或 runtime_deps。
resource_strip_prefix

字串；預設值為 ""

要從 Java 資源中移除的路徑前置字串。

如有指定，系統會從 resources 屬性中的每個檔案移除這個路徑前置字串。如果資源檔案不在這個目錄下，就會發生錯誤。如未指定 (預設)，資源檔案的路徑會根據與來源檔案的 Java 套件相同的邏輯決定。舉例來說，位於 stuff/java/foo/bar/a.txt 的來源檔案會位於 foo/bar/a.txt。
runtime_deps

標籤清單；預設值為 []

僅在執行階段提供給最終二進位檔或測試的程式庫。 與一般 deps 類似，這些項目會出現在執行階段類別路徑中，但與一般 deps 不同，這些項目不會出現在編譯階段類別路徑中。這裡應列出僅在執行階段需要的依附元件。出現在 runtime_deps 和 deps 中的目標應由依附元件分析工具忽略。

java_lite_proto_library

查看規則來源 
java_lite_proto_library(name, deps, data, compatible_with, deprecation, distribs, exec_compatible_with, exec_properties, features, licenses, restricted_to, tags, target_compatible_with, testonly, visibility)

java_lite_proto_library 會從 .proto 檔案生成 Java 程式碼。

deps 必須指向 proto_library 規則。

範例：

java_library(
    name = "lib",
    deps = [":foo"],
)

java_lite_proto_library(
    name = "foo",
    deps = [":bar"],
)

proto_library(
    name = "bar",
)

引數

屬性
name

名稱：必填

這個目標的專屬名稱。
deps

標籤清單；預設值為 []

要產生 Java 程式碼的規則清單 proto_library。

java_proto_library

查看規則來源 
java_proto_library(name, deps, data, compatible_with, deprecation, distribs, exec_compatible_with, exec_properties, features, licenses, restricted_to, tags, target_compatible_with, testonly, visibility)

java_proto_library 會從 .proto 檔案生成 Java 程式碼。

deps 必須指向 proto_library 規則。

範例：

java_library(
    name = "lib",
    deps = [":foo_java_proto"],
)

java_proto_library(
    name = "foo_java_proto",
    deps = [":foo_proto"],
)

proto_library(
    name = "foo_proto",
)

引數

屬性
name

名稱：必填

這個目標的專屬名稱。
deps

標籤清單；預設值為 []

要產生 Java 程式碼的規則清單 proto_library。

java_test

查看規則來源 
java_test(name, deps, srcs, data, resources, args, classpath_resources, compatible_with, create_executable, deploy_manifest_lines, deprecation, distribs, env, env_inherit, exec_compatible_with, exec_properties, features, flaky, javacopts, jvm_flags, launcher, licenses, local, main_class, plugins, resource_jars, resource_strip_prefix, restricted_to, runtime_deps, shard_count, size, stamp, tags, target_compatible_with, test_class, testonly, timeout, toolchains, use_launcher, use_testrunner, visibility)

java_test() 規則會編譯 Java 測試。測試是測試程式碼周圍的二進位封裝函式。系統會叫用測試執行器的主要方法，而非編譯主要類別。

隱含輸出目標

  • name.jar：Java 封存檔。
  • name_deploy.jar：適合部署的 Java 封存檔。(只有在明確要求時才會建構)。詳情請參閱 name_deploy.jar 輸出內容的說明。java_binary

請參閱 java_binary() 引數一節。這項規則也支援所有測試規則 (*_test) 的通用屬性。

範例

java_library(
    name = "tests",
    srcs = glob(["*.java"]),
    deps = [
        "//java/com/foo/base:testResources",
        "//java/com/foo/testing/util",
    ],
)

java_test(
    name = "AllTests",
    size = "small",
    runtime_deps = [
        ":tests",
        "//util/mysql",
    ],
)

引數

屬性
name

名稱：必填

這個目標的專屬名稱。
deps

標籤清單；預設值為 []

要連結至目標的其他程式庫清單。 請參閱deps的一般註解，瞭解大多數建構規則定義的典型屬性。
srcs

標籤清單；預設值為 []

系統會處理來源檔案清單，然後建立目標。 這項屬性幾乎一律為必填，詳情請參閱下方的例外狀況。

編譯 .java 類型的來源檔案。如果是產生的 .java 檔案，建議您在此處放置產生規則的名稱，而非檔案本身的名稱。這不僅能提升可讀性，還能讓規則更能因應日後的變更：如果產生規則日後產生不同的檔案，您只需要修正一個位置，也就是產生規則的 outs。您不應在 deps 中列出產生規則，因為這是無運算。

系統會解壓縮並編譯 .srcjar 類型的來源檔案。(如果您需要使用 genrule 產生一組 .java 檔案，這就非常實用)。

規則：如果規則 (通常是 genrule 或 filegroup) 會產生上述任何檔案，這些檔案的使用方式與來源檔案相同。

除非 main_class 屬性在執行階段類別路徑中指定類別，或您指定 runtime_deps 引數，否則幾乎一律需要這個引數。
resources

標籤清單；預設值為 []

要納入 Java JAR 的資料檔案清單。

如果指定資源，這些資源會與編譯產生的檔案一起封裝在 JAR 中。.classjar 檔案內資源的位置取決於專案結構。Bazel 會先尋找 Maven 的標準目錄版面配置 (「src」目錄，後面接著「resources」目錄的孫子目錄)。如果找不到，Bazel 會尋找名為「java」或「javatests」的最上層目錄 (舉例來說，如果資源位於 <workspace root>/x/java/y/java/z，資源路徑會是 y/java/z)。這項啟發式方法無法覆寫，但 resource_strip_prefix 屬性可用於指定資源檔案的特定替代目錄。

資源可以是來源檔案或產生的檔案。

classpath_resources

標籤清單；預設值為 []

(除非別無他法，否則請勿使用這個選項)

必須位於 Java 樹狀結構根目錄的資源清單。這個屬性的唯一用途是支援第三方程式庫，這些程式庫要求其資源必須在類別路徑上找到，且完全是 "myconfig.xml"。由於命名空間衝突的風險，這項功能僅適用於二進位檔，不適用於程式庫。
create_executable

布林值；無法設定；預設值為 True

已淘汰，請改用 java_single_jar。
deploy_manifest_lines

字串清單；預設值為 []

要新增至為 *_deploy.jar 目標產生的 META-INF/manifest.mf 檔案的行清單。這個屬性的內容不會受到「建立變數」替代作業影響。
javacopts

字串清單；預設值為 []

這個程式庫的額外編譯器選項。 須遵守「製作變數」替代和 Bourne Shell 權杖化。

這些編譯器選項會在全域編譯器選項之後傳遞至 javac。
jvm_flags

字串清單；預設值為 []

要嵌入為執行這個二進位檔產生的包裝函式指令碼中的標記清單。 須遵守 $(location) 和「Make variable」替代，以及 Bourne shell 權杖化。

Java 二進位檔的包裝函式指令碼包含 CLASSPATH 定義 (可找出所有依附 JAR)，並叫用正確的 Java 解譯器。包裝函式指令碼產生的指令列包含主要類別的名稱，後方加上 "$@"，因此您可以在類別名稱後方傳遞其他引數。不過，如要讓 JVM 剖析引數，必須在指令列的類別名稱之前指定引數。系統會在列出類別名稱前，將 jvm_flags 的內容新增至包裝函式指令碼。

請注意，這個屬性不會影響 *_deploy.jar 輸出內容。
launcher

標籤；預設值為 None

指定用於執行 Java 程式的二進位檔，而非 JDK 隨附的一般 bin/java 程式。目標必須是 cc_binary。實作 Java Invocation API 的任何 cc_binary 都可以指定為這個屬性的值。

根據預設，Bazel 會使用正常的 JDK 啟動器 (bin/java 或 java.exe)。

相關的 --java_launcher Bazel 標記只會影響 和  目標，這些目標未指定 launcher 屬性。java_binaryjava_test

請注意，視您使用的是 JDK 啟動器或其他啟動器而定，系統會以不同方式建構原生 (C++、SWIG、JNI) 依附元件：

  • 如果您使用一般 JDK 啟動器 (預設)，系統會將原生依附元件建構為名為 {name}_nativedeps.so 的共用程式庫，其中 {name} 是這個 java_binary 規則的 name 屬性。在此設定中，連結器不會移除未使用的程式碼。
  • 如果您使用任何其他啟動器，原生 (C++) 依附元件會靜態連結至名為 {name}_nativedeps 的二進位檔，其中 {name} 是這個 java_binary 規則的 name 屬性。在這種情況下，連結器會從產生的二進位檔中移除任何認為未使用的程式碼，這表示除非 cc_library 目標指定 alwayslink = 1，否則僅透過 JNI 存取的任何 C++ 程式碼可能不會連結。

使用預設 JDK 啟動器以外的任何啟動器時，*_deploy.jar 輸出內容的格式會變更。詳情請參閱主要的 java_binary 文件。
main_class

字串；預設值為 ""

要用做進入點的 main() 方法所屬類別名稱。 如果規則使用這個選項，就不需要 srcs=[...] 清單。 因此，只要使用這個屬性，就能從已包含一或多個 main() 方法的 Java 程式庫建立可執行檔。

這項屬性的值是類別名稱，而非來源檔案。類別必須在執行階段提供：可由這項規則 (從 srcs) 編譯，或由直接或遞移依附元件 (透過 runtime_deps 或 deps) 提供。如果類別無法使用，二進位檔會在執行階段失敗；沒有建構時間檢查。

plugins

標籤清單；預設值為 []

在編譯時執行的 Java 編譯器外掛程式。每當建構這項規則時，系統就會執行這個屬性中指定的所有 java_plugin。程式庫也可能從使用 exported_plugins 的依附元件繼承外掛程式。外掛程式產生的資源會納入這項規則產生的 JAR 中。
resource_jars

標籤清單；預設值為 []

已淘汰：請改用 java_import 和 deps 或 runtime_deps。
resource_strip_prefix

字串；預設值為 ""

要從 Java 資源中移除的路徑前置字串。

如有指定，系統會從 resources 屬性中的每個檔案移除這個路徑前置字串。如果資源檔案不在這個目錄下，就會發生錯誤。如未指定 (預設)，資源檔案的路徑會根據與來源檔案的 Java 套件相同的邏輯決定。舉例來說，位於 stuff/java/foo/bar/a.txt 的來源檔案會位於 foo/bar/a.txt。
runtime_deps

標籤清單；預設值為 []

僅在執行階段提供給最終二進位檔或測試的程式庫。 與一般 deps 類似，這些項目會出現在執行階段類別路徑中，但與一般 deps 不同，這些項目不會出現在編譯階段類別路徑中。這裡應列出僅在執行階段需要的依附元件。出現在 runtime_deps 和 deps 中的目標應由依附元件分析工具忽略。
stamp

整數；預設值為 0

是否要將建構資訊編碼為二進位檔。可能的值包括：
  • stamp = 1：一律將建構資訊蓋印到二進位檔中，即使是 --nostamp 建構作業也一樣。應避免使用這項設定，因為這可能會終止二進位檔的遠端快取，以及任何依附於該二進位檔的下游動作。
  • stamp = 0：一律以常數值取代建構資訊。這可提供良好的建構結果快取。
  • stamp = -1：建構資訊的嵌入作業由 --[no]stamp 標記控管。

除非依附元件有所變更，否則系統不會重建蓋章的二進位檔。
test_class

字串；預設值為 ""

測試執行工具要載入的 Java 類別。

根據預設，如果未定義這個引數，系統會使用舊版模式，並改用測試引數。設定 --nolegacy_bazel_java_test 標記，不要回溯至第一個引數。

這個屬性會指定要由這項測試執行的 Java 類別名稱。通常不需要設定這項屬性。如果省略這個引數，系統會使用目標的 name 和來源根目錄相對路徑推斷。如果測試位於已知來源根目錄之外，且 test_class 未設定，Bazel 就會回報錯誤。

如果是 JUnit3，測試類別必須是 junit.framework.TestCase 的子類別，或是必須有傳回 junit.framework.Test (或 Test 的子類別) 的公開靜態 suite() 方法。如果是 JUnit4，類別必須加上 org.junit.runner.RunWith 註解。

這個屬性可讓多個 java_test 規則共用相同的 Test (TestCase、TestSuite 等)。通常會將額外資訊傳遞至該屬性 (例如透過 jvm_flags=['-Dkey=value'])，以便在每個情況下改變其行為，例如執行不同的測試子集。這項屬性也允許在 javatests 樹狀結構以外使用 Java 測試。
use_launcher

布林值；預設值為 True

二進位檔是否應使用自訂啟動器。

如果將這項屬性設為 false，系統會忽略這個目標的 launcher 屬性和相關的 --java_launcher 旗標。

use_testrunner

布林值；預設值為 True

使用測試執行器 (預設為 com.google.testing.junit.runner.BazelTestRunner) 類別做為 Java 程式的主要進入點，並將測試類別提供給測試執行器，做為 bazel.test_suite 系統屬性的值。您可以藉此覆寫預設行為，也就是針對 java_test 規則使用測試執行器，但不要針對 java_binary 規則使用。您可能不會想這麼做。其中一個用途是針對由其他規則叫用的 AllTest 規則 (例如在執行測試前設定資料庫)。AllTest 規則必須宣告為 java_binary，但仍應使用測試執行器做為主要進入點。 測試執行器類別的名稱可使用 main_class 屬性覆寫。

java_package_configuration

查看規則來源 
java_package_configuration(name, data, compatible_with, deprecation, distribs, features, javacopts, licenses, packages, restricted_to, tags, target_compatible_with, testonly, visibility)

要套用至一組套件的設定。 設定可以新增至 java_toolchain.javacopts。

範例：

java_package_configuration(
    name = "my_configuration",
    packages = [":my_packages"],
    javacopts = ["-Werror"],
)

package_group(
    name = "my_packages",
    packages = [
        "//com/my/project/...",
        "-//com/my/project/testing/...",
    ],
)

java_toolchain(
    ...,
    package_configuration = [
        ":my_configuration",
    ]
)

引數

屬性
name

名稱：必填

這個目標的專屬名稱。
data

標籤清單；預設值為 []

此設定在執行階段需要的檔案清單。
javacopts

字串清單；預設值為 []

Java 編譯器標記。
packages

標籤清單；預設值為 []

應套用設定的 package_group 集。

java_plugin

查看規則來源 
java_plugin(name, deps, srcs, data, resources, compatible_with, deprecation, distribs, exec_compatible_with, exec_properties, features, generates_api, javacopts, licenses, neverlink, output_licenses, plugins, processor_class, proguard_specs, resource_jars, resource_strip_prefix, restricted_to, tags, target_compatible_with, testonly, visibility)

java_plugin 會定義 Bazel 執行的 Java 編譯器外掛程式。目前僅支援註解處理器這類外掛程式。java_library 或 java_binary 規則可以透過 plugins 屬性，依附外掛程式執行。java_library 也可以使用 exported_plugins，將外掛程式自動匯出至直接依附於該外掛程式的程式庫。

隱含輸出目標

  • libname.jar：Java 封存檔。

引數與 java_library 相同，但新增了 processor_class 引數。

引數

屬性
name

名稱：必填

這個目標的專屬名稱。
deps

標籤清單；預設值為 []

要連結至這個程式庫的程式庫清單。 如要查看一般註解，請參閱「deps」的「大多數建構規則定義的典型屬性」。

deps 中列出的 java_library 規則所建構的 JAR 會位於這項規則的編譯時間類路徑中。此外，系統也會將 deps、runtime_deps 和 exports 的遞移閉包放在執行階段類別路徑中。

相較之下，data 屬性中的目標會納入執行檔，但不會納入編譯時間或執行階段類別路徑。
srcs

標籤清單；預設值為 []

系統會處理來源檔案清單，然後建立目標。 這項屬性幾乎一律為必填，詳情請參閱下方的例外狀況。

編譯 .java 類型的來源檔案。如果是產生的 .java 檔案，建議您在此處放置產生規則的名稱，而非檔案本身的名稱。這不僅能提升可讀性，還能讓規則更能因應日後的變更：如果產生規則日後產生不同的檔案，您只需要修正一個位置，也就是產生規則的 outs。您不應在 deps 中列出產生規則，因為這是無運算。

系統會解壓縮並編譯 .srcjar 類型的來源檔案。(如果您需要使用 genrule 產生一組 .java 檔案，這就非常實用)。

規則：如果規則 (通常是 genrule 或 filegroup) 會產生上述任何檔案，這些檔案的使用方式與來源檔案相同。

除非 main_class 屬性在執行階段類別路徑中指定類別，或您指定 runtime_deps 引數，否則幾乎一律需要這個引數。
data

標籤清單；預設值為 []

這個程式庫在執行階段所需的檔案清單。 如要查看一般註解，請參閱「data」的「大多數建構規則定義的典型屬性」。

建構 java_library 時，Bazel 不會將這些檔案放在任何位置；如果 data 檔案是產生的檔案，Bazel 就會產生這些檔案。建構依附於此 java_library 的測試時，Bazel 會將 data 檔案複製或連結到執行檔案區域。
resources

標籤清單；預設值為 []

要納入 Java JAR 的資料檔案清單。

如果指定資源，這些資源會與編譯產生的檔案一起封裝在 JAR 中。.classjar 檔案內資源的位置取決於專案結構。Bazel 會先尋找 Maven 的標準目錄版面配置 (「src」目錄，後面接著「resources」目錄的孫子目錄)。如果找不到，Bazel 會尋找名為「java」或「javatests」的最上層目錄 (舉例來說，如果資源位於 <workspace root>/x/java/y/java/z，資源路徑會是 y/java/z)。這項啟發式方法無法覆寫，但 resource_strip_prefix 屬性可用於指定資源檔案的特定替代目錄。

資源可以是來源檔案或產生的檔案。

generates_api

布林值；預設值為 False

這個屬性會標記產生 API 程式碼的註解處理器。

如果規則使用 API 產生註解處理器，則其他依附於該規則的規則只能參照產生的程式碼，前提是這些規則的編譯動作排定在產生規則之後。啟用 --java_header_compilation 時，這項屬性會指示 Bazel 導入排程限制。

警告：這項屬性會影響建構效能，請僅在必要時使用。
javacopts

字串清單；預設值為 []

這個程式庫的額外編譯器選項。 須遵守「製作變數」替代和 Bourne Shell 權杖化。

這些編譯器選項會在全域編譯器選項之後傳遞至 javac。

布林值；預設值為 False

這個程式庫是否只應用於編譯，而不應在執行階段使用。 如果程式庫會在執行期間由執行階段環境提供，這個選項就非常實用。這類程式庫的範例包括 IDE 外掛程式的 IDE API，或是標準 JDK 上執行的任何項目適用的 tools.jar。

請注意，根據 Java 語言規格 (例如 neverlink = 1static final 常數 (String 或基本型別)。因此，執行階段程式庫與編譯程式庫完全相同時，是較好的使用情境。

如果執行階段程式庫與編譯程式庫不同，您必須確保只有在 JLS 禁止編譯器內嵌的位置不同 (且必須適用於所有未來版本的 JLS)。
output_licenses

授權類型；預設為 ["none"]

請參閱common attributes
plugins

標籤清單；預設值為 []

在編譯時執行的 Java 編譯器外掛程式。每當建構這項規則時，系統就會執行這個屬性中指定的所有 java_plugin。程式庫也可能從使用 exported_plugins 的依附元件繼承外掛程式。外掛程式產生的資源會納入這項規則產生的 JAR 中。
processor_class

字串；預設值為 ""

處理器類別是 Java 編譯器應做為註解處理工具進入點的類別完整合格型別。如果未指定，這項規則不會將註解處理工具提供給 Java 編譯器的註解處理作業，但其執行階段類別路徑仍會納入編譯器的註解處理工具路徑。(這項功能主要供容易出錯的外掛程式使用，這些外掛程式會使用 java.util.ServiceLoader 從註解處理工具路徑載入。)
proguard_specs

標籤清單；預設值為 []

用來做為 Proguard 規格的檔案。 這些檔案會說明 Proguard 要使用的規格集。如果指定，系統會將這些項目加入依附於這個程式庫的任何 android_binary 目標。這裡包含的檔案只能有等冪規則，也就是 -dontnote、-dontwarn、assumenosideeffects，以及以 -keep 開頭的規則。其他選項只能顯示在 android_binary 的 proguard_specs 中，確保合併作業不會出現同義反覆的情況。
resource_jars

標籤清單；預設值為 []

已淘汰：請改用 java_import 和 deps 或 runtime_deps。
resource_strip_prefix

字串；預設值為 ""

要從 Java 資源中移除的路徑前置字串。

如有指定，系統會從 resources 屬性中的每個檔案移除這個路徑前置字串。如果資源檔案不在這個目錄下，就會發生錯誤。如未指定 (預設)，資源檔案的路徑會根據與來源檔案的 Java 套件相同的邏輯決定。舉例來說，位於 stuff/java/foo/bar/a.txt 的來源檔案會位於 foo/bar/a.txt。

java_runtime

查看規則來源 
java_runtime(name, srcs, compatible_with, default_cds, deprecation, distribs, features, hermetic_srcs, java, java_home, lib_ct_sym, lib_modules, licenses, restricted_to, tags, target_compatible_with, testonly, version, visibility)

指定 Java 執行階段的設定。

範例：

java_runtime(
    name = "jdk-9-ea+153",
    srcs = glob(["jdk9-ea+153/**"]),
    java_home = "jdk9-ea+153",
)

引數

屬性
name

名稱：必填

這個目標的專屬名稱。
srcs

標籤清單；預設值為 []

執行階段中的所有檔案。
default_cds

標籤；預設值為 None

密封式 java_runtime 的預設 CDS 封存檔。如果為 java_binary 目標啟用密封功能，且目標未指定 classlist 屬性來提供自己的 CDS 封存檔，則 java_runtime 預設 CDS 會封裝在密封部署 JAR 中。
hermetic_srcs

標籤清單；預設值為 []

執行階段中用於密封部署的檔案。
java

標籤；預設值為 None

Java 可執行檔的路徑。
java_home

字串；預設值為 ""

執行階段根目錄的路徑。 須代入「Make」變數。 如果這個路徑是絕對路徑，規則會標示具有已知路徑的非密封式 Java 執行階段。在這種情況下，srcs 和 java 屬性必須留空。
lib_ct_sym

標籤；預設值為 None

使用 --release 編譯時所需的 lib/ct.sym 檔案。如果未指定，且 srcs 中只有一個路徑結尾為 /lib/ct.sym 的檔案，系統就會使用該檔案。
lib_modules

標籤；預設值為 None

用於密封式部署的 lib/modules 檔案。
version

整數；預設值為 0

Java 執行階段的功能版本。也就是 Runtime.version().feature() 傳回的整數。

java_toolchain

查看規則來源 
java_toolchain(name, android_lint_data, android_lint_jvm_opts, android_lint_opts, android_lint_package_configuration, android_lint_runner, bootclasspath, compatible_with, deprecation, deps_checker, distribs, features, forcibly_disable_header_compilation, genclass, header_compiler, header_compiler_direct, ijar, jacocorunner, java_runtime, javabuilder, javabuilder_data, javabuilder_jvm_opts, javac_supports_multiplex_workers, javac_supports_worker_multiplex_sandboxing, javac_supports_workers, javacopts, jvm_opts, licenses, oneversion, oneversion_allowlist_for_tests, oneversion_whitelist, package_configuration, proguard_allowlister, resourcejar, restricted_to, singlejar, source_version, tags, target_compatible_with, target_version, testonly, timezone_data, tools, turbine_data, turbine_jvm_opts, visibility, xlint)

指定 Java 編譯器的設定。如要變更使用的工具鍊，請透過 --java_toolchain 引數。除非您想調整 Java 編譯器，否則通常不應編寫這類規則。

範例

簡單的範例如下： 

java_toolchain(
    name = "toolchain",
    source_version = "7",
    target_version = "7",
    bootclasspath = ["//tools/jdk:bootclasspath"],
    xlint = [ "classfile", "divzero", "empty", "options", "path" ],
    javacopts = [ "-g" ],
    javabuilder = ":JavaBuilder_deploy.jar",
)

引數

屬性
name

名稱：必填

這個目標的專屬名稱。
android_lint_data

標籤清單；預設值為 []

android_lint_jvm_opts 中可用於標籤擴展的工具標籤。
android_lint_jvm_opts

字串清單；預設值為 []

叫用 Android Lint 時，JVM 的引數清單。
android_lint_opts

字串清單；預設值為 []

Android Lint 引數清單。
android_lint_package_configuration

標籤清單；預設值為 []

應套用至指定套件群組的 Android Lint 設定。
android_lint_runner

標籤；預設值為 None

Android Lint 執行器的標籤 (如有)。
bootclasspath

標籤清單；預設值為 []

Java 目標 bootclasspath 項目。對應於 javac 的 -bootclasspath 旗標。
deps_checker

標籤清單；預設值為 []

ImportDepsChecker 部署 JAR 的標籤。
forcibly_disable_header_compilation

布林值；預設值為 False

覆寫 --java_header_compilation，在不支援標頭編譯的平台 (例如 JDK 7 Bazel) 上停用標頭編譯。
genclass

標籤清單 (必要)

GenClass 部署 JAR 的標籤。
header_compiler

標籤清單；預設值為 []

標頭編譯器的標籤，如果啟用 --java_header_compilation，則為必要選項。
header_compiler_direct

標籤清單；預設值為 []

要用於直接類路徑動作的標頭編譯器選用標籤，不包含任何 API 產生註解處理器。

這項工具不支援註解處理。

ijar

標籤清單 (必要)

ijar 可執行檔的標籤。
jacocorunner

標籤；預設值為 None

JacocoCoverageRunner 部署 JAR 的標籤。
java_runtime

標籤 (必填)

這個工具鍊要使用的 java_runtime。執行設定中的預設值為 java_runtime。
javabuilder

標籤清單 (必要)

JavaBuilder 部署 JAR 的標籤。
javabuilder_data

標籤清單；預設值為 []

javabuilder_jvm_opts 中可供標籤擴展的資料標籤。
javabuilder_jvm_opts

字串清單；預設值為 []

叫用 JavaBuilder 時，JVM 的引數清單。
javac_supports_multiplex_workers

布林值；預設值為 True

如果 JavaBuilder 支援以多工持續性工作站的形式執行，則為 True；否則為 False。
javac_supports_worker_multiplex_sandboxing

布林值；預設值為 False

如果 JavaBuilder 支援多工沙箱，則為 True；否則為 False。
javac_supports_workers

布林值；預設值為 True

如果 JavaBuilder 支援以持續性工作站的形式執行，則為 True；如果不是，則為 False。
javacopts

字串清單；預設值為 []

Java 編譯器的額外引數清單。如需可能的 Java 編譯器旗標完整清單，請參閱 Java 編譯器說明文件。
jvm_opts

字串清單；預設值為 []

叫用 Java 編譯器時，JVM 的引數清單。如需這個選項的完整標記清單，請參閱 Java 虛擬機器說明文件。
oneversion

標籤；預設值為 None

單一版本強制執行二進位檔的標籤。
oneversion_allowlist_for_tests

標籤；預設值為 None

測試用單一版本許可清單的標籤。
oneversion_whitelist

標籤；預設值為 None

單一版本白名單的標籤。
package_configuration

標籤清單；預設值為 []

應套用至指定套件群組的設定。
proguard_allowlister

標籤；預設值為 "@bazel_tools//tools/jdk:proguard_whitelister"

Proguard 允許清單的標籤。
resourcejar

標籤清單；預設值為 []

資源 JAR 建構工具可執行檔的標籤。
singlejar

標籤清單 (必要)

SingleJar 部署 JAR 的標籤。
source_version

字串；預設值為 ""

Java 來源版本 (例如 「6」或「7」)。指定 Java 原始碼中允許的程式碼結構集。
target_version

字串；預設值為 ""

Java 目標版本 (例如 「6」或「7」)。指定要建構類別的 Java 執行階段。
timezone_data

標籤；預設值為 None

含有時區資料的資源 JAR 標籤。如果設定，時區資料會新增為所有 java_binary 規則的隱含執行階段依附元件。
tools

標籤清單；預設值為 []

jvm_opts 中可用於標籤擴展的工具標籤。
turbine_data

標籤清單；預設值為 []

turbine_jvm_opts 中可用於標籤擴展的資料標籤。
turbine_jvm_opts

字串清單；預設值為 []

叫用 turbine 時 JVM 的引數清單。
xlint

字串清單；預設值為 []

從預設清單新增或移除警告的清單。在要移除的字詞前面加上破折號。詳情請參閱 Javac 說明文件中的 -Xlint 選項。