C#使用Thrift作为RPC框架入门详细教程

C#使用Thrift作为RPC框架入门详细教程

什么是Thrift

Thrift是一个由Facebook开源的高效、多语言支持的远程过程调用（RPC）框架，可用于构建跨平台、可扩展的服务。

安装Thrift

在使用Thrift之前，先需要安装Thrift的编译器（thrift.exe），可以从Thrift官网（https://thrift.apache.org/download）下载对应平台的二进制包进行安装。安装完成后，可通过执行以下命令，验证Thrift是否已安装成功：

thrift --version

编写Thrift定义文件

在使用Thrift进行RPC之前，需要针对需要进行远程调用的方法和数据结构编写一个IDL文件。具体的语法可以参考Thrift官方文档。

在这里，我们以一个简单的示例来说明。代码如下：

namespace csharp Tutorial

service Calculator {
    i32 Add(1:i32 num1, 2:i32 num2)
}

这个IDL定义了一个服务Calculator，其中包含一个方法Add，该方法接受两个参数num1和num2，求和后返回一个整型值。

生成代码

使用Thrift提供的工具可以快速生成跨平台客户端和服务端代码。首先需要选择生成的语言，这里我们选用C#。执行以下命令：

thrift --gen csharp tutorial.thrift

其中，tutorial.thrift是我们上一步编写的IDL文件。执行该命令后，将在当前目录下生成一个以IDL文件名为前缀的文件夹，在里面包含了生成的代码。

实现服务端

现在我们已经生成了C#代码，接下来可以根据生成代码中自带的示例代码实现服务端。

在这里，我们以Console应用程序的形式实现。首先，创建一个新的C# Console应用程序项目，然后使用NuGet包管理器搜索并安装Thrift。

接下来，在项目中新增一个CalculatorHandler.cs文件，实现Calculator服务接口：

using System;
using System.Collections.Generic;
using Thrift.Server;
using Thrift.Transport;

namespace CalculatorServer
{
    internal class CalculatorHandler : Calculator.Iface
    {
        public int Add(int num1, int num2)
        {
            return num1 + num2;
        }
    }

    internal class Program
    {
        private static void Main(string[] args)
        {
            try
            {
                var handler = new CalculatorHandler();
                var processor = new Calculator.Processor(handler);
                var serverTransport = new TServerSocket(9090);
                var server = new TSimpleServer(processor, serverTransport);

                Console.WriteLine("Starting the server...");
                server.Serve();
            }
            catch (Exception x)
            {
                Console.WriteLine(x.StackTrace);
            }

            Console.WriteLine("done.");
        }
    }
}

在该实现中，我们实现了Add方法，根据我们在IDL文件里面定义的语法逻辑进行求和后输出。`

实现客户端

下一步就是编写客户端代码调用服务端提供的服务。我们也可以通过NuGet包管理器安装Thrift，从而使用Thrift提供的Client代理来调用服务端。

using System;
using Thrift.Protocol;
using Thrift.Transport;

namespace CalculatorClient
{
    internal class Program
    {
        private static void Main(string[] args)
        {
            try
            {
                var transport = new TSocket("localhost", 9090);
                var protocol = new TBinaryProtocol(transport);
                var client = new Calculator.Client(protocol);

                transport.Open();
                var sum = client.Add(1, 2);
                Console.WriteLine("1 + 2 = " + sum);
                transport.Close();
            }
            catch (Exception x)
            {
                Console.WriteLine(x.StackTrace);
            }

            Console.WriteLine("done.");
        }
    }
}

在该实现中，我们首先创建一个Thrift的Transport对象与服务端进行通信，在Transport对象之上建立一个Thrift的Protocol对象，可以根据需要配置不同的Protocol类型，在此我们选用TBinaryProtocol。通过Transport和Protocol对象实例化一个服务端提供的Client代理，并调用其生成的方法。最后关闭Transport对象。

示例说明

通过上面给出的教程，我们可以得到一个通过Thrift实现的简单的RPC服务端和客户端。

运行该样例程序可以获得以下输出：

服务端：

Starting the server...

客户端：

1 + 2 = 3

说明我们已经通过Thrift实现了一个基于RPC的服务器和客户端，并且客户端能够正确地调用远程服务器端提供的服务，确保链路通畅。

总结

本文中，我们介绍了如何使用Thrift实现基于RPC协议的服务器和客户端。Thrift支持跨平台，多语言，高效，易用等诸多优点，并且具有很强的可扩展性，适合构建大规模的分布式系统。