使用protobuf-maven-plugin检索protoc的外部.proto文件

时间:2018-02-15 16:37:11

标签: maven protocol-buffers

上下文:我的团队正在努力使我们的Java服务套件容器化并可动态扩展。为实现此目标,我们的计划是使用Endpoint Discovery Service中使用Envoy documentation的自定义构建v2 gRPC-based API来使用etd支持的Envoy。然后,我们将为每个服务生成Docker镜像,并使用Kubernetes部署/管理它们。

我们使用Maven作为构建系统。我非常精通Maven,但这是我第一次使用gRPC或协议缓冲区。

我使用Spring Boot为我的服务创建了一个存根,Jetty为管理提供了一些REST和JMX端点。在介绍protobuf的东西之前,存根建立并运行得很好。

我已经下载了Envoy data-plane-api并检查了API定义文件(** / * .proto)到src / main / proto下的项目中,保留了下载的目录结构(例如src / main /原/使者/ API / V2 / eds.proto)。 (附带问题:我需要BUILD文件吗?)

最后,我想要一个可以读取这些文件并生成Java类的独立Maven构建。构建需要在Windows和OS X框上工作,以便它适用于开发人员和Linux机箱,以便它在我们的CI(Bamboo)中工作。它只需要一个JDK,一个Maven安装和一个Maven仓库。 (我们有一个Artifactory实例,我可以在必要时上传其他在线无法提供的工件。)

到目前为止我所拥有的内容似乎将实现我的可移植性目标:

的pom.xml:

<?xml version="1.0" encoding="UTF-8"?>
<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/maven-v4_0_0.xsd">

    <modelVersion>4.0.0</modelVersion>
    <artifactId>discovery-service</artifactId>
    <packaging>jar</packaging>
    <name>Discovery Service</name>
    <version>1.0.0</version>

    <build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <version>3.7.0</version>
                <configuration>
                    <verbose>true</verbose>
                    <fork>true</fork>
                    <source>1.8</source>
                    <target>1.8</target>
                </configuration>
            </plugin>
            <plugin>
                <groupId>org.xolstice.maven.plugins</groupId>
                <artifactId>protobuf-maven-plugin</artifactId>
                <version>0.5.1</version>
                <configuration>
                    <protocArtifact>com.google.protobuf:protoc:3.5.1-1:exe:${os.detected.classifier}</protocArtifact>
                    <checkStaleness>true</checkStaleness>
                </configuration>
                <executions>
                    <execution>
                        <goals>
                            <goal>compile</goal>
                            <goal>test-compile</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>
        </plugins>
        <extensions>
            <!-- provides os.detected.classifier (i.e. linux-x86_64, osx-x86_64) property -->
            <extension>
                <groupId>kr.motd.maven</groupId>
                <artifactId>os-maven-plugin</artifactId>
                <version>1.4.1.Final</version>
            </extension>
        </extensions>
    </build>

    <dependencies>
        <dependency>
            <groupId>io.hydrosphere</groupId>
            <artifactId>envoy-data-plane-api_2.11</artifactId>
            <version>v1.5.0_1</version>
        </dependency>

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

        <dependency>
            <groupId>io.grpc</groupId>
            <artifactId>grpc-core</artifactId>
            <version>1.9.1</version>
        </dependency>

        <dependency>
            <groupId>io.grpc</groupId>
            <artifactId>grpc-protobuf</artifactId>
            <version>1.9.1</version>
        </dependency>

        <!--Unrelated deps (Spring Boot, Jetty, logging, etc) omitted for brevity -->

    </dependencies>
</project>

当我使用mvn compile构建此项目时,Maven正确下载protoc并调用它,但是protoc错误,因为它无法找到一些外部依赖项:

[INFO] Scanning for projects...
[INFO] ------------------------------------------------------------------------
[INFO] Detecting the operating system and CPU architecture
[INFO] ------------------------------------------------------------------------
[INFO] os.detected.name: osx
[INFO] os.detected.arch: x86_64
[INFO] os.detected.classifier: osx-x86_64
[INFO] 
[INFO] ------------------------------------------------------------------------
[INFO] Building Discovery Service 1.0.0
[INFO] ------------------------------------------------------------------------
Downloading: http://devutl1.sircon.com:8081/artifactory/libs-snapshot/org/glassfish/javax.el/maven-metadata.xml
Downloading: http://devutl1.sircon.com:8081/artifactory/libs-release/org/glassfish/javax.el/maven-metadata.xml
Downloaded: http://devutl1.sircon.com:8081/artifactory/libs-release/org/glassfish/javax.el/maven-metadata.xml (882 B at 547 B/s)
Downloaded: http://devutl1.sircon.com:8081/artifactory/libs-snapshot/org/glassfish/javax.el/maven-metadata.xml (882 B at 547 B/s)
[INFO] 
[INFO] --- maven-enforcer-plugin:3.0.0-M1:enforce (default-cli) @ discovery-service ---
[INFO] 
[INFO] --- protobuf-maven-plugin:0.5.1:compile (default) @ discovery-service ---
[INFO] Compiling 56 proto file(s) to /Users/jrobb/Projects/vertabrae/trunk/scaling/discovery-service/target/generated-sources/protobuf/java
[ERROR] PROTOC FAILED: validate/validate.proto: File not found.
gogoproto/gogo.proto: File not found.
envoy/api/v2/core/address.proto: Import "validate/validate.proto" was not found or had errors.
envoy/api/v2/core/address.proto: Import "gogoproto/gogo.proto" was not found or had errors.
envoy/config/metrics/v2/stats.proto: Import "envoy/api/v2/core/address.proto" was not found or had errors.
envoy/config/metrics/v2/stats.proto: Import "validate/validate.proto" was not found or had errors.
envoy/config/metrics/v2/stats.proto:148:5: "envoy.api.v2.core.Address" is not defined.
envoy/config/metrics/v2/stats.proto:167:5: "envoy.api.v2.core.Address" is not defined.

输出继续,每个.proto文件都有相同的错误集。

问题的关键似乎是我没有validate / validate.proto或gogoproto / gogo.proto,它们是在(几乎?)每个.proto文件的顶部导入的:

import "google/protobuf/wrappers.proto";

import "validate/validate.proto";
import "gogoproto/gogo.proto";

它似乎找到了wrappers.proto,我认为它来自我对protobuf-java的编译时Maven依赖。

我认为gogoproto/gogo.proto可能正在寻找:https://github.com/gogo/protobuf/blob/master/gogoproto/gogo.proto

我完全不知道validate/validate.proto应该来自哪里。我已经看到一些证据表明它特有于特使,但我找不到它。

我花了最后几个小时进行搜索,而且我对任何以前完成此操作的人都说空了。我从哪里获得这些文件?如果我不能从Maven Central获得它们,我将自己构建它们并上传到Artifactory。

我的眼睛正在看着为使用其他技术堆栈的人准备的文档,我在翻译我的需求时遇到了麻烦。任何和所有的帮助将不胜感激,如果这是一个非常难以理解的问题我会道歉。 :)

1 个答案:

答案 0 :(得分:2)

再一次,在SO上询问的行为让我得到了答案;在我的问题中添加上下文和细节时发现。有一个全新的Go-based Envoy control-plane Java端口:java-control-plane

有人像我一样,更愿意依赖Maven Central提供的东西,并且在我写这个问题的时候已经知道他们要找的是this issue 维护者回答:确切地说即将到来!

我很高兴地发现java-control-plane中的api/pom.xml看起来与我在问题中发布的内容非常相似。 :)

所以,如果你发现自己处于我的境地,想要在Java技术堆栈上实现Envoy的发现服务,那么java-control-plane已经存在 - 你只需要用你想要的任何后备存储扩展它使用。我认为,随着时间的推移,它的实现也将在社区中出现。我将为etcd撰写一篇文章,最终可能会将其贡献给社区。

回答我问题的更详细信息:

  • 我在哪里获取data-plane-api中未包含的两个.proto文件相关性?
    它们位于java-control-plane源:它们作为api模块的源代码的一部分签入,因此可能不作为单独的依赖项提供。我有理由相信我找到的gogo.proto是正确的,但我仍然不清楚我在哪里找到validate.proto
  • 我是否需要在data-plane-api中包含BUILD文件,以便使用*.proto编译protoc个文件?
    不! java-control-plane中的api模块不包含它们。