SpringBoot 整合gRPC

最新推荐文章于 2024-08-16 21:17:54 发布

影࿐ེ

最新推荐文章于 2024-08-16 21:17:54 发布

阅读量1.1k

点赞数

分类专栏： SpringBoot 文章标签： spring boot java

本文链接：https://blog.csdn.net/u014365523/article/details/112341327

版权

SpringBoot 专栏收录该内容

39 篇文章 2 订阅

订阅专栏

gRPC 是一种与语言无关的高性能远程过程调用 (RPC) 框架。

gRPC 的主要优点是：

现代高性能轻量级 RPC 框架。
协定优先 API 开发，默认使用协议缓冲区，允许与语言无关的实现。
可用于多种语言的工具，以生成强类型服务器和客户端。
支持客户端、服务器和双向流式处理调用。
使用 Protobuf 二进制序列化减少对网络的使用。

这些优点使 gRPC 适用于：

效率至关重要的轻量级微服务。
需要多种语言用于开发的 Polyglot 系统。
需要处理流式处理请求或响应的点对点实时服务。

关于GRPC，官方的介绍是：gRPC 是一个高性能、开源和通用的 RPC 框架，面向移动和 HTTP/2 设计，带来诸如双向流、流控、头部压缩、单 TCP 连接上的多复用请求等特。这些特性使得其在移动设备上表现更好，更省电和节省空间占用。从定义上可以看到这个主要是给移动应用做通信用的，其次他支持双向的通信，因此可以说GRPC是一个RPC框架没错，但是它的功能已经强于RPC，因为普通RPC是定义是一应一答的单向通信模式，而GRPC支持双向通信，毕竟做不到双向通信怎么能说是给移动应用设计的呢？

gRPC主要有4种请求／响应模式，分别是：

(1) 简单模式（Simple RPC）

客户端发起一次请求，服务端响应一个数据，即标准RPC通信。

ClientRequest：1，ServerResponse：1

(2) 服务端数据流模式（Server-side streaming RPC）

这种模式是客户端发起一次请求，服务端返回一段连续的数据流。典型的例子是客户端向服务端发送一个股票代码，服务端就把该股票的实时数据源源不断的返回给客户端。

ClientRequest：1，ServerResponse：N

(3) 客户端数据流模式（Client-side streaming RPC）

与服务端数据流模式相反，这次是客户端源源不断的向服务端发送数据流，而在发送结束后，由服务端返回一个响应。典型的例子是物联网终端向服务器报送数据。

ClientRequest：N，ServerResponse：1

(4) 双向数据流模式（Bidirectional streaming RPC）

这是客户端和服务端都可以向对方发送数据流，这个时候双方的数据可以同时互相发送，也就是可以实现实时交互。比如聊天应用。

ClientRequest：N，ServerResponse：N

grpc：数据的序列化以及进程数据通信的交互方式
主要有以下几个过程：
（1）通过 .proto文件定义传输的接口和消息体
（2）通过protocol编译器生成server端和client端的stub程序
（3）将请求封装成Http2的Stream
（4）通过Channel作为数据通信的通道使用Socket进行数据传输

快速开发：
SpringBoot构建grpc的demo
SpringBoot版本：2.1.4.RELEASE
JDK1.8

创建2个工程：
服务提供方：grpc-provider
服务消费方：grpc-consumer

server端
步骤1：创建server端工程 grpc-provier，目录结果如下
grpc-provider（多模块）
      - controller //请求接入
      - common //vo,po,DTO以及和java目录同一级的proto
          - java //存放vo, po, DTO以及根据proto生成的server端和client端的sub
          - proto
              - helloworld.proto
      - model
      - service

步骤2：common模块的依赖：（除了通用的作用，这里主要增加了proto相关的操作）

在这里插入图片描述

步骤5：service模块的pom依赖：

client端
步骤1：创建client工程grpc-consumer，目录如下
grpc-consumer（多层）
- controller //请求接入
- common
- model //持久层
- service //业务逻辑层

步骤2：pom依赖

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.2.2.RELEASE</version>
<relativePath/>
</parent>

<groupId>com.example</groupId>
<artifactId>demo2</artifactId>
<version>0.0.1-SNAPSHOT</version>
<name>demo2</name>
<description>gRPC - Spring Boot Hello World Example</description>

<properties>
<java.version>1.8</java.version>
</properties>

<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-jdbc</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>org.mybatis.spring.boot</groupId>
<artifactId>mybatis-spring-boot-starter</artifactId>
<version>2.1.1</version>
</dependency>

<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<scope>runtime</scope>
</dependency>
<dependency>
<groupId>com.github.pagehelper</groupId>
<artifactId>pagehelper-spring-boot-starter</artifactId>
<version>1.2.3</version>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
<exclusions>
<exclusion>
<groupId>org.junit.vintage</groupId>
<artifactId>junit-vintage-engine</artifactId>
</exclusion>
</exclusions>
</dependency>
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>1.16.6</version>
<scope>compile</scope>
</dependency>

<dependency>
<groupId>com.common</groupId>
<artifactId>grpc-springboot-demo</artifactId>
<version>0.0.1-SNAPSHOT</version>
</dependency>

<dependency>
<groupId>net.devh</groupId>
<artifactId>grpc-client-spring-boot-starter</artifactId>
<version>2.0.1.RELEASE</version>
</dependency>

</dependencies>

<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>

<plugin>
<groupId>org.mybatis.generator</groupId>
<artifactId>mybatis-generator-maven-plugin</artifactId>
<version>1.3.2</version>
<configuration>
<configurationFile>src/main/resources/generator/generatorConfig.xml</configurationFile>
</configuration>
</plugin>
</plugins>
</build>

</project>

步骤3：controller层请求接入
package com.example.demo2.controller;

import com.ccb.common.deviceFix;
import com.example.demo2.common.Result;
import com.example.demo2.common.ResultCode;
import com.example.demo2.service.impl.GrpcClientService;
import com.example.demo2.utils.ResultBulider;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.web.bind.annotation.RestController;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

/**
* @Description: TODO
* @Author: Top
* @Version: V1.0
* @Date: 2020-01-15 15:03
*/
@RestController
@RequestMapping("/api/{edition}")
public class ConsumerController {

@Autowired
private GrpcClientService grpcClientService;

@GetMapping("/getUser")
@ResponseBody
public Result getUser(HttpServletRequest request, HttpServletResponse response) {
try {
deviceFix device = deviceFix.newBuilder().setAddress("北京").setSerialNum("1000").setUserNum("20").build();
return ResultBulider.succuss("成功", grpcClientService.sendMessage(device));
} catch (Exception e) {
e.printStackTrace();
return ResultBulider.faile(ResultCode.DATA_IS_WRONG);
}
}
}

步骤4：service层
package com.example.demo2.service.impl;

import com.ccb.common.DeviceFixServiceGrpc;
import com.ccb.common.booleanReply;
import com.ccb.common.deviceFix;
import io.grpc.Channel;
import net.devh.springboot.autoconfigure.grpc.client.GrpcClient;
import org.springframework.stereotype.Service;

/**
* 项目名称: a 
* 文件名称: b 
* 功能描述: c 
* 创建时间: 2020/11/12 
* @author Top
* @version v1.0
*/
@Service
public class GrpcClientService {

@GrpcClient("grpc-server")
private Channel serverChannel;

public booleanReply sendMessage(deviceFix request) {
DeviceFixServiceGrpc.DeviceFixServiceBlockingStub stub = DeviceFixServiceGrpc.newBlockingStub(serverChannel);
booleanReply response = stub.insertDeviceFix(request);
return response;
}

}

步骤5：配置项
grpc.client.grpc-server.host=127.0.0.1
grpc.client.grpc-server.port=9898
grpc.client.grpc-server.enableKeepAlive=true
grpc.client.grpc-server.keepAliveWithoutCalls=true

--------------------------------------------------------------------------------------------------------
以上是集成grpc是基于依赖：
<dependency>
<groupId>net.devh</groupId>
 <artifactId>grpc-spring-boot-starter</artifactId>
 <version>2.5.1.RELEASE</version>
</dependency>
还有一种集成grpc的方式是基于依赖：
<dependency>
 <groupId>io.github.lognet</groupId>
 <artifactId>grpc-spring-boot-starter</artifactId>
 <version>3.0.0</version>
</dependency>
这种方式的参考文档：https://blog.csdn.net/21aspnet/article/details/100727562

参考资料：
https://gitee.com/chis123/grpc-spring-boot-starter
https://blog.csdn.net/JHC23/article/details/102568845
https://blog.csdn.net/qq_35875671/article/details/106012835 （SpringBoot + gRPC + nacos）