• spring boot 集成 gRPC 系列1

    @[toc]

    目录

    一、环境准备

    二、gRPC项目构建

    创建proto文件

    生成Java类

    创建模块local-server（gRPC服务端）

    创建模块local-client（gRPC客户端）

    调用效果

    一、环境准备


    安装protocbuf
    下载地址

    https://github.com/protocolbuffers/protobuf/releases

    选择对应的版本下载安装，这里我选择21.1
    选择对应的压缩包解压


    配置环境变量
    变量名 ：PROTOCBUF_HOME
    变量值：D:\protoc-21.1-win64

     

    找到系统变量中的path变量，选中后点击编辑，新增：%PROTOBUF_HOME%\bin

    安装protocbuf插件

    Protobuf - IntelliJ IDEs Plugin | Marketplace
    从idea官网下载插件

     选择idea对应的版本下载


    二、gRPC项目构建

     项目目录结构


    项目结构


    创建maven父工程spring-boot-grpc
    完整pom.xml

    1. <?xml version="1.0" encoding="UTF-8"?>
    2. <project xmlns="http://maven.apache.org/POM/4.0.0"
    3.          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    4.          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    5.     <modelVersion>4.0.0</modelVersion>
    6.     <packaging>pom</packaging>
    7.  
    8.     <modules>
    9.         <module>spring-boot-grpc-lib</module>
    10.         <module>local-server</module>
    11.         <module>local-client</module>
    12.     </modules>
    13.  
    14.     <parent>
    15.         <groupId>org.springframework.boot</groupId>
    16.         <artifactId>spring-boot-starter-parent</artifactId>
    17.         <version>2.6.1</version>
    18.         <relativePath/> <!-- lookup parent from repository -->
    19.     </parent>
    20.     <groupId>org.example</groupId>
    21.     <artifactId>spring-boot-grpc</artifactId>
    22.     <version>1.0-SNAPSHOT</version>
    23.  
    24.     <dependencies>
    25.         <dependency>
    26.             <groupId>org.springframework.boot</groupId>
    27.             <artifactId>spring-boot-starter-web</artifactId>
    28.         </dependency>
    29.  
    30.         <dependency>
    31.             <groupId>org.springframework.boot</groupId>
    32.             <artifactId>spring-boot-starter-test</artifactId>
    33.             <scope>test</scope>
    34.         </dependency>
    35.  
    36.     </dependencies>
    37.  
    38.  
    39.     <build>
    40.         <plugins>
    41.             <plugin>
    42.                 <groupId>org.apache.maven.plugins</groupId>
    43.                 <artifactId>maven-compiler-plugin</artifactId>
    44.                 <version>3.8.1</version>
    45.                 <configuration>
    46.                     <source>1.8</source>
    47.                     <target>1.8</target>
    48.                     <encoding>UTF-8</encoding>
    49.                 </configuration>
    50.             </plugin>
    51.             <plugin>
    52.                 <groupId>org.springframework.boot</groupId>
    53.                 <artifactId>spring-boot-maven-plugin</artifactId>
    54.                 <version>2.6.1</version>
    55.             </plugin>
    56.         </plugins>
    57.     </build>
    58. </project>


    创建模块spring-boot-grpc-lib
    此模块负责将.proto文件生成Java对应的类与接口

    根据官方文档

    选择对应的版本查看README.md

    可以根据提交历史查看具体proto版本对应的pom.xml

    完整pom.xml

    1. <?xml version="1.0" encoding="UTF-8"?>
    2. <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    3.          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    4.     <parent>
    5.         <groupId>org.example</groupId>
    6.         <artifactId>spring-boot-grpc</artifactId>
    7.         <version>1.0-SNAPSHOT</version>
    8.     </parent>
    9.     <modelVersion>4.0.0</modelVersion>
    10.     <groupId>com.example</groupId>
    11.     <artifactId>spring-boot-grpc-lib</artifactId>
    12.     <version>0.0.1-SNAPSHOT</version>
    13.     <name>spring-boot-grpc-lib</name>
    14.     <description>Demo project for Spring Boot</description>
    15.  
    16.     <properties>
    17.         <java.version>1.8</java.version>
    18.         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    19.         <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
    20.     </properties>
    21.  
    22.     <dependencies>
    23.         <dependency>
    24.             <groupId>io.grpc</groupId>
    25.             <artifactId>grpc-netty-shaded</artifactId>
    26.             <version>1.42.1</version>
    27.         </dependency>
    28.         <dependency>
    29.             <groupId>io.grpc</groupId>
    30.             <artifactId>grpc-protobuf</artifactId>
    31.             <version>1.42.1</version>
    32.         </dependency>
    33.         <dependency>
    34.             <groupId>io.grpc</groupId>
    35.             <artifactId>grpc-stub</artifactId>
    36.             <version>1.42.1</version>
    37.         </dependency>
    38.         <dependency> <!-- necessary for Java 9+ -->
    39.             <groupId>org.apache.tomcat</groupId>
    40.             <artifactId>annotations-api</artifactId>
    41.             <version>6.0.53</version>
    42.             <scope>provided</scope>
    43.         </dependency>
    44.         <dependency>
    45.             <groupId>com.google.protobuf</groupId>
    46.             <artifactId>protobuf-java</artifactId>
    47.             <version>3.17.2</version>
    48.         </dependency>
    49.         <dependency>
    50.             <groupId>com.google.protobuf</groupId>
    51.             <artifactId>protobuf-java-util</artifactId>
    52.             <version>3.17.2</version>
    53.         </dependency>
    54.         <dependency>
    55.             <groupId>javax.annotation</groupId>
    56.             <artifactId>javax.annotation-api</artifactId>
    57.             <version>1.3.2</version>
    58.         </dependency>
    59.     </dependencies>
    60.  
    61.     <dependencyManagement>
    62.         <dependencies>
    63.             <dependency>
    64.                 <groupId>io.grpc</groupId>
    65.                 <artifactId>grpc-bom</artifactId>
    66.                 <version>1.42.2</version>
    67.                 <type>pom</type>
    68.                 <scope>import</scope>
    69.             </dependency>
    70.         </dependencies>
    71.     </dependencyManagement>
    72.  
    73.     <build>
    74.         <extensions>
    75.             <extension>
    76.                 <groupId>kr.motd.maven</groupId>
    77.                 <artifactId>os-maven-plugin</artifactId>
    78.                 <version>1.6.2</version>
    79.             </extension>
    80.         </extensions>
    81.         <plugins>
    82.             <plugin>
    83.                 <groupId>org.xolstice.maven.plugins</groupId>
    84.                 <artifactId>protobuf-maven-plugin</artifactId>
    85.                 <version>0.6.1</version>
    86.                 <configuration>
    87.                     <protocArtifact>com.google.protobuf:protoc:3.17.2:exe:${os.detected.classifier}</protocArtifact>
    88.                     <pluginId>grpc-java</pluginId>
    89.                     <pluginArtifact>io.grpc:protoc-gen-grpc-java:1.42.1:exe:${os.detected.classifier}</pluginArtifact>
    90.                 </configuration>
    91.                 <executions>
    92.                     <execution>
    93.                         <goals>
    94.                             <goal>compile</goal>
    95.                             <goal>compile-custom</goal>
    96.                         </goals>
    97.                     </execution>
    98.                 </executions>
    99.             </plugin>
    100.         </plugins>
    101.     </build>
    102. </project>



    创建proto文件

    在spring-boot-grpc-lib模块的src/main/proto目录下新增名为helloworld.proto的文件

    这里面定义了一个gRPC服务，里面含有一个接口，并且还有这个接口的入参和返回结果的定义

    proto文件夹需要在 File -> ProjectStructure 中将其标记为sources


    helloworld.proto完整代码

    1. syntax = "proto3"; // 协议版本
    2.  
    3. // 选项配置
    4. option java_multiple_files = true;
    5. option java_package = "com.example.springbootgrpclib.grpc.protobuf";
    6. option java_outer_classname = "SimpleProto";
    7.  
    8. service Simple {
    9.     // 简单gRPC
    10.     rpc OneToOne (MyRequest) returns (MyResponse) {
    11.     }
    12. }
    13.  
    14. message MyRequest {
    15.     string name = 1;
    16.  
    17.     int32 value = 2;
    18. }
    19.  
    20. message MyResponse {
    21.     string message = 1;
    22.  
    23.     int64 result = 2;
    24. }


    生成Java类

    idea 单击编译类

    生成对应的类并且将其复制到spring-boot-grpc-lib下

    spring-boot-grpc-lib结构：

    创建模块local-server（gRPC服务端）


    在父工程下面新建名为local-server的springboot模块，

    添加gRPC 服务端 Maven 依赖和spring-boot-grpc-lib模块

    完整pom.xml

    1. <?xml version="1.0" encoding="UTF-8"?>
    2. <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    3.          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    4.     <modelVersion>4.0.0</modelVersion>
    5.     <parent>
    6.         <groupId>org.example</groupId>
    7.         <artifactId>spring-boot-grpc</artifactId>
    8.         <version>1.0-SNAPSHOT</version>
    9.     </parent>
    10.     <groupId>com.example</groupId>
    11.     <artifactId>local-server</artifactId>
    12.     <version>0.0.1-SNAPSHOT</version>
    13.     <name>local-server</name>
    14.     <description>Demo project for Spring Boot</description>
    15.  
    16.     <properties>
    17.         <java.version>11</java.version>
    18.         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    19.         <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
    20.         <spring-boot.version>2.6.1</spring-boot.version>
    21.     </properties>
    22.  
    23.     <dependencies>
    24.         <!--Lombok引入-->
    25.         <dependency>
    26.             <groupId>org.projectlombok</groupId>
    27.             <artifactId>lombok</artifactId>
    28.             <optional>true</optional>
    29.         </dependency>
    30.         <!--gRPC服务端-->
    31.         <dependency>
    32.             <groupId>net.devh</groupId>
    33.             <artifactId>grpc-server-spring-boot-starter</artifactId>
    34.             <version>2.13.0.RELEASE</version>
    35.         </dependency>
    36.         <!--spring-boot-grpc-lib模块-->
    37.         <dependency>
    38.             <groupId>com.example</groupId>
    39.             <artifactId>spring-boot-grpc-lib</artifactId>
    40.             <version>0.0.1-SNAPSHOT</version>
    41.         </dependency>
    42.     </dependencies>
    43. </project>


    springboot配置文件 application.yml

    1. spring:
    2.   application:
    3.     name: spring-boot-grpc-server
    4. # gRPC有关的配置，这里只需要配置服务端口号
    5. grpc:
    6.   server:
    7.     port: 9898
    8. server:
    9.   port: 8080

    增加启动类RpcServerApplication

    1. package com.example.localserver;
    2.  
    3. import org.springframework.boot.SpringApplication;
    4. import org.springframework.boot.autoconfigure.SpringBootApplication;
    5.  
    6. @SpringBootApplication
    7. public class RpcServerApplication {
    8.  
    9. 	public static void main(String[] args) {
    10. 		SpringApplication.run(RpcServerApplication.class, args);
    11. 	}
    12.  
    13. }


    在service类中将gRPC服务对外暴露出去

    完整代码如下

    1. package com.example.localserver.server;
    2.  
    3. import com.example.springbootgrpclib.grpc.protobuf.MyRequest;
    4. import com.example.springbootgrpclib.grpc.protobuf.MyResponse;
    5. import com.example.springbootgrpclib.grpc.protobuf.SimpleGrpc;
    6. import io.grpc.stub.StreamObserver;
    7. import lombok.extern.slf4j.Slf4j;
    8. import net.devh.boot.grpc.server.service.GrpcService;
    9.  
    10.  
    11. @GrpcService
    12. @Slf4j
    13. public class GrpcServerService extends SimpleGrpc.SimpleImplBase {
    14.  
    15.     @Override
    16.     public void oneToOne(MyRequest request, StreamObserver<MyResponse> responseObserver) {
    17.         log.info("接收客户端数据{}", request);
    18.         MyResponse response = MyResponse.newBuilder().setMessage( request.getName()).build();
    19.         responseObserver.onNext(response);
    20.         responseObserver.onCompleted();
    21.     }
    22.     
    23. }



    上述GrpcServerService.java中有几处需要注意：

    是使用@GrpcService注解，再继承SimpleImplBase，这样就可以借助grpc-server-spring-boot-starter库将oneToOne暴露为gRPC服务；

    SimpleImplBase是前文中根据proto自动生成的java代码，在spring-boot-grpc-lib模块中；

    oneToOne方法中处理完毕业务逻辑后，调用responseObserver.onNext方法填入返回内容；

    调用responseObserver.onCompleted方法表示本次gRPC服务完成；

    至此，gRPC服务端编码就完成了，服务端流、客户端流和双向流在后面介绍。

    创建模块local-client（gRPC客户端）


    在父工程grpc-turtorials下面新建名为local-client的模块

    添加gRPC客户端 Maven 依赖和spring-boot-grpc-lib模块

    完整pom.xml

    1. <?xml version="1.0" encoding="UTF-8"?>
    2. <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    3.          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    4.     <modelVersion>4.0.0</modelVersion>
    5.     <parent>
    6.         <groupId>org.example</groupId>
    7.         <artifactId>spring-boot-grpc</artifactId>
    8.         <version>1.0-SNAPSHOT</version>
    9.     </parent>
    10.     <groupId>com.example</groupId>
    11.     <artifactId>local-client</artifactId>
    12.     <version>0.0.1-SNAPSHOT</version>
    13.     <name>local-client</name>
    14.     <description>Demo project for Spring Boot</description>
    15.  
    16.     <properties>
    17.         <java.version>11</java.version>
    18.         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    19.         <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
    20.         <spring-boot.version>2.6.1</spring-boot.version>
    21.     </properties>
    22.  
    23.     <dependencies>
    24.         
    25.         <!--gRPC客户端-->
    26.         <dependency>
    27.             <groupId>net.devh</groupId>
    28.             <artifactId>grpc-client-spring-boot-starter</artifactId>
    29.             <version>2.13.0.RELEASE</version>
    30.         </dependency>
    31.         <!--spring-boot-grpc-lib模块-->
    32.         <dependency>
    33.             <groupId>com.example</groupId>
    34.             <artifactId>spring-boot-grpc-lib</artifactId>
    35.             <version>0.0.1-SNAPSHOT</version>
    36.         </dependency>
    37.         <!--lombok-->
    38.         <dependency>
    39.             <groupId>org.projectlombok</groupId>
    40.             <artifactId>lombok</artifactId>
    41.             <optional>true</optional>
    42.         </dependency>
    43.     </dependencies>
    44. </project>


    springboot配置文件 application.yml:

    1. server:
    2.   port: 8088
    3. spring:
    4.   application:
    5.     name: local-client
    6.  
    7. grpc:
    8.   client:
    9.     # gRPC配置的名字，GrpcClient注解会用到
    10.     local-grpc-server:
    11.       # gRPC服务端地址
    12.       address: 'static://127.0.0.1:9898'
    13.       enableKeepAlive: true
    14.       keepAliveWithoutCalls: true
    15.       negotiationType: plaintext

    启动类RpcClientApplication

    1. package com.example.localclient;
    2.  
    3. import org.springframework.boot.SpringApplication;
    4. import org.springframework.boot.autoconfigure.SpringBootApplication;
    5.  
    6. @SpringBootApplication
    7. public class RpcClientApplication {
    8.  
    9. 	public static void main(String[] args) {
    10. 		SpringApplication.run(RpcClientApplication.class, args);
    11. 	}
    12.  
    13. }



    服务类GrpcClientService

    1. package com.example.localclient.service;
    2.  
    3. import com.example.springbootgrpclib.grpc.protobuf.MyRequest;
    4. import com.example.springbootgrpclib.grpc.protobuf.MyResponse;
    5. import com.example.springbootgrpclib.grpc.protobuf.SimpleGrpc;
    6. import io.grpc.StatusRuntimeException;
    7. import lombok.extern.slf4j.Slf4j;
    8. import net.devh.boot.grpc.client.inject.GrpcClient;
    9. import org.springframework.stereotype.Service;
    10.  
    11. @Service
    12. @Slf4j
    13. public class GrpcClientService {
    14.  
    15.     @GrpcClient("local-grpc-server")
    16.     private SimpleGrpc.SimpleBlockingStub simpleStub;
    17.  
    18.     public String oneToOne(final String name) {
    19.         try {
    20.             final MyResponse response = this.simpleStub.oneToOne(MyRequest.newBuilder().setName(name).build());
    21.             return response.getMessage();
    22.         } catch (final StatusRuntimeException e) {
    23.             return "FAILED with " + e.getStatus().getCode().name();
    24.         }
    25.     }
    26. }



    上述GrpcClientService类有几处要注意的地方：

    用@Service将GrpcClientService注册为spring的普通bean实例；

    用@GrpcClient修饰SimpleBlockingStub，这样就可以通过grpc-client-spring-boot-starter库发起gRPC调用，被调用的服务端信息来自名为local-grpc-server的配置；

    SimpleBlockingStub来自前文中根据helloworld.proto生成的java代码；

    SimpleBlockingStub.oneToOne方法会远程调用local-server应用的gRPC服务；

    新增controller层验证gRPC服务调用能否成功

    1. package com.example.localclient.controller;
    2.  
    3. import com.example.localclient.service.GrpcClientService;
    4. import org.springframework.beans.factory.annotation.Autowired;
    5. import org.springframework.web.bind.annotation.RequestMapping;
    6. import org.springframework.web.bind.annotation.RequestParam;
    7. import org.springframework.web.bind.annotation.RestController;
    8.  
    9. import java.util.List;
    10.  
    11. /**
    12.  * @author cdj
    13.  * @date 2022/4/11 - 17:36
    14.  **/
    15. @RestController
    16. public class GrpcClientController {
    17.  
    18.     @Autowired
    19.     private GrpcClientService grpcClientService;
    20.  
    21.     @RequestMapping("/oneToOne")
    22.     public String oneToOne(@RequestParam(defaultValue = "name") String name) {
    23.         return grpcClientService.oneToOne(name);
    24.     }
    25.  
    26. }

    调用效果

    http://127.0.0.1:8088/oneToOne?name=rpc-test

  • 相关阅读:
    mybatis单框架实现数据库新增、删除、修改
    flowable-ui部署
    LeetCode50天刷题计划第二季（Day 17 — 克隆图 （10.00-11.20）
    加油站智能视频监控系统
    A1052 Linked List Sorting（25分）PAT 甲级(Advanced Level) Practice（C++）满分题解【链表地址+排序]
    解决npm报错Error: error:0308010C:digital envelope routines::unsupported
    花房集团赴港IPO：直播与社交双引擎驱动，构筑元宇宙生态迈入“以用户为核心”向阳路
    夜天之书 #67 为什么开源协议不授予商标权利？
    Hash的底层结构
    从0搭建Vue3组件库(二):Monorepo项目搭建
  • 原文地址：https://blog.csdn.net/rdhj5566/article/details/125407910