Gradle处理Proto文件时为何忽略sourceSets/srcDir？路径配置排查

看起来你遇到了两个核心问题：一是Gradle解析Proto源目录时出现了路径叠加错误，二是protoc找不到导入的依赖Proto文件。结合你的目录结构（src/ps/proto，build.gradle位于src目录下）和需求，我来一步步帮你解决：

问题根源分析 #

1. 路径混乱：你在sourceSets里设置srcDir 'ps/proto'，但执行命令时Gradle却查找src/src/ps/proto——这是因为如果在项目根目录（而不是src目录）执行gradlew，Gradle会把项目根目录作为基准路径，同时protobuf插件对自定义sourceSet默认会拼接src/前缀，导致路径叠加成了项目根目录/src/ps/proto，但你的build.gradle本身就在src目录下，最终变成了项目根目录/src/src/ps/proto，自然找不到。
2. Proto导入失败：protoc的include路径没有正确指向你的源目录，导致import "ps/proto/xxx.proto"无法找到对应文件。
3. 语法警告：你的Proto文件缺少语法声明，protoc默认回退到proto2，但最好显式声明避免警告。

解决方案步骤 #

1. 修正SourceSets的路径配置 #

根据你执行Gradle命令的路径，调整srcDir的设置：

• 如果在src目录下执行命令：直接用相对路径指向当前目录下的ps/proto：

  sourceSets {
      ps {
          proto {
              srcDir 'ps/proto'
          }
      }
  }
  

• 如果在项目根目录执行命令（需用-b src/build.gradle指定配置文件）：要指向相对于项目根目录的src/ps/proto：

  sourceSets {
      ps {
          proto {
              srcDir 'src/ps/proto'
          }
      }
  }
  

2. 配置Protobuf插件，确保protoc能找到导入文件 #

在protobuf配置块中，为生成任务添加源目录到protoc的include路径，同时禁用不需要的Java生成插件（如果你只需要C++文件）：

protobuf {
    protoc {
        artifact = 'com.google.protobuf:protoc:2.4.1'
    }
    generateProtoTasks {
        all().each { task ->
            task.plugins {
                cpp {} // 启用C++代码生成
            }
            task.builtins {
                java { enabled = false } // 禁用Java生成，节省编译时间
            }
            // 关键：把Proto源目录设为protoc的include路径
            task.protoSourceDirs = sourceSets.ps.proto.srcDirs
        }
    }
    // 可选：自定义生成文件的输出目录，默认是build/generated/source/proto/ps/cpp
    generatedFilesBaseDir = "$projectDir/build/generated"
}

3. 修复Proto文件的语法声明 #

在每个*.proto文件的开头添加语法声明（因为你用的是protobuf 2.4.1，对应proto2）：

syntax = "proto2";

4. 配置C++编译任务生成.o文件 #

如果你需要把生成的*.cc文件编译成*.o，可以添加以下配置：

tasks.withType(CppCompile) {
    // 添加生成的C++头文件目录到编译include路径
    includes += fileTree(dir: "${protobuf.generatedFilesBaseDir}/ps/cpp")
    // 指定要编译的生成的.cc文件
    source fileTree(dir: "${protobuf.generatedFilesBaseDir}/ps/cpp", include: '*.cc')
}

5. 正确执行Gradle命令 #

• 如果你切换到src目录：

  cd src
  ../gradlew generatePsProto
  

• 如果你在项目根目录：

  gradlew -b src/build.gradle generatePsProto
  

完整的build.gradle示例 #

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

apply plugin: 'c'
apply plugin: 'cpp'
apply plugin: 'java'
apply plugin: 'com.google.protobuf'

repositories {
    mavenCentral()
}

dependencies {
    compile "com.google.protobuf:protobuf-java:2.4.1"
}

sourceSets {
    ps {
        proto {
            // 根据执行命令的路径选择下面其中一行
            srcDir 'ps/proto' // 在src目录执行时用
            // srcDir 'src/ps/proto' // 在项目根目录执行并指定-b时用
        }
    }
}

protobuf {
    protoc {
        artifact = 'com.google.protobuf:protoc:2.4.1'
    }
    generateProtoTasks {
        all().each { task ->
            task.plugins {
                cpp {}
            }
            task.builtins {
                java { enabled = false }
            }
            task.protoSourceDirs = sourceSets.ps.proto.srcDirs
        }
    }
    generatedFilesBaseDir = "$projectDir/build/generated"
}

// 编译生成的cc文件为o文件
tasks.withType(CppCompile) {
    includes += fileTree(dir: "${protobuf.generatedFilesBaseDir}/ps/cpp")
    source fileTree(dir: "${protobuf.generatedFilesBaseDir}/ps/cpp", include: '*.cc')
}

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