Java 规则

报告问题 查看源代码

规则

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。

在没有 srcsjava_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 文件,这会非常有用。)

规则:如果规则(通常为 genrulefilegroup)生成上面列出的任何文件,则它们的使用方式与源文件相同。

此参数几乎始终是必需的,除非 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 变量”替换的影响。
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 目标。

请注意,原生(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_depsdeps)提供。如果该类不可用,则二进制文件将在运行时失败;没有构建时检查。

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_depsdeps 中的目标。
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, add_exports, add_opens, 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, toolchains, visibility)

此规则允许使用预编译的 .jar 文件作为 java_libraryjava_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
data

标签列表;默认值为 []

此规则在运行时所需的文件列表。
add_exports

字符串列表;默认值为 []

允许此库访问指定的 modulepackage

对应于 javac 和 JVM --add-exports= 标志。

add_opens

字符串列表;默认值为 []

允许此库反射访问指定的 modulepackage

对应于 javac 和 JVM --add-opens= 标记。

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, add_exports, add_opens, bootclasspath, compatible_with, deprecation, distribs, exec_compatible_with, exec_properties, exported_plugins, exports, features, javabuilder_jvm_flags, javacopts, licenses, neverlink, plugins, proguard_specs, resource_strip_prefix, restricted_to, runtime_deps, tags, target_compatible_with, testonly, toolchains, visibility)

此规则会将源代码编译并链接到 .jar 文件中。

隐式输出

  • libname.jar:包含类文件的 Java 归档文件。
  • libname-src.jar:包含源代码的归档(“源代码 jar”)。

参数

属性
name

名称(必填)

此目标的唯一名称。

deps

标签列表;默认值为 []

要链接到此库的库列表。请参阅由大多数构建规则定义的典型属性,查看有关 deps 的一般注释。

根据 deps 中列出的 java_library 规则构建的 JAR 将位于此规则的编译时类路径上。此外,其 depsruntime_depsexports 的传递闭包将位于运行时类路径上。

相比之下,data 属性中的目标会包含在 runfile 中,但既不包含编译时类路径,也不包含运行时类路径。

srcs

标签列表;默认值为 []

为创建目标而处理的源文件列表。此属性几乎始终是必需的,请参阅下面的例外情况。

编译 .java 类型的源文件。对于生成的 .java 文件,通常建议在此输入生成规则的名称,而不是文件本身的名称。这不仅可以提高可读性,还可以使规则更适应未来的更改:如果生成的规则将来生成了不同的文件,您只需要修正一个位置,即生成规则的 outs。您不应在 deps 中列出生成规则,因为它是一项空操作。

系统对 .srcjar 类型的源文件解压缩和编译。(如果您需要生成一组使用 genrule 的 .java 文件,这会非常有用。)

规则:如果规则(通常为 genrulefilegroup)生成上面列出的任何文件,则它们的使用方式与源文件相同。

.properties 类型的源文件被视为资源。

只要至少存在一个上述文件类型的文件,所有其他文件都会被忽略。否则,将发生错误。

除非您指定 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 属性可用于为资源文件指定特定的备用目录。

add_exports

字符串列表;默认值为 []

允许此库访问指定的 modulepackage

对应于 javac 和 JVM --add-exports= 标志。

add_opens

字符串列表;默认值为 []

允许此库反射访问指定的 modulepackage

对应于 javac 和 JVM --add-opens= 标记。

bootclasspath

标签;默认值为 None

受限 API,请勿使用!
exported_plugins

标签列表;默认值为 []

要导出到直接依赖于此库的库的 java_plugin(例如注解处理器)列表。

指定的 java_plugin 列表将应用于直接依赖于此库的任何库,就像该库已在 plugins 中明确声明这些标签一样。

exports

标签列表;默认值为 []

导出的库。

在此处列出的规则会将其提供给父级规则,就好像父级明确依赖于这些规则。常规(未导出的)deps 并非如此。

摘要:如果规则 X 可以访问 Y 中的代码,前提是规则之间存在以deps边开头,后跟零个或多个exports边的依赖关系路径。让我们通过一些示例来说明这一点。

假设 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 中。

javabuilder_jvm_flags

字符串列表;默认值为 []

受限 API,请勿使用!
javacopts

字符串列表;默认值为 []

此库的额外编译器选项。 受“创建变量”替换和 Bourne shell 标记化限制。

这些编译器选项在全局编译器选项之后传递给 javac。

布尔值;默认值为 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、assumenosideeffects,以及以 -keep 开头的规则。其他选项只能出现在 android_binary 的 proguard_specs 中,以确保非同义合并。
resource_strip_prefix

字符串;默认值为 ""

要从 Java 资源中删除的路径前缀。

如果指定,系统会从 resources 属性中的每个文件中删除此路径前缀。资源文件不在此目录下会导致错误。如果未指定(默认值),系统将根据与 Java 源文件软件包相同的逻辑确定资源文件的路径。例如,stuff/java/foo/bar/a.txt 下的源文件位于 foo/bar/a.txt 中。

runtime_deps

标签列表;默认值为 []

仅供最终二进制文件或在运行时进行测试的库。与普通的 deps 一样,这些依赖项会显示在运行时类路径上,但与之不同的是,它们不会出现在编译时类路径上。仅在运行时需要的依赖项应在此处列出。依赖项分析工具应忽略 runtime_depsdeps 中出现的目标。

java_lite_proto_library

查看规则来源
java_lite_proto_library(name, deps, compatible_with, deprecation, distribs, exec_compatible_with, exec_properties, features, restricted_to, tags, target_compatible_with, testonly, toolchains, visibility)

java_lite_proto_library 会从 .proto 文件生成 Java 代码。

deps 必须指向 proto_library 规则。

例如:


java_library(
    name = "lib",
    runtime_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, compatible_with, deprecation, distribs, exec_compatible_with, exec_properties, features, licenses, restricted_to, tags, target_compatible_with, testonly, toolchains, visibility)

java_proto_library 会从 .proto 文件生成 Java 代码。

deps 必须指向 proto_library 规则。

例如:


java_library(
    name = "lib",
    runtime_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, add_exports, add_opens, args, bootclasspath, 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, neverlink, plugins, 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 测试。测试是一种封装了测试代码的二进制文件封装容器。调用测试运行程序的 main 方法,而不是编译主类。

隐式输出目标

  • name.jar:Java 归档文件。
  • name_deploy.jar:适合部署的 Java 归档。(仅在明确请求时构建。)如需了解详情,请参阅 java_binaryname_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 文件,这会非常有用。)

规则:如果规则(通常为 genrulefilegroup)生成上面列出的任何文件,则它们的使用方式与源文件相同。

此参数几乎始终是必需的,除非 main_class 属性指定了运行时类路径中的类或您指定了 runtime_deps 参数。

data

标签列表;默认值为 []

此库在运行时所需的文件列表。请参阅由大多数构建规则定义的典型属性中有关 data 的一般注释。
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 属性可用于为资源文件指定特定的备用目录。

add_exports

字符串列表;默认值为 []

允许此库访问指定的 modulepackage

对应于 javac 和 JVM --add-exports= 标志。

add_opens

字符串列表;默认值为 []

允许此库反射访问指定的 modulepackage

对应于 javac 和 JVM --add-opens= 标记。

bootclasspath

标签;默认值为 None

受限 API,请勿使用!
classpath_resources

标签列表;默认值为 []

请勿使用此选项,除非别无选择)

必须位于 Java 树根目录的资源列表。此属性的唯一用途是支持某些第三方库,这些库要求其资源可以在类路径上正好找到 "myconfig.xml"。由于存在命名空间冲突的风险,因此仅适用于二进制文件,而不适用于库。

create_executable

布尔值;默认值为 True

已废弃,请改用 java_single_jar
deploy_manifest_lines

字符串列表;默认值为 []

要添加到为 *_deploy.jar 目标生成的 META-INF/manifest.mf 文件中的行的列表。此属性的内容会被 “Make 变量”替换。
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 目标。

请注意,原生(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_depsdeps)提供。如果该类不可用,则二进制文件将在运行时失败;因此,系统不会在构建时检查该类。

布尔值;默认值为 False

plugins

标签列表;默认值为 []

在编译时运行的 Java 编译器插件。每当构建此规则时,此属性中指定的每个 java_plugin 都将运行。库还可以从使用 exported_plugins 的依赖项继承插件。插件生成的资源将包含在此规则生成的 jar 中。
resource_strip_prefix

字符串;默认值为 ""

要从 Java 资源中删除的路径前缀。

如果指定,系统会从 resources 属性中的每个文件中删除此路径前缀。资源文件不在此目录下会导致错误。如果未指定(默认值),系统将根据与 Java 源文件软件包相同的逻辑确定资源文件的路径。例如,stuff/java/foo/bar/a.txt 下的源文件位于 foo/bar/a.txt 中。

runtime_deps

标签列表;默认值为 []

仅供最终二进制文件或在运行时进行测试的库。与普通的 deps 一样,这些依赖项会显示在运行时类路径上,但与之不同的是,它们不会出现在编译时类路径上。仅在运行时需要的依赖项应在此处列出。依赖项分析工具应忽略 runtime_depsdeps 中出现的目标。
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 及其 source-root-relative 路径推断出此参数。如果测试位于已知的源代码根目录之外,如果未设置 test_class,Bazel 会报告错误。

对于 JUnit3,测试类必须是 junit.framework.TestCase 的子类,或者需要有一个返回 junit.framework.Test(或 Test 的子类)的公共静态 suite() 方法。对于 JUnit4,该类需要带有 org.junit.runner.RunWith 注解。

此属性允许多条 java_test 规则共用同一个 TestTestCaseTestSuite...)。通常情况下,会向其传递额外信息(例如,通过 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, exec_compatible_with, exec_properties, features, javacopts, output_licenses, packages, restricted_to, tags, target_compatible_with, testonly, toolchains, 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 编译器标志。
output_licenses

字符串列表;默认值为 []

packages

标签列表;默认值为 []

应该应用配置的一组 package_group

java_plugin

查看规则来源
java_plugin(name, deps, srcs, data, resources, add_exports, add_opens, bootclasspath, compatible_with, deprecation, distribs, exec_compatible_with, exec_properties, features, generates_api, javabuilder_jvm_flags, javacopts, licenses, neverlink, output_licenses, plugins, processor_class, proguard_specs, resource_strip_prefix, restricted_to, tags, target_compatible_with, testonly, toolchains, visibility)

java_plugin 为 Bazel 运行的 Java 编译器定义插件。目前,唯一支持的插件类型是注解处理器。java_libraryjava_binary 规则可以通过 plugins 属性依赖于相应插件,从而运行相应插件。java_library 还可以使用 exported_plugins 自动将插件导出到直接依赖于它的库。

隐式输出目标

  • libname.jar:Java 归档文件。

除了添加了 processor_class 参数之外,其他参数与 java_library 相同。

参数

属性
name

名称(必填)

此目标的唯一名称。

deps

标签列表;默认值为 []

要链接到此库的库列表。请参阅由大多数构建规则定义的典型属性,查看有关 deps 的一般注释。

根据 deps 中列出的 java_library 规则构建的 JAR 将位于此规则的编译时类路径上。此外,其 depsruntime_depsexports 的传递闭包将位于运行时类路径上。

相比之下,data 属性中的目标会包含在 runfile 中,但既不包含编译时类路径,也不包含运行时类路径。

srcs

标签列表;默认值为 []

为创建目标而处理的源文件列表。此属性几乎始终是必需的,请参阅下面的例外情况。

编译 .java 类型的源文件。对于生成的 .java 文件,通常建议在此输入生成规则的名称,而不是文件本身的名称。这不仅可以提高可读性,还可以使规则更适应未来的更改:如果生成的规则将来生成了不同的文件,您只需要修正一个位置,即生成规则的 outs。您不应在 deps 中列出生成规则,因为它是一项空操作。

系统对 .srcjar 类型的源文件解压缩和编译。(如果您需要生成一组使用 genrule 的 .java 文件,这会非常有用。)

规则:如果规则(通常为 genrulefilegroup)生成上面列出的任何文件,则它们的使用方式与源文件相同。

.properties 类型的源文件被视为资源。

只要至少存在一个上述文件类型的文件,所有其他文件都会被忽略。否则,将发生错误。

除非您指定 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 属性可用于为资源文件指定特定的备用目录。

add_exports

字符串列表;默认值为 []

允许此库访问指定的 modulepackage

对应于 javac 和 JVM --add-exports= 标志。

add_opens

字符串列表;默认值为 []

允许此库反射访问指定的 modulepackage

对应于 javac 和 JVM --add-opens= 标记。

bootclasspath

标签;默认值为 None

受限 API,请勿使用!
generates_api

布尔值;默认值为 False

此属性用于标记生成 API 代码的注解处理器。

如果规则使用 API 生成注解处理器,则依赖于它的其他规则只能在生成规则之后安排其编译操作时引用生成的代码。该属性指示 Bazel 在启用 --java_header_compilation 时引入调度限制。

警告:此属性会影响构建性能,请仅在必要时使用它。

javabuilder_jvm_flags

字符串列表;默认值为 []

受限 API,请勿使用!
javacopts

字符串列表;默认值为 []

此库的额外编译器选项。 受“创建变量”替换和 Bourne shell 标记化限制。

这些编译器选项在全局编译器选项之后传递给 javac。

布尔值;默认值为 False

此库是否仅用于编译而不在运行时使用。 如果库将在执行期间由运行时环境提供,则此参数非常有用。此类库的示例包括适用于 IDE 插件的 IDE API,或适用于标准 JDK 上运行的插件的 tools.jar

请注意,在 Java 语言规范(例如neverlink = 1String 或基元类型的 static final 常量)。因此,首选用例是运行时库与编译库完全相同时。

如果运行时库与编译库不同,您必须确保它只在 JLS 禁止编译器内嵌的方面不同(并且必须适用于所有未来版本的 JLS)。

output_licenses

字符串列表;默认值为 []

plugins

标签列表;默认值为 []

在编译时运行的 Java 编译器插件。每当构建此规则时,此属性中指定的每个 java_plugin 都将运行。库还可以从使用 exported_plugins 的依赖项继承插件。插件生成的资源将包含在此规则生成的 jar 中。
processor_class

字符串;默认值为 ""

处理器类是类的完全限定类型,Java 编译器应将其用作注解处理器的入口点。如果未指定,此规则不会对 Java 编译器的注解处理贡献注解处理器,但其运行时类路径仍包含在编译器的注解处理器路径中。(这主要供 Error Prone 插件使用,这些插件使用 java.util.ServiceLoader 从注解处理器路径加载。)
proguard_specs

标签列表;默认值为 []

要用作 Proguard 规范的文件。 这些内容将描述 Proguard 要使用的一组规范。如果指定,它们将添加到依赖于此库的任何 android_binary 目标。 此处包含的文件只能包含幂等规则,即 -dontnote、-dontwarn、assumenosideeffects,以及以 -keep 开头的规则。其他选项只能出现在 android_binary 的 proguard_specs 中,以确保非同义合并。
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, exec_compatible_with, exec_properties, features, hermetic_srcs, hermetic_static_libs, java, java_home, lib_ct_sym, lib_modules, output_licenses, restricted_to, tags, target_compatible_with, testonly, toolchains, 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

标签列表;默认值为 []

封闭式部署所需的运行时中的文件。
hermetic_static_libs

标签列表;默认值为 []

与用于封闭部署的启动器静态链接的库
java

标签;默认值为 None

Java 可执行文件的路径。
java_home

字符串;默认值为 ""

运行时根目录的路径。 替换后可使用“Make”变量。 如果此路径是绝对路径,该规则将表示具有已知路径的非封闭 Java 运行时。在这种情况下,srcsjava 属性必须为空。
lib_ct_sym

标签;默认值为 None

使用 --release 进行编译所需的 lib/ct.sym 文件。如果未指定,并且 srcs 中只有一个路径以 /lib/ct.sym 结尾的文件,则使用该文件。
lib_modules

标签;默认值为 None

封闭部署所需的 lib/modules 文件。
output_licenses

字符串列表;默认值为 []

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_javacopts, compatible_with, deprecation, deps_checker, distribs, exec_compatible_with, exec_properties, features, forcibly_disable_header_compilation, genclass, header_compiler, header_compiler_builtin_processors, header_compiler_direct, ijar, jacocorunner, java_runtime, javabuilder, javabuilder_data, javabuilder_jvm_opts, javac_supports_multiplex_workers, javac_supports_worker_cancellation, javac_supports_worker_multiplex_sandboxing, javac_supports_workers, javacopts, jspecify_implicit_deps, jspecify_javacopts, jspecify_packages, jspecify_processor, jspecify_processor_class, jspecify_stubs, jvm_opts, licenses, misc, oneversion, oneversion_allowlist_for_tests, oneversion_whitelist, package_configuration, proguard_allowlister, reduced_classpath_incompatible_processors, restricted_to, singlejar, source_version, tags, target_compatible_with, target_version, testonly, timezone_data, toolchains, 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 标志。
compatible_javacopts

null; default is {}

内部 API,请勿使用!
deps_checker

标签;默认值为 None

ImportDepsChecker 部署 jar 的标签。
forcibly_disable_header_compilation

布尔值;默认值为 False

替换了 --java_header_compilation,以便在不支持头文件编译的平台(例如 JDK 7 Bazel)上停用头文件编译。
genclass

标签;默认值为 None

GenClass 部署 jar 的标签。
header_compiler

标签;默认值为 None

标头编译器的标签。如果启用了 --java_header_compilation,则必需。
header_compiler_builtin_processors

字符串列表;默认值为 []

内部 API,请勿使用!
header_compiler_direct

标签;默认值为 None

头文件编译器的可选标签,用于不包含任何可生成 API 的注解处理器的直接类路径操作。

此工具不支持注解处理。

ijar

标签;默认值为 None

ijar 可执行文件的标签。
jacocorunner

标签;默认值为 None

JacoCoverageRunner 部署 jar 的标签。
java_runtime

标签;默认值为 None

要与此工具链配合使用的 java_runtime。在执行配置中,默认为 java_runtime。
javabuilder

标签;默认值为 None

JavaBuilder 部署 jar 的标签。
javabuilder_data

标签列表;默认值为 []

javabuilder_jvm_opts 中可用于标签扩展的数据标签。
javabuilder_jvm_opts

字符串列表;默认值为 []

调用 JavaBuilder 时的 JVM 参数列表。
javac_supports_multiplex_workers

布尔值;默认值为 True

如果 JavaBuilder 支持作为多路持久性工作器运行,则为 true;如果不支持,则为 false。
javac_supports_worker_cancellation

布尔值;默认值为 True

如果 JavaBuilder 支持取消持久性工作器,则为 true;如果不支持取消,则为 false。
javac_supports_worker_multiplex_sandboxing

布尔值;默认值为 False

如果 JavaBuilder 支持作为具有沙盒的多重持久性工作器运行,则为 true;如果不支持,则为 false。
javac_supports_workers

布尔值;默认值为 True

如果 JavaBuilder 支持作为持久性工作器运行,则为 true;如果不支持,则为 false。
javacopts

字符串列表;默认值为 []

Java 编译器的额外参数列表。如需查看可能的 Java 编译器标志的完整列表,请参阅 Java 编译器文档。
jspecify_implicit_deps

标签;默认值为 None

实验性功能,请勿使用!
jspecify_javacopts

字符串列表;默认值为 []

实验性功能,请勿使用!
jspecify_packages

标签列表;默认值为 []

实验性功能,请勿使用!
jspecify_processor

标签;默认值为 None

实验性功能,请勿使用!
jspecify_processor_class

字符串;默认值为 ""

实验性功能,请勿使用!
jspecify_stubs

标签列表;默认值为 []

实验性功能,请勿使用!
jvm_opts

字符串列表;默认值为 []

调用 Java 编译器时 JVM 的参数列表。如需查看此选项的可能标志的详尽列表,请参阅 Java 虚拟机文档。
misc

字符串列表;默认值为 []

已废弃:请改用 javacopts
oneversion

标签;默认值为 None

单一版本强制执行二进制文件的标签。
oneversion_allowlist_for_tests

标签;默认值为 None

用于测试的单一版本许可名单的标签。
oneversion_whitelist

标签;默认值为 None

单一版本许可名单的标签。
package_configuration

标签列表;默认值为 []

应应用于指定软件包组的配置。
proguard_allowlister

标签;默认值为 "@bazel_tools//tools/jdk:proguard_whitelister"

Proguard 许可名单器的标签。
reduced_classpath_incompatible_processors

字符串列表;默认值为 []

内部 API,请勿使用!
singlejar

标签;默认值为 None

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 文档。