使用Gradle简单编译Protobuf

Question

使用Gradle简单编译Protobuf

29

如果您正在寻找Gradle Protobuf示例项目，请在此处查看。

我在处理Gradle和Protobuf方面遇到了困难，我想创建一个简单的Gradle项目，将默认的src/main/proto、src/test/proto中的任何Proto文件编译为相应的src/main/java、src/test/java，然后打包成一个jar并发布到本地仓库。

不幸的是，我还不熟悉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文件到适当的源目录（蓝色箭头），之后普通的构建就会做正确的事情...毕竟我们需要这些类在业务逻辑中使用...

因此，我们只需要一个任务来将proto编译到适当的源目录中...仅此而已。

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

当前项目所在地为这里。请帮忙配置，我相信以后会有很多人需要它...

- vach

你能分享一个可运行的例子吗？我知道它可能是未完成的。 - Opal

@Opal 我会把最终可用的版本留在这里，供其他人使用。https://github.com/vach/sample-gradle-protobuf - vach

你可以看一下这个例子 https://github.com/google/protobuf-gradle-plugin/blob/master/testProject/build.gradle - SubOptimal

1

@vach，请看一下这行代码：https://github.com/google/protobuf-gradle-plugin/blob/master/src/main/groovy/com/google/protobuf/gradle/ProtobufPlugin.groovy#L86。由于proto任务是在“afterEvaluate”中添加的，因此您在“gradle tasks”输出中看不到这些任务-但它们确实存在。运行“gradlew generateProto”，并调查“build”目录。源代码将被生成。 - Opal

好的。我会看一下，但需要几个小时后才能给你答复。 - Opal

显示剩余8条评论

1个回答

网页内容由stack overflow 提供, 点击上面的

可以查看英文原文，
原文链接

- TobiSH · Accepted Answer

如果我没有误解您的问题，那么解决起来很简单。如果您不想区分自己的源代码和生成的源代码，只需像这样设置generatedFileBaseDir即可：generateProtoTasks.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.java

但是：可能将生成的代码与手工编写的源代码混合在一起并不是最好的想法。因此，我的建议是将生成的源代码放入一个名为generatedSources的单独目录中，并将该目录添加到java sourceSet中。构建文件应如下所示：

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.proto
src/main/java/com/vach/tryout/protobuf/Main.java
generated-sources/main/java/com/vach/tryout/AddressBookProtos.java

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