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

Jak*_*obb 5 protocol-buffers maven

上下文:我的团队正在致力于使我们的 Java 服务套件具有容器化和动态可扩展性。为了实现这一点,我们的计划是使用由 etcd 支持的 Envoy,以及Envoy 文档中描述的自定义构建端点发现服务,使用基于v2 gRPC 的 API。然后,我们将为每个服务生成 Docker 镜像,并使用 Kubernetes 部署/管理它们。

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

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

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

最后,我想要一个独立的 Maven 构建,它可以读取这些文件并生成 Java 类。构建需要在 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>
Run Code Online (Sandbox Code Playgroud)

当我使用 构建此项目时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.
Run Code Online (Sandbox Code Playgroud)

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

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

import "google/protobuf/wrappers.proto";

import "validate/validate.proto";
import "gogoproto/gogo.proto";
Run Code Online (Sandbox Code Playgroud)

似乎正在寻找wrappers.proto,我认为这来自我的编译时 Maven 对protobuf-java.

我想gogoproto/gogo.proto可能正在寻找这个:https : //github.com/gogo/protobuf/blob/master/gogoproto/gogo.proto

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

我花了最后几个小时进行搜索,但我对以前做过这件事的人一无所知。我从哪里得到这些文件?如果我无法从 Maven Central 获取它们,我将自己构建它们并上传到 Artifactory。

我的眼睛盯着为使用其他技术堆栈的人准备的文档,而且我无法根据我的需要进行翻译。任何和所有帮助都将不胜感激,如果这是一个非常不切实际的问题,我深表歉意。:)

Jak*_*obb 2

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

像我一样,更愿意依赖 Maven Central 的东西,并且已经知道他们在寻找什么的人报告了这个问题当我写这个问题时,维护者回答:正是这即将到来!

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

因此,如果您发现自己处于我的情况,想要在 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不包含它们。