Java 规则

报告问题 查看源代码

规则

• java_binary
• java_import
• java_library
• java_lite_proto_library
• java_proto_library
• java_test
• java_package_configuration
• java_plugin
• java_runtime
• java_toolchain

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 文件”），以及与该规则同名的封装容器 Shell 脚本。 封装容器 Shell 脚本使用的类路径包含二进制文件所依赖的每个库的 jar 文件（以及其他内容）。运行封装容器 Shell 脚本时，任何非空 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：包含源代码的归档（“源代码 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 中的数据文件的列表。 如果指定了资源，这些资源将与编译生成的常规 .class 文件一起捆绑在 jar 中。jar 文件内资源的位置由项目结构决定。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 文件中的行列表。此属性的内容不受替换 "Make variable" 的约束。
javacopts	字符串列表；默认值为 [] 此库的额外编译器选项。 取决于使用 "Make variable" 替换和 Bourne shell 令牌化。 这些编译器选项会在全局编译器选项之后传递到 javac。
jvm_flags	字符串列表；默认值为 [] 为了运行此二进制文件而生成的一系列要嵌入的封装容器脚本中的标志。受 $(location) 和 "Make variable" 替换和 Bourne shell 令牌化的约束。 Java 二进制文件的封装容器脚本包含类路径定义（用于查找所有相关的 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_binary 和 java_test 目标。 请注意，原生（C++、SWIG、JNI）依赖项的构建方式有所不同，具体取决于您使用的是 JDK 启动器还是其他启动器： 如果您使用的是常规的 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 一样，它们将出现在运行时类路径中，但不同之处在于，它们不会出现在编译时类路径中。此处应列出仅在运行时需要的依赖项。依赖项分析工具应忽略同时出现在 runtime_deps 和 deps 中的目标。
stamp	整数；默认值为 -1 是否将 build 信息编码到二进制文件中。可能的值包括： stamp = 1：始终将 build 信息标记到二进制文件中，即使在 --nostamp build 中也是如此。应避免使用此设置，因为它可能会终止二进制文件的远程缓存以及依赖于该文件的任何下游操作。 stamp = 0：始终用常量值替换 build 信息。这样可以提供良好的构建结果缓存。 stamp = -1：build 信息的嵌入由 --[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 文件列表。
neverlink	布尔值；默认值为 False 请仅将此库用于编译，不要在运行时使用该库。如果库将在执行期间由运行时环境提供，则此选项很有用。例如，此类库的示例包括 IDE 插件的 IDE API 或标准 JDK 上运行的 tools.jar。
proguard_specs	标签列表；默认值为 [] 用作 Proguard 规范的文件。 这些将描述 Proguard 使用的一组规范。如果指定，系统会将其添加到依赖于此库的任何 android_binary 目标。 此处包含的文件必须仅具有幂等规则，即 -dontnote、-dontwarn、shouldnosideeffects 以及以 -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：包含源代码的归档（“源代码 jar”）。

参数

属性
name	名称（必需） 此目标的唯一名称。
deps	标签列表；默认值为 [] 要关联到此库的库的列表。 请参阅大多数构建规则定义的典型属性中有关 deps 的一般注释。 根据 deps 中列出的 java_library 规则构建的 JAR 将位于此规则的编译时类路径中。此外，其 deps、runtime_deps 和 exports 的传递闭包将位于运行时类路径中。 相比之下，data 属性中的目标会包含在 runfile 中，但既不包含在编译时类路径中，也不包含在运行时类路径中。
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 文件复制或关联到 runfiles 区域。
resources	标签列表；默认值为 [] 要包含在 Java jar 中的数据文件的列表。 如果指定了资源，这些资源将与编译生成的常规 .class 文件一起捆绑在 jar 中。jar 文件内资源的位置由项目结构决定。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 之间存在以 deps 边缘开头，后跟零个或多个 exports 边缘的依赖关系路径，则规则 X 可以访问 Y 中的代码。XX我们来看一些示例来对此进行说明。 假设 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 中列出它。
javacopts	字符串列表；默认值为 [] 此库的额外编译器选项。 取决于使用 "Make variable" 替换和 Bourne shell 令牌化。 这些编译器选项会在全局编译器选项之后传递到 javac。
neverlink	布尔值；默认值为 False 此库是否仅用于编译，而不用于运行时。 如果库将在执行期间由运行时环境提供，则此选项非常有用。此类库的示例包括 IDE 插件的 IDE API 或标准 JDK 上运行的 tools.jar。 请注意，在 Java 语言规范（例如neverlink = 1String 或基元类型的 static final 常量）。因此，首选用例是运行时库与编译库相同。 如果运行时库与编译库不同，则您必须确保它仅在 JLS 禁止编译器内嵌的位置（并且 JLS 的所有未来版本都必须适用）不同。
plugins	标签列表；默认值为 [] 在编译时运行的 Java 编译器插件。 每当构建此规则时，此属性中指定的每个 java_plugin 都会运行。库还可以从使用 exported_plugins 的依赖项继承插件。插件生成的资源将包含在此规则生成的 jar 中。
proguard_specs	标签列表；默认值为 [] 用作 Proguard 规范的文件。 这些将描述 Proguard 使用的一组规范。如果指定，系统会将其添加到依赖于此库的任何 android_binary 目标。 此处包含的文件必须仅具有幂等规则，即 -dontnote、-dontwarn、shouldnosideeffects 以及以 -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 一样，它们将出现在运行时类路径中，但不同之处在于，它们不会出现在编译时类路径中。此处应列出仅在运行时需要的依赖项。依赖项分析工具应忽略同时出现在 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 归档。（仅在明确请求的情况下构建）。如需了解详情，请参阅 java_binary 的 name_deploy.jar 输出的说明。

请参阅有关 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 中的数据文件的列表。 如果指定了资源，这些资源将与编译生成的常规 .class 文件一起捆绑在 jar 中。jar 文件内资源的位置由项目结构决定。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 文件中的行列表。此属性的内容不受替换 "Make variable" 的约束。
javacopts	字符串列表；默认值为 [] 此库的额外编译器选项。 取决于使用 "Make variable" 替换和 Bourne shell 令牌化。 这些编译器选项会在全局编译器选项之后传递到 javac。
jvm_flags	字符串列表；默认值为 [] 为了运行此二进制文件而生成的一系列要嵌入的封装容器脚本中的标志。受 $(location) 和 "Make variable" 替换和 Bourne shell 令牌化的约束。 Java 二进制文件的封装容器脚本包含类路径定义（用于查找所有相关的 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_binary 和 java_test 目标。 请注意，原生（C++、SWIG、JNI）依赖项的构建方式有所不同，具体取决于您使用的是 JDK 启动器还是其他启动器： 如果您使用的是常规的 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 一样，它们将出现在运行时类路径中，但不同之处在于，它们不会出现在编译时类路径中。此处应列出仅在运行时需要的依赖项。依赖项分析工具应忽略同时出现在 runtime_deps 和 deps 中的目标。
stamp	整数；默认值为 0 是否将 build 信息编码到二进制文件中。可能的值包括： stamp = 1：始终将 build 信息标记到二进制文件中，即使在 --nostamp build 中也是如此。应避免使用此设置，因为它可能会终止二进制文件的远程缓存以及依赖于该文件的任何下游操作。 stamp = 0：始终用常量值替换 build 信息。这样可以提供良好的构建结果缓存。 stamp = -1：build 信息的嵌入由 --[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 归档。

除了添加了 processor_class 参数外，参数与 java_library 完全相同。

参数

属性
name	名称（必需） 此目标的唯一名称。
deps	标签列表；默认值为 [] 要关联到此库的库的列表。 请参阅大多数构建规则定义的典型属性中有关 deps 的一般注释。 根据 deps 中列出的 java_library 规则构建的 JAR 将位于此规则的编译时类路径中。此外，其 deps、runtime_deps 和 exports 的传递闭包将位于运行时类路径中。 相比之下，data 属性中的目标会包含在 runfile 中，但既不包含在编译时类路径中，也不包含在运行时类路径中。
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 文件复制或关联到 runfiles 区域。
resources	标签列表；默认值为 [] 要包含在 Java jar 中的数据文件的列表。 如果指定了资源，这些资源将与编译生成的常规 .class 文件一起捆绑在 jar 中。jar 文件内资源的位置由项目结构决定。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 生成注解处理器，则只有在其编译操作安排在生成规则之后的情况下，依赖于它的其他规则才能引用生成的代码。此属性指示 Bazel 在启用 --java_header_compile 时引入调度约束。 警告：此属性会影响构建性能，请仅在必要时使用。
javacopts	字符串列表；默认值为 [] 此库的额外编译器选项。 取决于使用 "Make variable" 替换和 Bourne shell 令牌化。 这些编译器选项会在全局编译器选项之后传递到 javac。
neverlink	布尔值；默认值为 False 此库是否仅用于编译，而不用于运行时。 如果库将在执行期间由运行时环境提供，则此选项非常有用。此类库的示例包括 IDE 插件的 IDE API 或标准 JDK 上运行的 tools.jar。 请注意，在 Java 语言规范（例如neverlink = 1String 或基元类型的 static final 常量）。因此，首选用例是运行时库与编译库相同。 如果运行时库与编译库不同，则您必须确保它仅在 JLS 禁止编译器内嵌的位置（并且 JLS 的所有未来版本都必须适用）不同。
output_licenses	许可类型；默认值为 ["none"] 请参阅 common attributes
plugins	标签列表；默认值为 [] 在编译时运行的 Java 编译器插件。 每当构建此规则时，此属性中指定的每个 java_plugin 都会运行。库还可以从使用 exported_plugins 的依赖项继承插件。插件生成的资源将包含在此规则生成的 jar 中。
processor_class	字符串；默认值为 "" 处理器类是类的完全限定类型，Java 编译器应该将其用作注解处理器的入口点。如果未指定，此规则不会向 Java 编译器的注解处理贡献注解处理器，但其运行时类路径仍将包含在编译器的注解处理器路径中。（这主要供 Error Prone 插件使用，这些插件使用 java.util.ServiceLoader 从注解处理器路径加载）。
proguard_specs	标签列表；默认值为 [] 用作 Proguard 规范的文件。 这些将描述 Proguard 使用的一组规范。如果指定，系统会将其添加到依赖于此库的任何 android_binary 目标。 此处包含的文件必须仅具有幂等规则，即 -dontnote、-dontwarn、shouldnosideeffects 以及以 -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_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_compile 以在不支持头文件的平台（例如 JDK 7 Bazel）上停用头文件编译。
genclass	标签列表（必需） GenClass 部署 jar 的标签。
header_compiler	标签列表；默认值为 [] 标头编译器的标签。如果已启用 --java_header_编译，则为必需项。
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_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	字符串列表；默认值为 [] 要在默认列表中添加或移除的警告列表。在名称前面加上短划线，即可将其移除。如需了解详情，请参阅有关 -Xlint 选项的 Javac 文档。