用gradle编译简单protobuf

Question

如果你正在寻找GradleProtobuf项目的样本，请看这里。

我在gradle和protobuf方面遇到了困难，我想创建一个简单的gradle项目，该项目将从默认的src/main/proto、src/test/proto中获取任何proto文件，并将它们编译为src/main/java、src/test/java，然后将其打包到jar中并发布到本地repo。

不幸的是，我是gradle的新手，无法理解最初的项目是如何组成的。

这是我未完成的build.gradle档案

apply plugin: 'java'
apply plugin: "com.google.protobuf"

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

repositories {
    mavenCentral()
}

dependencies {
    compile 'com.google.protobuf:protobuf-java:3.0.0-beta-1'
}

sourceSets {
    main {
        proto {
            srcDir 'src/main/proto'
        }
        java {
            srcDir 'src/main/java'
        }
    }
    test {
        proto {
            srcDir 'src/test/proto'
        }
        proto {
            srcDir 'src/test/java'
        }
    }
}

protobuf {
    // Configure the protoc executable
    protoc {
        // Download from repositories
        artifact = 'com.google.protobuf:protoc:3.0.0-alpha-3'
    }
    generateProtoTasks {
        // all() returns the collection of all protoc tasks
        all().each { task ->
            // Here you can configure the task
        }

        // In addition to all(), you may get the task collection by various
        // criteria:

        // (Java only) returns tasks for a sourceSet
        ofSourceSet('main')

    }
}

运行jar任务后，我们有以下内容：

正如您所看到的，gradle将测试和主proto构建到相同的类目录（红色箭头），在jar中，我可以看到两个生成的类都包含在内（而测试应该被跳过）。

但主要问题是我想将proto文件直接编译到适当的源目录（蓝色箭头），之后普通构建会做正确的事情...毕竟我们需要src中的那些类才能在业务逻辑中使用它们...

所以我们只需要一个任务，将proto编译到相应的src目录。。。没什么了。

src/main/proto to src/main/java
src/test/proto to src/test/java

当前项目位于此处。请帮助配置这个，我很确定很多人以后会需要它。。。

Answer 1

如果我没有误解你的问题，解决起来很简单。如果不想区分自己的源代码和生成的源代码，只需添加并设置generatedFileBaseDir，如下所示。generatedFilesBaseDir='src'

因此，整个构建文件如下所示：

// ...

protobuf {
// Configure the protoc executable
protoc {
    // Download from repositories
    artifact = 'com.google.protobuf:protoc:3.0.0-alpha-3'
}

generateProtoTasks.generatedFilesBaseDir = 'src' // <- that line 

generateProtoTasks {
    // all() returns the collection of all protoc tasks
    all().each { task ->
        // Here you can configure the task
    }

比您的文件夹看起来更像：

• src/main/java/com/vach/tryout/AddressBookProtos。java
• src/main/java/com/vach/tryout/protobuf/main。爪哇

但是：这可能不是将generate与手工制作的源代码混合使用的最佳方法。因此，我的建议是将源代码生成到自己的目录中，如generatedSources，并将此目录添加到java源集中。生成文件如下所示：

sourceSets {
    main {
        proto {
            srcDir 'src/main/proto'
        }
        java {
            // include self written and generated code
            srcDirs 'src/main/java', 'generated-sources/main/java'            
        }
    }
    // remove the test configuration - at least in your example you don't have a special test proto file
}

protobuf {
    // Configure the protoc executable
    protoc {
        // Download from repositories
        artifact = 'com.google.protobuf:protoc:3.0.0-alpha-3'
    }

    generateProtoTasks.generatedFilesBaseDir = 'generated-sources'

    generateProtoTasks {
        // all() returns the collection of all protoc tasks
        all().each { task ->
            // Here you can configure the task
        }

        // In addition to all(), you may get the task collection by various
        // criteria:

        // (Java only) returns tasks for a sourceSet
        ofSourceSet('main')

    }   
}

您的目录如下所示

• src/main/proto/dtos。协议

一个很好的副作用是您可以在git配置中忽略这个生成的源代码目录。不发布生成的源代码总是一个好主意。