如何在 Bazel 中基于生成的 Java 文件构建可编译的 Java 库

酷婷同学_1516

酷婷同学_1516

2026-11-02

726人浏览

原创

如何在 Bazel 中基于生成的 Java 文件构建可编译的 Java 库

Bazel 的原生 Java 规则不支持直接消费 declare_directory 创建的树状目录(tree artifact),导致 java_library 无法识别其中的 .java 文件;正确做法是将生成的源码打包为 .srcjar 格式的 ZIP 归档,Java 规则即可自动解压并编译。

Bazel 的原生 Java 规则不支持直接消费 `declare_directory` 创建的树状目录(tree artifact),导致 `java_library` 无法识别其中的 `.java` 文件;正确做法是将生成的源码打包为 `.srcjar` 格式的 ZIP 归档,Java 规则即可自动解压并编译。

要使 java_library 正确编译由自定义规则生成的 java 源文件,关键在于避免直接传递 directory 类型的输出(即 tree artifact),而应将其封装为 bazel 明确支持的 source jar(.srcjar)。bazel 的 java 规则(如 java_library、java_binary)原生支持 .srcjar 文件:它们会自动解压其中的 .java 文件,并将其纳入编译路径。

✅ 正确实现步骤

  1. 保留原有代码生成逻辑,仍使用 ctx.actions.declare_directory 创建临时目录;
  2. 新增归档步骤:调用 ctx.actions.run 或 ctx.actions.run_shell,将生成的 Java 文件打包为 .srcjar(即扩展名为 .srcjar 的 ZIP 文件);
  3. 在 rule 返回值中提供该 .srcjar 文件(而非目录),供 java_library.srcs 消费。

以下是修正后的规则示例:

def _generator_java_impl(ctx):
    # Step 1: 声明生成目录
    src_tree = ctx.actions.declare_directory(ctx.attr.name + "_srcs")

    # Step 2: 执行实际代码生成(保持不变)
    ctx.actions.run(
        outputs = [src_tree],
        executable = ctx.executable._generator_tool,
        arguments = [src_tree.path],
        # ... 其他参数(inputs, tools 等)
    )

    # Step 3: 将目录打包为 .srcjar(必须使用 .srcjar 后缀!)
    srcjar = ctx.actions.declare_file(ctx.attr.name + ".srcjar")
    ctx.actions.run_shell(
        inputs = [src_tree],
        outputs = [srcjar],
        command = "zip -r $1 $2 && touch $1",  # 确保 zip 非空且时间戳更新
        arguments = [srcjar.path, src_tree.path],
    )

    # ✅ 关键:只返回 .srcjar 文件,不返回目录
    return [DefaultInfo(files = depset([srcjar]))]

generator_java = rule(
    implementation = _generator_java_impl,
    attrs = {
        "_generator_tool": attr.label(
            executable = True,
            cfg = "exec",
            allow_files = True,
        ),
        # 其他属性...
    },
    output_to_genfiles = True,  # 推荐设为 True,确保 srcjar 输出到 genfiles 目录
)

? BUILD 文件用法(保持简洁)

load("//tools/rules:generator.bzl", "generator_java")

generator_java(
    name = "generated_java",
    # ... 参数
)

java_library(
    name = "mylib",
    srcs = [":generated_java"],  # ✅ 现在指向 .srcjar,可被正确编译
    visibility = ["//visibility:public"],
)

⚠️ 注意事项

  • .srcjar 必须是合法 ZIP 文件,且内部路径需为标准 Java 包结构(如 com/example/Foo.java),否则编译可能失败或包名解析异常;
  • 不要尝试在 java_library.srcs 中混用目录和 .srcjar —— Bazel 会忽略目录;
  • 若生成的 Java 文件含资源(如 resources/),.srcjar 仅支持源码;资源需单独通过 resources 属性或 java_library.resources 提供;
  • 可使用 jar tf target.jar 验证最终 JAR 是否包含预期类:bazel build //:mylib && jar tf bazel-bin/libmylib.jar。

通过将动态生成的源码标准化为 .srcjar,你既保留了灵活的代码生成能力,又完全兼容 Bazel 的 Java 生态链——编译、IDE 导入(如 bazel run @rules_jvm_external//:export_classpath)、测试与发布均可无缝衔接。

Java调试
Java调试

通过 JDWP 实现 Java 远程调试:连接远程 JVM、设置断点、单步执行代码、查看变量值、获取调用栈。适用于需要调试远程 Java 应用、排查运行时状态、追踪代码执行流程的场景。 术语注解 JDWP:Java Debug Wire Protocol,Java 调试有线协议(Java 远程调试底层通信协议) remote JVM:远程 Java 虚拟机 step through code:代码单步调试(步入 / 步过 / 步出调试) inspect variables:变量查看 / 变量检视 stac

下载

Java免费学习笔记:立即使用
解锁 Java 大师之旅:从入门到精通的终极指南

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

java

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
java
java

Java是一个通用术语,用于表示Java软件及其组件,包括“Java运行时环境 (JRE)”、“Java虚拟机 (JVM)”以及“插件”。php中文网还为大家带了Java相关下载资源、相关课程以及相关文章等内容,供大家免费下载使用。

2023.06.15

11717

6

java正则表达式语法
java正则表达式语法

java正则表达式语法是一种模式匹配工具,它非常有用,可以在处理文本和字符串时快速地查找、替换、验证和提取特定的模式和数据。本专题提供java正则表达式语法的相关文章、下载和专题,供大家免费下载体验。

2023.07.05

8822

9

java自学难吗
java自学难吗

Java自学并不难。Java语言相对于其他一些编程语言而言,有着较为简洁和易读的语法,本专题为大家提供java自学难吗相关的文章,大家可以免费体验。

2023.07.31

7572

8

java配置jdk环境变量
java配置jdk环境变量

Java是一种广泛使用的高级编程语言,用于开发各种类型的应用程序。为了能够在计算机上正确运行和编译Java代码,需要正确配置Java Development Kit(JDK)环境变量。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.08.01

1244

3

java保留两位小数
java保留两位小数

Java是一种广泛应用于编程领域的高级编程语言。在Java中,保留两位小数是指在进行数值计算或输出时,限制小数部分只有两位有效数字,并将多余的位数进行四舍五入或截取。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.08.02

1008

3

java基本数据类型
java基本数据类型

java基本数据类型有:1、byte;2、short;3、int;4、long;5、float;6、double;7、char;8、boolean。本专题为大家提供java基本数据类型的相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.02

1496

5

java有什么用
java有什么用

java可以开发应用程序、移动应用、Web应用、企业级应用、嵌入式系统等方面。本专题为大家提供java有什么用的相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.02

3069

5

java在线网站
java在线网站

Java在线网站是指提供Java编程学习、实践和交流平台的网络服务。近年来,随着Java语言在软件开发领域的广泛应用,越来越多的人对Java编程感兴趣,并希望能够通过在线网站来学习和提高自己的Java编程技能。php中文网给大家带来了相关的视频、教程以及文章,欢迎大家前来学习阅读和下载。

2023.08.03

20331

3

配置java环境变量
配置java环境变量

配置Java环境变量是为了让操作系统能够识别和使用Java的相关命令和功能。本专题为大家提供配置java环境变量相关文章,帮助大家解决问题。

2023.08.03

1355

8

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
dev.java 官方:Learn Java
dev.java 官方:Learn Java

共0课时 | 0人学习

Java JDBC数据库连接官方教程
Java JDBC数据库连接官方教程

共0课时 | 0人学习