如何在 Bazel 中基于生成的 Java 文件构建有效的 Java 库

云强酱_7997

云强酱_7997

2026-11-02

973人浏览

原创

如何在 Bazel 中基于生成的 Java 文件构建有效的 Java 库

Bazel 的 Java 规则不支持目录型(tree)输出,导致 java_library 无法识别通过 declare_directory 生成的源文件;正确做法是将生成的 Java 文件打包为 .srcjar 格式的源码 ZIP 归档,Java 规则即可自动编译其中的 .java 文件。

在 bazel 中构建 java 库时,若源文件由自定义规则动态生成,需特别注意 java 原生规则对输入格式的严格限制:它们不支持目录型(tree)artifact,而仅识别常规文件(如 `.java`)或符合规范的源码归档(`.srcjar`)。直接将 `declare_directory` 输出传给 `java_library.srcs` 将导致静默失败——jar 中仅含 manifest,无任何编译类。

要解决该问题,关键在于将生成的 Java 源文件打包为 .srcjar。.srcjar 本质是一个 ZIP 文件,扩展名必须为 .srcjar(而非 .zip),且内部路径结构应与 Java 包声明一致(例如 com/example/Foo.java 对应包 com.example)。Bazel 的 java_library 会自动解压并编译其中所有 .java 文件。

以下是修改后的完整实现方案:

✅ 步骤 1:更新生成规则,输出 .srcjar

def _generator_java_impl(ctx):
    # 声明输出目录(仍用于中间生成)
    tree = ctx.actions.declare_directory(ctx.attr.name + "_srcs")

    # 执行生成逻辑(保持不变)
    ctx.actions.run(
        inputs = ctx.attr._tools,  # 示例:工具依赖
        outputs = [tree],
        executable = ctx.executable._generator,
        arguments = ["--output", tree.path],
        mnemonic = "JavaGenerator",
    )

    # 新增:创建 .srcjar 归档
    srcjar = ctx.actions.declare_file(ctx.attr.name + ".srcjar")
    ctx.actions.run(
        inputs = [tree],
        outputs = [srcjar],
        executable = ctx.executable._zipper,
        arguments = [
            "c", srcjar.path,  # 'c' 表示 create
            "-C", tree.path, ".",  # 将 tree 下所有内容打包
        ],
        mnemonic = "SrcJarPack",
    )

    return [DefaultInfo(files = depset([srcjar]))]

generator_java = rule(
    implementation = _generator_java_impl,
    attrs = {
        "_zipper": attr.label(
            default = Label("@bazel_tools//tools/zip:zipper"),
            cfg = "exec",
            executable = True,
        ),
        # 其他属性...
    },
    output_to_genfiles = True,
)

? 提示:Bazel 内置 @bazel_tools//tools/zip:zipper 是轻量、确定性高的 ZIP 工具,推荐用于 .srcjar 打包;避免使用系统 zip 命令以确保可重现性。

Java调试
Java调试

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

下载

✅ 步骤 2:在 BUILD 文件中引用 .srcjar

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

java_library(
    name = "mylib",
    srcs = [":generated_java"],  # ✅ 现在指向 .srcjar 文件
    # 可选:添加 deps(如生成代码依赖的其他库)
    # deps = ["//some/dep"],
)

⚠️ 注意事项

  • 扩展名必须为 .srcjar:即使内容是合法 ZIP,若命名为 generated.zip,Bazel 将忽略它。
  • 路径一致性:.srcjar 内部的 Java 文件路径需与 package 声明匹配,否则编译报错(如 package com.example; 要求文件位于 com/example/Foo.java)。
  • 增量构建友好:.srcjar 是普通文件 artifact,Bazel 能正确追踪其变更,触发精准重编译。
  • 调试技巧:运行 bazel build //:generated_java && unzip -l bazel-bin/generated_java.srcjar 验证归档内容是否正确。

通过此方式,你既能保留灵活的代码生成逻辑,又能无缝集成到 Bazel 的 Java 编译流水线中——生成即编译,零配置、高可靠。

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人学习