spring boot grpc客户端

原创

mob64ca12f028ff 2024-12-31 05:18:01 ©著作权

文章标签 java 客户端 spring 文章分类 spring boot 后端开发

©著作权归作者所有：来自51CTO博客作者mob64ca12f028ff的原创作品，请联系作者获取转载授权，否则将追究法律责任

Spring Boot gRPC 客户端的创建与使用

gRPC（gRPC Remote Procedure Call）是一种高性能、开源的通用RPC框架，能够简化分布式系统中的服务间调用。它使用HTTP/2作为传输协议，这使得其具有更低的延迟和高效的多路复用。结合Spring Boot，可以很方便地构建和使用gRPC客户端。接下来，我们将介绍如何创建一个简单的Spring Boot gRPC客户端，并提供代码示例来帮助理解。

gRPC的基本概念

gRPC允许你定义服务及其方法，用户可以通过定义的接口进行调用。它使用 protobuf（Protocol Buffers）作为IDL（接口描述语言），能够实现跨语言的服务调用。

项目结构

在介绍代码之前，我们先看一下项目的基本结构：

spring-boot-grpc-client/
├── src/
│   ├── main/
│   │   ├── java/
│   │   │   └── com/
│   │   │       └── example/
│   │   │           ├── GreetServiceClient.java
│   │   │           ├── Application.java
│   │   │           └── proto/
│   │   │               └── greet.proto
│   │   └── resources/
│   │       └── application.properties
├── pom.xml
└── README.md

环境搭建

创建Spring Boot项目：可以使用Spring Initializr（ Boot项目，添加依赖spring-boot-starter和grpc-spring-boot-starter。
在pom.xml中添加gRPC与Protobuf相关依赖：

<dependency>
    <groupId>io.grpc</groupId>
    <artifactId>grpc-protobuf</artifactId>
    <version>1.48.1</version>
</dependency>
<dependency>
    <groupId>io.grpc</groupId>
    <artifactId>grpc-netty-shaded</artifactId>
    <version>1.48.1</version>
</dependency>
<dependency>
    <groupId>io.grpc</groupId>
    <artifactId>grpc-spring-boot-starter</artifactId>
    <version>2.8.0</version>
</dependency>

定义gRPC服务：在 src/main/java/com/example/proto/ 路径下创建 greet.proto 文件，用于定义服务。

syntax = "proto3";

package greet;

service GreetService {
    rpc sayHello (HelloRequest) returns (HelloResponse);
}

message HelloRequest {
    string name = 1;
}

message HelloResponse {
    string message = 1;
}

使用 protobuf 编译器生成 Java 代码。

创建gRPC客户端

在 src/main/java/com/example/ 下创建 GreetServiceClient.java。

package com.example;

import io.grpc.ManagedChannel;
import io.grpc.ManagedChannelBuilder;
import io.grpc.stub.Stub;
import greet.GreetServiceGrpc;
import greet.HelloRequest;
import greet.HelloResponse;

import javax.annotation.PostConstruct;
import org.springframework.stereotype.Component;

@Component
public class GreetServiceClient {

    private final GreetServiceGrpc.GreetServiceBlockingStub stub;

    public GreetServiceClient() {
        ManagedChannel channel = ManagedChannelBuilder.forAddress("localhost", 9090)
                .usePlaintext()
                .build();
        stub = GreetServiceGrpc.newBlockingStub(channel);
    }

    @PostConstruct
    public void greet() {
        HelloRequest request = HelloRequest.newBuilder()
                .setName("World")
                .build();
        HelloResponse response = stub.sayHello(request);
        System.out.println(response.getMessage());
    }
}

应用启动类

创建 Application.java 文件来启动应用：

package com.example;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

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

启动服务

为了完整测试我们的gRPC客户端，确保有gRPC服务在运行。在终端启动Spring Boot应用，等待客户端发送“Hello, World!”的请求。

流程图

接下来，我们可以用Mermaid语法为上述流程绘制一个流程图。如下所示：

flowchart TD
    A[创建Spring Boot项目] --> B[定义gRPC服务]
    B --> C[实现gRPC客户端]
    C --> D[启动应用]
    D --> E[发送请求并接收响应]

项目进度安排

接下来，我们可以使用甘特图来显示项目的进度：

gantt
    title gRPC客户端开发进度
    dateFormat  YYYY-MM-DD
    section 项目初始化
    创建Spring Boot项目          :done,  des1, 2023-10-01, 5d
    添加gRPC依赖                  :done,  des2, 2023-10-06, 2d
    section 服务实现
    定义gRPC服务                 :active, des3, 2023-10-08, 3d
    实现gRPC客户端              :   des4, after des3, 4d
    section 应用测试
    启动服务                     :  des5, 2023-10-15, 2d