java_common

报告问题 查看源代码 每夜版 · 8.4 · 8.3 · 8.2 · 8.1 · 8.0 · 7.6

用于在 Starlark 中支持 Java 编译的实用程序。

成员

BootClassPathInfo

Provider java_common.BootClassPathInfo

用于提供启动 classpath 信息的提供程序

compile

struct java_common.compile(ctx, *, source_jars=[], source_files=[], output, output_source_jar=None, javac_opts=[], deps=[], runtime_deps=[], exports=[], plugins=[], exported_plugins=[], native_libraries=[], annotation_processor_additional_inputs=[], annotation_processor_additional_outputs=[], strict_deps='ERROR', java_toolchain, bootclasspath=None, host_javabase=None, sourcepath=[], resources=[], resource_jars=[], classpath_resources=[], neverlink=False, enable_annotation_processing=True, enable_compile_jar_action=True, add_exports=[], add_opens=[])

根据 Starlark 规则的实现编译 Java 源文件/jar，并返回一个提供程序，该提供程序表示编译结果，可以添加到此规则发出的提供程序集中。

参数

参数 说明
ctx 必需
规则上下文。
source_jars 文件的序列；默认值为 []
要编译的 jar 的列表。应至少指定 source_jars 或 source_files 之一。
source_files File 的序列；默认值为 []
要编译的 Java 源文件的列表。应至少指定 source_jars 或 source_files 之一。
output 必需
output_source_jar 文件；或 None； 默认值为 None
输出源 JAR。可选。如果未设置，则默认为 `{output_jar}-src.jar`。
javac_opts 字符串的序列；默认值为 []
所需 javac 选项的列表。选填。
deps 结构的序列；默认值为 []
依赖项列表。选填。
runtime_deps 结构的序列；默认值为 []
运行时依赖项的列表。选填。
exports struct 的序列； 默认值为 []
导出内容的列表。选填。
plugins 结构体的序列；或结构体的序列；默认值为 []
插件列表。选填。
exported_plugins 结构的序列；或结构的序列；默认值为 []
导出的插件的列表。选填。
native_libraries CcInfo 的序列；默认值为 []
此库所需的 CC 原生库依赖项。
annotation_processor_additional_inputs 序列的 File； 默认值为 []
Java 编译操作将采用的输入列表，除了用于注释处理的 Java 源之外。
annotation_processor_additional_outputs 序列的 File；默认值为 []
Java 编译操作将输出的输出列表（除了注释处理中的类 JAR）。
strict_deps 默认值为 'ERROR'
一个字符串，用于指定如何处理严格依赖项。可能的值：“OFF”“ERROR”“WARN”和“DEFAULT”。如需了解详情，请参阅 /docs/user-manual#flag--strict_java_deps。默认值为“ERROR”。
java_toolchain 必需
要用于此编译的 JavaToolchainInfo。强制性。
bootclasspath 默认值为 None
要用于此编译的 BootClassPathInfo。如果存在，则替换与所提供的 java_toolchain 关联的启动 classpath。选填。
host_javabase 默认值为 None
已弃用。此参数已被弃用，很快就会被移除。请勿依赖此功能。它已通过 --+incompatible_java_common_parameters 停用。使用此标志可验证您的代码是否与即将进行的移除操作兼容。
已弃用：您可以舍弃此参数（host_javabase 随 java_toolchain 提供）
sourcepath 文件的序列；默认值为 []
resources 文件的序列；默认值为 []
resource_jars 文件的序列；默认值为 []
classpath_resources 文件的序列；默认值为 []
默认值为 False
enable_annotation_processing 默认值为 True
停用此编译中的注释处理，导致忽略插件或依赖项的 exported_plugins 中提供的任何注释处理器。
enable_compile_jar_action 默认值为 True
启用头文件编译或 ijar 创建。如果设置为 False，则强制在任何依赖项的编译类路径中使用完整的类 JAR。这样做是为了供非库目标（例如没有依赖项的二进制文件）使用。
add_exports 字符串序列；默认值为 []
允许此库访问给定的 /。可选。
add_opens 字符串的序列；默认值为 []
允许此库以反射方式访问给定的 /。可选。

JavaRuntimeInfo

Provider java_common.JavaRuntimeInfo

用于检索包含有关所用 Java 运行时信息的提供程序的键。

JavaToolchainInfo

Provider java_common.JavaToolchainInfo

用于检索包含有关所用 Java 工具链信息的提供程序的键。

合并

struct java_common.merge(providers)

将给定的提供程序合并到单个 JavaInfo 中。

参数

参数 说明
providers 结构体的序列；必需
要合并的提供商的列表。

pack_sources

File java_common.pack_sources(actions, *, output_jar=None, output_source_jar=None, sources=[], source_jars=[], java_toolchain, host_javabase=None)

将源代码和源代码 JAR 打包到单个源代码 JAR 文件中。返回值通常会传递给

JavaInfo#source_jar

必须提供 output_jar 和 output_source_jar 参数中的至少一个。

参数

参数 说明
actions 必需
ctx.actions
output_jar 文件；或 None； 默认值为 None
已弃用。此参数已被弃用，很快就会被移除。请勿依赖此功能。它已通过 --+incompatible_java_common_parameters 停用。使用此标志可验证您的代码是否与即将进行的移除操作兼容。
已弃用：相应规则的输出 JAR。用于命名生成的源 JAR。该参数将 output_source_jar 参数设置为“{output_jar}-src.jar”。请直接使用 output_source_jar 参数。
output_source_jar 文件；或 None； 默认值为 None
输出源 JAR。
sources 序列的 File；默认值为 []
要打包到源 JAR 中的 Java 源文件列表。
source_jars File 的序列；默认值为 []
要打包到源 jar 中的源 jar 的列表。
java_toolchain 必需
用于查找 ijar 工具的 JavaToolchainInfo。
host_javabase 默认值为 None
已弃用。此参数已被弃用，很快就会被移除。请勿依赖此功能。它已通过 --+incompatible_java_common_parameters 停用。使用此标志可验证您的代码是否与即将进行的移除操作兼容。
已弃用：您可以舍弃此参数（host_javabase 随 java_toolchain 提供）

run_ijar

File java_common.run_ijar(actions, *, jar, target_label=None, java_toolchain)

对 jar 运行 ijar，剥离其方法正文。这有助于减少在仅包含对方法实现的简单更改的任何重新编译期间重新构建依赖 JAR 的次数。返回值通常会传递给 JavaInfo#compile_jar。

参数

参数 说明
actions 必需
ctx.actions
jar 必需
要运行 ijar 的 jar。
target_label 标签；或 None； 默认值为 None
要为 JAR 盖印的目标标签。用于 add_dep 支持。通常，您会传递 ctx.label 以使用当前规则的标签来标记 JAR。
java_toolchain 必需
用于查找 ijar 工具的 JavaToolchainInfo。

stamp_jar

File java_common.stamp_jar(actions, *, jar, target_label, java_toolchain)

为 jar 盖上目标标签，以支持 add_dep。返回值通常会传递给 JavaInfo#compile_jar。建议尽可能使用 run_ijar。

参数

参数 说明
actions 必需
ctx.actions
jar 必需
要运行 stamp_jar 的 jar。
target_label 必需
要为 jar 盖印的目标标签。用于 add_dep 支持。通常，您会传递 ctx.label 以使用当前规则的标签来标记 JAR。
java_toolchain 必需
用于查找 stamp_jar 工具的 JavaToolchainInfo。