解决Bazel Java测试中Protobuf间接依赖错误的指南

本文旨在解决bazel构建系统中，java_test_suite在使用protobuf类型（如com.google.protobuf.timestamp）时遇到的“using type from an indirect dependency”错误。核心在于理解protobuf的proto_library与java_proto_library之间的区别，并正确配置依赖，确保java测试直接依赖于protobuf生成的java代码库，而非原始的.proto定义。

理解Bazel的严格依赖与Protobuf类型

在使用Bazel构建Java项目时，我们经常会遇到“Using type X from an indirect dependency”的错误。这通常是Bazel严格依赖（Strict Deps）检查的结果，它要求所有直接使用的类型都必须通过直接依赖显式声明。对于Protobuf类型，如com.google.protobuf.Timestamp，这个错误尤其常见，因为Protobuf的定义和其对应的Java类是分开生成的。

原始的timestamp_proto（通常由proto_library规则定义）仅仅包含了Protobuf的.proto文件定义。它本身并不直接提供Java类型。要使用这些Protobuf定义的Java类，我们需要一个中间步骤：通过java_proto_library规则将.proto文件编译成Java源代码，并打包成一个Java库。

当java_test_suite直接依赖于@com_google_protobuf//:timestamp_proto时，它实际上只看到了Protobuf的原始定义。虽然在某些情况下，这些原始定义可能间接拉取了包含Java类的库，但Bazel的严格依赖机制会认为com.google.protobuf.Timestamp这个Java类型并非来自timestamp_proto的直接输出，从而抛出间接依赖错误。

错误的依赖配置示例

考虑以下java_test_suite配置，它试图直接依赖Protobuf的timestamp_proto：

立即学习“Java免费学习笔记（深入）”；

# BUILD文件片段
java_test_suite(
    name = "all-tests",
    srcs = glob(["src/test/java/**/*.java"]),
    runner = "junit5",
    test_suffixes = ["Test.java"],
    runtime_deps = JUNIT5_DEPS,
    deps = [
        ":mylib",
        "@com_google_protobuf//:timestamp_proto", # 错误：直接依赖proto_library
        artifact("org.junit.jupiter:junit-jupiter-api"),
        artifact("org.junit.jupiter:junit-jupiter-params"),
    ] + deps,
)

当CustomTest.java中包含import com.google.protobuf.Timestamp;并尝试使用该类型时，Bazel会报错：

src/test/java/com/x/CustomTest.java:75: error: [strict] Using type com.google.protobuf.Timestamp from an indirect dependency (TOOL_INFO: "@com_google_protobuf//:timestamp_proto wrapped in java_proto_library").

错误信息中TOOL_INFO: "@com_google_protobuf//:timestamp_proto wrapped in java_proto_library"这一部分是关键，它暗示了timestamp_proto需要被java_proto_library包装才能提供Java类型。

正确的解决方案

解决此问题的核心在于引入一个java_proto_library规则，它将timestamp_proto编译为可供Java代码使用的库。然后，java_test_suite应该依赖于这个新创建的java_proto_library目标。

步骤一：定义java_proto_library目标

在您的BUILD文件中，定义一个java_proto_library规则。这个规则将负责从@com_google_protobuf//:timestamp_proto生成Java类。

挖错网

一款支持文本、图片、视频纠错和AIGC检测的内容审核校对平台。

28

查看详情

# 在您的BUILD文件中添加此规则
java_proto_library(
  name = "timestamp_java_proto",
  deps = ["@com_google_protobuf//:timestamp_proto"],
)

这里，timestamp_java_proto是我们创建的新目标，它依赖于Protobuf的原始timestamp_proto定义。当这个目标被构建时，它会生成包含com.google.protobuf.Timestamp等Java类的库。

步骤二：更新java_test_suite依赖

现在，将java_test_suite的deps从@com_google_protobuf//:timestamp_proto改为新创建的//:timestamp_java_proto。

# 更新后的BUILD文件片段
java_test_suite(
    name = "all-tests",
    srcs = glob(["src/test/java/**/*.java"]),
    runner = "junit5",
    test_suffixes = ["Test.java"],
    runtime_deps = JUNIT5_DEPS,
    deps = [
        ":mylib",
        "//:timestamp_java_proto", # 正确：依赖java_proto_library
        artifact("org.junit.jupiter:junit-jupiter-api"),
        artifact("org.junit.jupiter:junit-jupiter-params"),
    ] + deps,
)

通过这个修改，java_test_suite现在直接依赖于一个提供com.google.protobuf.Timestamp Java类型的库，满足了Bazel的严格依赖要求。

关于buildozer命令的注意事项

在问题描述中，提到了buildozer 'add deps @com_google_protobuf//:timestamp_proto' //:src/test/java/com/x/CustomTest命令失败，并提示rule 'src/test/java/com/x/CustomTest' not found。这是因为buildozer命令是用来修改Bazel规则的，而//:src/test/java/com/x/CustomTest指向的是一个源文件路径，而非一个Bazel规则目标。依赖关系应该添加到定义这些源文件的Bazel规则（例如java_test_suite或java_library）上，而不是源文件本身。理解Bazel的目标和源文件之间的区别对于正确使用buildozer至关重要。

总结

当在Bazel的Java项目中遇到Protobuf类型相关的“Using type from an indirect dependency”错误时，请记住以下几点：

1. proto_library vs. java_proto_library: proto_library仅定义.proto文件，而java_proto_library负责将其编译为Java类。
2. 直接依赖: 您的Java代码（包括测试）需要直接依赖于提供Java类的java_proto_library目标。
3. 创建中间目标: 如果您直接使用的Protobuf定义是proto_library类型，请为其创建一个java_proto_library包装目标。

遵循这些原则，可以有效解决Bazel严格依赖下Protobuf Java类型的引用问题，确保构建的清晰性和正确性。

以上就是解决Bazel Java测试中Protobuf间接依赖错误的指南的详细内容，更多请关注php中文网其它相关文章！