• SpringBoot集成grpc实现微服务

    前言

    传统的SpringCloud实现微服务的方案中，我们通常都是使用SpringCloud OpenFeign组件以RESTFUL API的调用方式来完成微服务之间的RPC调用；使用RESTFUL API的方式在SpringCloud实施的微服务在实际的项目中还是非常常见的；在实现上比较的简单，而且关于RPC调用中的服务熔断等处理的组件也支持的较多；一般的SpringCloud都是采用OpenFeign通过HTTP的方式；今天我们这个文章给大家介绍一种在云原生中应用的更为广泛的RPC调用的方式gRPC； 并看看SpringBoot如何集成gRPC实现一个微服务。

    gRPC

    gRPC，也是RPC框架的一种，可以看作是g-RPC；是一个高性能、开源和通用的 RPC 框架，基于ProtoBuf(Protocol Buffers) 序列化协议开发，且支持众多开发语言。面向服务端和移动端，基于 HTTP/2 设计，带来诸如双向流、流控、头部压缩、单 TCP 连接上的多复用请求等特。这些特性使得其在移动设备上表现更好，更省电和节省空间占用。 gRPC的方式有点和JAVA技术里的RMI相识， ProtoBuf会产生一个类似RMI技术中Stub（桩子）;在Stub中包括了协议解析Marshal和Unmarshel，以及协议通过Tcp/IP进行通信的接口和实现类，在调用的时候，我们直接调用这个实现类的接口，即可完成和目标通信以及远程调用的细节实现；和RMI不同点就是协议方式不同，gRPC使用的是Protobut的协议进行数据传输；

    如下图所示；

    gRPC和RESTFUL的比较

    gRPC 优点

    性能

    gRPC 消息使用 Protobuf（一种高效的二进制消息格式）进行序列化。 Protobuf 在服务器和客户端上可以非常快速地序列化。 Protobuf 序列化产生的有效负载较小，这在移动应用等带宽有限的方案中很重要。

    gRPC 专为 HTTP/2（HTTP 的主要版本）而设计，与 HTTP 1.x 相比，HTTP/2 具有巨大性能优势：

    • 二进制组帧和压缩。 HTTP/2 协议在发送和接收方面均紧凑且高效。
    • 在单个 TCP 连接上多路复用多个 HTTP/2 调用。 多路复用可消除队头阻塞。

    HTTP/2 不是 gRPC 独占的。 许多请求类型（包括具有 JSON 的 HTTP API）都可以使用 HTTP/2，并受益于其性能改进。

    代码生成

    所有 gRPC 框架都为代码生成提供一流支持。 .proto文件是 gRPC 开发的核心文件，它定义 gRPC 服务和消息的协定。 通过此文件，gRPC 框架生成服务基类、消息和完整的客户端。

    通过在服务器和客户端之间共享 .proto 文件，可以端到端生成消息和客户端代码。 客户端的代码生成消除了客户端和服务器上的消息重复，并为你创建强类型客户端。 无需编写客户端可在具有许多服务的应用程序中节省大量开发时间。

    严格规范

    具有 JSON 的 HTTP API 没有正式规范。 开发人员为 URL、HTTP 谓词和响应代码的最佳格式争论不休。

    gRPC 规范对 gRPC 服务必须遵循的格式进行了规定。 gRPC 消除了争论并为开发人员节省了时间，因为 gRPC 在各个平台和实现中都是一致的。

    流式处理

    HTTP/2 为长期实时通信流提供基础。 gRPC 为通过 HTTP/2 进行流式传输提供一流支持。

    gRPC 服务支持所有流式传输组合：

    • 一元（无流式传输）
    • 服务器到客户端流式传输
    • 客户端到服务器流式传输
    • 双向流式传输

    截止时间/超时和取消

    gRPC 允许客户端指定其愿意等待 RPC 完成的时间期限。 截止时间会发送到服务器，如果超过截止时间，服务器可以决定要执行的操作。 例如，服务器可能会在超时后取消正在进行的 gRPC/HTTP/数据库请求。

    通过 gRPC 子调用传播截止时间和取消有助于强制执行资源使用限制。

    gRPC使用流程

    定义标准的proto文件

    生成标准代码

    服务端使用生成的代码提供服务

    客户端使用生成的代码调用服务

    SpringBoot基础gRPC

    定义proto文件作为服务标准

    1. syntax = "proto3";
    2.  
    3. package service;
    4. option java_multiple_files = false;
    5. option java_package = "com.joinsun.application.dubbo.demo.protobuf";
    6. option java_outer_classname = "HelloGrpcServiceProto";
    7. option go_package = "./hello_grpc";
    8.  
    9. service Greeter {
    10.   rpc SayHello (HelloRequest) returns (HelloReply) {}
    11.   rpc SayHelloOutStream (HelloRequest) returns (stream HelloReply) {}
    12.   rpc SayHelloInStream (stream HelloRequest) returns (HelloReply) {}
    13.   rpc SayHelloBothStream (stream HelloRequest) returns (stream HelloReply) {}
    14. }
    15.  
    16. message HelloRequest {
    17.   string name = 1;
    18. }
    19.  
    20. message HelloReply {
    21.   string message = 1;
    22. }
    23.  
    24.  
    25. message HelloRequest {
    26.  
    27. string name = 1;
    28.  
    29. }
    30.  
    31.  
    32.  
    33. message HelloReply {
    34.  
    35. string message = 1;
    36.  
    37. }

     

    生成标准代码

    在pom.xml中加入proto文件处理的插件，这样在maven进行springboot项目构建的时候，会自动进行proto的文件构建

    在pom.xml的build-》plugins部分，添加支持proto文件的插件

    1.     <plugin>
    2.         <groupId>org.xolstice.maven.pluginsgroupId>
    3.         <artifactId>protobuf-maven-pluginartifactId>
    4.         <version>0.5.0version>
    5.         <configuration>
    6.             <protocArtifact>com.google.protobuf:protoc:${protobuf.version}:exe:${os.detected.classifier}protocArtifact>
    7.             <pluginId>grpc-javapluginId>
    8.             <pluginArtifact>io.grpc:protoc-gen-grpc-java:${grpc.version}:exe:${os.detected.classifier}pluginArtifact>
    9.             <outputDirectory>src/main/javaoutputDirectory>
    10.             <clearOutputDirectory>falseclearOutputDirectory>            
    11.         configuration>
    12.         <executions>
    13.             <execution>
    14.                 <goals>
    15.                     <goal>compilegoal>
    16.                     <goal>compile-customgoal>
    17.                 goals>
    18.             execution>
    19.         executions>
    20.     plugin>

    上面的插件里，相关的一些属性参数；如下

    1. <properties>
    2.     <dubbo.protobuf.verion>2.7.14dubbo.protobuf.verion>
    3.     <dubbo.compiler.version>0.0.2dubbo.compiler.version>
    4.     <grpc.version>1.6.1grpc.version>
    5.     <protobuf.version>3.3.0protobuf.version>
    6.     <protobuf.format.version>1.2protobuf.format.version>
    7. properties>

    编译以后的内容

    编写服务端代码（实现业务逻辑）

    加入依赖

    引入上面编译后产生的proto文件； 编写服务提供方的业务逻辑代码

    在pom文件里加入grpc的依赖

    1.         
    2.         <dependency>
    3.             <groupId>org.lognetgroupId>
    4.             <artifactId>grpc-spring-boot-starterartifactId>
    5.             <version>${grpc-spring-boot-starter.version}version>
    6.         dependency>

    编写业务代码

    1. @GRpcService
    2. public class OperateImpl extends GreeterGrpc.GreeterImplBase {
    3.     @Override
    4.     public void sayHello(HelloRequest request, StreamObserver responseObserver) {
    5. String msg = String.format("Protobuf: Hello, %s %s", request.getName(), DateUtil.formatDateTime(DateUtil.date()));
    6.  
    7. return HelloGrpcServiceProto.HelloReply.newBuilder().setMessage(msg).build();
    8.      }
    9. }

    编写消费端代码（调用服务）

    加入依赖

    引入上面编译后产生的proto文件； 编写服务提供方的业务逻辑代码

    在pom文件里加入grpc的依赖

    1.         
    2.         <dependency>
    3.             <groupId>org.lognetgroupId>
    4.             <artifactId>grpc-spring-boot-starterartifactId>
    5.             <version>${grpc-spring-boot-starter.version}version>
    6.         dependency>

    调用服务

    1. @Component
    2. @Slf4j
    3. public class GRpcService {
    4.     private Channel serverChannel;
    5.  
    6.     @Setter
    7.     @Value("${grpc.client.grpc-server.host:localhost}")
    8.     private String host;
    9.  
    10.     @Setter
    11.     @Value("${grpc.client.grpc-server.port:8098}")
    12.     private int port;
    13.  
    14.     @PostConstruct
    15.     public void init(){
    16.         ManagedChannel managedChannel = ManagedChannelBuilder.forAddress(host, port).usePlaintext(true).build();
    17.         this.serverChannel = managedChannel;
    18.     }
    19.  
    20.     public String sayHello(String word){
    21.         GreeterGrpc.GreeterStub stub = GreeterGrpc.newBlockingStub(serverChannel);
    22.  
    23.         HelloGrpcServiceProto.HelloReply helloReply = stub.sayHello(HelloGrpcServiceProto.HelloRequest.newBuilder().setName(word).build());
    24.  
    25.         return helloReply.getMessage();
    26.     }
    27.  
    28.     public String sayHelloStream(String word){
    29.         GreeterGrpc.GreeterStub stub = GreeterGrpc.newStub(serverChannel);
    30.  
    31.         stub.sayHelloOutStream(HelloGrpcServiceProto.HelloRequest.newBuilder().setName(word+"-Java-Out").build(), new StreamObserver() {
    32.             @Override
    33.             public void onNext(HelloGrpcServiceProto.HelloReply helloReply) {
    34.                 log.info("Receiver[Out] {}", helloReply.getMessage());
    35.             }
    36.  
    37.             @Override
    38.             public void onError(Throwable throwable) {
    39.                 log.info("Error[Out] {}", throwable);
    40.             }
    41.  
    42.             @Override
    43.             public void onCompleted() {
    44.                 log.info("Receive[Out] finish");
    45.             }
    46.         });
    47.  
    48.         StreamObserver requestStreamObserver =
    49.                 stub.sayHelloInStream(new StreamObserver() {
    50.             @Override
    51.             public void onNext(HelloGrpcServiceProto.HelloReply helloReply) {
    52.                 log.info("Receiver[In] {}", helloReply.getMessage());
    53.             }
    54.  
    55.             @Override
    56.             public void onError(Throwable throwable) {
    57.                 log.info("Error[In] {}", throwable);
    58.             }
    59.  
    60.             @Override
    61.             public void onCompleted() {
    62.                 log.info("Receive[In] finish");
    63.             }
    64.         });
    65.  
    66.         for( int idx = 1; idx <= 10; idx ++) {
    67.             requestStreamObserver.onNext(HelloGrpcServiceProto.HelloRequest.newBuilder().setName(word+"-Java-In-"
    68.                     + idx).build());
    69.         }
    70.  
    71.         requestStreamObserver.onCompleted();
    72.  
    73.         requestStreamObserver =
    74.                 stub.sayHelloBothStream(new StreamObserver() {
    75.             @Override
    76.             public void onNext(HelloGrpcServiceProto.HelloReply helloReply) {
    77.                 log.info("Receiver[Both] {}", helloReply.getMessage());
    78.             }
    79.  
    80.             @Override
    81.             public void onError(Throwable throwable) {
    82.                 log.info("Error[Both] {}", throwable);
    83.             }
    84.  
    85.             @Override
    86.             public void onCompleted() {
    87.                 log.info("Receive[Both] finish");
    88.             }
    89.         });
    90.  
    91.         for( int idx = 1; idx <= 10; idx ++) {
    92.             requestStreamObserver.onNext(HelloGrpcServiceProto.HelloRequest.newBuilder().setName(word+"-Java-Both-"
    93.                     + idx).build());
    94.         }
    95.  
    96.         requestStreamObserver.onCompleted();
    97.  
    98.         return "OK";
    99.     }
    100. }

    在上述消费者进行RPC远程调用的代码中，我们演示了2中调用，一种是普通调用，一种是单向流的调用；

    部署服务端和消费端

    将服务端和客户端都启动，通过消费端的GRpcService的调用，就可以实现grpc的远程调用了

    结束语

    本文介绍了gRpc这种在云原生里非常使用非常广泛的RPC调用方式，并介绍了通过Springboot的方式集成gRPC进行java语言的gRPC调用的实战案例；gRPC的调用是跨语言的，有兴趣的朋友可以使用GO语言来实现对Java实现的服务端调用；通过对比，你会发现Go对gRPC的调用支持比Java是更加的方便。

    谢谢大家继续关注！！！

  • 相关阅读:
    李超线段树
    原生小程序小话题——数据绑定、列表渲染和条件渲染
    零基础学Java（2）数据类型与变量
    使用Docker安装Drone和Gogs实现自动化部署
    力扣 667. 优美的排列 II
    面试官：什么是MySQL 事务与 MVCC 原理？
    MobTech短信验证ApiCloud SDK
    【0到1学习Unity脚本编程】第一人称视角的角色控制器
    等级保护 —— 安全控制点，安全要求
    nexus搭建测试docker&maven&npm仓库
  • 原文地址：https://blog.csdn.net/inthirties/article/details/126761747