java版gRPC实战之一：用proto生成代码

欢迎访问我的GitHub

https://github.com/zq2599/blog_demos

内容：所有原创文章分类汇总及配套源码，涉及Java、Docker、Kubernetes、DevOPS等；

关于《java版gRPC实战》系列

《java版gRPC实战》是欣宸原创的面向java程序员的gRPC开发笔记，与读者们一起通过实战来学习掌握gRPC的各个知识点；

《java版gRPC实战》全系列链接

用proto生成代码

服务发布和调用

服务端流

客户端流

双向流

客户端动态获取服务端地址

基于eureka的注册发现

关于gRPC

gRPC 是一个高性能、开源和通用的 RPC 框架，面向移动和 HTTP/2 设计。目前提供 C、Java 和 Go 语言版本，分别是：grpc, grpc-java, grpc-go. 其中 C 版本支持 C, C++, Node.js, Python, Ruby, Objective-C, PHP 和 C# 支持.

gRPC 基于 HTTP/2 标准设计，带来诸如双向流、流控、头部压缩、单 TCP 连接上的多复用请求等特。这些特性使得其在移动设备上表现更好，更省电和节省空间占用。

各个进程之间可以通过gRPC相互调用，如下图：

核心技术

为了用java发布gRPC服务，我使用的是开源库net.devh:grpc-server-spring-boot-starter

在调用其他gRPC服务时用的是net.devh:grpc-client-spring-boot-starter

感谢该开源库的作者Michael大神，您的智慧的简化了java程序员的gRPC开发工作，项目地址：https://github.com/yidongnan/grpc-spring-boot-starter

本篇概览

作为系列文章的开篇，本篇要做的事情如下：

明确依赖库和开发环境

新建父工程grpc-tutorials，今后《java版gRPC实战》系列的所有源码都在这个工程中

实战用proto文件自动生成java代码

明确依赖库和开发环境

整个系列文章涉及的依赖库和开发环境的情况如下：

JDK：1.8.0_281

gradle：6.7.1

springboot：2.3.8.RELEASE

grpc：1.35.0

protobuf：3.14.0

grpc-server-spring-boot-starter：2.11.0.RELEASE

grpc-client-spring-boot-starter：2.11.0.RELEASE

操作系统：win10专业版

IDEA：2021.1 (Ultimate Edition)

源码下载

本篇实战中的完整源码可在GitHub下载到，地址和链接信息如下表所示(https://github.com/zq2599/blog_demos)：

名称 链接 备注
项目主页   https://github.com/zq2599/blog_demos   该项目在GitHub上的主页  
git仓库地址(https)   https://github.com/zq2599/blog_demos.git   该项目源码的仓库地址，https协议  
git仓库地址(ssh)   git@github.com:zq2599/blog_demos.git   该项目源码的仓库地址，ssh协议  

这个git项目中有多个文件夹，《java版gRPC实战》系列的源码在grpc-tutorials文件夹下，如下图红框所示：

创建《java版gRPC实战》系列的父工程

新建名为grpc-tutorials的gradle工程，前面提到的库及其版本都在此工程中处理好，build.gradle内容如下：

import java.time.OffsetDateTime import java.time.format.DateTimeFormatter buildscript { repositories { maven { url 'https://plugins.gradle.org/m2/' } // 如果有私服就在此配置，如果没有请注释掉 maven { url 'http://192.168.50.43:8081/repository/aliyun-proxy/' } // 阿里云 maven { url 'http://maven.aliyun.com/nexus/content/groups/public/' } mavenCentral() } ext { // 项目版本 projectVersion = '1.0-SNAPSHOT' // 依赖库的版本 grpcSpringBootStarterVersion = '2.11.0.RELEASE' // grpc版本 https://github.com/grpc/grpc-java/releases grpcVersion = '1.35.0' // protobuf版本 https://github.com/protocolbuffers/protobuf/releases protobufVersion = '3.14.0' // protobuf的gradle插件版本 protobufGradlePluginVersion = '0.8.12' // sprignboot版本 https://github.com/spring-projects/spring-boot/releases springBootVersion = '2.3.8.RELEASE' // springcloud版本 https://github.com/spring-cloud/spring-cloud-release/releases springCloudVersion = 'Hoxton.SR9' // nacos版本 https://github.com/alibaba/spring-cloud-alibaba/releases springCloudAlibabaNacosVersion = '2.2.3.RELEASE' // security版本 https://github.com/spring-projects/spring-security-oauth/releases springSecurityOAuthVersion = '2.5.0.RELEASE' } } plugins { id 'java' id 'java-library' id 'org.springframework.boot' version "${springBootVersion}" apply false id 'io.spring.dependency-management' version '1.0.11.RELEASE' id 'net.nemerosa.versioning' version '2.14.0' id 'com.google.protobuf' version '0.8.14' id 'io.franzbecker.gradle-lombok' version '4.0.0' apply false id 'com.github.ben-manes.versions' version '0.36.0' // gradle dependencyUpdates } // If you attempt to build without the `--scan` parameter in `gradle 6.0+` it will cause a build error that it can't find // a buildScan property to change. This avoids that problem. if (hasProperty('buildScan')) { buildScan { termsOfServiceUrl = 'https://gradle.com/terms-of-service' termsOfServiceAgree = 'yes' } } wrapper { gradleVersion = '6.7.1' } def buildTimeAndDate = OffsetDateTime.now() ext { // 构建时取得当前日期和时间 buildDate = DateTimeFormatter.ISO_LOCAL_DATE.format(buildTimeAndDate) buildTime = DateTimeFormatter.ofPattern('HH:mm:ss.SSSZ').format(buildTimeAndDate) buildRevision = versioning.info.commit } allprojects { apply plugin: 'java' apply plugin: 'idea' apply plugin: 'eclipse' apply plugin: 'io.spring.dependency-management' apply plugin: 'io.franzbecker.gradle-lombok' compileJava { sourceCompatibility = JavaVersion.VERSION_1_8 targetCompatibility = JavaVersion.VERSION_1_8 options.encoding = 'UTF-8' } compileJava.options*.compilerArgs = [ '-Xlint:all', '-Xlint:-processing' ] // Copy LICENSE tasks.withType(Jar) { from(project.rootDir) { include 'LICENSE' into 'META-INF' } } // 写入到MANIFEST.MF中的内容 jar { manifest { attributes( 'Created-By': "${System.properties['java.version']} (${System.properties['java.vendor']} ${System.properties['java.vm.version']})".toString(), 'Built-By': 'travis', 'Build-Date': buildDate, 'Build-Time': buildTime, 'Built-OS': "${System.properties['os.name']}", 'Build-Revision': buildRevision, 'Specification-Title': project.name, 'Specification-Version': projectVersion, 'Specification-Vendor': 'Will Zhao', 'Implementation-Title': project.name, 'Implementation-Version': projectVersion, 'Implementation-Vendor': 'Will Zhao' ) } } repositories { mavenCentral() // 如果有私服就在此配置，如果没有请注释掉 maven { url 'http://192.168.50.43:8081/repository/aliyun-proxy/' } // 阿里云 maven { url 'http://maven.aliyun.com/nexus/content/groups/public/' } jcenter() } buildscript { repositories { maven { url 'https://plugins.gradle.org/m2/' } } } } allprojects { project -> buildscript { dependencyManagement { imports { mavenBom "org.springframework.boot:spring-boot-starter-parent:${springBootVersion}" mavenBom "org.springframework.cloud:spring-cloud-dependencies:${springCloudVersion}" mavenBom "com.google.protobuf:protobuf-bom:${protobufVersion}" mavenBom "io.grpc:grpc-bom:${grpcVersion}" mavenBom "org.junit:junit-bom:5.7.0" } dependencies { dependency 'org.projectlombok:lombok:1.16.16' dependency 'org.apache.commons:commons-lang3:3.11' dependency 'commons-collections:commons-collections:3.2.2' dependency "net.devh:grpc-server-spring-boot-starter:${grpcSpringBootStarterVersion}" dependency "net.devh:grpc-client-spring-boot-starter:${grpcSpringBootStarterVersion}" } } ext { micrometerVersion = dependencyManagement.importedProperties['micrometer.version'] springFrameworkVersion = dependencyManagement.importedProperties['spring-framework.version'] springSecurityVersion = dependencyManagement.importedProperties['spring-security.version'] springCloudCommonsVersion = dependencyManagement.importedProperties['spring-cloud-commons.version'] } } } group = 'com.bolingcavalry' version = projectVersion

整个系列用到的父工程已经完成，接下来可以开始编码了；

实战用proto文件自动生成java代码

gRPC服务能够用不同的语言编写，其中的关键是定义服务的proto文件可以被生成各种语言的代码，java也不例外，接下来一起体验；