百度360必应搜狗淘宝本站头条
当前位置:网站首页 > 技术教程 > 正文

把远程进程通讯grpc引入到Spring boot maven项目中

csdh11 2025-02-19 11:37 17 浏览

1、参考链接:

gRPC官网:https://grpc.io/

HTTP2:https://http2.github.io/

Protocol Buffers:https://protobuf.dev/

grpc中文文档:
http://doc.oschina.net/grpc

Java版文档:
https://grpc.io/docs/languages/java/quickstart/

Go版gRPC文档地址:
https://grpc.io/docs/languages/go/

2、简单介绍

gRPC 是一个高性能、开源、通用的RPC框架,由Google推出,基于HTTP2 协议标准设计开发,默认采用Protocol Buffers 数据序列化协议,支持多种开发语言。

推荐gRPC和istio配合使用,istio基于k8s提供服务治理等功能。

3、RPC通用流程和Grpc流程



4、grpc引入到spring boot项目的步骤

(1)编写ProtocolBuffers文件

ProtoBuf是gRPC默认支持的数据存储和通讯协议,或者称为数据序列化协议,和XML、JSON、HESSIAN类似。

实际上ProtoBuf文件也是服务定义文件(IDL),通常包含三个部分:

第一部分,协议版本、头部声明和选项

A、协议版本:

syntax = "proto3";

B、通用包名指定

package google.protobuf;

C、java包名指定

option java_package = "com.google.protobuf";

D、Java类名指定

option java_outer_classname = "DescriptorProtos";

E、优化

option optimize_for = SPEED;

option optimize_for = CODE_SIZE;

option optimize_for = LITE_RUNTIME;

F、编译产生的java文件是多个

option java_multiple_files = true;

第二部分,消息定义

其中,string和int32是字段类型,其他常用类型还有double、float、int64、bool、bytes,query和page_number是字段名称,1/2/3是字段标识,1~15的标识最快。Message是消息关键字,searchrequest是消息名称。

枚举型:

Map字段类型:

字段类型前面可以加optional和repeated关键词,optional表示可以设置也可以不设置,repeated表示可以重复若干次。

以上图5,map示例相当于:

第三部分,服务定义

其中,service是关键词,searchservice是服务名称,rpc是关键词,search是服务里面的方法名称,searchrequest是入参,searchresponse是出参。

(2)编译proto文件

编译方法有两种,一是下载编译工具,二是直接在maven项目中指定build工具包。

编译工具下载参见:

https://github.com/protocolbuffers/protobuf#protobuf-compiler-installation

安装方法参见其中的readme。

在maven项目中指定build工具包,如下图,在pom文件中加入build插件:

protobuf-maven-plugin的相关文档如下:

https://www.xolstice.org/protobuf-maven-plugin/compile-mojo.html

其中说明了如下主要参数:

- protocArtifact: protoc编译器工具的格式规范,
groupId:artifactId:version[:type[:classifier]]。如果指定了该参数,protoc将尝试按照指定的参数对文件proto文件进行编译。

- protocExecutable:配置protoc的编译执行程序的路径。

- protocPluginDirectory: protoc的执行文件目录。

- protoSourceRoot: 原始proto文件的路径,比如${project.basedir}/src/main/proto。

- outputDirectory: 编译后生成.java文件的路径,比如:${project.basedir}/src/main/java。

-
temporaryProtoFileDirectory: 临时使用目录。

- clearOutputDirectory: 设置是否在生成java文件之前清空outputDirectory的文件,默认值为true,设置为false时也会覆盖同名文件。

-
additionalProtoPathElement:附加的源proto文件定义路径,如果设备源路径没找到,会到该目录找。

- excludes:排除不需要编译的文件列表。

- includes:包含需要编译的proto文件列表,默认如下:

**/*.proto

(3)创建使用grpc的springboot项目步骤

使用Spring Starter Project或者Import Spring Getting Started Content创建三个项目:

Grpc-lib-test:提供proto文件,并由此自动生成服务类和消息类

Grpc-server-test:提供grpc服务器端

Grpc-client-test:提供grpc客户端

第一个项目:Grpc-lib-test

POM文件如下:

然后,编写一个示例proto文件放到src/main/proto目录下:

最后,使用如下指令来自动产生源代码:

这个指令就是mvn generate-sources,由于相当于执行mvn compile 和 mvn compile-custom。

在IDE中使用install构建安装(或者执行mvn clean install -D maven.test.skip=true),等待另外两个模块调用。

第二个项目:grpc-server-test

POM文件如下:

新增日志拦截器:

新增日志拦截器的配置类

新增服务类:

在IDE中使用install构建安装(或者执行mvn clean install -D maven.test.skip=true)。

使用java -jar
target/grpc-server-test-0.0.1-SNAPSHOT.jar运行,如下图。注意java版本是17(“无效的标记: --release”这个错误的解决办法是从jdk1.8改为17)。

第三个项目:grpc-client-test

POM文件:

新增日志拦截器:

新增日志拦截器的配置类:

新增grpc客户端服务类:

新增控制器类:

在IDE中使用install构建安装(或者执行mvn clean install -D maven.test.skip=true)。

使用java -jar
target/grpc-client-test-0.0.1-SNAPSHOT.jar运行。

最后,看看效果。我们使用浏览器来测试。在浏览器中输入地址localhost:8088后:

切换到gRPC客户端grpc-client-test启动界面:

切换到gRPC服务器端grpc-server-test启动界面:

相关推荐

pdf怎么在线阅读?这几种在线阅读方法看看

pdf怎么在线阅读?我们日常生活中经常使用到pdf文档。这种格式的文档在不同平台和设备上的可移植性,以及保留文档格式和布局的能力都很强。在阅读这种文档的时候,很多人会选择使用在线阅读的方法。在线阅读P...

PDF比对不再眼花缭乱:开源神器diff-pdf助你轻松揪出差异

PDF比对不再眼花缭乱:开源神器diff-pdf助你轻松揪出差异在日常工作和学习中,PDF文件可谓是无处不在。然而,有时我们需要比较两个PDF文件之间的差异,这可不是一件轻松的事情。手动逐页对比简直是...

全网爆火!580页Python编程快速上手,零基础也能轻松学会

Python虽然一向号称新手友好,但对完全零基础的编程小白来讲,总会在很长时间内,都对某些概念似懂非懂,每次拿起书本教程,都要从第一章看起。对于这种迟迟入不了门的情况,给大家推荐一份简单易懂的入门级教...

我的名片能运行Linux和Python,还能玩2048小游戏,成本只要20元

晓查发自凹非寺量子位报道|公众号QbitAI猜猜它是什么?印着姓名、职位和邮箱,看起来是个名片。可是右下角有芯片,看起来又像是个PCB电路板。其实它是一台超迷你的ARM计算机,不仅能够运...

由浅入深学shell,70页shell脚本编程入门,满满干货建议收藏

不会Linux的程序员不是好程序员,不会shell编程就不能说自己会Linux。shell作为Unix第一个脚本语言,结合了延展性和高效的优点,保持独有的编程特色,并不断地优化,使得它能与其他脚本语言...

真工程师:20块钱做了张「名片」,可以跑Linux和Python

机器之心报道参与:思源、杜伟、泽南对于一个工程师来说,如何在一张名片上宣告自己的实力?在上面制造一台完整的计算机说不定是个好主意。最近,美国一名嵌入式系统工程师GeorgeHilliard的名片...

《Linux 命令行大全》.pdf

今天跟大家推荐个Linux命令行教程:《TheLinuxCommandLine》,中文译名:《Linux命令行大全》。该书作者出自自美国一名开发者,兼知名Linux博客LinuxCo...

PDF转换是难题? 搜狗浏览器即开即看

由于PDF文件兼容性相当广泛,越来越多的电子图书、产品说明、公司文告、网络资料、电子邮件选择开始使用这种格式来进行内容的展示,以便给用户更好的再现原稿的细节,但需要下载专用阅读器进行转化才能浏览的问题...

彻底搞懂 Netty 线程模型

点赞再看,养成习惯,微信搜一搜【...

2022通俗易懂Redis的线程模型看完就会

Redis真的是单线程吗?我们一般说Redis是单线程,是指Redis的网络IO和键值对操作是一个线程完成的,这就是Redis对外提供键值存储服务的主要流程。Redis的其他功能,例如持久化、异步删除...

实用C语言编程(第三版)高清PDF

编写C程序不仅仅需要语法正确,最关键的是所编代码应该便于维护和修改。现在有很多介绍C语言的著作,但是本书在这一方面的确与众不同,例如在讨论C中运算优先级时,15种级别被归纳为下面两条原则:需要的...

手拉手教你搭建redis集群(redis cluster)

背景:最近需要使用redis存储数据,但是随着时间的增加,发现原本的单台redis已经不满足要求了,于是就倒腾了一下搭建redistclusterredis集群。好了,话不多说,下面开始展示:...

记录处理登录页面显示: HTTP Error 503. The service is unavailable.

某天一个系统的登录页面无法显示,显示ServiceUnavailableHTTPError503.Theserviceisunavailable,马上登录服务器上查看IIS是否正常。...

黑道圣徒杀出地狱破解版下载 免安装硬盘版

游戏名称:黑道圣徒杀出地狱英文名称:SaintsRow:GatOutofHell游戏类型:动作冒险类(ACT)游戏游戏制作:DeepSilverVolition/HighVoltage...

Exchange Server 2019 实战操作指南

...