SpringBoot基于gRPC进行RPC调用

SpringBoot基于gRPC进行RPC调用

  • 一、gRPC
    • 1.1 什么是gRPC?
    • 1.2 如何编写proto
    • 1.3 数据类型及对应关系
    • 1.4 枚举
    • 1.5 数组
    • 1.6 map类型
    • 1.7 嵌套对象
  • 二、SpringBoot gRPC
    • 2.1 工程目录
    • 2.2 jrpc-api
      • 2.2.1 引入gRPC依赖
      • 2.2.2 编写 .proto 文件
      • 2.2.3 使用插件机制生产proto相关文件
    • 2.2 jrpc-server
      • 2.2.1 引入 `jrpc-api` 依赖
      • 2.2.2 编写impl
      • 2.2.3 编写Config
      • 2.2.4 yaml
    • 2.3 jrpc-client
      • 2.3.1 引入 `jrpc-api` 依赖
      • 2.3.2 编写config
      • 2.3.3 yaml
      • 2.3.4 测试验证
  • 三、gRPC高级应用

一、gRPC

1.1 什么是gRPC?

In gRPC, a client application can directly call a method on a server application on a different machine as if it were a local object, making it easier for you to create distributed applications and services. As in many RPC systems, gRPC is based around the idea of defining a service, specifying the methods that can be called remotely with their parameters and return types. On the server side, the server implements this interface and runs a gRPC server to handle client calls. On the client side, the client has a stub (referred to as just a client in some languages) that provides the same methods as the server.

在 gRPC 中,客户端应用程序可以直接调用服务器应用程序上的方法 在另一台机器上,就好像它是本地对象一样,使你更容易 创建分布式应用程序和服务。与许多 RPC 系统一样,gRPC 是 基于定义服务的思想,指定可以 使用其参数和返回类型进行远程调用。在服务器端, server 实现此接口并运行 gRPC 服务器来处理客户端调用。 在客户端,客户端有一个存根(在某些客户端中称为客户端 languages),它提供与服务器相同的方法。
在这里插入图片描述

gRPC 客户端和服务器可以在各种 环境 - 从 Google 内部的服务器到您自己的桌面 - 并且可以 用 gRPC 支持的任何语言编写。因此,例如,您可以轻松地 在 Java 中创建一个 gRPC 服务器,客户端使用 Go、Python 或 Ruby。另外 最新的 Google API 将具有其接口的 gRPC 版本,让您 轻松将 Google 功能构建到您的应用程序中。

gRPC 使用 proto buffers 作为服务定义语言,编写 proto 文件,即可完成服务的定义

在这里插入图片描述

1.2 如何编写proto

syntax = "proto3";option java_multiple_files = true;
// 生成位置
option java_package = "com.lizq.jrpc.api";
option java_outer_classname = "UserService";package user;service User {rpc SayHello (UserRequest) returns (UserResponse) {}
}message UserRequest {string name = 1;int32 age = 2;string addr = 3;
}message UserResponse {string name = 1;int32 age = 2;string addr = 3;OtherMsg otherMsg = 4;map<string, string> otherMap = 5;// 嵌套对象message OtherMsg {string ext1 = 1;string ext2 = 2;}
}
  • syntax = "proto3";:指定使用的protobuf版本;
  • option java_multiple_files = true;:如果为 false,则只会.java为此文件生成一个.proto文件,以及所有 Java 类/枚举/等。为顶级消息、服务和枚举生成的将嵌套在外部类中。如果为 true,.java将为每个 Java 类/枚举/等生成单独的文件。为顶级消息、服务和枚举生成,并且为此.proto文件生成的包装 Java 类将不包含任何嵌套类/枚举/等。 如果不生成 Java 代码,则此选项无效。
  • package user;:定义本服务的包名,避免不同服务相同消息类型产生冲突;
  • option java_package = "com.lizq.jrpc.api";:生成java文件包名;
  • option java_outer_classname = "UserService";:生成java文件类名称。如果文件中没有明确 java_outer_classname指定,.proto则将通过将.proto文件名转换为驼峰式来构造类名(因此 foo_bar.proto变为FooBar.java)
  • message UserResponse:定义服务的接口名称;
  • rpc SayHello (UserRequest) returns (UserResponse) {}:远程调用方法名,参数及响应类型;
  • message XXXXX{}:定义数据类型;

1.3 数据类型及对应关系

.proto类型NotesC++ TypeJava/KotlinPython
doubledoubledoublefloat
floatfloatfloatfloat
int32使用可变长度编码。对负数进行编码效率低下——如果您的字段可能有负值,请改用 sint32。int32intint
int64使用可变长度编码。对负数进行编码效率低下——如果您的字段可能有负值,请改用 sint64。int64longint/long
uint32使用可变长度编码。uint32intint/long
uint64使用可变长度编码。uint64longint/long
sint32使用可变长度编码。带符号的 int 值。这些比常规 int32 更有效地编码负数。int32intint
sint64使用可变长度编码。带符号的 int 值。这些比常规 int64 更有效地编码负数。int64longint/long
fixed32总是四个字节。如果值通常大于 228,则比 uint32 更有效uint32intint/long
fixed64总是八个字节。如果值通常大于 256,则比 uint64 更有效。uint64longint/long
sfixed32总是四个字节。int32intint
sfixed64总是八个字节。int64longint/long
boolboolbooleanbool
string字符串必须始终包含 UTF-8 编码或 7 位 ASCII 文本,并且不能超过 232。stringStringstr/unicode
bytes可能包含不超过 2 32的任意字节序列。stringByteStringstr (Python 2)、bytes (Python 3)

1.4 枚举

enum Sex {NONE = 0;MAN = 1;WOMAN = 2;
}message UserRequest {string name = 1;int32 age = 2;string addr = 3;Sex sex = 4;
}

**注意:**第一个枚举的值必须为0,因为0 是默认值,0 必须是第一个,保持和proto2 兼容

1.5 数组

使用 repeated 关键字来定义数组。

message UserRequest {string name = 1;int32 age = 2;string addr = 3;Sex sex = 4;// 定义一个数组repeated string cellphones = 5;
}

1.6 map类型

在开发的过程中经常需要使用关联字段,很自然的想到使用map,protobuf也提供了map的类型。

message UserResponse {string name = 1;map<string, string> otherMap = 2;
}

注意: map 字段前面不能是repeated

1.7 嵌套对象

message UserResponse {string name = 1;int32 age = 2;string addr = 3;OtherMsg otherMsg = 4;map<string, string> otherMap = 5;// 嵌套对象message OtherMsg {string ext1 = 1;string ext2 = 2;}
}

二、SpringBoot gRPC

2.1 工程目录

在这里插入图片描述

2.2 jrpc-api

2.2.1 引入gRPC依赖

<dependency><groupId>io.grpc</groupId><artifactId>grpc-all</artifactId><version>1.28.1</version>
</dependency>

2.2.2 编写 .proto 文件

syntax = "proto3";option java_multiple_files = true;
// 生成位置
option java_package = "com.lizq.jrpc.api";
option java_outer_classname = "UserService";package user;service User {rpc SayHello (UserRequest) returns (UserResponse) {}
}message UserRequest {string name = 1;int32 age = 2;string addr = 3;
}message UserResponse {string name = 1;int32 age = 2;string addr = 3;OtherMsg otherMsg = 4;map<string, string> otherMap = 5;// 嵌套对象message OtherMsg {string ext1 = 1;string ext2 = 2;}
}

2.2.3 使用插件机制生产proto相关文件

在 jrpc-api pom.xml 中添加如下:

<build><extensions><extension><groupId>kr.motd.maven</groupId><artifactId>os-maven-plugin</artifactId><version>1.6.2</version></extension></extensions><plugins><plugin><groupId>org.xolstice.maven.plugins</groupId><artifactId>protobuf-maven-plugin</artifactId><version>0.6.1</version><configuration><!--&lt;!&ndash; ${os.detected.classifier} 变量由${os.detected.name} 和 ${os.detected.arch} 组成--><protocArtifact>com.google.protobuf:protoc:3.12.0:exe:${os.detected.classifier}</protocArtifact><pluginId>grpc-java</pluginId><pluginArtifact>io.grpc:protoc-gen-grpc-java:1.28.1:exe:${os.detected.classifier}</pluginArtifact><!--protoSourceRoot 默认src/main/proto--><protoSourceRoot>src/main/proto</protoSourceRoot></configuration><executions><execution><goals><goal>compile</goal><goal>compile-custom</goal></goals></execution></executions></plugin></plugins>
</build>

执行命令生产proto相关文件

在这里插入图片描述
将生成的文件拷贝到工程中,如下:

在这里插入图片描述

2.2 jrpc-server

jrpc-server 为 springboot 项目。

2.2.1 引入 jrpc-api 依赖

<dependency><groupId>com.example</groupId><artifactId>jrpc-api</artifactId><version>1.0.0-SNAPSHOT</version>
</dependency>

2.2.2 编写impl

@Service
public class UserServiceImpl extends UserGrpc.UserImplBase {@Overridepublic void sayHello(UserRequest request, StreamObserver<UserResponse> responseObserver) {Map<String, String> otherMap = new HashMap<>();otherMap.put("test", "testmap");UserResponse response = UserResponse.newBuilder().setName("server:" + request.getName()).setAddr("server:" + request.getAddr()).setAge(request.getAge()).setOtherMsg(UserResponse.OtherMsg.newBuilder().setExt1("ext1").setExt2("ext2").build()).putAllOtherMap(otherMap).build();responseObserver.onNext(response);responseObserver.onCompleted();}
}

2.2.3 编写Config

@Configuration
public class GrpcServerConfiguration {@Value("${grpc.server-port}")private int port;@Beanpublic Server server() throws Exception {System.out.println("Starting gRPC on port {}." + port);// 构建服务端ServerBuilder<?> serverBuilder = ServerBuilder.forPort(port);// 添加需要暴露的接口this.addService(serverBuilder);// startServer server = serverBuilder.build().start();System.out.println("gRPC server started, listening on {}." + port);// 添加服务端关闭的逻辑Runtime.getRuntime().addShutdownHook(new Thread(() -> {System.out.println("Shutting down gRPC server.");if (server != null) {// 关闭服务端server.shutdown();}System.out.println("gRPC server shut down successfully.");}));if (server != null) {// 服务端启动后直到应用关闭都处于阻塞状态,方便接收请求server.awaitTermination();}return server;}@Autowiredprivate UserServiceImpl userService;/*** 添加需要暴露的接口* @param serverBuilder*/private void addService(ServerBuilder<?> serverBuilder) {serverBuilder.addService(userService);}
}

2.2.4 yaml

server:port: 8081
spring:application:name: spring-boot-jrpc-server
grpc:server-port: 18081

2.3 jrpc-client

2.3.1 引入 jrpc-api 依赖

<dependency><groupId>com.example</groupId><artifactId>jrpc-api</artifactId><version>1.0.0-SNAPSHOT</version>
</dependency>

2.3.2 编写config

@Configuration
public class GrpcClientConfiguration {@Value("${server-host}")private String host;/*** gRPC Server的端口*/@Value("${server-port}")private int port;@Beanpublic ManagedChannel managedChannel() {// 开启gRPC客户端ManagedChannel managedChannel = ManagedChannelBuilder.forAddress(host, port).usePlaintext().build();System.out.println("gRPC client started, server address: " + host + " , " + port);// 添加客户端关闭的逻辑Runtime.getRuntime().addShutdownHook(new Thread(() -> {try {// 调用shutdown方法后等待1秒关闭channelmanagedChannel.shutdown().awaitTermination(1, TimeUnit.SECONDS);System.out.println("gRPC client shut down successfully.");} catch (InterruptedException e) {e.printStackTrace();}}));return managedChannel;}@Autowiredprivate ManagedChannel managedChannel;@Beanpublic UserGrpc.UserBlockingStub userBlockingStub(ManagedChannel channel) {// 通过channel获取到服务端的stubreturn UserGrpc.newBlockingStub(managedChannel);}
}

2.3.3 yaml

server:port: 8080
spring:application:name: spring-boot-jrpc-client# 本地测试
server-host: 127.0.0.1
server-port: 18081

2.3.4 测试验证

@RestController("/user")
public class UserController {@Autowiredprivate UserGrpc.UserBlockingStub userBlockingStub;@GetMapping("/sayHello")public String sayHello(String name, String addr, int age) {UserRequest request = UserRequest.newBuilder().setName(name).setAddr(addr).setAge(age).build();UserResponse response;try {response = userBlockingStub.sayHello(request);} catch (StatusRuntimeException e) {e.printStackTrace();return e.getMessage();}return response.toString();}
}

浏览器访问:http://localhost:8080/user/sayHello?name=test&addr=addr&age=99 返回:

name: "server:test" age: 99 addr: "server:addr" otherMsg { ext1: "ext1" ext2: "ext2" } otherMap { key: "test" value: "testmap" }

三、gRPC高级应用

可以阅读 Alibaba Nacos 2.x 源码,通过 gRPC 进行client、server网络通信,并且会有连接保持、重试机制。

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.mzph.cn/news/234322.shtml

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

CWE-611

CWE-611&#xff0c;也称为“URL Redirection to Untrusted Site (‘Open Redirect’)”&#xff0c;是一种常见的Web应用程序安全漏洞。这种漏洞出现在应用程序接受用户提供的URL作为重定向参数&#xff0c;并在未经充分验证的情况下直接将用户重定向到该URL时。攻击者可以利用…

Java 基础学习(十四)Map集合与Set集合

1 Map集合 1.1 Map接口 1.1.1 Map接口概述 Map接口是一种双列集合。Map的每个元素都包含一个键对象Key和一个值对象Value &#xff0c;键对象和值对象之间存在对应关系&#xff0c;这种关系称为映射&#xff08;Mapping&#xff09;。 Map接口中的元素&#xff0c;可以通过…

DC-6靶场

DC-6靶场下载&#xff1a; https://www.five86.com/downloads/DC-6.zip 下载后解压会有一个DC-3.ova文件&#xff0c;直接在vm虚拟机点击左上角打开-->文件-->选中这个.ova文件就能创建靶场&#xff0c;kali和靶机都调整至NAT模式&#xff0c;即可开始渗透 首先进行主…

【Transformer框架代码实现】

Transformer Transformer框架注意力机制框架导入必要的库Input Embedding / Out EmbeddingPositional EmbeddingTransformer EmbeddingScaleDotProductAttention(self-attention)MultiHeadAttention 多头注意力机制EncoderLayer 编码层Encoder多层编码块&#xff0f;前馈网络层…

【机器学习】密度聚类:从底层手写实现DBSCAN

【机器学习】Building-DBSCAN-from-Scratch 概念代码数据导入实现DBSCAN使用样例及其可视化 补充资料 概念 DBSCAN&#xff08;Density-Based Spatial Clustering of Applications with Noise&#xff0c;具有噪声的基于密度的聚类方法&#xff09;是一种基于密度的空间聚类算…

新手做抖店应该怎么做?应该注意些什么?踩坑避雷!

我是电商珠珠 新手做抖店&#xff0c;对于办理营业执照、选类目确定品&#xff0c;或是找达人这些&#xff0c;往往会在这上面吃很多亏。 我做抖店也已经三年了&#xff0c;关于抖店的玩法和规则这块也非常熟悉&#xff0c;这就来给大家讲讲我所踩的那些坑。 第一个&#xf…

自动化边坡监测设备是什么?

随着科技的不断进步&#xff0c;我们的生活和环境也在不断地发生变化。然而&#xff0c;自然灾害仍然是我们无法完全避免的风险。其中&#xff0c;边坡滑坡就是一种常见的自然灾害。为了保护人民的生命财产安全&#xff0c;科学家们研发出了自动化边坡监测设备。 WX-WY1 自动化…

C++基础-内存模型详解

目录 一、概述 二、内存分区模型分类 三、代码区 四、全局区 五、栈区

亚信安慧AntDB数据库引领中文信息处理标准化创新

近期&#xff0c;亚信科技旗下的AntDB数据库再获殊荣&#xff0c;成功通过GB 18030-2022《信息技术中文编码字符集》最高实现级别&#xff08;级别3&#xff09;的检测认证&#xff0c;成为首批达到该认证标准的数据库产品之一。这一认证不仅是对AntDB数据库卓越技术实力的肯定…

算法02哈希法

算法01之哈希法 1.哈希法理论基础1.1哈希表&#xff08;1&#xff09;哈希表&#xff08;2&#xff09;哈希函数&#xff08;3&#xff09;哈希碰撞 1.2哈希法基本思想1.3哈希法适用场景与最常用的哈希结构 2.LeetCode242&#xff1a;有效的字母异位词&#xff08;1&#xff09…

《每天一分钟学习C语言·三》

1、 scanf的返回值由后面的参数决定scanf(“%d%d”,& a, &b); 如果a和b都被成功读入&#xff0c;那么scanf的返回值就是2如果只有a被成功读入&#xff0c;返回值为1如果a和b都未被成功读入&#xff0c;返回值为0 如果遇到错误或遇到end of file&#xff0c;返回值为EOF…

罗列一下js reduce 的能做的事情?

JavaScript 的 reduce 方法是一个非常强大的工具&#xff0c;可以用于处理数组数据。 以下是一些 reduce 可以做的事情&#xff1a; 1. 累加器&#xff1a;reduce 最常见的用途是将数组的所有元素累加到一个值中。例如&#xff0c;计算数组中所有数字的总和 const numbers …

ACE Tools环境配置指导

简介 ACE Tools是一套为ArkUI-X应用开发者提供的命令行工具&#xff0c;支持在Windows/Ubuntu/macOS平台运行&#xff0c;用于构建OpenHarmony、HarmonyOS、Android和iOS平台的应用程序&#xff0c; 其功能包括开发环境检查&#xff0c;新建项目&#xff0c;编译打包&#xff…

Debian系统设置SSH密钥登陆

如果没有安装ssh&#xff0c;root权限运行apt install openssh-server进行安装。 ssh-keygen -t rsa # 生成配对密钥&#xff0c;后续一路enter即可会在用户目录&#xff08;即~这个&#xff09;下生成.ssh文件夹&#xff0c;里面的id_rsa是私钥&#xff0c;id_rsa.pub是公钥…

另一种理解伦敦金支撑阻力位的方法

支撑阻力位一向被认为是做伦敦金交易不可或缺的分析工具&#xff0c;但很多人对它的原理并不清楚&#xff0c;甚至不太服气&#xff0c;觉得凭什么一根平平无奇的水平位&#xff0c;能带来所谓的“大作用”呢&#xff1f;下面我们不妨从另外一个角度来看一下伦敦金市场中的支撑…

23、Web攻防——Python考点CTF与CMS-SSTI模板注入PYC反编译

文章目录 一、PYC文件二、SSTI 一、PYC文件 pyc文件&#xff1a;python文件编译后生成的字节码文件&#xff08;byte code&#xff09;&#xff0c;pyc文件经过python解释器最终会生成机器码运行。因此pyc文件是可以跨平台部署的&#xff0c;类似java的.class文件&#xff0c;…

金蝶EAS打印凭证,数据量多点的就会出错

金蝶EAS打印凭证&#xff0c;数据量多点的就会出错&#xff0c;约过100页&#xff0c;提示数据源有问题 经咨询工程师需修改java虚拟机内存。 打开eas客户端目录&#xff0c;运行set-url.bat 看到原来java虚拟机只配置了512M内存&#xff0c;把虚拟机内存修改为4096&#xff0…

如何解决苹果应用商城审核拒绝的Guideline 2.1 - Information Needed问题

当你的应用程序在苹果应用商城审核过程中被拒绝时&#xff0c;苹果会向您发送一封邮件&#xff0c;其中提供了关于拒绝原因的详细信息。本文将指导您如何正确处理Guideline 2.1 - Information Needed问题&#xff0c;并提供解决方案&#xff0c;以确保您的应用程序能够通过审核…

ansible的脚本—playbook剧本

一、playbook 1、简介 Playbook 剧本是由一个或多个play组成的列表。 play的主要功能在于将预定义的一组主机&#xff0c;装扮成事先通过ansible中的task定义好的角色。 Task实际是调用ansible的一个module&#xff0c;将多个play组织在一个playbook中&#xff0c;即可以让它…