java_common

报告问题 查看源代码

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

成员

• BootClassPathInfo
• compile
• JavaRuntimeInfo
• JavaToolchainInfo
• 合并
• pack_sources
• run_ijar
• stamp_jar

BootClassPathInfo

Provider java_common.BootClassPathInfo

用于提供 bootclasspath 信息的提供程序

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

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	File 或 None；默认值为 None 已弃用。此参数已被弃用，很快就会被移除。请勿依赖它。此选项已通过 --+incompatible_java_common_parameters 停用。使用此标记验证您的代码与其即将移除的兼容性兼容。 已弃用：规则的输出 jar。用于命名生成的源 jar。该参数会将 output_source_jar 参数设置为“{output_jar}-src.jar”。请改为直接使用 output_source_jar 参数。
output_source_jar	File；或 None；默认值为 None 输出源 jar。
sources	File 的 sequence，默认值为 [] 要打包到源 jar 中的 Java 源文件列表。
source_jars	File 的 sequence；默认值为 [] 要打包到源 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 剥离其方法正文。这有助于减少在任何重新编译（仅包含对方法实现的简单更改）期间重新编译依赖 JAR 的情况。返回值通常会传递给 JavaInfo#compile_jar。

参数

参数	说明
actions	必需 ctx.actions
jar	必需 要运行 ijar 的 jar。
target_label	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)

在罐子上标记目标标签以实现 add_dep 支持。返回值通常会传递给 JavaInfo#compile_jar。请尽可能使用 run_ijar。

参数

参数	说明
actions	必需 ctx.actions
jar	必需 要运行 short_jar 的 jar。
target_label	必需 用于标记罐子的目标标签。用于提供 add_dep 支持。通常，您会传递 ctx.label 来为 jar 添加当前规则的标签。
java_toolchain	必需 用于查找 spot_jar 工具的 JavaToolchainInfo。