springboot整合gprc传输对象

一&＃xff0c;grpc简介&＃xff1a;

GRPC是google开源的一个高性能、跨语言的RPC框架&＃xff0c;基于HTTP2协议&＃xff0c;基于protobuf 3.x&＃xff0c;基于Netty 4.x &＃43;。GRPC与thrift、avro-rpc等其实在总体原理上并没有太大的区别&＃xff0c;简而言之GRPC并没有太多突破性的创新。

    对于开发者而言&＃xff1a;

    1&＃xff09;需要使用protobuf定义接口&＃xff0c;即.proto文件

    2&＃xff09;然后使用compile工具生成特定语言的执行代码&＃xff0c;比如JAVA、C/C&＃43;&＃43;、Python等。类似于thrift&＃xff0c;为了解决跨语言问题。

    3&＃xff09;启动一个Server端&＃xff0c;server端通过侦听指定的port&＃xff0c;来等待Client链接请求&＃xff0c;通常使用Netty来构建&＃xff0c;GRPC内置了Netty的支持。

    4&＃xff09;启动一个或者多个Client端&＃xff0c;Client也是基于Netty&＃xff0c;Client通过与Server建立TCP常链接&＃xff0c;并发送请求&＃xff1b;Request与Response均被封装成HTTP2的stream Frame&＃xff0c;通过Netty Channel进行交互。

二&＃xff0c;proto3&＃xff1a;

Protocol Buffers是一个跨语言、跨平台的具有可扩展机制的序列化数据工具。也就是说&＃xff0c;我在ubuntu下用python语言序列化一个对象&＃xff0c;并使用http协议传输到使用java语言的android客户端&＃xff0c;java使用对用的代码工具进行反序列化&＃xff0c;也可以得到对应的对象。听起来好像跟json没有多大区别。。。其实区别挺多的。

Google说protobuf是smaller&＃xff0c;faster&＃xff0c;simpler&＃xff0c;我们使用google规定的proto协议定义语言&＃xff0c;之后使用proto的工具对代码进行“编译”&＃xff0c;生成对应的各个平台的源代码&＃xff0c;我们可以使用这些源代码进行工作。

 Proto2与proto3&＃xff1a;

Proto2和proto3有些区别&＃xff0c;包括proto语言的规范&＃xff0c;以及生成的代码&＃xff0c;proto3更好用&＃xff0c;更简便&＃xff0c;所以我们直接存proto3开始。

三&＃xff0c;Grpc Spring Boot Starter

grpc对于springboot封装的Starter&＃xff0c;

Grpc Spring Boot Starter地址&＃xff1a;https://github.com/yidongnan/grpc-spring-boot-starter

1&＃xff0c;用法&＃xff1a;

          a, 使用proto3生成java文件&＃xff1a;

[java] view plain copy

1.   
2.        2.8.3  
3.        1.6.1  
4.        1.5.0.Final  
5.        0.5.0  
6.        3.3.0  
7.        4.1.14.Final  
8.    
9.   
10.    
11.   
12.        
13.          io.grpc  
14.          grpc-netty  
15.          ${grpc.version}  
16.        
17.        
18.          io.grpc  
19.          grpc-protobuf  
20.          ${grpc.version}  
21.        
22.        
23.          io.grpc  
24.          grpc-stub  
25.          ${grpc.version}  
26.        
27.        
28.          io.netty  
29.          netty-common  
30.          ${grpc.netty.version}  
31.        
32.   
33.        
34.         com.fasterxml.jackson.core  
35.         jackson-annotations  
36.         ${jackson.version}  
37.       
38.   
39.   
40.   
41.   
42.        
43.         com.fasterxml.jackson.core  
44.         jackson-core  
45.         ${jackson.version}  
46.       
47.   
48.        
49.         com.fasterxml.jackson.core  
50.         jackson-databind  
51.         ${jackson.version}  
52.       
53.    
54.   
55.   
56.      
57.          
58.              
59.                kr.motd.maven  
60.                os-maven-plugin  
61.                ${os.plugin.version}  
62.              
63.          
64.          
65.              
66.                org.xolstice.maven.plugins  
67.                protobuf-maven-plugin  
68.                ${protobuf.plugin.version}  
69.                  
70.                    com.google.protobuf:protoc:${protoc.version}:exe:${os.detected.classifier}  
71.                    grpc-java  
72.                    io.grpc:protoc-gen-grpc-java:${grpc.version}:exe:${os.detected.classifier}  
73.                  
74.                  
75.                      
76.                          
77.                            compile  
78.                            compile-custom  
79.                          
80.                      
81.                  
82.              
83.          
84.      

注意版本号&＃xff0c;如果包版本不一致可能会有classnotFound的error

b,编写proto3文件&＃xff0c;

[java] view plain copy

1. syntax &＃61; "proto3";  
2.   
3. option java_multiple_files &＃61; true;  
4. option java_package &＃61; "com.aiccms.device.grpc.lib";  
5. option java_outer_classname &＃61; "DeviceFixProto";  
6. option objc_class_prefix &＃61; "HLW";  
7.   
8. package device;  
9.   
10. // The device service definition.  
11. service DeviceFixService {  
12.     // Sends a message  
13.     rpc insertDeviceFix (deviceFix) returns (booleanReply){}  
14.     rpc updateDeviceFix (deviceFix) returns (booleanReply){}  
15.     rpc searchDeviceFix (conditionsRequest) returns (deviceFix){}  
16.     rpc deleteDeviceFix (conditionsRequest) returns (booleanReply){}  
17. }  
18.   
19.   
20. // The request message .  
21. message conditionsRequest {  
22.      string id &＃61; 1;  
23. }  
24. message deviceFix {  
25.      string id&＃61;1;  
26.      string serialNum&＃61;2;  
27.      string userNum&＃61;3;  
28.      int32  status&＃61;4;  
29.      int32  type&＃61;5;  
30.      string address&＃61;6;  
31.      string createtime&＃61;7;  
32.      string updatetime&＃61;8;  
33. }  
34.   
35. // The response message  
36. message booleanReply {  
37.     bool reply &＃61; 1;  
38. }  
39.   
40. // The response message  
41. message objectReply {  
42.     bool reply &＃61; 1;  
43. }  

  编写proto3文件&＃xff0c;开头syntax中要指定为proto3版本。其他语法这里不做详细介绍。

c,使用mvn命令 protobuf:compile 和protobuf:compile-custom命令编译生成java文件

生成之后的文件在target目录中 

注意&＃xff1a;proto目录与java目录同级

d,以上这些都在一个公共的工程当中&＃xff0c;因为这些类不管是客户端和服务端都要使用。

e,编写grpc服务端&＃xff0c;首先添加maven依赖

[html] view plain copy

1. 1.3.0-RELEASE  
2.   
3.   
4.   
5.    net.devh  
6.    grpc-server-spring-boot-starter  
7.    ${grpc.stater.version}  
8.   

f,服务端代码

[html] view plain copy

1. /**  
2.  * User: hmemb  
3.  * Email: 949530857&＃64;qq.com  
4.  * Date: 2018/1/9  
5.  */  
6. &＃64;Slf4j  
7. &＃64;GrpcService(DeviceFixServiceGrpc.class)  
8. public class deviceGrpcService extends DeviceFixServiceGrpc.DeviceFixServiceImplBase{  
9.   
10.     &＃64;Autowired  
11.     private IDevicesFixService deviceService;  
12.       
13.     &＃64;Override  
14.     public void insertDeviceFix(deviceFix request, StreamObserver responseObserver) {  
15.          DevicesFix deviceFix &＃61; DevicesFix.builder().id(request.getId())  
16.                                                     .serialNum(request.getSerialNum())  
17.                                                     .address(request.getAddress())  
18.                                                     .createtime(DateUtil.toDate(request.getCreatetime(), DatePattern.TIMESTAMP))  
19.                                                     .updatetime(DateUtil.toDate(request.getUpdatetime(), DatePattern.TIMESTAMP))  
20.                                                     .userNum(request.getUserNum())  
21.                                                     .status(request.getStatus())  
22.                                                     .type(request.getType())  
23.                                                     .build();  
24.          log.info(deviceFix.toString());  
25.          boolean replyTag &＃61; deviceService.insert(deviceFix);  
26.          booleanReply reply &＃61; booleanReply.newBuilder().setReply(replyTag).build();  
27.          responseObserver.onNext(reply);  
28.          responseObserver.onCompleted();  
29.     }  

g,在配置文件中添加配置信息

[html] view plain copy

1. #grpc server config  
2. spring.application.name: device-grpc-server  
3. grpc.server.port:7052  

h,编写客户端代码&＃xff1a;引入maven依赖

[html] view plain copy

1. 1.3.0-RELEASE

[html] view plain copy

1.   
2.    net.devh  
3.    grpc-client-spring-boot-starter  
4.    ${grpc.stater.version}  
5.   

i,编写gprc接口实现&＃xff0c;注解&＃64;grpcClient 填写grpc接口名称

[java] view plain copy

1. /** 
2.  * User: hmemb 
3.  * Email: 949530857&＃64;qq.com 
4.  * Date: 2018/01/19 
5.  */  
6. &＃64;Service  
7. &＃64;Slf4j  
8. public class DeviceGrpcService {  
9.   
10.     &＃64;GrpcClient("device-grpc-server")  
11.     private Channel serverChannel;  
12.   
13.     public String insertDeviceFix( ){  
14.         DeviceFixServiceGrpc.DeviceFixServiceBlockingStub stub &＃61; DeviceFixServiceGrpc.newBlockingStub(serverChannel);  
15.         booleanReply response &＃61; stub.insertDeviceFix(  
16.                 deviceFix.newBuilder()  
17.                                 .setId("UUID-O1")  
18.                                 .setSerialNum("AUCCMA-01")  
19.                                 .setAddress("SHENZHEN")  
20.                                 .setCreatetime(DateUtil.toString(new Date(), DatePattern.TIMESTAMP))  
21.                                 .setUpdatetime(DateUtil.toString(new Date(), DatePattern.TIMESTAMP))  
22.                                 .setStatus(1)  
23.                                 .setType(1)  
24.                 .build());  
25.         log.info("grpc消费者收到&＃xff1a;--》"&＃43;response.getReply());  
26.         if(response.getReply()){  
27.         return "success";  
28.         }else{  
29.         return "fail";  
30.         }  
31.     }  
32. }  

j,配置文件中加入接口的服务端地址&＃xff0c;grpc.client.[服务器规定的接口名称].post/host

[html] view plain copy

1. grpc.client.device-grpc-server.host:127.0.0.1  
2. grpc.client.device-grpc-server.port:7052  

k,封装成http rest接口测试

[java] view plain copy

1. /** 
2.  * &＃64;Author:Hmemb 
3.  * &＃64;Description: 
4.  * &＃64;Date:Created in 18:24 2018/1/18 
5.  */  
6. &＃64;RestController  
7. &＃64;Api(value &＃61; "Testcontroller", description &＃61; "测试swagger")  
8. public class Testcontroller {  
9.   
10.   
11.     &＃64;Autowired  
12.     private DeviceGrpcService deviceGrpcService;  
13.   
14.   
15.     &＃64;RequestMapping("/testInsertDeviceFix")  
16.     &＃64;ApiOperation(value &＃61; "test", httpMethod &＃61; "GET", notes &＃61; "测试grpc插入")  
17.     public String printMessage3(&＃64;RequestParam(defaultValue &＃61; "Hmemb") String name) {  
18.         return deviceGrpcService.insertDeviceFix();  
19.     }  
20.     &＃64;RequestMapping("/TEST1")  
21.     &＃64;ApiOperation(value &＃61; "test", httpMethod &＃61; "GET", notes &＃61; "测试1")  
22.     public String printMessage(&＃64;RequestParam(defaultValue &＃61; "Michael") String name) {  
23.         return name;  
24.     }  
25. }  

l,接口测试结果

我只实现了proto中的一个接口&＃xff0c;其他接口同理。