歡迎訪問我的GitHub
https://github.com/zq2599/blog_demos
內容：所有原創文章分類匯總及配套源碼，涉及Java、Docker、Kubernetes、DevOPS等；
關於《java版gRPC實戰》系列
- 《java版gRPC實戰》是欣宸原創的面向java程序員的gRPC開發筆記，與讀者們一起通過實戰來學習掌握gRPC的各個知識點；
《java版gRPC實戰》全系列鏈接
關於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也不例外，接下來一起體驗；
- 在父工程grpc-tutorials下新建模塊，名為grpc-lib，其build.gradle內容如下，可見主要是配置了protobuf插件，以及生成的java代碼如何才能被IDE工具加入到source path中：
// 根據proto生成java代碼的gradle插件
plugins {
id 'com.google.protobuf'
}
dependencies {
implementation 'io.grpc:grpc-netty-shaded'
implementation 'io.grpc:grpc-protobuf'
implementation 'io.grpc:grpc-stub'
if (JavaVersion.current().isJava9Compatible()) {
// Workaround for @javax.annotation.Generated
// see: https://github.com/grpc/grpc-java/issues/3633
implementation 'jakarta.annotation:jakarta.annotation-api'
}
}
protobuf {
protoc {
artifact = "com.google.protobuf:protoc:${protobufVersion}"
}
// 自動生成的代碼放在這里
generatedFilesBaseDir = "$projectDir/src/generated"
clean {
delete generatedFilesBaseDir
}
// 生成java代碼的插件
plugins {
grpc {
artifact = 'io.grpc:protoc-gen-grpc-java'
}
}
generateProtoTasks {
all()*.plugins {
grpc {}
}
}
}
// 對於eclipse，通過以下腳本可以將生成的代碼加入source路徑中，編譯時會被用到
eclipse {
classpath {
file.beforeMerged { cp ->
def generatedGrpcFolder = new org.gradle.plugins.ide.eclipse.model.SourceFolder('src/generated/main/grpc', null);
generatedGrpcFolder.entryAttributes['ignore_optional_problems'] = 'true';
cp.entries.add( generatedGrpcFolder );
def generatedJavaFolder = new org.gradle.plugins.ide.eclipse.model.SourceFolder('src/generated/main/java', null);
generatedJavaFolder.entryAttributes['ignore_optional_problems'] = 'true';
cp.entries.add( generatedJavaFolder );
}
}
}
// 對於idea，通過以下腳本可以將生成的代碼加入source路徑中，編譯時會被用到
idea {
module {
sourceDirs += file('src/generated/main/java')
sourceDirs += file('src/generated/main/grpc')
generatedSourceDirs += file('src/generated/main/java')
generatedSourceDirs += file('src/generated/main/grpc')
}
}
- 在grpc-lib模塊的src/main/proto目錄下新增名為helloworld.proto的文件，這里面定義了一個gRPC服務，里面含有一個接口，並且還有這個接口的入參和返回結果的定義：
syntax = "proto3";
option java_multiple_files = true;
// 生成java代碼的package
option java_package = "com.bolingcavalry.grpctutorials.lib";
option java_outer_classname = "HelloWorldProto";
// gRPC服務
service Simple {
// 接口定義
rpc SayHello (HelloRequest) returns (HelloReply) {
}
}
// 入參的數據結構
message HelloRequest {
string name = 1;
}
// 返回結果的數據結構
message HelloReply {
string message = 1;
}
- proto文件已經做好，接下來要根據這個文件來生成java代碼，在grpc-tutorials目錄下執行命令gradle grpc-lib:generateProto，即可根據helloworld.proto文件生成java代碼，執行成功后會生出下圖紅框中的內容，這些就是java代碼：
-
本篇只聊如何生成上述代碼，至於這些代碼的用途就留到下一篇再說吧，這里只簡單提一下，SimpleGrpc里面有抽象類SimpleImplBase，制作gRPC服務的時候需要繼承該類，另外，如果您要遠程調用gRPC的sayHello接口，就會用到SimpleGrpc類中的SimpleStub類，其余的HelloReply、HelloRequest這些則是入參和返回的數據結構定義；
-
至此，java版gRPC實戰的准備工作就完成了，根據proto文件生成java代碼的方法也掌握了，接下來的章節咱們一起嘗試服務的發布和調用；
你不孤單，欣宸原創一路相伴
歡迎關注公眾號：程序員欣宸
微信搜索「程序員欣宸」，我是欣宸，期待與您一同暢游Java世界...
https://github.com/zq2599/blog_demos