SpringBoot使用GRPC框架

2023-06-01 22:22:13

利用 gRPC 构建现代微服务系统：一个深入指南

简介

在当今分布式系统的时代，微服务已成为构建复杂企业应用程序的首选架构。这些微服务需要通过某种方式相互连接并进行通信，这正是 Google 开发的 gRPC（gRPC 远程过程调用）框架发挥作用的地方。本文将深入探讨如何使用 gRPC 和 SpringBoot 构建现代微服务系统，涵盖从项目搭建到客户端和服务端代码实现的所有步骤。

gRPC 概述

gRPC 是一种现代、高性能、通用的 RPC（远程过程调用）框架，专为分布式系统的通信而设计。它提供了跨语言的二进制协议，并自动生成客户端和服务端代码存根，从而简化了应用程序的开发和维护。gRPC 基于 HTTP/2 协议，使其高效、灵活，并且与现代云原生环境高度兼容。

项目搭建

创建 SpringBoot 项目

使用 Spring Initializr 创建一个新的 SpringBoot 项目。
添加以下依赖项：

<dependency>
    <groupId>io.grpc</groupId>
    <artifactId>grpc-netty-shaded</artifactId>
    <version>1.47.0</version>
</dependency>
<dependency>
    <groupId>io.grpc</groupId>
    <artifactId>grpc-protobuf</artifactId>
    <version>1.47.0</version>
</dependency>
<dependency>
    <groupId>io.grpc</groupId>
    <artifactId>grpc-stub</artifactId>
    <version>1.47.0</version>
</dependency>

定义 proto 文件

创建一个名为 helloworld.proto 的新文件。
编写以下 proto 定义：

syntax = "proto3";

package helloworld;

message HelloRequest {
  string name = 1;
}

message HelloReply {
  string message = 1;
}

service Greeter {
  rpc SayHello (HelloRequest) returns (HelloReply) {}
  rpc SayHelloAgain (HelloRequest) returns (stream HelloReply) {}
}

生成 Java 代码

protoc --java_out=./src/main/java --grpc-java_out=./src/main/java helloworld.proto

这将生成客户端和服务端代码存根，用于 gRPC 通信。

服务端接口实现

在 src/main/java 包中创建一个名为 GreeterGrpcImpl.java 的新文件。
实现 GreeterGrpc.GreeterImplBase 接口。
实现 SayHello 和 SayHelloAgain 方法，如下所示：

public class GreeterGrpcImpl extends GreeterGrpc.GreeterImplBase {

    @Override
    public void sayHello(HelloRequest request, StreamObserver<HelloReply> responseObserver) {
        String message = "Hello " + request.getName();
        HelloReply reply = HelloReply.newBuilder().setMessage(message).build();
        responseObserver.onNext(reply);
        responseObserver.onCompleted();
    }

    @Override
    public void sayHelloAgain(HelloRequest request, StreamObserver<HelloReply> responseObserver) {
        List<String> messages = Arrays.asList("Hello", "again", request.getName());
        List<HelloReply> replies = messages.stream()
            .map(m -> HelloReply.newBuilder().setMessage(m).build())
            .collect(Collectors.toList());
        replies.forEach(responseObserver::onNext);
        responseObserver.onCompleted();
    }
}

启动服务端

在 src/main/java 包中创建一个名为 GrpcServerApplication.java 的新文件。
创建一个带有 @SpringBootApplication 注解的 SpringBoot 应用程序类。
添加 @GrpcService 注解到 GreeterGrpcImpl 服务端接口实现上。
在主方法中启动 gRPC 服务：

@SpringBootApplication
public class GrpcServerApplication {

    public static void main(String[] args) {
        SpringApplication.run(GrpcServerApplication.class, args);
    }

    @GrpcService
    public GreeterGrpcImpl greeterService() {
        return new GreeterGrpcImpl();
    }
}

客户端代码

在 src/main/java 包中创建一个名为 GreeterClient.java 的新文件。
使用 ManagedChannelBuilder 创建一个 gRPC 通道。
使用 GreeterGrpc.newBlockingStub 创建一个阻塞式服务端存根。
调用 SayHello 和 SayHelloAgain 方法发送请求和接收响应：

public class GreeterClient {

    private ManagedChannel channel;
    private GreeterGrpc.GreeterBlockingStub blockingStub;

    public GreeterClient(String host, int port) {
        channel = ManagedChannelBuilder.forAddress(host, port)
            .usePlaintext()
            .build();
        blockingStub = GreeterGrpc.newBlockingStub(channel);
    }

    public void greet(String name) {
        HelloRequest request = HelloRequest.newBuilder().setName(name).build();
        HelloReply response;
        try {
            response = blockingStub.sayHello(request);
        } catch (StatusRuntimeException e) {
            logger.log(Level.WARNING, "RPC failed: {0}", e.getStatus());
            return;
        }
        logger.info("Greeting: " + response.getMessage());
    }

    public static void main(String[] args) throws InterruptedException {
        GreeterClient client = new GreeterClient("localhost", 50051);
        try {
            client.greet("World");
        } finally {
            client.shutdown();
        }
    }
}