Apache Thrift 跨语言服务开发框架

Apache Thrift 是一种支持多种编程语言的远程服务调用框架，由 Facebook 于 2007 年开发，并于 2008 年进入 Apache 开源项目管理。Apache Thrift 通过 IDL 来定义 RPC 的接口和数据类型，然后通过代码生成工具来生成针对不同编程语言的代码，目前支持 C++, Java, Python, PHP, Ruby, Erlang, Perl, Haskell, C#, Cocoa, JavaScript, Node.js, Smalltalk, OCaml, Delphi 等。

本文将从 C# 开发人员的角度介绍基于 Apache Thrift 的服务开发过程。

在文章《开源跨平台数据格式化框架概览》中主要介绍了各开源框架的数据格式化处理部分，但并没有描述消息的传输和 RPC 服务的定义。而实际上，Apache Thrift 与 Google Protocol Buffers 的一大不同点就是，Google Protocol Buffers 仅支持定义 RPC 服务接口，而 Apache Thrift 不仅支持定义 RPC 服务接口，还提供了支持 RPC 服务实现的完整的堆栈结构，并为 RPC 服务的 Server 端和 Client 端直接生成了可用代码。如下图描绘了 Thrift 的堆栈架构。

传输层（Transport）

传输层提供对网络 I/O 的抽象，通过 Transport 对客户端进行抽象，ServerTransport 对服务端进行抽象。

• TTransport
  • TBufferedTransport
  • TFramedTransport
  • TStreamTransport
    • TSocket
    • TTLSSocket
  • THttpClient
  • TMemoryBuffer
  • TNamedPipeClientTransport
• TServerTransport
  • TServerSocket
  • TTLSServerSocket
  • TNamedPipeServerTransport

其实，看一眼 TSocket 的源代码就可以了解事情的真相了。

    public TSocket(string host, int port, int timeout)
    {
      this.host = host;
      this.port = port;
      this.timeout = timeout;

      InitSocket();
    }

    private void InitSocket()
    {
      client = new TcpClient();
      client.ReceiveTimeout = client.SendTimeout = timeout;
      client.Client.NoDelay = true;
    }

协议层（Protocol）

协议层抽象了数据结构的定义，描述了如何组织数据以进行传输，包括 Encode 和 Decode 数据处理。所以，协议层负责实现数据的序列化和反序列化机制，例如序列化 Json, XML, Plain Text, Binary, Compact Binary 等。

协议层抽象了大量的读写操作接口，以供扩展。

  public abstract void WriteMessageBegin(TMessage message);
  public abstract void WriteMessageEnd();
  public abstract void WriteStructBegin(TStruct struc);
  public abstract void WriteStructEnd();
  public abstract void WriteFieldBegin(TField field);
  public abstract void WriteFieldEnd();
  public abstract void WriteFieldStop();
  public abstract void WriteMapBegin(TMap map);
  public abstract void WriteMapEnd();
  public abstract void WriteListBegin(TList list);
  public abstract void WriteListEnd();
  public abstract void WriteSetBegin(TSet set);
  public abstract void WriteSetEnd();
  public abstract void WriteBool(bool b);
  public abstract void WriteByte(sbyte b);
  public abstract void WriteI16(short i16);
  public abstract void WriteI32(int i32);
  public abstract void WriteI64(long i64);
  public abstract void WriteDouble(double d);
  public virtual void WriteString(string s);
  public abstract void WriteBinary(byte[] b);
  
  public abstract TMessage ReadMessageBegin();
  public abstract void ReadMessageEnd();
  public abstract TStruct ReadStructBegin();
  public abstract void ReadStructEnd();
  public abstract TField ReadFieldBegin();
  public abstract void ReadFieldEnd();
  public abstract TMap ReadMapBegin();
  public abstract void ReadMapEnd();
  public abstract TList ReadListBegin();
  public abstract void ReadListEnd();
  public abstract TSet ReadSetBegin();
  public abstract void ReadSetEnd();
  public abstract bool ReadBool();
  public abstract sbyte ReadByte();
  public abstract short ReadI16();
  public abstract int ReadI32();
  public abstract long ReadI64();
  public abstract double ReadDouble();
  public virtual string ReadString();
  public abstract byte[] ReadBinary();

处理层（Processor）

Processor 封装了对输入输出流的读写操作，输入输出流也就代表着协议层处理的对象。Processor 接口定义的极其简单。

  public interface TProcessor
  {
    bool Process(TProtocol iprot, TProtocol oprot);
  }

服务层（Server）

Server 将所有功能整合到一起：

• 创建一个 Transport；
• 创建 Transport 使用的 I/O Protocol；
• 为 I/O Protocol 创建 Processor；
• 启动服务，等待客户端的连接；

通过抽象 TServer 类来提供上述整合。

• TServer
  • TSimpleServer -- Simple single-threaded server for testing.
  • TThreadedServer -- Server that uses C# threads (as opposed to the ThreadPool) when handling requests.
  • TThreadPoolServer -- Server that uses C# built-in ThreadPool to spawn threads when handling requests.

    public TServer(TProcessor processor,
              TServerTransport serverTransport,
              TTransportFactory inputTransportFactory,
              TTransportFactory outputTransportFactory,
              TProtocolFactory inputProtocolFactory,
              TProtocolFactory outputProtocolFactory,
              LogDelegate logDelegate)
    {
    }

    public abstract void Serve();
    public abstract void Stop();

Thrift 实例

使用 Thrift 的过程：

• 编写类似于结构体的消息格式定义，使用类似于 IDL 的语言定义。
• 使用代码生成工具，生成目标语言代码。
• 在程序中直接使用这些代码。

这里我们从一个简单的 Thrift 实例开始，对 Thrift 服务的构建进行直观的展示。创建一个简单的 CalculatorService，通过 Calculate 接口来支持 "+ - x /" 简单的计算。Thrift 文件名为 calculator.thrift。

namespace cpp com.contracts.calculator
namespace java com.contracts.calculator
namespace csharp Contracts

enum Operation {
  Add = 1,
  Subtract = 2,
  Multiply = 3,
  Divide = 4
}

exception DivideByZeroException {
  1: string Message;
}

service CalculatorService {
   i32 Calculate(1:i32 x, 2:i32 y, 3:Operation op) throws (1:DivideByZeroException divisionByZero);
}

上面的 calculator.thrift 实例中，

• namespace 定义针对不同编程语言的名空间或者包；
• enum 定义了 Calculate 需要支持的枚举类型；
• exception 定义了 Calculate 中可能发生的异常类型；
• service 定义了 CalculatorService 服务接口；

Apache Thrift 与 Google Protocol Buffers 的另一个不同点就是，Apache Thrift 支持对 Exception 的定义，使得在定义服务和实现服务接口时可以方便的处理服务端异常。

在命令行使用 Thrift 代码生成工具为 C# 编程语言生成代码：

thrift --gen csharp calculator.thrift

代码生成工具根据 calculator.thrift 中的定义会生成 3 个 C# 代码文件：

• CalculatorService.cs
• DivideByZeroException.cs
• Operation.cs

有了这些生成的代码文件，就可以设计服务端和客户端代码了。这里，创建 3 个 solution 文件：

• Contracts：存放生成的代码文件，共享给 Server 和 Client；
• Server：实现服务端代码，为客户端提供服务；
• Client：实现客户端代码，调用服务端；

Contracts 代码

由于在 calculator.thrift 文件中定义了 C# 的名空间：

namespace csharp Contracts

所以生成的代码的 namespace 即为 Contracts。

namespace Contracts
{
  public enum Operation
  {
    Add = 1,
    Subtract = 2,
    Multiply = 3,
    Divide = 4,
  }
}

相应的，在 CalculatorService 文件中也生成了名为 Iface 的接口定义，也就是 Server 端需要为 Client 端实现的接口。

  public partial class CalculatorService {
    public interface Iface {
      int Calculate(int x, int y, Operation op);
    }
  }

Server 端实现

为了实现 CalculatorService，需要实现一个 CalculatorServiceHandler 类来实现生成的 Contracts 中的 CalculatorService.Iface 接口。

  public class CalculatorServiceHandler : CalculatorService.Iface
  {
    public int Calculate(int x, int y, Operation op)
    {
      switch (op)
      {
        case Operation.Add:
          return x + y;
        case Operation.Subtract:
          return x - y;
        case Operation.Multiply:
          return x * y;
        case Operation.Divide:
          if (y == 0)
            throw new Contracts.DivideByZeroException()
            {
              Message = "Cannot divide by zero."
            };
          return x / y;
      }

      throw new NotImplementedException();
    }
  }

上面代码中的 Operation.Divide 段，判断了当除数为 0 时将抛出 Contracts.DivideByZeroException 异常。

然后，需要启动 Server 来提供 CalculatorService 服务。将 CalculatorServiceHandler 类的实例传递给 CalculatorService.Processor 的构造函数，指定 Socket 绑定端口 8888，然后启动服务。

  class Program
  {
    static void Main(string[] args)
    {
      var handler = new CalculatorServiceHandler();
      var processor = new CalculatorService.Processor(handler);

      TServerTransport transport = new TServerSocket(8888);
      TServer server = new TThreadPoolServer(processor, transport);

      server.Serve();

      Console.ReadKey();
    }
  }

Client 端实现

Client 端消费 Server 端的代码更加简单，基本上 Thrift 都已提供了默认的实现，需要做的就是指定地址、端口和协议。

  class Program
  {
    static void Main(string[] args)
    {
      var transport = new TSocket("localhost", 8888);
      var protocol = new TBinaryProtocol(transport);
      var client = new CalculatorService.Client(protocol);

      transport.Open();

      var test1 = client.Calculate(100, 2, Operation.Add);
      Console.WriteLine(test1);

      var test2 = client.Calculate(100, 2, Operation.Subtract);
      Console.WriteLine(test2);

      var test3 = client.Calculate(100, 2, Operation.Multiply);
      Console.WriteLine(test3);

      var test4 = client.Calculate(100, 2, Operation.Divide);
      Console.WriteLine(test4);

      try
      {
        var test5 = client.Calculate(100, 0, Operation.Divide);
        Console.WriteLine(test5);
      }
      catch (Contracts.DivideByZeroException ex)
      {
        Console.WriteLine(ex.Message);
      }

      Console.ReadKey();
    }
  }

然后，就可以启动 Server 端和 Client 端程序，实现简单的服务调用了。

本篇文章《Apache Thrift 跨语言服务开发框架》由 Dennis Gao 发表自博客园，未经作者本人同意禁止任何形式的转载，任何自动或人为的爬虫转载行为均为耍流氓。