教你在Spring Boot微服務(wù)中集成gRPC通訊的方法

更新時間：2021年09月09日 10:44:35 作者：麥神-mirson

這篇文章主要介紹了教你在Spring Boot微服務(wù)中集成gRPC通訊的方法,本文給大家介紹的非常詳細(xì)，對大家的學(xué)習(xí)或工作具有一定的參考借鑒價值，需要的朋友可以參考下

一、首先聲明gRPC接口

這里引入的是最新的gRpc-core 1.37版本，采用的grcp-spring-boot-starter封裝的版本進(jìn)行實現(xiàn)，github地址：

https://github.com/yidongnan/grpc-spring-boot-starter

要實現(xiàn)gRpc通訊，先定義接口以及入?yún)⒊鰠⑿畔?/p>

syntax = "proto3";

option java_multiple_files = true;
option java_package = "com.grpc.spring.api.order";
option java_outer_classname = "OrderServiceProto";

// The service definition.
service OrderService {
    // The service method
    rpc GetOrderInfo (GetOrderRequest) returns (GetOrderReply) {
    }
}

// The request message
message GetOrderRequest {
    string orderNo = 1;
}

// The response message
message GetOrderReply {
    string orderNo = 1;
    string userName = 2;
    string address = 3;
    int64 price = 4;
}

定義好之后，就需要通過protoc工具，生成對應(yīng)的JAVA代碼。

為便于使用，這里封裝了bat腳本，并提供了對應(yīng)的protoc執(zhí)行程序。

@echo off
for %%i in (proto/*.proto) do (
  d:/TestCode/protoc.exe --plugin=protoc-gen-grpc-java=d:/TestCode/protoc-grpc.exe --java_out=../java --grpc-java_out=../java ./proto/%%i
  echo generate %%i to java file successfully!
)

該腳本意思，會掃描當(dāng)前proto目錄下的所有proto腳本文件，通過protoc-grpc插件，在指定目錄下生成gRpc通訊接口的JAVA代碼。

生成后的JAVA代碼

file

執(zhí)行成功后，會生成GPRC通訊接口，入?yún)⒑统鰠⑿畔ⅰ?/p>

二、如何在服務(wù)端集成gRPC

首先整理配置好POM依賴，這里將共用的依賴抽取到父級POM文件中。

父級POM依賴：

<dependencies>
    <dependency>
        <groupId>javax.servlet</groupId>
        <artifactId>javax.servlet-api</artifactId>
        <version>3.1.0</version>
    </dependency>
    <!-- spring boot grpc 依賴 -->
    <dependency>
        <groupId>net.devh</groupId>
        <artifactId>grpc-spring-boot-starter</artifactId>
        <version>${gprc.spring.version}</version>
    </dependency>
    <!-- jackson -->
    <dependency>
        <groupId>com.fasterxml.jackson.core</groupId>
        <artifactId>jackson-databind</artifactId>
        <version>${jackson.verson}</version>
    </dependency>
    <dependency>
        <groupId>com.fasterxml.jackson.core</groupId>
        <artifactId>jackson-core</artifactId>
        <version>${jackson.verson}</version>
    </dependency>
    <dependency>
        <groupId>com.fasterxml.jackson.core</groupId>
        <artifactId>jackson-annotations</artifactId>
        <version>${jackson.verson}</version>
    </dependency>
    <!-- lombok 插件， 簡化開發(fā)代碼 -->
    <dependency>
        <groupId>org.projectlombok</groupId>
        <artifactId>lombok</artifactId>
        <optional>true</optional>
        <version>1.18.8</version>
    </dependency>
</dependencies>

<dependencyManagement>
    <dependencies>
        <dependency>
            <groupId>com.grpc.spring</groupId>
            <artifactId>grpc-spring-api</artifactId>
            <version>${grpc.api.version}</version>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-parent</artifactId>
            <version>${spring.boot.version}</version>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
            <version>${spring.boot.version}</version>
        </dependency>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-dependencies</artifactId>
            <version>2020.0.2</version>
        </dependency>
        <dependency>
            <groupId>com.alibaba.cloud</groupId>
            <artifactId>spring-cloud-alibaba-dependencies</artifactId>
            <version>2021.1</version>
        </dependency>
    </dependencies>
</dependencyManagement>

服務(wù)端POM配置

<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    <dependency>
        <groupId>net.devh</groupId>
        <artifactId>grpc-server-spring-boot-starter</artifactId>
        <version>${gprc.spring.version}</version>
    </dependency>
    <dependency>
        <groupId>com.grpc.spring</groupId>
        <artifactId>grpc-spring-api</artifactId>
    </dependency>
    <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
        <version>3.0.2</version>
        <exclusions>
            <exclusion>
                <artifactId>servlet-api</artifactId>
                <groupId>javax.servlet</groupId>
            </exclusion>
        </exclusions>
    </dependency>
</dependencies>

作為服務(wù)端，需要加入gRpc服務(wù)端的依賴grpc-server-spring-boot-starter，同時引入eureka，可以實現(xiàn)微服務(wù)之間的調(diào)用以及負(fù)載。

服務(wù)端接口實現(xiàn)

這里為作測試驗證，定義個訂單服務(wù)接口， GrpcOrderService：

/**
 * 訂單服務(wù)接口實現(xiàn)
 */
@GrpcService
public class GrpcOrderService extends OrderServiceGrpc.OrderServiceImplBase {

    @Value("${server.port}")
    private String serverPort;

    @Override
    public void getOrderInfo(GetOrderRequest request, StreamObserver<GetOrderReply> responseObserver) {
        GetOrderReply reply =GetOrderReply.newBuilder().setOrderNo(request.getOrderNo())
                .setAddress("廣東省深圳市,端口號" + serverPort)
                .setUserName("tester")
                .setPrice(System.currentTimeMillis())
                .build();
        responseObserver.onNext(reply);
        responseObserver.onCompleted();
    }
}

要實現(xiàn)gRpc服務(wù)端接口，必須做聲明，采用@GrpcService注解，然后繼承g(shù)Rpc生成的接口OrderServiceGrpc，重新getOrderInfo獲取訂單信息接口，實現(xiàn)具體的處理邏輯。

服務(wù)端的配置

application.yml

server:
  port: 18082
spring:
  application:
    name: grpc-spring-server
grpc:
  server:
    port: 0
eureka:
  instance:
    prefer-ip-address: true
  client:
    register-with-eureka: true
    fetch-registry: false
    service-url:
      defaultZone: http://${eureka.instance.hostname:eureka.kyeapi.com}:${eureka.server.port:18761}/eureka/

服務(wù)端的gRpc端口配置為0代表隨機(jī)分配， gRpc服務(wù)信息會注冊至eureka。

三、如何在客戶單集成gRPC：

客戶端的POM依賴配置

<dependencies>
    <dependency>
        <groupId>com.grpc.spring</groupId>
        <artifactId>grpc-spring-api</artifactId>
    </dependency>
    <dependency>
        <groupId>net.devh</groupId>
        <artifactId>grpc-client-spring-boot-starter</artifactId>
        <version>${gprc.spring.version}</version>
    </dependency>
    <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
        <version>3.0.2</version>
    </dependency>

    <!-- 添加 Spring Boot 依賴 -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>

    <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
        <version>3.0.2</version>
        <exclusions>
            <exclusion>
                <artifactId>servlet-api</artifactId>
                <groupId>javax.servlet</groupId>
            </exclusion>
        </exclusions>
    </dependency>
</dependencies>

加入提供的客戶端依賴grpc-client-spring-boot-starter，這里注意，添加的eureka-client依賴，要排除servlet-api，以免啟動沖突。

客戶端調(diào)用實現(xiàn)

GrpcOrderClientService：

/**
 *  訂單信息獲取客戶端接口
 */
@Service
@Log4j2
public class GrpcOrderClientService {

    @GrpcClient("grpc-server")
    private OrderServiceGrpc.OrderServiceBlockingStub orderServiceBlockingStub;

    /**
     * 獲取訂單信息
     * @param orderNo
     * @return
     */
    public String getOrderInfo(String orderNo) {
        try {
            //將遠(yuǎn)程調(diào)用的Grpc服務(wù)端接口信息, 返回給客戶端。
            GetOrderRequest request  = GetOrderRequest.newBuilder().setOrderNo(orderNo).build();
            final GetOrderReply response = orderServiceBlockingStub.getOrderInfo(request);
            String result = "orderNo: " + response.getOrderNo() + ", userName: " + response.getUserName() + ", address: " + response.getAddress();
            return result;
        }catch (Exception e) {
            log.error(e.getMessage(), e);
            return "error! " + e.getMessage();
        }
    }
}

這里通過@GrpcClient注解，引入gRpc接口，這里的gRpc服務(wù)端名稱grpc-server要與配置文件的名稱保持一致。

客戶端配置

application.yml

server:
  port: 18080
spring:
  application:
    name: grpc-spring-client
grpc:
  client:
    grpc-server:
      address: 'discovery:///grpc-spring-server'
      enableKeepAlive: true
      keepAliveWithoutCalls: true
      negotiationType: plaintext
eureka:
  instance:
    prefer-ip-address: true
    status-page-url-path: /actuator/info
    health-check-url-path: /actuator/health
  client:
    register-with-eureka: false
    fetch-registry: true
    service-url:
      defaultZone: http://${eureka.instance.hostname:eureka.kyeapi.com}:${eureka.server.port:18761}/eureka/

這里定義了一個gRpc的連接信息grpc-server，與前面注解的名稱保持一致， adress要配置gRpc服務(wù)端的名稱，不需要配置具體的IP和端口，會通過eureka來拉取服務(wù)端的具體連接信息。