protobuf及grpc的client请求

Posted

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了protobuf及grpc的client请求相关的知识,希望对你有一定的参考价值。

参考技术A

背景:
需要对rpc服务进行压测,需要构造rpc请求。

protobuf 简介
Protocol Buffer (简称Protobuf) 是Google出品的性能优异、跨语言、跨平台的序列化库。

文档结构
protobuf 使用 .proto 文件来保存文档。

定义消息
protobuf使用message定义消息,例如:

AlgPluginObject消息定义了三个字段,分别为插件名称,U0ID及插件方法。
消息定义中的每个字段都有唯一的编号。 这些字段编号用于以消息二进制格式标识字段,并且在使用消息类型后不应更改

定义服务
定义RPC方法,需要使用service关键字定义服务,并在里面定义方法。

此处定义了一个AlgReportPush服务,包含两个rpc方法:

下面针对上面的proto文件,写一个grpc client 进行rpc请求。

教你使用ProtoBuf,通过gRPC服务在Android上进行网络请求

教你如何使用ProtoBuf,通过gRPC服务在android上进行网络请求。

https://github.com/xuexiangjys/Protobuf-gRPC-Android

简介

ProtoBuf

google公司发布的一套开源编码规则,基于二进制流的序列化传输,可以转换成多种编程语言,几乎涵盖了市面上所有的主流编程语言,是目前公认的非常高效的序列化技术。

ProtoBuf的Github主页:

https://github.com/protocolbuffers/protobuf

gRPC

gRPC是一个高性能、开源和通用的RPC框架,面向移动和HTTP/2设计。目前提供C、Java和Go语言版本,分别是grpc、grpc-java、grpc-go。gRPC基于HTTP/2标准设计,带来诸如双向流、流控、头部压缩、单TCP连接上的多复用请求等特性。这些特性使得其在移动设备上表现更好,更省电和节省空间占用。gRPC由google开发,是一款语言中立、平台中立、开源的远程过程调用系统。

gRPC(Java)的Github主页:

https://github.com/grpc/grpc-java

为什么要使用ProtoBuf和gRPC

简而言之,ProtoBuf就好比信息传输的媒介,类似我们常用的json,而grpc则是传输他们的通道,类似我们常用的socket。

ProtoBuf和json

如果用一句话来概括ProtoBuf和JSON的区别的话,那就是:对于较多信息存储的大文件而言,ProtoBuf的写入和解析效率明显高很多,而JSON格式的可读性明显要好。网上有一段数据用以对此ProtoBuf和JSON之间的性能差异:

JSON

 
   
   
 
  1. 总共写65535Data记录到文件中,测试结果如下:

  2. 生成的文件尺寸是23,733k

  3. 生成文件的时间是12.80秒。

  4. 从该文件中解析的时间是11.50秒。

ProtoBuf

 
   
   
 
  1. 总共写65535Data记录到文件中,测试结果如下:

  2. 生成的文件尺寸是3760k

  3. 生成文件的时间是0.08秒。

  4. 从该文件中解析的时间是0.07秒。

gRPC

作为google公司极力推荐的分布式网络架构,基于HTTP2.0标准设计,使用用ProtoBuf作为序列化工具,在移动设备上表现更好,更省电和节省空间占用。google出品,品质值得信赖。

如何使用

像这种国外的开源框架,还是建议大家先直接阅读官方文档,再看国内的文章,这样才不容易被误导。

官方教程:

https://grpc.io/docs/quickstart/android.html

官方示例:

https://github.com/grpc/grpc-java/tree/master/examples/android

环境配置

1.首先需要下载安装Protobuf Support插件,如下图:

2.在项目的根目录的 build.gradle 的 buildscript中加入 protobuf-gradle-plugin插件:

 
   
   
 
  1. buildscript {

  2. ...

  3. dependencies {

  4. ...

  5. classpath "com.google.protobuf:protobuf-gradle-plugin:0.8.6"

  6. }

  7. }

3.然后在应用Module的 build.gradle 中进行如下配置

 
   
   
 
  1. apply plugin: 'com.android.application'

  2. apply plugin: 'com.google.protobuf' //引用protobuf-gradle-plugin插件


  3. android {

  4. ...


  5. lintOptions {

  6. abortOnError false

  7. disable 'GoogleAppIndexingWarning', 'HardcodedText', 'InvalidPackage'

  8. textReport true

  9. textOutput "stdout"

  10. }

  11. }


  12. protobuf {

  13. protoc { artifact = 'com.google.protobuf:protoc:3.6.1' }

  14. plugins {

  15. javalite { artifact = "com.google.protobuf:protoc-gen-javalite:3.0.0" }

  16. grpc { artifact = 'io.grpc:protoc-gen-grpc-java:1.19.0' // CURRENT_GRPC_VERSION

  17. }

  18. }

  19. generateProtoTasks {

  20. all().each { task ->

  21. task.plugins {

  22. javalite {}

  23. grpc { // Options added to --grpc_out

  24. option 'lite' }

  25. }

  26. }

  27. }

  28. }


  29. dependencies {

  30. //protobuf

  31. implementation 'io.grpc:grpc-okhttp:1.19.0'

  32. implementation 'io.grpc:grpc-protobuf-lite:1.19.0'

  33. implementation 'io.grpc:grpc-stub:1.19.0'

  34. implementation 'javax.annotation:javax.annotation-api:1.2'

  35. }

4.最后将你 .proto协议文件放至 src/main/proto/文件夹下,点击build进行编译,如果出现如下图,则证明环境配置成功!教你使用ProtoBuf,通过gRPC服务在Android上进行网络请求

普通请求

在测试demo中的请求前,请务必先运行服务端的代码。

1.构建Channel

 
   
   
 
  1. /**

  2. * 构建一条普通的Channel

  3. *

  4. * @param port 端口

  5. * @return

  6. */

  7. public static ManagedChannel newChannel(String host, int port) {

  8. return ManagedChannelBuilder.forAddress(host, port)

  9. .usePlaintext()

  10. .build();

  11. }

2.构建服务请求API代理

 
   
   
 
  1. //构建通道

  2. final ManagedChannel channel = gRPCChannelUtils.newChannel(host, port);

  3. //构建服务api代理

  4. mStub = GreeterGrpc.newStub(channel);

3.构建请求实体

 
   
   
 
  1. //HelloRequest是自动生成的实体类

  2. HelloRequest request = HelloRequest.newBuilder().setName(message).build();

4.执行请求

 
   
   
 
  1. //进行请求

  2. mStub.sayHello(request, new SimpleStreamObserver<HelloReply>() {

  3. @Override

  4. protected void onSuccess(HelloReply value) {

  5. tvGrpcResponse.setText(value.getMessage());

  6. btnSend.setEnabled(true);

  7. }

  8. @MainThread

  9. @Override

  10. public void onError(Throwable t) {

  11. super.onError(t);

  12. tvGrpcResponse.setText(Log.getStackTraceString(t));

  13. btnSend.setEnabled(true);

  14. }

  15. @Override

  16. public void onCompleted() {

  17. super.onCompleted();

  18. gRPCChannelUtils.shutdown(channel); //关闭通道

  19. }

  20. });

Https请求

与普通请求相比,就在第一步建立通道有所不同,需要设置CA证书,其他步骤都相同。

 
   
   
 
  1. /**

  2. * 构建一条SSLChannel

  3. *

  4. * @param port 端口

  5. * @param authority 域名

  6. * @param certificates 证书

  7. * @return

  8. */

  9. public static ManagedChannel newSSLChannel(String host, int port, String authority, InputStream... certificates) {

  10. HttpsUtils.SSLParams sslParams = HttpsUtils.getSslSocketFactory(certificates);

  11. return OkHttpChannelBuilder.forAddress(host, port)

  12. //overrideAuthority非常重要,必须设置调用

  13. .overrideAuthority(authority)

  14. .sslSocketFactory(sslParams.sSLSocketFactory)

  15. .build();

  16. }

联系方式

微信公众号


以上是关于protobuf及grpc的client请求的主要内容,如果未能解决你的问题,请参考以下文章

go+protobuf+grpc+consul简单的服务发现模型

教你使用ProtoBuf,通过gRPC服务在Android上进行网络请求

grpc从0开始-1-protobuf的认识及使用

grpc:使用 golang 开发 grpc 服务端和client

gRPC 一定要使用 Protobuf 吗?

在windows环境下 编译pb (protobuf) 文件