Spring Boot+Nacos+gRPC，一個(gè)區(qū)別于 OpenFeign 的微服務(wù)通信方案！

作者：江南一點(diǎn)雨 2023-04-03 17:43:47

通過(guò) @GrpcClient? 注解注入一個(gè) HelloServiceBlockingStub 實(shí)例，其中 @GrpcClient 注解中的參數(shù)就是注冊(cè)到 nacos 上服務(wù)的名字，將來(lái)會(huì)自動(dòng)根據(jù)服務(wù)的名字查找到服務(wù)的具體地址進(jìn)行調(diào)用。

gRPC 的基礎(chǔ)知識(shí)前面跟小伙伴們分享了很多了，今天再寫一篇給這個(gè)小小的系列收個(gè)尾。

我們前面介紹的都是 gRPC 的基本用法，最終目的當(dāng)然是希望能夠在 Spring Boot 中用上這個(gè)東西，相信大部分小伙伴對(duì)于微服務(wù)的通信方案如 OpenFeign、Dubbo、消息驅(qū)動(dòng)都有所了解，但是對(duì)于這三種方案之外的其他方案，可能聽(tīng)的多用的少，今天我們就來(lái)實(shí)踐一下 gRPC 這種方案。

順便說(shuō)一下我為什么會(huì)想到寫 gRPC 教程呢，是因?yàn)橹拔蚁虢o小伙伴們總結(jié)一下常見(jiàn)的各種微服務(wù)通信方案。整理到 gRPC 的時(shí)候發(fā)現(xiàn)我還沒(méi)寫過(guò) gRPC 相關(guān)的教程，因此就有了一個(gè)小系列。

1. 依賴選擇

Spring Boot 整合 gRPC，官方其實(shí)并沒(méi)有提供相應(yīng)的依賴，不過(guò)目前有一個(gè)比較流行的第三方庫(kù)可以使用：

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

接下來(lái)松哥就結(jié)合這個(gè)庫(kù)，來(lái)和小伙伴們演示一下 Spring Boot+Nacos+gRPC 的用法。

可能有小伙伴也會(huì)見(jiàn)到一些其他的第三方庫(kù)，這個(gè)其實(shí)都可以，只要穩(wěn)定可靠就行，本文就以上面這個(gè)庫(kù)為例來(lái)和小伙伴們介紹。

2. 準(zhǔn)備工作

這里我采用了 Nacos 來(lái)做服務(wù)注冊(cè)中心，使用的 Nacos 版本是 2.0.2 這個(gè)版本。Nacos 簡(jiǎn)單安裝一下就行了，為了省事，數(shù)據(jù)持久化啥的可以先不配置。也就是 Nacos 下載解壓之后，直接執(zhí)行如下命令單體運(yùn)行就行了：

sh startup.sh -m standalone

這塊沒(méi)啥好說(shuō)的，松哥在 vhr 系列里也有相關(guān)的視頻教程，這里就不啰嗦了。

3. 代碼實(shí)踐

首先我們來(lái)看看我們的項(xiàng)目結(jié)構(gòu)：

├─grpc-api
│  └─src
│      └─main
│          └─proto
├─grpc-client
│  └─src
│      ├─main
│      │  ├─java
│      │  └─resources
│      └─test
└─grpc-server
    └─src
        ├─main
        │  ├─java
        │  └─resources
        └─test

首先有一個(gè)公共的模塊 grpc-api，這個(gè)模塊用來(lái)放我們的公共代碼和依賴，包括 Protocol Buffers 文件也放在這里。

grpc-client 和 grpc-server 就不用多說(shuō)了，分別是我們的客戶端和服務(wù)端。

3.1 grpc-api

grpc-api 中主要是處理 grpc 相關(guān)的事情，包括添加需要的依賴、插件等，編寫 Protocol Buffers 文件等。

我們先來(lái)看看該項(xiàng)目的 pom.xml 文件中的依賴：

<properties>
    <maven.compiler.source>17</maven.compiler.source>
    <maven.compiler.target>17</maven.compiler.target>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    <protobuf.version>3.21.7</protobuf.version>
    <protobuf-plugin.version>0.6.1</protobuf-plugin.version>
    <grpc.version>1.52.1</grpc.version>
</properties>
<dependencies>
    <dependency>
        <groupId>io.grpc</groupId>
        <artifactId>grpc-stub</artifactId>
        <version>${grpc.version}</version>
    </dependency>
    <dependency>
        <groupId>io.grpc</groupId>
        <artifactId>grpc-protobuf</artifactId>
        <version>${grpc.version}</version>
    </dependency>
    <dependency>
        <!-- Java 9+ compatibility - Do NOT update to 2.0.0 -->
        <groupId>jakarta.annotation</groupId>
        <artifactId>jakarta.annotation-api</artifactId>
        <version>1.3.5</version>
        <optional>true</optional>
    </dependency>
</dependencies>
<build>
    <extensions>
        <extension>
            <groupId>kr.motd.maven</groupId>
            <artifactId>os-maven-plugin</artifactId>
            <version>1.7.0</version>
        </extension>
    </extensions>
    <plugins>
        <plugin>
            <groupId>org.xolstice.maven.plugins</groupId>
            <artifactId>protobuf-maven-plugin</artifactId>
            <version>${protobuf-plugin.version}</version>
            <configuration>
                <protocArtifact>com.google.protobuf:protoc:${protobuf.version}:exe:${os.detected.classifier}</protocArtifact>
                <pluginId>grpc-java</pluginId>
                <pluginArtifact>io.grpc:protoc-gen-grpc-java:${grpc.version}:exe:${os.detected.classifier}</pluginArtifact>
            </configuration>
            <executions>
                <execution>
                    <goals>
                        <goal>compile</goal>
                        <goal>compile-custom</goal>
                    </goals>
                </execution>
            </executions>
        </plugin>
    </plugins>
</build>

這塊的依賴跟我們之前的 gRPC 文章中案例的依賴基本上都是一致的，沒(méi)有區(qū)別，再來(lái)看看我們的 Protocol Buffers 文件：

syntax = "proto3";

option java_multiple_files = true;
option java_package = "org.javaboy.grpc.api";
option java_outer_classname = "LoginProto";
import "google/protobuf/wrappers.proto";

package login;

service HelloService{
  rpc sayHello(google.protobuf.StringValue) returns (google.protobuf.StringValue);
}

很簡(jiǎn)單的一個(gè) HelloService 服務(wù)。

3.2 grpc-server

grpc-server 則是我們的服務(wù)端，這是一個(gè) Spring Boot 工程，項(xiàng)目依賴如下：

<parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>2.7.7</version>
    <relativePath/> <!-- lookup parent from repository -->
</parent>
<groupId>org.javaboy</groupId>
<artifactId>grpc-server</artifactId>
<version>0.0.1-SNAPSHOT</version>
<name>grpc-server</name>
<description>grpc-server</description>
<properties>
    <java.version>17</java.version>
</properties>
<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    <dependency>
        <groupId>com.alibaba.cloud</groupId>
        <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
    </dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-test</artifactId>
        <scope>test</scope>
    </dependency>
    <dependency>
        <groupId>org.javaboy</groupId>
        <artifactId>grpc-api</artifactId>
        <version>1.0-SNAPSHOT</version>
    </dependency>
    <dependency>
        <groupId>net.devh</groupId>
        <artifactId>grpc-server-spring-boot-starter</artifactId>
        <version>2.14.0.RELEASE</version>
    </dependency>
</dependencies>
<dependencyManagement>
    <dependencies>
        <dependency>
            <groupId>com.alibaba.cloud</groupId>
            <artifactId>spring-cloud-alibaba-dependencies</artifactId>
            <version>2021.0.5.0</version>
            <type>pom</type>
            <scope>import</scope>
        </dependency>
    </dependencies>
</dependencyManagement>
<build>
    <plugins>
        <plugin>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-maven-plugin</artifactId>
        </plugin>
    </plugins>
</build>

由于第三方庫(kù) grpc-server-spring-boot-starter 在支持 Spring Boot3 上還有一些瑕疵，因此我這里使用了 Spring Boot2.7.7 這個(gè)版本。

這里需要注意的是就是添加了 gRPC 的依賴 grpc-server-spring-boot-starter 和 nacos 的依賴。其他都是常規(guī)配置。

接下來(lái)我們來(lái)在服務(wù)端提供 gRPC 方法的實(shí)現(xiàn)：

@GrpcService
public class HelloServiceImpl extends HelloServiceGrpc.HelloServiceImplBase {
    @Override
    public void sayHello(StringValue request, StreamObserver<StringValue> responseObserver) {
        String value = request.getValue();
        responseObserver.onNext(StringValue.newBuilder().setValue("hello " + value).build());
        responseObserver.onCompleted();
    }
}

小伙伴們看到，通過(guò) @GrpcService 注解去標(biāo)記我們的一個(gè)服務(wù)即可。

最后，在 application.yaml 中進(jìn)行配置，將當(dāng)前服務(wù)注冊(cè)到 nacos 容器中：

grpc:
  server:
    port: 9099
spring:
  cloud:
    nacos:
      discovery:
        server-addr: hc.javaboy.org:8848
        username: nacos
        password: nacos
        enabled: true
  application:
    name: grpc_server

OK，服務(wù)端搞定。

3.3 grpc-client

最后再來(lái)看看客戶端。

先來(lái)看依賴：

<parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>2.7.7</version>
    <relativePath/> <!-- lookup parent from repository -->
</parent>
<groupId>org.javaboy</groupId>
<artifactId>grpc-client</artifactId>
<version>0.0.1-SNAPSHOT</version>
<name>grpc-client</name>
<description>grpc-client</description>
<properties>
    <java.version>17</java.version>
</properties>
<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    <dependency>
        <groupId>com.alibaba.cloud</groupId>
        <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
    </dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-test</artifactId>
        <scope>test</scope>
    </dependency>
    <dependency>
        <groupId>org.javaboy</groupId>
        <artifactId>grpc-api</artifactId>
        <version>1.0-SNAPSHOT</version>
    </dependency>
    <dependency>
        <groupId>net.devh</groupId>
        <artifactId>grpc-client-spring-boot-starter</artifactId>
        <version>2.14.0.RELEASE</version>
    </dependency>
</dependencies>
<dependencyManagement>
    <dependencies>
        <dependency>
            <groupId>com.alibaba.cloud</groupId>
            <artifactId>spring-cloud-alibaba-dependencies</artifactId>
            <version>2021.0.5.0</version>
            <type>pom</type>
            <scope>import</scope>
        </dependency>
    </dependencies>
</dependencyManagement>
<build>
    <plugins>
        <plugin>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-maven-plugin</artifactId>
        </plugin>
    </plugins>
</build>

注意，客戶端 grpc 的依賴是 grpc-client-spring-boot-starter，其他的基本上和服務(wù)端一致。

然后配置客戶端，將之注冊(cè)到 nacos 上，如下：

server:
  port: 8088
spring:
  cloud:
    nacos:
      discovery:
        enabled: true
        server-addr: hc.javaboy.org:8848
        username: nacos
        password: nacos
  application:
    name: grpc_client
grpc:
  client:
    grpc_server:
      negotiation-type: plaintext

最后面有一個(gè) grpc_server，這個(gè)是固定的（依據(jù)就是 grpc_server 注冊(cè)到 nacos 上的名稱），表示這個(gè)服務(wù)的通信不使用 TLS 加密。

最后再來(lái)看看調(diào)用代碼：

@RestController
public class HelloController {

    @Autowired
    GrpcClientService grpcClientService;

    @GetMapping("/hello")
    public void hello() {
        grpcClientService.hello();
    }

}
@Component
public class GrpcClientService {

    @GrpcClient("grpc_server")
    HelloServiceGrpc.HelloServiceBlockingStub helloServiceBlockingStub;

    public void hello() {
        StringValue s = helloServiceBlockingStub.sayHello(StringValue.newBuilder().setValue("javaboy").build());
        System.out.println("s = " + s.getValue());
    }
}

這里的核心其實(shí)就是通過(guò) @GrpcClient? 注解注入一個(gè) HelloServiceBlockingStub 實(shí)例，其中 @GrpcClient 注解中的參數(shù)就是注冊(cè)到 nacos 上服務(wù)的名字，將來(lái)會(huì)自動(dòng)根據(jù)服務(wù)的名字查找到服務(wù)的具體地址進(jìn)行調(diào)用。

好啦，大功告成。

接下來(lái)我們啟動(dòng) grpc_server 和 grpc_client 就可以進(jìn)行測(cè)試了。

責(zé)任編輯：武曉燕來(lái)源：江南一點(diǎn)雨