gRPC 的基础知识前面跟小伙伴们分享了很多了，今天再写一篇给这个小小的系列收个尾。
我们前面介绍的都是 gRPC 的基本用法，最终目的当然是希望能够在 Spring Boot 中用上这个东西，相信大部分小伙伴对于微服务的通信方案如 OpenFeign、Dubbo、消息驱动都有所了解，但是对于这三种方案之外的其他方案，可能听的多用的少，今天我们就来实践一下 gRPC 这种方案。
顺便说一下我为什么会想到写 gRPC 教程呢，是因为之前我想给小伙伴们总结一下常见的各种微服务通信方案。整理到 gRPC 的时候发现我还没写过 gRPC 相关的教程，因此就有了一个小系列。
1. 依赖选择
Spring Boot 整合 gRPC，官方其实并没有提供相应的依赖，不过目前有一个比较流行的第三方库可以使用：
接下来松哥就结合这个库，来和小伙伴们演示一下 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 方法的实现：
@GrpcServicepublic 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: 9099spring: 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: 8088spring: cloud: nacos: discovery: enabled: true server-addr: hc.javaboy.org:8848 username: nacos password: nacos application: name: grpc_clientgrpc: client: grpc_server: negotiation-type: plaintext
复制代码
最后面有一个 grpc_server，这个是固定的（依据就是 grpc_server 注册到 nacos 上的名称），表示这个服务的通信不使用 TLS 加密。
最后再来看看调用代码：
@RestControllerpublic class HelloController {
@Autowired GrpcClientService grpcClientService;
@GetMapping("/hello") public void hello() { grpcClientService.hello(); }
}@Componentpublic 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 就可以进行测试了。
评论