Java 版 gRPC 服务器框架

您可以下载我们的框架 gRPC 服务器，以便开始实现完整的 gRPC 服务器。

开始使用

  1. 创建一个 Java Gradle 项目 (grpc-booking-service)，在 src/main 下创建一个“proto”目录。

  2. 下载预订服务定义和健康检查协议，并将其放置在 src/main/proto 下。这些文件用于定义 Actions Center API 和健康检查的 gRPC 方法和消息。

  3. 更新 build.gradle 文件，为 Gradle 添加依赖项和 protobuf 插件。如需了解 protobuf-gradle-plugin 的简介和指南，请点击此处。

        apply plugin: 'java'
    apply plugin: 'com.google.protobuf'

    repositories {
        mavenCentral()
    }

    // updating the version in our release process.
    def grpcVersion = '1.8.0' // CURRENT_GRPC_VERSION
    def nettyTcNativeVersion = '2.0.7.Final'

    dependencies {
        compile "com.google.api.grpc:proto-google-common-protos:0.1.9"
        compile "io.grpc:grpc-netty:${grpcVersion}"
        compile "io.grpc:grpc-protobuf:${grpcVersion}"
        compile "io.grpc:grpc-stub:${grpcVersion}"
        compile "io.netty:netty-tcnative-boringssl-static:${nettyTcNativeVersion}"
        compile "org.bouncycastle:bcmail-jdk15:1.46"

        testCompile "io.grpc:grpc-testing:${grpcVersion}"
        testCompile "junit:junit:4.12"
        testCompile "org.mockito:mockito-core:1.9.5"
    }

    buildscript {
        repositories {
            mavenCentral()
        }
        dependencies {
            // ASSUMES GRADLE 2.12 OR HIGHER. Use plugin version 0.7.5 with earlier
            // gradle versions
            classpath 'com.google.protobuf:protobuf-gradle-plugin:0.8.1'
        }
    }

    protobuf {
        protoc {
            artifact = 'com.google.protobuf:protoc:3.4.0'
        }
        plugins {
            grpc {
                artifact = "io.grpc:protoc-gen-grpc-java:${grpcVersion}"
            }
        }
        generateProtoTasks {
            all()*.plugins {
                grpc {}
            }
        }
    }

    // Inform IDEs like IntelliJ IDEA, Eclipse or NetBeans about the generated code.
    sourceSets {
        main {
            java {
                srcDirs 'build/generated/source/proto/main/grpc'
                srcDirs 'build/generated/source/proto/main/java'
            }
        }
    }

    // Generate IntelliJ IDEA's .idea & .iml project files
    apply plugin: 'idea'

    // Provide convenience executables for trying out the examples.
    apply plugin: 'application'

    startScripts.enabled = false

  4. 运行以下命令以构建库并从 protoc build 插件自动生成代码：

      ./gradlew build

  5. 如需在服务器上启用 TLS，您需要在 src/main/certificates/ 下创建以下文件：

    • server_cert_chain.pem 采用 PEM 格式的服务器证书链
    • server_private_key.pem 服务器证书链的私钥，需要是 PKCS#8 私钥
    • trusted_client_roots.pem 在对客户端进行身份验证时受信任的根证书，您可以选择从 Mozilla 等授权机构获取这组受信任的根证书，也可以安装 Google Internet Authority G2 目前推荐的一组根证书。在后一种情况下，您有时可能需要手动更新根证书

  6. 从以下代码库检索示例代码：

      git clone https://maps-booking.googlesource.com/java-maps-booking-grpc-server-skeleton

    将 BookingService.java 放在 src/main/java/ext/maps/booking/partner/v2 下，将 Health.java 放在 src/main/java/grpc/health/v1 下。在这两个文件中，按照 TODO 完成实现。

  7. 更新 gradle.build 文件，通过添加以下代码来指定服务器可执行文件的生成版本：

    task bookingService(type: CreateStartScripts) {
    mainClassName = 'ext.maps.booking.partner.v2.BookingService'
    applicationName = 'booking-service'
    outputDir = new File(project.buildDir, 'tmp')
    classpath = jar.outputs.files + project.configurations.runtime
}

applicationDistribution.into('bin') {
    from(bookingService)
    fileMode = 0755
}

  8. 编译服务器：

    ./gradlew installDist

  9. 运行预订服务器：

    ./build/install/grpc-booking-service/bin/booking-service

最终目录结构

src
|---main
    |---certificates
        |---server_cert_chain.pem
        |---server_private_key.pem
        |---trusted_client_roots.pem
    |---java
        |---ext.maps.booking.partner.v2.BookingService.java
        |---grpc.health.v1.Health.java
    |---proto
        |---booking_service.proto
        |---health.proto
|---test

其他参考