1. 依賴選擇

Spring Boot 整合 gRPC，官方其實并沒有提供相應的依賴，不過目前有一個比較流行的第三方庫可以使用：

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

接下來就結合這個庫，來和小夥伴們示範一下 Spring Boot+Nacos+gRPC 的用法。

可能有小夥伴也會見到一些其他的第三方庫，這個其實都可以，隻要穩定可靠就行，本文就以上面這個庫為例來和小夥伴們介紹。

2. 準備工作

這裡我采用了 Nacos 來做服務注冊中心，使用的 Nacos 版本是 2.0.2 這個版本。Nacos 簡單安裝一下就行了，為了省事，資料持久化啥的可以先不配置。也就是 Nacos 下載下傳解壓之後，直接執行如下指令單體運作就行了：

sh startup.sh -m standalone

這塊沒啥好說的， vhr 系列裡也有相關的教程，這裡就不啰嗦了。

3. 代碼實踐

首先我們來看看我們的項目結構：

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

首先有一個公共的子產品 grpc-api，這個子產品用來放我們的公共代碼和依賴，包括 Protocol Buffers 檔案也放在這裡。

grpc-client 和 grpc-server 就不用多說了，分别是我們的用戶端和服務端。

3.1 grpc-api

grpc-api 中主要是處理 grpc 相關的事情，包括添加需要的依賴、插件等，編寫 Protocol Buffers 檔案等。

我們先來看看該項目的 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 文章中案例的依賴基本上都是一緻的，沒有差別，再來看看我們的 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);
}

很簡單的一個 HelloService 服務。

3.2 grpc-server

grpc-server 則是我們的服務端，這是一個 Spring Boot 工程，項目依賴如下：

<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>

由于第三方庫 grpc-server-spring-boot-starter 在支援 Spring Boot3 上還有一些瑕疵，是以我這裡使用了 Spring Boot2.7.7 這個版本。

這裡需要注意的是就是添加了 gRPC 的依賴 grpc-server-spring-boot-starter 和 nacos 的依賴。其他都是正常配置。

接下來我們來在服務端提供 gRPC 方法的實作：

@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();
    }
}

小夥伴們看到，通過 @GrpcService 注解去标記我們的一個服務即可。

最後，在 application.yaml 中進行配置，将目前服務注冊到 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，服務端搞定。

3.3 grpc-client

最後再來看看用戶端。

先來看依賴：

<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，其他的基本上和服務端一緻。

然後配置用戶端，将之注冊到 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

最後面有一個 grpc_server，這個是固定的（依據就是 grpc_server 注冊到 nacos 上的名稱），表示這個服務的通信不使用 TLS 加密。

最後再來看看調用代碼：

@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());
    }
}

這裡的核心其實就是通過 @GrpcClient 注解注入一個 HelloServiceBlockingStub 執行個體，其中 @GrpcClient 注解中的參數就是注冊到 nacos 上服務的名字，将來會自動根據服務的名字查找到服務的具體位址進行調用。

好啦，大功告成。

接下來我們啟動 grpc_server 和 grpc_client 就可以進行測試了。

Spring Boot+Nacos+gRPC，一個差別于 OpenFeign 的微服務通信方案！

1. 依賴選擇

2. 準備工作

3. 代碼實踐

3.1 grpc-api

3.2 grpc-server

3.3 grpc-client

繼續閱讀

基于Springboot+VUE+Mysql的大學生校園疫情防控管理系統

Using MessageConverter

馴服爛代碼_C＃中的馴服配置

springboot使用 swagger-ui 2.10.5 有關版本更新帶來的問題

Spring Cloud整合Sleuth，當請求完成後，Zipkin沒有鍊路資訊

JAVA自學之路——馬士兵

Rabbitmq指令行手動建立隊列

整合 Spring 開發架構及服務端技術

SSM整合02---Spring-SpringMVC層一、添加web架構支援二、web.xml三、spring-mvc.xml

SSM架構（二）------------表現層的SpringMVC

Intellij idea基于Maven 的SSM 架構整合

Spring資料和Redis

SpringMVC的啟動過程源碼分析1 SpringMVC 配置XML的方式啟動2 SpringMVC純注解模式啟動

Java Spring 架構

spring boot @SpringBootApplication @EnableAutoConfiguration 的工作原理

SpringCloud微服務（四）之ribbon筆記ribbon是什麼？入門案例自定義均衡負載算法