rpc框架之 thrift 学习 2 - 基本概念

thrift的基本构架：

上图源自：http://jnb.ociweb.com/jnb/jnbJun2009.html

底层Underlying I/O以上的部分，都是由thrift编译器生成的代码，其中：

Your Code 这是根据thrift文件中定义的dto及service接口方法

FooService.Client及FooService.Processer是thrift生成的用于客户端及服务端的标准代码

Foo.read/write 参数对象及结果对象在传输时，最终需要在client、server间进行重写，红色框指的就是这个

TProtocal 指传输的内容是啥？（二进制？Json ? ）由于TProtocal是一个抽象类，因此最终调用时，如果想从BinaryProtocal换成JsonProtocal，这部分代码也不用重新生成

TTransport 指用什么方式传输？（Scoket? Memory？File?）同样，TTransport是抽象类，运行时由具体子类决定运输方式

最底层的Underlying I/O则是依赖于各种语言的实现，负责底层的网络通讯，thrift最初是由c++写的，理论上讲，c++上的性能应该最好。

以上一章的demo为例如，QueryParameter及DemoService的类图如下：

点击图片可以查看大图，从类图上看，大量使用了内部类(inner class)，对于dto对象，内部类基本上分为_Fileds, Schema,SchemaFactory 三类，

_Fields 是一个枚举，罗列了dto的各种属性成员，

Schema 封装了write/read方法

SchemaFactory 是一个工厂，用于创建Schema实例

服务接口的类图，就有点复杂了，密密麻麻象蜘蛛网，除了刚才的三大类外，DemoService的Inner Class中还有Client、Processor等类，大家有兴趣可以慢慢看。

TProtocal : 传输的内容（即：What? ）

从类图上看，支持 压缩格式、二进制格式、Json格式 等。

TTransport : 传输的方式（即：How? ）

Thrift支持的传输方式非常多，从类的命名就能大概看出一二。

TServer: Server的类图如下

基本上分为二大类：一类是同步阻塞的Server，一类是非阻塞模式的Server，其中THsHaServer是一个Half-Sync/Half-Async 半同步，半异步的server

meta_data 元数据

类图中的xxxMetaData，基本对应了 列表、K-V映射、（无重复元素）集合、结构（即：类）、枚举以及字段的元数据信息。

Schema ：对不同类型的TProtocal的读写操作，在这里抽象出来。

Variable-Length Quantity VLQ 变长编码：
Thirft采用TCompactProtocol序列化时之所以高效，跟VLQ变长编码有很大关系，直接借下面这张图来说吧：

整数106903，在java中我们知道int占用4个bytes，也就是32bit，高位字节如果不满，用0填充（最高位符号位除外）， 这样的话，很多用0填充的高位字节位置其实是浪费的，VLQ的基本思路是将2进制每7位分组，这样106903的2进制就可以分成3组，然后每1组的最高位设为1或0，如果为1，表示相邻的下一个字节还有内容，要继续读取，如果该位置为0，则表示结束了。

这样的话，106903最终只需要3个字节就可以存储了，节省了1个字节。

上述这一堆概念在运行时，是如何串起来的呢？

可以从TServer的部分源码中略知一二：

public abstract class TServer {

  public static class Args extends AbstractServerArgs<Args> {
    public Args(TServerTransport transport) {
      super(transport);
    }
  }

  public static abstract class AbstractServerArgs<T extends AbstractServerArgs<T>> {
    final TServerTransport serverTransport;
    TProcessorFactory processorFactory;
    TTransportFactory inputTransportFactory = new TTransportFactory();
    TTransportFactory outputTransportFactory = new TTransportFactory();
    TProtocolFactory inputProtocolFactory = new TBinaryProtocol.Factory();
    TProtocolFactory outputProtocolFactory = new TBinaryProtocol.Factory();

    public AbstractServerArgs(TServerTransport transport) {
      serverTransport = transport;
    }

    ...

  /**
   * Core processor
   */
  protected TProcessorFactory processorFactory_;

  /**
   * Server transport
   */
  protected TServerTransport serverTransport_;

  /**
   * Input Transport Factory
   */
  protected TTransportFactory inputTransportFactory_;

  /**
   * Output Transport Factory
   */
  protected TTransportFactory outputTransportFactory_;

  /**
   * Input Protocol Factory
   */
  protected TProtocolFactory inputProtocolFactory_;

  /**
   * Output Protocol Factory
   */
  protected TProtocolFactory outputProtocolFactory_;

  private boolean isServing;

  protected TServerEventHandler eventHandler_;

  // Flag for stopping the server
  // Please see THRIFT-1795 for the usage of this flag
  protected volatile boolean stopped_ = false;

  protected TServer(AbstractServerArgs args) {
    processorFactory_ = args.processorFactory;
    serverTransport_ = args.serverTransport;
    inputTransportFactory_ = args.inputTransportFactory;
    outputTransportFactory_ = args.outputTransportFactory;
    inputProtocolFactory_ = args.inputProtocolFactory;
    outputProtocolFactory_ = args.outputProtocolFactory;
  }

从上述源码可以看出，TServer 中包含有input/output二类TProtocol，即：体现了 数据进来和出去时传输的格式(Binary? Json?...)，另外还有input与output的Transport，即：数据进来和出去的时候，如何传输？(Scoket? File?...)，另外还有一个Processor，其子类是通过IDL(thrift定义文件)生成的，运行时必须传递进来具体的子类。

这样，传递什么数据（what）？用什么方式传输（how）? 以及数据如何处理（process）？都有了

而且从源码中，可以发现默认的input/output Protocol都是BinaryProtocol（14，15行）。

Server端启动的时序图如下：

Client调用的时序图：

注：上面这二张序列图均出自https://www.ibm.com/developerworks/cn/java/j-lo-apachethrift/

有了这些整体的概念后，上一篇中的示例，如果我们想换成TCompactProtocal，Client与Server的代码都得同步修改，这样二边才能一致：

Client端：

public class ThriftClient {

    public static void main(String[] args) {

        try {
            TTransport transport;
            transport = new TSocket("localhost", 9090);
            transport.open();

            //TProtocol protocol = new TBinaryProtocol(transport);
            TProtocol protocol = new TCompactProtocol(transport);
            DemoService.Client client = new DemoService.Client(protocol);
...

Server端：

    public static void simple(DemoService.Processor processor) {
        try {
            TServerTransport serverTransport = new TServerSocket(9090);
            Args args = new Args(serverTransport);
            args.outputProtocolFactory(new TCompactProtocol.Factory());
            args.inputProtocolFactory(new TCompactProtocol.Factory());
            TServer server = new TSimpleServer(args.processor(processor));
            //TServer server = new TSimpleServer(new Args(serverTransport).processor(processor));
            System.out.println("Starting the simple server...");
            server.serve();
        } catch (Exception e) {
            e.printStackTrace();
        }
    }

最后，对TCompactProtocol、TBinaryProtocol、TJSONProtocol这三种序列化协议简单测试下效率：

    @Test
    public void testProtocol() throws Exception {
        QueryParameter parameter = getQueryParameter();

        //CompactProtocol测试
        TSerializer serializerCompact = new TSerializer(new TCompactProtocol.Factory());
        byte[] bytes1 = serializerCompact.serialize(parameter);
        System.out.println("CompactProtocol序列后的byte数组长度：" + bytes1.length);

        //BinaryProtocol测试
        TSerializer serializerBinary = new TSerializer(new TBinaryProtocol.Factory());
        byte[] bytes2 = serializerBinary.serialize(parameter);
        System.out.println("BinaryProtocol序列后的byte数组长度：" + bytes2.length);

        //JsonProtocol测试
        TSerializer serializerJson = new TSerializer(new TJSONProtocol.Factory());
        byte[] bytes3 = serializerJson.serialize(parameter);
        System.out.println("JsonProtocol序列后的byte数组长度：" + bytes3.length);
        System.out.println(serializerJson.toString(parameter));

        System.out.println("-----------");
        TDeserializer deserializerCompact = new TDeserializer(new TCompactProtocol.Factory());
        QueryParameter query1 = new QueryParameter();
        deserializerCompact.deserialize(query1, bytes1);
        System.out.println("CompactProtocol反序列化结果：" + query1.equals(parameter));

        TDeserializer deserializerBinary = new TDeserializer(new TBinaryProtocol.Factory());
        QueryParameter query2 = new QueryParameter();
        deserializerBinary.deserialize(query2, bytes2);
        System.out.println("BinaryProtocol反序列化结果：" + query2.equals(parameter));

        TDeserializer deserializerJSON = new TDeserializer(new TJSONProtocol.Factory());
        QueryParameter query3 = new QueryParameter();
        deserializerJSON.deserialize(query3, bytes3);
        System.out.println("JSONProtocol反序列化结果：" + query2.equals(parameter));
    }

    private QueryParameter getQueryParameter(){
        QueryParameter query = new QueryParameter();
        short start = 1;
        short end = 5;
        query.setAgeStart(start);
        query.setAgeEnd(end);
        return query;
    }

输出结果：

CompactProtocol序列后的byte数组长度：5
BinaryProtocol序列后的byte数组长度：11
JsonProtocol序列后的byte数组长度：29
{"1":{"i16":1},"2":{"i16":5}}
-----------
CompactProtocol反序列化结果：true
BinaryProtocol反序列化结果：true
JSONProtocol反序列化结果：true

TCompactProtocol优势明显，序列后的bytes长度只有JSON的1/5左右，可以大幅减少网络传输量。

参考文章：

http://dongxicheng.org/search-engine/thrift-rpc/

http://blog.chinaunix.net/uid-20357359-id-2876170.html

http://jnb.ociweb.com/jnb/jnbJun2009.html

https://www.ibm.com/developerworks/cn/java/j-lo-apachethrift/

http://www.cnblogs.com/brucewoo/tag/Thrift/