什么是Grpc

gRPC 是一个现代开源的高性能 RPC 框架，可以在任何环境下运行。它可以有效地将数据中心内和跨数据中心的服务与可插拔支持进行负载均衡、跟踪、健康检查和认证。它也适用于分布式计算，将不同设备、移动应用程序和浏览器连接到后端服务。
在gRPC中，一个客户应用程序可以直接访问另外一台机器上的服务应用程序中的一个方法，就好像这个方法是一个本地对象一样，这种功能使得创建分布式应用程序和服务更加简单。和很多其他的RPC系统一样，gRPC是基于这样的思想：定义一个服务，指定一些方法，这些方法可以通过它的形式参数和返回值类型远程调用。在服务器端，服务器实现了这个接口，并且运行了一个gRPC的服务端去处理这些客户端调用。
springboot整合Grpc实现通讯的方法 - 图1
gRPC客户端和服务端在各种环境下都能相互通信，从google内部的服务器到你自己台式机上的服务器，而且可以使用gRPC支持的各种语言来实现gRPC客户端和服务器端。因此，你可以非常容易地创建一个用java语言写的gRPC服务器和一个用go语言或者Python语言或者Ruby语言写gRPC客户端。除此之外，最新的Google API也有gRPC版本的接口，这样用户可以非常方便的将Google的功能集成到自己的应用程序中。

使用场景

  • 在微服务架构中有效地连接多个服务
  • 将移动设备、浏览器客户端连接到后端服务
  • 生成高效的客户端库
  • 不同项目、产品之间的交互

    使用Protocol Buffers

    默认情况下，gRPC使用Protocol Buffers，这是Google的开源成熟序列化结构化数据的机制（不过，gRPC也可以和其他的数据格式一起使用，比如JSON）。这是一份关于如何使用Protocol Buffers的快速介绍。如果你已经对Protocol Buffers比较熟悉了，可以先跳到下一节。
    使用Protocol Buffers的第一步是在一个proto文件中定义你想要序列化的数据结构，Proto文件是一个扩展名为.proto的普通文本文件。Protocol Buffers数据是结构化为message的，一个message是一个小的逻辑信息单元，这个逻辑信息单元包含一系列的键值对，这些键值对被称为字段。这里有一个例子： ```java // The greeter service definition. service Greeter { // Sends a greeting rpc SayHello (HelloRequest) returns (HelloReply) {} }

// The request message containing the user’s name. message HelloRequest { string name = 1; }

// The response message containing the greetings message HelloReply { string message = 1; }

  1. <a name="F7Zca"></a>
  2. # Springboot集成Grpc
  3. <a name="T0HUo"></a>
  4. ## 创建qingfeng-grpc项目
  5. 项目创建好之后，继续创建qingfeng-grpclib模块、qingfeng-server模块、qingfeng-client模块。<br />![image.png](https://cdn.nlark.com/yuque/0/2022/png/12591990/1651403439991-c2d7e4e6-8fd8-4bae-a6bc-542bc82be355.png#clientId=u3222c419-0fae-4&crop=0&crop=0&crop=1&crop=1&from=paste&height=245&id=u3f5ec06c&margin=%5Bobject%20Object%5D&name=image.png&originHeight=294&originWidth=417&originalType=binary&ratio=1&rotation=0&showTitle=false&size=21335&status=done&style=none&taskId=u8ad85317-df23-49d5-8cfc-58d64b5050d&title=&width=347.4999861915912)<br />引入pom依赖
  6. ```java
  7. <?xml version="1.0" encoding="UTF-8"?>
  9. <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  10.   xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  11.   <modelVersion>4.0.0</modelVersion>
  12.   <packaging>pom</packaging>
  13.   <modules>
  14.     <module>qingfeng-grpclib</module>
  15.     <module>qingfeng-server</module>
  16.     <module>qingfeng-client</module>
  17.     <module>qingfeng-protobuf</module>
  18.   </modules>
  19.   <parent>
  20.     <groupId>org.springframework.boot</groupId>
  21.     <artifactId>spring-boot-starter-parent</artifactId>
  22.     <version>2.1.4.RELEASE</version>
  23.     <relativePath/>
  24.   </parent>
  26.   <groupId>com.qingfeng</groupId>
  27.   <artifactId>qingfeng-grpc</artifactId>
  28.   <version>1.0-SNAPSHOT</version>
  30.   <name>qingfeng-grpc</name>
  32.   <properties>
  33.     <java.version>1.8</java.version>
  34.   </properties>
  36.   <dependencyManagement>
  37.   <dependencies>
  38.     <dependency>
  39.       <groupId>com.com.qingfeng</groupId>
  40.       <artifactId>com.qingfeng-grpclib</artifactId>
  41.       <version>1.0-SNAPSHOT</version>
  42.     </dependency>
  43.     <!--核心grpc-spring-boot依赖-->
  44.     <dependency>
  45.       <groupId>net.devh</groupId>
  46.       <artifactId>grpc-client-spring-boot-starter</artifactId>
  47.       <version>2.0.1.RELEASE</version>
  48.     </dependency>
  49.     <dependency>
  50.       <groupId>net.devh</groupId>
  51.       <artifactId>grpc-server-spring-boot-starter</artifactId>
  52.       <version>2.0.1.RELEASE</version>
  53.     </dependency>
  55.   </dependencies>
  56.   </dependencyManagement>
  57. </project>

创建qingfeng-grpclib

引入pom依赖

  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.     <parent>
  6.         <artifactId>qingfeng-grpc</artifactId>
  7.         <groupId>com.qingfeng</groupId>
  8.         <version>1.0-SNAPSHOT</version>
  9.     </parent>
  10.     <modelVersion>4.0.0</modelVersion>
  11.     <groupId>com.qingfeng</groupId>
  12.     <artifactId>qingfeng-grpclib</artifactId>
  13.     <version>1.0-SNAPSHOT</version>
  14.     <properties>
  15.         <os.plugin.version>1.6.0</os.plugin.version>
  16.         <grpc.version>1.15.1</grpc.version>
  17.         <protoc.version>3.6.1</protoc.version>
  18.         <protobuf.plugin.version>0.6.1</protobuf.plugin.version>
  19.     </properties>
  21.     <dependencies>
  22.         <dependency>
  23.             <groupId>io.grpc</groupId>
  24.             <artifactId>grpc-all</artifactId>
  25.             <version>${grpc.version}</version>
  26.         </dependency>
  27.     </dependencies>
  29.     <build>
  30.         <extensions>
  31.             <extension>
  32.                 <groupId>kr.motd.maven</groupId>
  33.                 <artifactId>os-maven-plugin</artifactId>
  34.                 <version>${os.plugin.version}</version>
  35.             </extension>
  36.         </extensions>
  37.         <plugins>
  38.             <plugin>
  39.                 <groupId>org.xolstice.maven.plugins</groupId>
  40.                 <artifactId>protobuf-maven-plugin</artifactId>
  41.                 <version>${protobuf.plugin.version}</version>
  42.                 <extensions>true</extensions>
  43.                 <configuration>
  44.                     <protocArtifact>com.google.protobuf:protoc:${protoc.version}:exe:${os.detected.classifier}
  45.                     </protocArtifact>
  46.                     <pluginId>grpc-java</pluginId>
  47.                     <pluginArtifact>io.grpc:protoc-gen-grpc-java:${grpc.version}:exe:${os.detected.classifier}
  48.                     </pluginArtifact>
  49.                     <!--默认值-->
  50.                     <protoSourceRoot>${project.basedir}/src/main/proto</protoSourceRoot>
  51.                     <!--默认值-->
  52.                     <!--<outputDirectory>${project.build.directory}/generated-sources/protobuf/java</outputDirectory>-->
  53.                     <outputDirectory>${project.basedir}/src/main/java</outputDirectory>
  54.                     <!--设置是否在生成java文件之前清空outputDirectory的文件，默认值为true，设置为false时也会覆盖同名文件-->
  55.                     <clearOutputDirectory>false</clearOutputDirectory>
  56.                     <!--更多配置信息可以查看https://www.xolstice.org/protobuf-maven-plugin/compile-mojo.html-->
  57.                 </configuration>
  58.                 <executions>
  59.                     <execution>
  60.                         <!--在执行mvn compile的时候会执行以下操作-->
  61.                         <phase>compile</phase>
  62.                         <goals>
  63.                             <!--生成OuterClass类-->
  64.                             <goal>compile</goal>
  65.                             <!--生成Grpc类-->
  66.                             <goal>compile-custom</goal>
  67.                         </goals>
  68.                     </execution>
  69.                 </executions>
  70.             </plugin>
  71.         </plugins>
  72.     </build>
  75. </project>

在线构建protobuf代码

  1.  <build>
  2.         <extensions>
  3.             <extension>
  4.                 <groupId>kr.motd.maven</groupId>
  5.                 <artifactId>os-maven-plugin</artifactId>
  6.                 <version>${os.plugin.version}</version>
  7.             </extension>
  8.         </extensions>
  9.         <plugins>
  10.             <plugin>
  11.                 <groupId>org.xolstice.maven.plugins</groupId>
  12.                 <artifactId>protobuf-maven-plugin</artifactId>
  13.                 <version>${protobuf.plugin.version}</version>
  14.                 <extensions>true</extensions>
  15.                 <configuration>
  16.                     <protocArtifact>com.google.protobuf:protoc:${protoc.version}:exe:${os.detected.classifier}
  17.                     </protocArtifact>
  18.                     <pluginId>grpc-java</pluginId>
  19.                     <pluginArtifact>io.grpc:protoc-gen-grpc-java:${grpc.version}:exe:${os.detected.classifier}
  20.                     </pluginArtifact>
  21.                     <!--默认值-->
  22.                     <protoSourceRoot>${project.basedir}/src/main/proto</protoSourceRoot>
  23.                     <!--默认值-->
  24.                     <!--<outputDirectory>${project.build.directory}/generated-sources/protobuf/java</outputDirectory>-->
  25.                     <outputDirectory>${project.basedir}/src/main/java</outputDirectory>
  26.                     <!--设置是否在生成java文件之前清空outputDirectory的文件，默认值为true，设置为false时也会覆盖同名文件-->
  27.                     <clearOutputDirectory>false</clearOutputDirectory>
  28.                     <!--更多配置信息可以查看https://www.xolstice.org/protobuf-maven-plugin/compile-mojo.html-->
  29.                 </configuration>
  30.                 <executions>
  31.                     <execution>
  32.                         <!--在执行mvn compile的时候会执行以下操作-->
  33.                         <phase>compile</phase>
  34.                         <goals>
  35.                             <!--生成OuterClass类-->
  36.                             <goal>compile</goal>
  37.                             <!--生成Grpc类-->
  38.                             <goal>compile-custom</goal>
  39.                         </goals>
  40.                     </execution>
  41.                 </executions>
  42.             </plugin>
  43.         </plugins>
  44.     </build>

创建Greeter.proto

  2. syntax = "proto3";
  5. option java_package = "com.qingfeng.grpc.lib";
  7. // The greeting service definition.
  8. service Greeter{
  9.     // Sends a greeting
  10.     rpc SayHello (HelloRequest) returns (HelloReply) {
  11.     }
  12. }
  14. // The request message containing the user's name.
  15. message HelloRequest {
  16.     string name = 1;
  17. }
  19. // The response message containing the greetings
  20. message HelloReply {
  21.     string message = 1;
  22. }

执行maven compile 编译
image.png

创建qingfeng-server服务端

引入pom依赖

  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.     <parent>
  6.         <artifactId>qingfeng-grpc</artifactId>
  7.         <groupId>com.qingfeng</groupId>
  8.         <version>1.0-SNAPSHOT</version>
  9.     </parent>
  10.     <modelVersion>4.0.0</modelVersion>
  12.     <artifactId>qingfeng-server</artifactId>
  14.     <properties>
  15.         <java.version>1.8</java.version>
  16.     </properties>
  18.     <dependencies>
  19.         <dependency>
  20.             <groupId>com.qingfeng</groupId>
  21.             <artifactId>qingfeng-grpclib</artifactId>
  22.             <version>1.0-SNAPSHOT</version>
  23.         </dependency>
  24.         <dependency>
  25.             <groupId>org.springframework.boot</groupId>
  26.             <artifactId>spring-boot-starter</artifactId>
  27.         </dependency>
  29.         <dependency>
  30.             <groupId>org.springframework.boot</groupId>
  31.             <artifactId>spring-boot-starter-test</artifactId>
  32.             <scope>test</scope>
  33.         </dependency>
  34.         <dependency>
  35.             <groupId>org.projectlombok</groupId>
  36.             <artifactId>lombok</artifactId>
  37.         </dependency>
  39.         <dependency>
  40.             <groupId>net.devh</groupId>
  41.             <artifactId>grpc-server-spring-boot-starter</artifactId>
  42.         </dependency>
  43.     </dependencies>
  45. </project>

创建application.yml

  1. spring:
  2.   application:
  3.     name: qingfeng-server
  4. grpc:
  5.   server:
  6.     port: 9000
  7. server:
  8.   port: 9002

创建GreeterService

  1. package com.qingfeng.service;
  3. import com.qingfeng.grpc.lib.GreeterGrpc;
  4. import com.qingfeng.grpc.lib.GreeterOuterClass;
  5. import io.grpc.stub.StreamObserver;
  6. import lombok.extern.slf4j.Slf4j;
  7. import net.devh.springboot.autoconfigure.grpc.server.GrpcService;
  9. @Slf4j
  10. @GrpcService(GreeterOuterClass.class)
  11. public class GreeterService extends GreeterGrpc.GreeterImplBase {
  12.     @Override
  13.     public void sayHello(GreeterOuterClass.HelloRequest request, StreamObserver<GreeterOuterClass.HelloReply> responseObserver) {
  14.         String message = "Hello " + request.getName();
  15.         final GreeterOuterClass.HelloReply.Builder replyBuilder = GreeterOuterClass.HelloReply.newBuilder().setMessage(message);
  16.         responseObserver.onNext(replyBuilder.build());
  17.         responseObserver.onCompleted();
  18.         log.info("Returning " + message);
  19.     }
  20. }

完成后-启动服务

image.png

创建qingfeng-client客户端

引入pom依赖

  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.     <parent>
  6.         <artifactId>qingfeng-grpc</artifactId>
  7.         <groupId>com.qingfeng</groupId>
  8.         <version>1.0-SNAPSHOT</version>
  9.     </parent>
  10.     <modelVersion>4.0.0</modelVersion>
  12.     <artifactId>qingfeng-client</artifactId>
  14.     <properties>
  15.         <java.version>1.8</java.version>
  16.     </properties>
  18.     <dependencies>
  19.         <dependency>
  20.             <groupId>com.qingfeng</groupId>
  21.             <artifactId>qingfeng-grpclib</artifactId>
  22.             <version>1.0-SNAPSHOT</version>
  23.         </dependency>
  24.         <dependency>
  25.             <groupId>org.springframework.boot</groupId>
  26.             <artifactId>spring-boot-starter</artifactId>
  27.         </dependency>
  29.         <dependency>
  30.             <groupId>org.springframework.boot</groupId>
  31.             <artifactId>spring-boot-starter-test</artifactId>
  32.             <scope>test</scope>
  33.         </dependency>
  34.         <dependency>
  35.             <groupId>org.springframework.boot</groupId>
  36.             <artifactId>spring-boot-starter-web</artifactId>
  37.         </dependency>
  38.         <dependency>
  39.             <groupId>net.devh</groupId>
  40.             <artifactId>grpc-client-spring-boot-starter</artifactId>
  41.         </dependency>
  42.         <dependency>
  43.             <groupId>org.springframework.boot</groupId>
  44.             <artifactId>spring-boot-starter-web</artifactId>
  45.         </dependency>
  46.         <dependency>
  47.             <groupId>org.projectlombok</groupId>
  48.             <artifactId>lombok</artifactId>
  49.         </dependency>
  50.     </dependencies>
  52. </project>

创建application.yml

  1. server:
  2.   port: 9001
  3. spring:
  4.   application:
  5.     name: qingfeng-client
  7. grpc:
  8.   client:
  9.     qingfeng-server:
  10.       port: 9000
  11.       enableKeepAlive: true
  12.       keepAliveWithoutCalls: true

创建GrpcClientService

  1. package com.qingfeng.service;
  4. import com.qingfeng.grpc.lib.GreeterGrpc;
  5. import com.qingfeng.grpc.lib.GreeterOuterClass;
  6. import com.qingfeng.grpc.lib.InterruptGrpc;
  7. import com.qingfeng.grpc.lib.InterruptStatus;
  8. import io.grpc.Channel;
  9. import io.grpc.netty.NegotiationType;
  10. import io.grpc.netty.NettyChannelBuilder;
  11. import net.devh.springboot.autoconfigure.grpc.client.GrpcClient;
  12. import org.springframework.beans.BeanUtils;
  13. import org.springframework.beans.factory.annotation.Value;
  14. import org.springframework.stereotype.Service;
  16. import java.util.ArrayList;
  17. import java.util.List;
  18. import java.util.Objects;
  21. @Service
  22. public class GrpcClientService {
  25.     @GrpcClient("qingfeng-server")
  26.     private Channel serverChannel;
  28.     public String sendMessage(String name) {
  29.         GreeterGrpc.GreeterBlockingStub stub = GreeterGrpc.newBlockingStub(serverChannel);
  30.         GreeterOuterClass.HelloReply response = stub.sayHello(GreeterOuterClass.HelloRequest.newBuilder().setName(name).build());
  31.         return response.getMessage();
  32.     }
  34. }

创建GrpcClientController

  2. @RestController
  3. public class GrpcClientController {
  5.     @Autowired
  6.     private GrpcClientService grpcClientService;
  8.     @RequestMapping("/")
  9.     public String printMessage(@RequestParam(defaultValue = "青锋") String name) {
  10.         return grpcClientService.sendMessage(name);
  11.     }
  13. }

完成后-启动客户端测试

image.png
在浏览器输入 http://localhost:9001/
image.png