Gradle+Protobuf项目单元测试中生成类父类无法解析的解决咨询

问题描述 #

我有一个使用proto3生成器的Gradle项目，相关配置如下：

buildscript {
    repositories {
        mavenCentral()
    }
    dependencies {
        classpath("com.google.protobuf:protobuf-gradle-plugin:0.8.14")
    }
}
...

dependencies {
  ...
  implementation("com.google.protobuf:protobuf-java:$protoBufCoreVersion")
}

protobuf {
    protoc {
        artifact = "com.google.protobuf:protoc:$protoBufCoreVersion"
    }
}

同时配置了将生成的源码打包的任务：

tasks.register<Jar>("sourcesJar") {
    from(sourceSets.main.get().allSource)
    archiveClassifier.set("sources")
}

publishing {
    publications {
        create<MavenPublication>("mavenJava") {
            from(components["java"])
            artifact(tasks["sourcesJar"])
        }
    }
}

Protobuf模型生成源码后，能在类路径中看到它并在单元测试中导入，但执行构建或手动运行单元测试时出现编译错误。

单元测试代码：

@Test
fun test() {
   Device.newBuilder() // 编译错误     
}

错误信息：

Supertypes of the following classes cannot be resolved. Please make sure you have the required dependencies in the classpath:
    class my.project.model.request.Device, unresolved supertypes: com.google.protobuf.GeneratedMessageV3
    class my.project.model.request.DeviceOrBuilder, unresolved supertypes: com.google.protobuf.MessageOrBuilder
Adding -Xextended-compiler-checks argument might provide additional information.

对应的Protobuf模型：

message Device {
  string id = 1;
  Type type = 2;
  optional string manufacturer = 3;
  optional string model = 4;
  optional string software = 5;
}

生成的Java类片段：

public final class Device extends
    com.google.protobuf.GeneratedMessageV3 implements
    // @@protoc_insertion_point(message_implements:source.request.Device)
    DeviceOrBuilder {
private static final long serialVersionUID = 0L;
...
 @java.lang.Override
  public Builder newBuilderForType() { return newBuilder(); }
  public static Builder newBuilder() {
    return DEFAULT_INSTANCE.toBuilder();
  }

请问如何在单元测试中正常使用这些生成的模型？

解决方案 #

1. 确保测试编译路径包含Protobuf核心依赖 #

虽然implementation依赖理论上会被测试编译路径继承，但部分场景下可能存在传递失效问题，直接为测试添加显式依赖：

dependencies {
    // 主代码依赖
    implementation("com.google.protobuf:protobuf-java:$protoBufCoreVersion")
    // 测试代码显式依赖，确保父类定义可被访问
    testImplementation("com.google.protobuf:protobuf-java:$protoBufCoreVersion")
}

2. 完善Protobuf插件配置，确保生成代码被正确识别 #

显式配置生成Java代码的任务，避免插件自动配置失效：

protobuf {
    protoc {
        artifact = "com.google.protobuf:protoc:$protoBufCoreVersion"
    }
    // 强制开启Java代码生成任务
    generateProtoTasks {
        all().each { task ->
            task.builtins {
                java {}
            }
        }
    }
}

3. 手动关联生成的Protobuf代码到主源码集 #

如果插件未自动将生成代码加入源码路径，手动添加目录：

sourceSets {
    main {
        java {
            srcDirs += "${protobuf.generatedFilesBaseDir}/main/java"
        }
    }
}

4. 清理缓存并重新构建 #

执行Gradle清理任务清除旧编译缓存，再重新构建项目：

./gradlew clean build

内容的提问来源于stack exchange，提问作者Aleksandr T