gRPC入门

Posted 2021-01-06 2ysp

一、gRPC简介

在介绍gRPC之前先说一下RPC（Remote Procedure Call）,也叫远程过程调用协议，它是一种通过网络从远程计算机程序上请求服务，而不需要了解底层网络技术的协议。相比HTTP协议来说，它主要是基于TCP/IP协议的的,传输效率更高，能够跨语言，典型的RPC框架有RMI、Hessian、Dubbo等。想要深入了解它们之间区别的话可以看这篇博客。

---

gRPC由 google 开发，是一款语言中立、平台中立、开源的远程过程调用(RPC)系统。具备以下特性：

1. 基于HTTP/2，HTTP/2 提供了连接多路复用、双向流、服务器推送、请求优先级、首部压缩等机制。可以节省带宽、降低TCP链接次数、节省CPU，帮助移动设备延长电池寿命等。gRPC 的协议设计上使用了HTTP2 现有的语义，请求和响应的数据使用HTTP Body 发送，其他的控制信息则用Header 表示。
2. IDL使用ProtoBuf ，gRPC使用ProtoBuf来定义服务，ProtoBuf是由Google开发的一种数据序列化协议（类似于XML、JSON、hessian）。ProtoBuf能够将数据进行序列化，并广泛应用在数据存储、通信协议等方面。压缩和传输效率高，语法简单，表达力强。
3. 多语言支持（C, C++, Python, PHP, Nodejs, C#, Objective-C、Golang、Java），gRPC支持多种语言，并能够基于语言自动生成客户端和服务端功能库。目前已提供了C版本grpc、Java版本grpc-java 和 Go版本grpc-go，其它语言的版本正在积极开发中，其中，grpc支持C、C++、Node.js、Python、Ruby、Objective-C、php和C#等语言，grpc-java已经支持android开发。

二、认识protocol buffers

2.1简介

protocol buffers(简称protobuf),是由google开源的,在 RPC （远程方法调用）里非常流行的二进制编解码格式,类似xml,json等。主要有以下几个优点：

1. 性能好/效率高
2. 代码生成机制，比如可以将proto文件编译为Java文件
3. 支持多种编程语言
4. 支持“向后兼容”和“向前兼容”

2.2语法

2.2.1 定义一个消息类型

syntax = "proto3";

message SearchRequest {

  required string query = 1;

  optional int32 page_number = 2;

  optional int32 result_per_page = 3;

}

第一行指定了使用proto3语法，如果没有指定，编译器会使用proto2。这个指定语法行必须是文件的非空非注释的第一个行。

SearchRequest相当于我们Java中的一个实体类,里面有三个字段分别为String 类型query，int类型page_number和int类型result_per_page。

后面的数字1,2，3是标识号，必须从1开始。这些标识符是用来在消息的二进制格式中识别各个字段的，一旦开始使用就不能够再改 变。注：[1,15]之内的标识号在编码的时候会占用一个字节。[16,2047]之内的标识号则占用2个字节。所以应该为那些频繁出现的消息元素保留 [1,15]之内的标识号

字段的第一个是修饰符，必须是required,optional,repeated其中一个。

1. required：一个格式良好的消息一定要含有1个这种字段。表示该值是必须要设置的；
2. optional：表示可选的，可以有值也可以没有。
3. repeated：在一个格式良好的消息中，这种字段可以重复任意多次（包括0次）。重复的值的顺序会被保留。表示该值可以重复，相当于java中的List；

字段类型与Java类型对应关系如下图：

2.2.2 定义一个服务(service)

如果想要将消息类型用在RPC(远程方法调用)系统中，可以在.proto文件中定义一个RPC服务接口，protocol buffer编译器将会根据所选择的不同语言生成服务接口代码及存根。如，想要定义一个RPC服务并具有一个方法，该方法能够接收 SearchRequest并返回一个SearchResponse，此时可以在.proto文件中进行如下定义：

service SearchService {

  rpc Search (SearchRequest) returns (SearchResponse);

}

更多相关语法可以查看这篇博客

三、完成Hello World

项目结构如图：

3.1新建项目

新建一个maven项目grpc_demo，然后在pom文件引入grpc和代码生成插件，内容如下。

1. <properties> 

   ---

2. <grpc.version>1.0.3</grpc.version> 

   ---

3. </properties> 

   ---

4.  

   ---

5. <dependencies> 

   ---

6. <dependency> 

   ---

7. <groupId>io.grpc</groupId> 

   ---

8. <artifactId>grpc-netty</artifactId> 

   ---

9. <version>${grpc.version}</version> 

   ---

10. </dependency> 

    ---

11. <dependency> 

    ---

12. <groupId>io.grpc</groupId> 

    ---

13. <artifactId>grpc-protobuf</artifactId> 

    ---

14. <version>${grpc.version}</version> 

    ---

15. </dependency> 

    ---

16. <dependency> 

    ---

17. <groupId>io.grpc</groupId> 

    ---

18. <artifactId>grpc-stub</artifactId> 

    ---

19. <version>${grpc.version}</version> 

    ---

20. </dependency> 

    ---

21. </dependencies> 

    ---

22.  

    ---

23. <build> 

    ---

24. <extensions> 

    ---

25. <extension> 

    ---

26. <groupId>kr.motd.maven</groupId> 

    ---

27. <artifactId>os-maven-plugin</artifactId> 

    ---

28. <version>1.4.1.Final</version> 

    ---

29. </extension> 

    ---

30. </extensions> 

    ---

31. <plugins> 

    ---

32. <plugin> 

    ---

33. <groupId>org.xolstice.maven.plugins</groupId> 

    ---

34. <artifactId>protobuf-maven-plugin</artifactId> 

    ---

35. <version>0.5.0</version> 

    ---

36. <configuration> 

    ---

37. <protocArtifact>com.google.protobuf:protoc:3.1.0:exe:${os.detected.classifier}</protocArtifact> 

    ---

38. <pluginId>grpc-java</pluginId> 

    ---

39. <pluginArtifact>io.grpc:protoc-gen-grpc-java:${grpc.version}:exe:${os.detected.classifier}</pluginArtifact> 

    ---

40. </configuration> 

    ---

41. <executions> 

    ---

42. <execution> 

    ---

43. <goals> 

    ---

44. <goal>compile</goal> 

    ---

45. <goal>compile-custom</goal> 

    ---

46. </goals> 

    ---

47. </execution> 

    ---

48. </executions> 

    ---

49. </plugin> 

    ---

50. </plugins> 

    ---

51. </build> 

    ---

3.2编写proto文件

syntax = "proto3";


option java_multiple_files = true;
//定义包名
option java_package = "cn.sp.helloworld";
//定义生成的类名称
option java_outer_classname = "HelloWorldProto";

option objc_class_prefix = "HLW";



package helloworld;

// The greeting 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;

}

运行命令mvn clean compile，就可以看到编译后生成的Java文件。
控制台输出：

目录结构

将这些代码复制到src/main/java/cn/sp目录下

3.3完成HelloWorldClient和HelloWorldServer

客户端代码

1. package cn.sp.client; 

   ---

2.  

   ---

3. import cn.sp.GreeterGrpc; 

   ---

4. import cn.sp.HelloReply; 

   ---

5. import cn.sp.HelloRequest; 

   ---

6. import io.grpc.ManagedChannel; 

   ---

7. import io.grpc.ManagedChannelBuilder; 

   ---

8. import io.grpc.StatusRuntimeException; 

   ---

9.  

   ---

10. import java.util.concurrent.TimeUnit; 

    ---

11.  

    ---

12. public class HelloWorldClient { 

    ---

13.  

    ---

14. //一个gRPC信道 

    ---

15. private final ManagedChannel channel; 

    ---

16.  

    ---

17.  

    ---

18. private final GreeterGrpc.GreeterBlockingStub blockingStub;//阻塞/同步 存根 

    ---

19.  

    ---

20. //初始化信道和存根 

    ---

21. public HelloWorldClient(int port,String host){ 

    ---

22. this(ManagedChannelBuilder.forAddress(host,port).usePlaintext(true)); 

    ---

23. } 

    ---

24.  

    ---

25. private HelloWorldClient(ManagedChannelBuilder<?> channelBuilder){ 

    ---

26. channel = channelBuilder.build(); 

    ---

27. blockingStub = GreeterGrpc.newBlockingStub(channel); 

    ---

28. } 

    ---

29.  

    ---

30. public void shutDown()throws InterruptedException{ 

    ---

31. channel.shutdown().awaitTermination(5, TimeUnit.SECONDS); 

    ---

32. } 

    ---

33.  

    ---

34. //客户端方法 

    ---

35. public void greet(String name){ 

    ---

36. HelloRequest request = HelloRequest.newBuilder().setName(name).build(); 

    ---

37. HelloReply response; 

    ---

38. try{ 

    ---

39. response = blockingStub.sayHello(request); 

    ---

40. }catch (StatusRuntimeException e){ 

    ---

41. System.out.println("RPC调用失败："+e.getMessage()); 

    ---

42. return; 

    ---

43. } 

    ---

44.  

    ---

45. System.out.println("服务器返回信息："+response.getMessage()); 

    ---

46. } 

    ---

47.  

    ---

48. public static void main(String[] args)throws Exception { 

    ---

49. HelloWorldClient client = new HelloWorldClient(50051,"127.0.0.1"); 

    ---

50. try { 

    ---

51. for (int i=0;i<5;i++){ 

    ---

52. client.greet("world:"+i); 

    ---

53. } 

    ---

54. }finally { 

    ---

55. client.shutDown(); 

    ---

56. } 

    ---

57.  

    ---

58. } 

    ---

59.  

    ---

60. } 

    ---

61.  

    ---

服务器端代码

1. package cn.sp.server; 

   ---

2.  

   ---

3. import cn.sp.GreeterGrpc; 

   ---

4. import cn.sp.HelloReply; 

   ---

5. import cn.sp.HelloRequest; 

   ---

6. import io.grpc.Server; 

   ---

7. import io.grpc.ServerBuilder; 

   ---

8. import io.grpc.stub.StreamObserver; 

   ---

9.  

   ---

10. public class HelloWorldServer { 

    ---

11.  

    ---

12.  

    ---

13. private int port = 50051; 

    ---

14. private Server server; 

    ---

15.  

    ---

16. /** 

    ---

17. * 启动服务 

    ---

18. * @throws Exception 

    ---

19. */ 

    ---

20. private void start()throws Exception{ 

    ---

21. server = ServerBuilder.forPort(port) 

    ---

22. .addService(new GreeterImpl()) 

    ---

23. .build().start(); 

    ---

24. System.out.println("service start ...."); 

    ---

25. Runtime.getRuntime().addShutdownHook(new Thread(){ 

    ---

26. @Override 

    ---

27. public void run() { 

    ---

28. System.err.println("*** shutting down gRPC server since JVM is shutting down"); 

    ---

29. HelloWorldServer.this.stop(); 

    ---

30. System.err.println("*** server shut down"); 

    ---

31. } 

    ---

32. }); 

    ---

33. } 

    ---

34.  

    ---

35. private void stop(){ 

    ---

36. if (server != null){ 

    ---

37. server.shutdown(); 

    ---

38. } 

    ---

39. } 

    ---

40. // block 一直到程序退出 

    ---

41. private void blockUntilShutDown()throws InterruptedException{ 

    ---

42. if (server != null){ 

    ---

43. server.awaitTermination(); 

    ---

44. } 

    ---

45. } 

    ---

46.  

    ---

47. // 定义一个实现服务接口的类 

    ---

48. private class GreeterImpl extends GreeterGrpc.GreeterImplBase{ 

    ---

49.  

    ---

50. public void sayHello(HelloRequest req, StreamObserver<HelloReply> responseObserver){ 

    ---

51. System.out.println("收到的信息："+req.getName()); 

    ---

52.  

    ---

53. //这里可以放置具体业务处理代码 start 

    ---

54. //这里可以放置具体业务处理代码 end 

    ---

55.  

    ---

56. //构造返回 

    ---

57. HelloReply reply = HelloReply.newBuilder().setMessage("Hello: " + req.getName()).build(); 

    ---

58. responseObserver.onNext(reply); 

    ---

59. responseObserver.onCompleted(); 

    ---

60. } 

    ---

61. } 

    ---

62.  

    ---

63. public static void main(String[] args)throws Exception { 

    ---

64. HelloWorldServer server = new HelloWorldServer(); 

    ---

65. server.start(); 

    ---

66. server.blockUntilShutDown(); 

    ---

67. } 

    ---

68. } 

    ---

69.  

    ---

3.4运行测试

先运行服务端的main方法，再运行客户端，可以看到服务端控制台输出信息如下：

service start ....
收到的信息：world:0
收到的信息：world:1
收到的信息：world:2
收到的信息：world:3
收到的信息：world:4

客户端控制台输出信息：

服务器返回信息：Hello: world:0
服务器返回信息：Hello: world:1
服务器返回信息：Hello: world:2
服务器返回信息：Hello: world:3
服务器返回信息：Hello: world:4

说明客户端发出的五次问候请求服务端都接收到了，并且返回了响应。

四、总结

gRPC中proto文件的编写就显得十分重要了，要多加注释相当于接口文档，目前代码调用过程看着貌似有些复杂，后面整合SpringBoot之后就很简单了，不过我还是喜欢HTTP。。。。