CSharp使用Thrift作为RPC框架入门(一)

UCloud 发布于2021-11-24 09:39 / 2483人阅读

摘要：以当前文件为根目录，生成多级目录在生成的代码上添加命名空间。结尾结尾这篇文件我们讲了从到使用框架的方法，也讲了一些该框架的基本知识，接下来的文件，我们将通过一个示例具体讲解一下指令代码生成的代码的具体含义和使用方法

前言

本文将介绍由 Facebook 开发的远程服务调用框架 Apache Thrift，它采用接口描述语言定义并创建服务，支持可扩展的跨语言服务开发，所包含的代码生成引擎可以在多种语言中，如 C++, Java, Python, PHP, Ruby, Erlang, Perl, Haskell, C#, Cocoa, Smalltalk 等创建高效的、无缝的服务，其传输数据采用二进制格式，相对 XML 和 JSON 体积更小，对于高并发、大数据量和多语言的环境更有优势。本文将详细介绍 Thrift 在C#语言下的使用方式，并且提供丰富的实例代码加以解释说明，帮助使用者快速构建服务。

完善开发工具

通过nuget在vs2019中安装thrift

在项目中引用右键点击管理Nuget程序包，在打开的界面输入thrift，如下图：

我们选择ApacheThrift这一项进行安装，安装后，在我们项目里有Thrift45.dll的引用，如下图：

下载thrift代码生成工具

thrift是支持异构语言、异构平台的通信开发RPC框架，它通过中间语言IDL进行描述你要定义的结构、类、服务等，并通过代码生成工具生成各个语言上对应的代码。

接下来，我们进入Apache网站Thrift项目下载Thrift代码生成工具，如下图：

我们把下载的这个exe文件放到我们项目的根目录下，以备后用，如下图：

至此，关于thrift的开发工具，我们已经准备完毕，接下来来编写thrift接口描述文件

thrift描述文件

thrift提供的接口描述文件是以thrift结尾的格式文件，我们来解释一下这种IDL的语法，

它提供了基础类型的定义，包括bool、i16、i32、i64、double、string
enum
Struct 对一些基础类型的封装，对应C#中Class字段
还有一些集合的定义，包含 set<> 对应C#中的HashSet，是一种唯一元素的集合（Thrift框架自己定义了THashSet类型与之相对应）；list<>对应C#中的List<>;map对应C#的Dictionary
service 这个是thrift的重点，它是一些方法集合，thrift会根据这个定义生成客户端代码和服务端代码
exception 对应C#中的Exception类型
thrift关于类型的定义以及示例代码请打开这个网址：IDL描述

在IDL描述文件中，Thrift除了对类型的定义外，我们还需要记住一下知识点：

namespace 在描述文件的头部定义。以当前文件为根目录，生成多级目录；在生成的代码上添加namespace命名空间。代码如下:

namespace csharp WpfApp1.ceshi

include 在描述文件的头部定义。用该命令包含其他thrift描述文件，当编译生成代码时也会编译include指定的thrift文件。代码如下：

include "pe1.thrift"

使用方法,pe1.thrift文件定义如下：

struct pe1{ 1: i32 id;}

在其他文件中，引入上述文件，定义如下：

include "pe1.thrift"service GuidGenService{   string getGuid(1:pe1.pe1 pe1);}

typedef 类型定义命令，将thrift支持的类型定义一个别名。代码如下：

typedef i32 intstruct People{1: int ID;2: string Name;3: i16 Age;4: list onelist;5: set oneSet;6: map oneset;}

当定义完描述文件后，我们通过如下cmd命令生成代码文件：

thrift-0.12.0.exe -r -gen csharp People.thrift

我们先要通过cd 将当前路径跳转到thrift-0.12.0.exe所在的路径

示例

我定义了了一个描述文件，如下：

namespace csharp WpfApp1.ceshiinclude "pe1.thrift"typedef i32 intstruct People{1: int ID;2: string Name;3: i16 Age;4: list onelist;5: set oneSet;6: map oneset;}service HelloService{ void SetPeople(1: People people1);}service GuidGenService{  string getGuid(1:pe1.pe1 pe1);}

我们通过上述命令执行后，生成的代码结构如下图：

我们打开people.cs可以看到struct people生成了如下代码：

namespace WpfApp1.ceshi{  #if !SILVERLIGHT  [Serializable]  #endif  public partial class People : TBase  {    private int _ID;    private string _Name;    private short _Age;    private List _onelist;    private THashSet _oneSet;    private Dictionary _oneset;    .....

这里需要注意一下people类的命名空间，这和我们上文讲的时一致的。
我们定义的service GuidGenService生成了如下代码：

该类是我们使用该框架的重点，它给我们生成了客户端和服务器端代码，从图中我们可以看该文件下生成了两个接口ISync和Iface，前者是同步方法，后者生成的是异步调用方法，接下来是一个供我们客户端调用的类，它继承了iface接口，而iface又继承了ISync接口；再往下看是一个Processor，是服务端使用的类。

结尾

这篇文件我们讲了从0到1使用thrift框架的方法，也讲了一些该框架的基本知识，接下来的文件，我们将通过一个示例具体讲解一下service指令代码生成的代码的具体含义和使用方法

文章版权归作者所有，未经允许请勿转载,若此文章存在违规行为，您可以联系管理员删除。

转载请注明本文地址：https://www.ucloud.cn/yun/124804.html

Thrift RPC使用入门

摘要：使用入门目前项目使用来作为服务之间调用的底层框架，组内人员说可以尝试使用替换他，性能更出色，且使用更方便。所以找了一些资料，为做一个入门。客户端客户端引入接口，使用生成代理，来访问远程服务对象。 thrift使用入门目前项目使用hessian来作为服务之间RPC调用的底层框架，组内人员说可以尝试使用thrift替换他，thrift性能更出色，且使用更方便。所以找了一些资料，为thri...

junfeng777 2019-08-15 12:05 评论0 收藏0
后端必备——数据通信知识(RPC、消息队列)一站式总结

摘要：具体可以参考消息队列之具体可以参考实战之快速入门十分钟入门阿里中间件团队博客是一个分布式的可分区的可复制的基于发布订阅的消息系统主要用于大数据领域当然在分布式系统中也有应用。目前市面上流行的消息队列就是阿里借鉴的原理用开发而得。我自己总结的Java学习的系统知识点以及面试问题，目前已经开源，会一直完善下去，欢迎建议和指导欢迎Star： https://github.com/Snail...

Kahn 2019-08-16 12:34 评论0 收藏0
RPC框架实践之：Apache Thrift

摘要：在文章微服务调用链追踪中心搭建一文中模拟出来的调用链就是一个远程调用的例子，只不过这篇文章里是通过这种同步调用方式，利用的是协议在应用层完成的，这种方法虽然奏效，但有时效率并不高。 showImg(https://segmentfault.com/img/remote/1460000014858219); 一、概述 RPC（Remote Procedure Call）即远程过程调...

Gilbertat 2019-08-15 17:42 评论0 收藏0
RPC框架实践之：Apache Thrift

摘要：在文章微服务调用链追踪中心搭建一文中模拟出来的调用链就是一个远程调用的例子，只不过这篇文章里是通过这种同步调用方式，利用的是协议在应用层完成的，这种方法虽然奏效，但有时效率并不高。 showImg(https://segmentfault.com/img/remote/1460000014858219); 一、概述 RPC（Remote Procedure Call）即远程过程调...

keithxiaoy 2019-06-24 18:00 评论0 收藏0
Spring Boot 中使用 thrift 入门

摘要：简介是什么是一个软件框架，用来进行可扩展且跨语言的服务的开发。的功能允许定义一个简单的定义文件中的数据类型和服务接口，以作为输入文件，编译器生成代码用来方便地生成客户端和服务器通信的无缝跨编程语言。 Thrift 简介 Thrift 是什么 Thrift是一个软件框架，用来进行可扩展且跨语言的服务的开发。它结合了功能强大的软件堆栈和代码生成引擎，以构建在 C++, Java, Go,P...

cnio 2019-08-15 17:52 评论0 收藏0