gRPC的Java端使用

2022-05-30

介绍

gRPC简介

gRPC is a modern open source high performance Remote Procedure Call (RPC) framework that can run in any environment.

gRPC是一个现代、开源、高性能的远程调用（RPC）框架，可以在任何环境中运行

gRPC

适合场景

gRPC非常适合以下场景：
- 微服务 - gRPC设计为低延迟和高吞吐量通信。gRPC非常适用于效率至关重要的轻型微服务。
- 点对点实时通信 - gRPC对双向流媒体提供出色的支持。gRPC服务可以实时推送消息而无需轮询。
- 多语言混合开发环境 - gRPC工具支持所有流行的开发语言，使gRPC成为多语言开发环境的理想选择。
- 网络受限环境 - 使用Protobuf（一种轻量级消息格式）序列化gRPC消息。gRPC消息始终小于等效的JSON消息。
不建议使用场景

在以下场景中，建议使用其他框架而不是gRPC：
- 浏览器可访问的API - 浏览器不完全支持gRPC。gRPC-Web可以提供浏览器支持，但它有局限性并引入了服务器代理。
- 广播实时通信 - gRPC支持通过流媒体进行实时通信，但不存在向已注册连接广播消息的概念。例如，在应该将新聊天消息发送到聊天室中的所有客户端的聊天室场景中，需要每个gRPC呼叫以单独地将新的聊天消息流传输到客户端。对于这种场景，SignalR是这种情况的有用框架。SignalR具有持久连接的概念和对广播消息的内置支持。
- 进程间通信 - 进程必须承载HTTP/2服务才能接受传入的gRPC调用。对于Windows，进程间通信管道是一种快速，轻量级的通信方法。

Protocol Buffers

一种轻便、高效的结构化数据存储方式，与语言、平台无关

gRPC框架默认使用的数据交换格式
文件名以.proto结尾
字段类型包含常见的数字、字符串、布尔、枚举、数组
每个字段需要一个数字标识符，定义好后不能改变。最小的标识号可以从1开始，最大到2^29 - 1, or 536,870,911。不可以使用其中的[19000－19999]的标识号， Protobuf协议实现中对这些进行了预留。如果非要在.proto文件中使用这些预留标识号，编译时就会报警

示例：

person.proto

message Person {
  int32 id = 1;
  string name = 2;
  bool is_married = 3;
}

gRPC的四种通信模式

unary call 一元通信
Server-side streaming RPC 服务端流式通信
Client-side streaming RPC 客户端流式通信
Bidirectional streaming RPC 双向流式通信

maven依赖

<dependencies>
  <dependency>
    <groupId>io.grpc</groupId>
    <artifactId>grpc-protobuf</artifactId>
    <version>${grpc.version}</version>
  </dependency>

  <dependency>
    <groupId>io.grpc</groupId>
    <artifactId>grpc-stub</artifactId>
    <version>${grpc.version}</version>
  </dependency>

  <dependency>
    <groupId>io.grpc</groupId>
    <artifactId>grpc-netty</artifactId>
    <version>${grpc.version}</version>
  </dependency>
</dependencies>

<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>
        <protocArtifact>
          com.google.protobuf:protoc:3.19.2:exe:${os.detected.classifier}																		</protocArtifact>
        <pluginId>grpc-java</pluginId>
        <pluginArtifact>
          io.grpc:protoc-gen-grpc-java:1.45.1:exe:${os.detected.classifier}																	</pluginArtifact>
      </configuration>
      <executions>
        <execution>
          <goals>
            <goal>compile</goal>
            <goal>compile-custom</goal>
          </goals>
        </execution>
      </executions>
    </plugin>
  </plugins>
</build>

定义gRPC服务

定义proto文件

syntax = "proto3";

option java_package = "com.example.demo";
option java_multiple_files = true;

service Greeter {
  
  // unary call
  rpc SayHello (HelloRequest) returns (HelloReply) {}
  
  // server stream
  rpc SayHelloAgain (HelloRequest) returns (stream HelloReply) {}
}

message HelloRequest {
  string name = 1;
}

message HelloReply {
  string message = 1;
}

生成代码

compile: 生成proto文件
compile-custom: 生成gRPC文件

gRPC

服务端

自己写一个类，继承GreeterGrpc.GreeterImplBase

public class GreeterService extends GreeterGrpc.GreeterImplBase {

    @Override
    public void sayHello(HelloRequest request, StreamObserver<HelloReply> responseObserver) {
     	  System.out.println(request.getName());
      	// 构造返回对象
        HelloReply helloReply = HelloReply.newBuilder()
                .setMessage("okok")
                .build();
        responseObserver.onNext(helloReply);
      	// 结束调用
        responseObserver.onCompleted();
    }

    @Override
    public void sayHelloAgain(HelloRequest request, StreamObserver<HelloReply> responseObserver) {
        System.out.println(request.getName());
        for (int i = 0; i < 10; i++) {
            HelloReply helloReply = HelloReply.newBuilder()
                    .setMessage("okok" + i)
                    .build();
            // 多次调用onNext()
            responseObserver.onNext(helloReply);
        }
        // 结束调用
        responseObserver.onCompleted();
    }
}

启动服务

public static void main(String[] args) throws IOException, InterruptedException {
    Server server = ServerBuilder.forPort(8527)
            .addService(new GreeterService())
            .build()
            .start();
    System.out.println("server started");
    System.out.println("==============");
    server.awaitTermination();
}

客户端

使用stub调用进行远程调用

public class GreeterClient {

    public static void main(String[] args) {
        // 指定主机和端口
        ManagedChannel channel = ManagedChannelBuilder.forAddress("localhost", 8527)
                .usePlaintext()
                .build();
        GreeterGrpc.GreeterBlockingStub blockingStub = GreeterGrpc.newBlockingStub(channel);
				
      	// 构造请求对象
        HelloRequest helloRequest = HelloRequest.newBuilder()
                .setName("张三")
                .build();
      	// 远程调用，获取响应 
        HelloReply helloReply = blockingStub.sayHello(helloRequest);
        System.out.println(helloReply);
    }
}