Question

我正在现有的，相当普通的Maven 2项目中试验Protocol Buffers。目前，每次我需要更新生成的源时，都会调用shell脚本。这显然是一个麻烦，因为我希望在每次构建之前自动生成源。希望不要诉诸可耻的hackery。

所以，我的问题是双重的：

远射：是否有Maven 2的“Protocol Buffers插件”能够以自动方式实现上述目标？有一个branch on Google Code，其作者似乎已经开始实施这样的插件。不幸的是，它hasn't passed code review或已合并到protobuf主干。因此，该插件的状态是未知的。
可能更现实：缺少一个实际的插件，我怎样才能从我的Maven 2版本中调用protoc？我想我可以将现有的shell脚本连接到antrun调用或类似的东西。

非常感谢个人经历。

Answer 1

您可以在Protocol Buffers讨论组的Protocol Buffers Compiler Maven Plug-In线程中的Protocol Buffers存储库中找到有关插件的一些信息。我的理解是它可用但缺乏测试。我试一试。

或者你可以使用antrun插件（从上面提到的线程粘贴的snipet）：

 <build>
   <plugins>
     <plugin>
       <artifactId>maven-antrun-plugin</artifactId>
       <executions>
         <execution>
           <id>generate-sources</id>
           <phase>generate-sources</phase>
           <configuration>
             <tasks>
               <mkdir dir="target/generated-sources"/>
               <exec executable="protoc">
                 <arg value="--java_out=target/generated-sources"/>
                 <arg value="src/main/protobuf/test.proto"/>
               </exec>
             </tasks>
             <sourceRoot>target/generated-sources</sourceRoot>
           </configuration>
           <goals>
             <goal>run</goal>
           </goals>
         </execution>
       </executions>
     </plugin>
   </plugins>
 </build>

 <dependencies>
   <dependency>
     <groupId>com.google.protobuf</groupId>
     <artifactId>protobuf-java</artifactId>
     <version>2.0.3</version>
   </dependency>
 </dependencies>

Answer 2

accepted answer鼓励我让Google提供的插件正常运行。我将我的问题中提到的分支合并到2.2.0源代码的检查中，构建并安装/部署了该插件，并且能够在我的项目中使用它，如下所示：

  <build>
    <plugins>
      <plugin>
        <groupId>com.google.protobuf.tools</groupId>
        <artifactId>maven-protoc-plugin</artifactId>
        <version>0.0.1</version>
        <executions>
          <execution>
            <id>generate-sources</id>
            <goals>
              <goal>compile</goal>
            </goals>
            <phase>generate-sources</phase>
            <configuration>
              <protoSourceRoot>${basedir}/src/main/protobuf/</protoSourceRoot>
              <includes>
                <param>**/*.proto</param>
              </includes>
            </configuration>
          </execution>
        </executions>
        <configuration>
          <protocExecutable>/usr/local/bin/protoc</protocExecutable>
        </configuration>
      </plugin>
    </plugins>
  </build>

请注意，我将插件的版本更改为0.0.1（无-SNAPSHOT），以使其进入我的非快照第三方Nexus存储库。因人而异。需要注意的是，一旦不再需要跳过篮筐就可以使用这个插件。

Answer 3

已接受的解决方案无法扩展到多个原型文件。我必须拿出自己的：

<build>
    <plugins>
        <plugin>
            <artifactId>maven-antrun-plugin</artifactId>
            <executions>
                <execution>
                    <id>compile-protoc</id>
                    <phase>generate-sources</phase>
                    <configuration>
                        <tasks>
                            <mkdir dir="${generated.sourceDirectory}" />
                            <path id="proto.path">
                                <fileset dir="src/main/proto">
                                    <include name="**/*.proto" />
                                </fileset>
                            </path>
                            <pathconvert pathsep=" " property="proto.files" refid="proto.path" />
                            <exec executable="protoc" failonerror="true">
                                <arg value="--java_out=${generated.sourceDirectory}" />
                                <arg value="-I${project.basedir}/src/main/proto" />
                                <arg line="${proto.files}" />
                            </exec>
                        </tasks>
                    </configuration>
                    <goals>
                        <goal>run</goal>
                    </goals>
                </execution>
            </executions>
        </plugin>
</build>

Answer 4

Igor Petruk还有一个很棒的插件，名为protobuf-maven-plugin。它现在在中央回购中并与eclipse很好地配合（建议使用m2e-1.1）。

Answer 5

我刚刚更新了maven插件以使用2.2.0 - 更新的pom附加到代码审查错误。

以下是自行构建插件的说明：

svn co http://protobuf.googlecode.com/svn/branches/maven-plugin/tools/maven-plugin
cd maven-plugin
wget -O pom.xml 'http://protobuf.googlecode.com/issues/attachment?aid=8860476605163151855&name=pom.xml'
mvn install

然后您可以使用上面的maven配置。

Answer 6

我刚从https://github.com/dtrott/maven-protoc-plugin尝试了一个较少官方但非常近期（v 0.1.7）的分叉，并且它工作得非常好，由大卫特罗特提供。我用几个Maven模块进行了测试，其中一个模块包含DTO样式的消息，另一个模块依赖于它们。我借用了MaxA于2009年10月16日发布的插件配置，我在PATH上使用了protoc并添加了

<temporaryProtoFileDirectory>${basedir}/target/temp</temporaryProtoFileDirectory>

之后

<protocExecutable>protoc</protocExecutable>。

真正好的是，我所要做的就是从DTO模块上的服务模块声明一个正常的依赖关系。该插件能够通过查找与DTO模块一起打包的proto文件，将它们提取到临时目录并在为服务生成代码时使用来解析原始文件依赖项。并且很聪明，不要将生成的DTO类的第二个副本与服务模块打包在一起。

Answer 7

protobuf有一个maven插件。 https://www.xolstice.org/protobuf-maven-plugin/usage.html

最小配置

 <plugin>
    <groupId>org.xolstice.maven.plugins</groupId>
    <artifactId>protobuf-maven-plugin</artifactId>
    <version>0.5.0</version>
    <configuration>
      <protocExecutable>/usr/local/bin/protoc</protocExecutable>
    </configuration>
    <executions>
      <execution>
        <goals>
          <goal>compile</goal>
          <goal>test-compile</goal>
        </goals>
      </execution>
    </executions>
  </plugin>

Answer 8

我认为使用antrun调用非Maven步骤是普遍接受的解决方案。

您也可以尝试maven-exec-plugin。

Answer 9

我将David Trott的插件分开，让它编译多种语言，这使它更有用。请参阅github项目here以及有关将其与maven构建here集成的教程。

将协议缓冲区集成到Maven2构建中

9 个答案: