在Eclipse IDE中使用maven / m2e从.proto自动生成Java

时间:2016-11-04 15:27:40

标签: java eclipse maven protocol-buffers m2e

对于我的团队,我想配置maven / eclipse构建以从*.proto文件(在使用gRPC的项目中)自动生成Java代码。目前,需要运行mvn generate-sourcemvn protobuf:compile(如插件usage page中所示)。或者是什么是相同的添加运行配置来调用maven目标compile

每当刷新Eclipse Maven项目( Alt + F5 )或重新启动IDE时,都会重建项目但不会出现target/generated中的内容,从而转向投成红色。因此需要生成并刷新项目( F5 )。更新Eclipse需要在.clathpath文件中配置源文件夹。

据我所知,应该是m2e连接器,但我只能为最早的Google s plugin com.google.protobuf.tools:maven-protoc-plugin找到一个https://github.com/masterzen/m2e-protoc-connector,目前在https://github.com/grpc/grpc-java

上都没有提及

我们使用完全引用/推荐的

  <groupId>org.xolstice.maven.plugins</groupId>
  <artifactId>protobuf-maven-plugin</artifactId>

即:

<build>
  <extensions>
    <extension>
      <groupId>kr.motd.maven</groupId>
      <artifactId>os-maven-plugin</artifactId>
      <version>1.4.1.Final</version>
    </extension>
  </extensions>
  <plugins>
    <plugin>
      <groupId>org.xolstice.maven.plugins</groupId>
      <artifactId>protobuf-maven-plugin</artifactId>
      <version>0.5.0</version>
      <configuration>
        <protocArtifact>com.google.protobuf:protoc:3.1.0:exe:${os.detected.classifier}</protocArtifact>
        <pluginId>grpc-java</pluginId>
        <pluginArtifact>io.grpc:protoc-gen-grpc-java:1.0.1:exe:${os.detected.classifier}</pluginArtifact>
      </configuration>
      <executions>
        <execution>
          <goals>
            <goal>compile</goal>
            <goal>compile-custom</goal>
          </goals>
        </execution>
      </executions>
    </plugin>
  </plugins>
</build>

相关:

3 个答案:

答案 0 :(得分:4)

我的团队使用 org.xolstice.maven.plugins:protobuf-maven-plugin 来生成邮件类,而不是使用com.github.os72:protoc-jar-maven-plugin。我相信它们是相同的,因为它们似乎都在使用谷歌的工具。

我没有为此插件使用任何m2e连接器(编辑: protoc-jar-maven-plugin的m2e连接器与它捆绑在一起,因此无需额外安装,这就是为什么它似乎我没有使用过,但技术上我是,但这并不重要)。遗憾的是,.proto文件中的更改未“自动”传播到生成的.java文件,您需要手动运行Maven或触发项目在Eclipse中构建(下面的说明),但幸运的是target/generated-sources文件不会消失或清空,也不会像你描述的那样奇怪。

  

如果要在不使用命令行.java的情况下从.proto类重建mvn clean compile个文件,可以清理Eclipse项目。项目→清除...→选择项目→选择构建选项(仅在未选中项目菜单中的“自动构建”时显示)。

我能够在最新的Eclipse Neon中做到这一点(它可能会在以后的版本中使用,但我不确定)。

以下是我正在使用的POM。我不认为它需要任何特殊的解释,我的解决方案是简单地使用与您使用的插件不同的插件。 (如果需要一些解释,我会很乐意提供它。)

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <groupId>io.github.jacksonbailey</groupId>
    <artifactId>protobuf-m2e-sample</artifactId>
    <version>0.1.0-SNAPSHOT</version>
    <dependencies>
        <dependency>
            <groupId>com.google.protobuf</groupId>
            <artifactId>protobuf-java</artifactId>
            <version>3.1.0</version>
        </dependency>
    </dependencies>
    <build>
        <plugins>
            <plugin>
                <groupId>com.github.os72</groupId>
                <artifactId>protoc-jar-maven-plugin</artifactId>
                <version>3.1.0.1</version>
                <executions>
                    <execution>
                        <phase>generate-sources</phase>
                        <goals>
                            <goal>run</goal>
                        </goals>
                        <configuration>
                            <protocVersion>3.1.0</protocVersion>
                            <inputDirectories>
                                <include>src/main/resources</include>
                            </inputDirectories>
                        </configuration>
                    </execution>
                </executions>
            </plugin>
        </plugins>
    </build>
</project>

答案 1 :(得分:1)

protobuf-maven-plugin

感谢https://github.com/xolstice/protobuf-maven-plugin/issues/16中的sergei-ivanov回答,提供了链接https://github.com/trustin/os-maven-plugin#issues-with-eclipse-m2e-or-other-ides

需要下载os-maven-plugin-x.x.x.Final.jar(pomx.ml中的版本)并将其放入<ECLIPSE_HOME>/plugins目录。

之后Eclipse将在项目清理时生成源代码,包括在Maven -update项目之后...( Alt + F5 ),但不是在Project之后 - &gt;构建(或使用默认构建自动)。同样在IDE启动时它将无法编译。

是的,这是不合逻辑的:

项目 - Clean将生成并编译Java源

项目 - 构建不会。

P.S。提升Bug 507412

答案 2 :(得分:0)

eclipse和vscode都可以在更改后自动编译proto。

            <plugin>
                <groupId>kr.motd.maven</groupId>
                <artifactId>os-maven-plugin</artifactId>
                <version>1.6.2</version>
                <executions>
                    <execution>
                        <phase>initialize</phase>
                        <goals>
                            <goal>detect</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>
            <plugin>
                <groupId>org.xolstice.maven.plugins</groupId>
                <artifactId>protobuf-maven-plugin</artifactId>
                <version>0.6.1</version>
                <configuration>
                    <protocArtifact>com.google.protobuf:protoc:3.12.0:exe:${os.detected.classifier}</protocArtifact>
                    <pluginId>grpc-java</pluginId>
                    <pluginArtifact>io.grpc:protoc-gen-grpc-java:1.32.1:exe:${os.detected.classifier}</pluginArtifact>
                </configuration>
                <executions>
                    <execution>
                        <goals>
                            <goal>compile</goal>
                            <goal>compile-custom</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <version>3.8.1</version>
                <configuration>
                    <source>8</source>
                    <target>8</target>
                    <encoding>UTF-8</encoding>
                </configuration>
            </plugin>