问道gRPC_v1.0.0

爱被打了一巴掌 2023-03-12 12:26 8阅读 0赞

### 文章目录 ###

*   *   *  简介
         *   *  诞生
             *  主要用途
         *  基础
         *   *  数据结构
             *  gRPC如何调用
         *  gRPC与微服务
         *   *  与SpringCloud整合
             *   *  预配置
                 *  编码
                 *  实现&&配置
                 *  调用RPC，执行客户端代码，即可调用
                 *  新增字段
                 *  资源消耗
             *  报错
             *   *  服务提供者不在线

<table> 
 <thead> 
  <tr> 
   <th>文件名称</th> 
   <th>版本号</th> 
   <th>作者</th> 
   <th>qq</th> 
   <th>版本</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>问道gRPC</td> 
   <td>v1.0.0</td> 
   <td>学生宫布</td> 
   <td>8416837</td> 
   <td>net-devh-grpc.version 2.7.0.RELEASE<br>grpc.version 1.29.0<br>protobuf.version 3.4.0</td> 
  </tr> 
 </tbody> 
</table>

### 简介 ###

#### 诞生 ####

Google的孩子

#### 主要用途 ####

进程通信

### 基础 ###

*  检测是否安装protobuf

go version
    protoc --version

*  下载 [protoc-3.10.1-win64.zip][]
 *  将安装目录/bin配置到Win环境变量  
    ![在这里插入图片描述][20200514220533469.png]

#### 数据结构 ####

数据格式Protobuf  
查看[我写的protobuf教程][protobuf]  
一个简单的proto文件

syntax = 'proto3';
    
    package proto;
    
    message Human { 
    	int32 age = 1;
    	string name = 2;
    	int32 sex = 3;
    }

安装编译插件

go get -u github.com/golang/protobuf/protoc-gen-go

![在这里插入图片描述][2020051422581336.png]  
进入该文件目录使用gitbash编译该文件  
`protoc --go_out=. --python_out=. fruit.proto`  
编译完毕，说明插件安装成功：  
![在这里插入图片描述][20200514230012689.png]

#### gRPC如何调用 ####

grpc提供的原生接口服务无法被http模式访问

*  在golang代码里调用 查看[教程][Link 1]
 *  查看[GitHub代码][GitHub]

### gRPC与微服务 ###

*  服务消费模式，与FeignClient、Dubbo RPC模式接近
 *  路由表 来自注册中心
 *  负载均衡 软负载 根据路由表轮询、一致性hash、活跃度等

#### 与SpringCloud整合 ####

*  基础→ [Protocol Buffers教程][protobuf]
 *  进入[安装Nacos教程][Nacos],gRPC服务注册到Nacos

##### 预配置 #####

*  pom.xml 核心配置节选

<plugin>
                    <groupId>org.xolstice.maven.plugins</groupId>
                    <artifactId>protobuf-maven-plugin</artifactId>
                    <version>0.5.0</version>
                    <configuration>
                        <protocArtifact>
                            com.google.protobuf:protoc:3.1.0:exe:${os.detected.classifier}
                        </protocArtifact>
                        <pluginId>grpc-java</pluginId>
    
                        <pluginArtifact>io.grpc:protoc-gen-grpc-java:${grpc.version}:exe:${os.detected.classifier}</pluginArtifact>
                        
                        <protoSourceRoot>${project.basedir}/src/main/proto</protoSourceRoot>
                        
                        
                        <outputDirectory>${project.basedir}/src/main/java</outputDirectory>
                        
                        <clearOutputDirectory>false</clearOutputDirectory>
    
                    </configuration>
                    <executions>
                        <execution>
                            <goals>
                                <goal>compile</goal>
                                <goal>compile-custom</goal>
                            </goals>
                        </execution>
                    </executions>
                </plugin>

*  引入插件，可能报红↓  
    ![在这里插入图片描述][20201205142735410.png]  
    引入变量就不会报红了↓

<properties>
            <grpc.version>1.29.0</grpc.version>
            <os.detected.classifier>windows-x86_64</os.detected.classifier>
            <net-devh-grpc.version>2.7.0.RELEASE</net-devh-grpc.version>
        </properties>

##### 编码 #####

*  新建目录`src\main\proto`  
    ![在这里插入图片描述][20201205143522133.png]
 *  编辑Human.proto文件

syntax = "proto3"; // 版本号。与proto2差别不大
    option java_package = "test.pro.domain";
    option java_outer_classname = "HumanDomain";
    
    // 简单定义一个rpc服务和一个接口 定义了接口的输入输出 而输入输出都在下述结构体
    service TheFirstRpc { 
        rpc SayHello ( HelloParams) returns ( Human ) { }
    }
    
    message HelloParams {  // 类结构体
        string name = 1;
    }
    message Human {  // 类结构体
        int32 id = 1; // 结构体属性
        int32 sex = 2; // 数字作为key，省空间。不一定要连续
        string age = 3;
    }

##### 实现&&配置 #####

*  引入protobuf依赖↓  
    父项目

<properties>
            <protobuf.version>3.4.0</protobuf.version>
    ... ...
    <dependencyManagement>
            <dependencies>
                <dependency>
                    <groupId>com.google.protobuf</groupId>
                    <artifactId>protobuf-java</artifactId>
    				<version>${protobuf.version}</version>
                </dependency>
                <dependency>
                <groupId>io.grpc</groupId>
                <artifactId>grpc-all</artifactId>
                <version>${grpc.version}</version>
            </dependency>

子项目

<dependency>
                <groupId>com.google.protobuf</groupId>
                <artifactId>protobuf-java</artifactId>
            </dependency>
            <dependency>
                <groupId>io.grpc</groupId>
                <artifactId>grpc-all</artifactId>
            </dependency>

*  编译 找到Maven插件  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NjMDA3Y2MwMDk_size_16_color_FFFFFF_t_70]  
    执行插件compile && compile-custom命令，或自己打命令（不推荐）  
    若报错：![在这里插入图片描述][20201205152330227.png]  
    说明缺少依赖

编译成功  
![在这里插入图片描述][20200517154135752.png]  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NjMDA3Y2MwMDk_size_16_color_FFFFFF_t_70 1]  
这样proto就变成了Java类，以备后续使用

*  服务端实现RPC  
    服务提供者配置

grpc:
      server:
        port: 9080 # 不配置默认9090

服务端引入依赖包

<net-devh-grpc.version>2.7.0.RELEASE</net-devh-grpc.version>
    
    <dependency>
                    <groupId>net.devh</groupId>
                    <artifactId>grpc-client-spring-boot-starter</artifactId>
                    <version>${net-devh-grpc.version}</version>
                </dependency>
                <dependency>
                    <groupId>net.devh</groupId>
                    <artifactId>grpc-server-spring-boot-starter</artifactId>
                    <version>${net-devh-grpc.version}</version>
                </dependency>

前提是服务端和客户端都引入RPC相关Java类  
上一步只是编译了RPC结构，并未实现它。因此，可以在服务端（提供者）编写实现代码，以备客户端（消费者）调用。  
注意：有些类的名字改成你自己的。这些类主要与proto关联。

package test.rpc;
    
    /** * 功能：rpc实现 * * @author: cc * @qq: 8416837 * @date: 2020/5/17 15:48 */
    
    import io.grpc.stub.StreamObserver;
    import lombok.extern.slf4j.Slf4j;
    import net.devh.boot.grpc.server.service.GrpcService;
    import test.pro.domain.HumanDomain;
    import test.pro.domain.TheFirstRpcGrpc;
    
    @Slf4j
    @GrpcService
    public class HelloService extends TheFirstRpcGrpc.TheFirstRpcImplBase { 
    	@Override
    	public void sayHello(HumanDomain.HelloParams request, StreamObserver<HumanDomain.Human> responseObserver) { 
    		String name = request.getName();
    		log.debug("{} === {}", "[请求参数]", request);
    		final HumanDomain.Human.Builder replyBuilder = HumanDomain.Human.newBuilder().setSex(1).setAge(18).setName(name);
    		responseObserver.onNext(replyBuilder.build());
    		responseObserver.onCompleted();
    	}
    }

*  客户端配置文件

# grpc
    grpc:
      client:
        TheFirstRpc: # 服务名称
          address: static://localhost:9080
          negotiationType: plaintext
        # 服务
        # GLOBAL:
          # address: static://localhost:9080 // 服务端的端口号
          # negotiation-type: plaintext

*  客户端代码，节选，注意区分：

@GrpcClient("TheFirstRpc")
    	private TheFirstRpcGrpc.TheFirstRpcBlockingStub theFirstRpcBlockingStub;
    	@GetMapping("/grpc/{name}")
    	public Object sayHello(@PathVariable("name") String name) throws InterruptedException { 
    
    		// 服务端默认ip是微服务ip，端口是9090
    		HumanDomain.Human response = theFirstRpcBlockingStub.sayHello(HumanDomain.HelloParams.newBuilder().setName(name).build());
    		String resStr = response.toString();
    		return resStr;
    	}

##### 调用RPC，执行客户端代码，即可调用 #####

使用REST API触发客户端调用服务端RPC，即可完成调用，原理见上述代码  
把RPC调用结果toString后再返回，避免REST Json返回响应时报错。按上述代码，实操调用成功。

*  调用成功  
    ![在这里插入图片描述][20201205201246730.png]

##### 新增字段 #####

在proto新增字段之后，执行命令↓  
![在这里插入图片描述][20201205200522854.png]

##### 资源消耗 #####

*  开启grpc Nacos通讯后，Nacos消耗运存情况：  
    ![在这里插入图片描述][20201206001624698.png]  
    运存占用不多，持续增长中，但是吃cpu，nacos 是1.2.1， 可能是bug， 多方运行核实一下，例如普通的不带grpc的微服务会不会出现这种大量吃cpu的情况

#### 报错 ####

##### 服务提供者不在线 #####

报错：

io.grpc.StatusRuntimeException: UNAVAILABLE: io exception
    	at io.grpc.stub.ClientCalls.toStatusRuntimeException(ClientCalls.java:244) ~[grpc-stub-1.29.0.jar:1.29.0]
    	Suppressed: reactor.core.publisher.FluxOnAssembly$OnAssemblyException: 
    Error has been observed at the following site(s):
    	|_ checkpoint ⇢ org.springframework.security.web.server.authorization.AuthorizationWebFilter [DefaultWebFilterChain]

解决办法：开启服务

[protoc-3.10.1-win64.zip]: https://github.com/protocolbuffers/protobuf/releases/download/v3.10.1/protoc-3.10.1-win64.zip
[20200514220533469.png]: /images/20230312/fea365f89cfd48cbbcb9c20786993338.png
[protobuf]: https://blog.csdn.net/cc007cc009/article/details/103107725
[2020051422581336.png]: /images/20230312/0037f79486d241dba3afe348aacfc3e2.png
[20200514230012689.png]: /images/20230312/f456e3143b634fda9e46b30d2fe86a2a.png
[Link 1]: https://www.cnblogs.com/iiiiiher/p/12076616.html
[GitHub]: https://github.com/cakin24/spring-cloud-code/blob/master/ch20/cloud-grpc-server/src/main/java/cn/springcloud/cloudgrpcserver/GrpcServerService.java
[Nacos]: https://blog.csdn.net/cc007cc009/article/details/102959801
[20201205142735410.png]: /images/20230312/8dabdf0cc129467e9c1687b038f38d3d.png
[20201205143522133.png]: /images/20230312/43349a299ea94ec69dccab714b592eba.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NjMDA3Y2MwMDk_size_16_color_FFFFFF_t_70]: /images/20230312/6b50fda6f4e0457891fa80c078f4b435.png
[20201205152330227.png]: /images/20230312/bbd6908e8f8640b7b9453634a7f720a1.png
[20200517154135752.png]: /images/20230312/b1268708636c476c83d1ba1d591163bd.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NjMDA3Y2MwMDk_size_16_color_FFFFFF_t_70 1]: /images/20230312/673d62d7c6ed4ee0b10363ada6f9ce1b.png
[20201205201246730.png]: /images/20230312/91a6f16ac6334802b17e9853e7e6a9fb.png
[20201205200522854.png]: /images/20230312/056e50beb20842c9968e19cc96df0008.png
[20201206001624698.png]: /images/20230312/e5134d054ad7431aa2238cae34c6c6a1.png