4.17. Protobuf

使用 IDL 定义服务

当前 Dubbo 的服务定义和具体的编程语言绑定,没有提供一种语言中立的服务描述格式,比如 Java 就是定义 Interface 接口,到了其他语言又得重新以另外的格式定义一遍。 2.7.5 版本通过支持 Protobuf IDL 实现了语言中立的服务定义。

日后,不论我们使用什么语言版本来开发 Dubbo 服务,都可以直接使用 IDL 定义如下服务,具体请 参见示例

syntax = "proto3";
option java_multiple_files = true;
option java_package = "org.apache.dubbo.demo";
option java_outer_classname = "DemoServiceProto";
option objc_class_prefix = "DEMOSRV";
package demoservice;
// The demo service definition.
service DemoService {
  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;
}

GoogleProtobuf 对象泛化调用

  • 对 Google Protobuf 对象进行泛化调用。
  • 泛化接口调用方式主要用于客户端没有 API 接口及模型类元的情况,参考 4.16. 使用泛化调用 。 一般泛化调用只能用于生成的服务参数为POJO的情况,而 GoogleProtobuf 的对象是基于 Builder 生成的非正常POJO,可以通过 protobuf-json 泛化调用。
  • GoogleProtobuf 序列化相关的Demo可以参考 protobuf-demo

通过Spring对Google Protobuf对象泛化调用

  • 在 Spring 中配置声明 generic = “protobuf-json”
    <dubbo:reference id="barService" interface="com.foo.BarService" generic="protobuf-json" />
    
  • 在 Java 代码获取 barService 并开始泛化调用:
    GenericService barService = (GenericService) applicationContext.getBean("barService");
    Object result = barService.$invoke("sayHello",new String[]{"org.apache.dubbo.protobuf.GooglePbBasic$CDubboGooglePBRequestType"}, new Object[]{"{\"double\":0.0,\"float\":0.0,\"bytesType\":\"Base64String\",\"int32\":0}"});
    

通过 API 方式对 Google Protobuf 对象泛化调用

ReferenceConfig<GenericService> reference = new ReferenceConfig<GenericService>();
// 弱类型接口名
reference.setInterface(GenericService.class.getName());
reference.setInterface("com.xxx.XxxService");
// 声明为Protobuf-json
reference.setGeneric(Constants.GENERIC_SERIALIZATION_PROTOBUF);
GenericService genericService = reference.get();
Map<String, Object> person = new HashMap<String, Object>();
person.put("fixed64", "0");
person.put("int64", "0");
// 参考google官方的protobuf 3 的语法,服务的每个方法中只传输一个POJO对象
// protobuf的泛化调用只允许传递一个类型为String的json对象来代表请求参数
String requestString = new Gson().toJson(person);
// 返回对象是GoolgeProtobuf响应对象的json字符串。
Object result = genericService.$invoke("sayHello", new String[] {
    "com.xxx.XxxService.GooglePbBasic$CDubboGooglePBRequestType"},
    new Object[] {requestString});

GoogleProtobuf 对象的处理

  • GoogleProtobuf 对象是由 Protocol 契约生成,相关知识请参考 ProtocolBuffers 文档。假如有如下Protobuf 契约
    syntax = "proto3";
    package com.xxx.XxxService.GooglePbBasic.basic;
    message CDubboGooglePBRequestType {
        double double = 1;
        float float = 2;
        int32 int32 = 3;
        bool bool = 13;
        string string = 14;
        bytes bytesType = 15;
    }
    message CDubboGooglePBResponseType {
        string msg = 1;
    }
    service CDubboGooglePBService {
        rpc sayHello (CDubboGooglePBRequestType) returns (CDubboGooglePBResponseType);
    }
    
  • 则对应请求按照如下方法构造
    Map<String, Object> person = new HashMap<>();
    person.put("double", "1.000");
    person.put("float", "1.00");
    person.put("int32","1" );
    person.put("bool","false" );
    //String 的对象需要经过base64编码
    person.put("string","someBaseString");
    person.put("bytesType","150");
    

GoogleProtobuf 服务元数据解析

  • Google Protobuf 对象缺少标准的 JSON 格式,生成的服务元数据信息存在错误。请添加如下依赖元数据解析的依赖。
    <dependency>
        <groupId>org.apache.dubbo</groupId>
        <artifactId>dubbo-metadata-definition-protobuf</artifactId>
        <version>${dubbo.version}</version>
    </dependency>
    
  • 从服务元数据中也可以比较容易构建泛化调用对象。
下一节:实现一个通用的远程服务 Mock 框架,可通过实现 GenericService 接口处理所有服务请求。