Gradle Java/Kotlin项目如何导入依赖中的Proto文件？

场景说明 #

现有两个Gradle项目：

• dependency-project：包含models/catalog.proto文件
• my-project：包含source/client.proto文件，需复用catalog.proto中定义的模型

当前遇到的问题：

1. 类路径中能找到catalog.proto，但无法在client.proto中直接导入
2. catalog.proto未声明任何package

解决方案 #

1. 调整Gradle配置，让Protoc识别依赖中的Proto文件 #

修改my-project的build.gradle.kts，核心是给Protoc指定依赖中Proto文件的来源，同时使用正确的依赖类型：

dependencies {
    // 编译后的Protobuf类依赖
    implementation("com.google.protobuf:protobuf-java:$protoBufCoreVersion")
    // 引入包含catalog.proto的依赖（本地项目依赖用project，第三方库替换为对应GAV）
    proto(project(":dependency-project"))
}

apply(plugin = "com.google.protobuf")

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

    // 配置生成Java/Kotlin代码的规则
    generateProtoTasks {
        all().forEach { task ->
            task.builtins {
                create("java") // 生成Java代码，Kotlin项目可额外添加create("kotlin")
            }
        }
    }

    // 让Protoc能找到依赖包中的Proto文件
    sourceSets {
        main {
            proto {
                // 加载依赖中的Proto文件（自动解压依赖包中的Proto资源）
                srcDirs += configurations.proto.map { zipTree(it) }
            }
        }
    }
}

2. 修正client.proto的导入语句 #

导入路径需对应catalog.proto在依赖项目中的实际目录结构，无需加classpath/前缀：

syntax = "proto3";
package client;

import "google/protobuf/descriptor.proto";
import "models/catalog.proto"; // 对应dependency-project中catalog.proto的路径

3. 处理无Package的问题 #

由于catalog.proto没有声明package，生成的Java/Kotlin类会处于默认包下，容易引发命名冲突。建议给catalog.proto添加package声明：

syntax = "proto3";
package catalog; // 添加package声明

// 原有的消息定义...

添加后，在client.proto中即可通过catalog.XXX的方式引用其定义的类型。

可行性说明 #

这种跨依赖复用Proto文件的用法完全可行，核心是通过Gradle的proto依赖类型和protobuf插件配置，让Protoc能扫描到依赖包中的原始Proto文件。ScalaPB的实现思路本质一致，Java/Kotlin项目使用官方的com.google.protobuf插件即可完成配置。

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