C++ Thrift服务端记录调用者IP和被调接口方法

ゞ浴缸里的玫瑰 2022-02-18 14:47 195阅读 0赞

Apache开源的Thrift（[http://thrift.apache.org][http_thrift.apache.org]）有着广泛的使用，有时候需要知道谁调用了指定的函数，比如在下线一起老的接口之前，需要确保对这些老接口的访问已全部迁移到新口。Thrift提供了支持，在《[**Thrift结构分析及增加取客户端IP功能实现**][Thrift_IP]》一文中已做过介绍，但不够具体。

本文对这个做一个详细的介绍，过程中使用到了开源的C++ Thrift服务端的辅助类CThriftServerHelper（对应的客户端辅助类为CThriftClientHelper），源代码网址为：

<table style="width:426.1pt;"> 
 <tbody> 
 <tr> 
 <td style="vertical-align:top;width:426.1pt;"> <a href="https://github.com/eyjian/libmooon/blob/master/include/mooon/net/thrift_helper.h" rel="nofollow">https://github.com/eyjian/libmooon/blob/master/include/mooon/net/thrift_helper.h</a> </td> 
 </tr> 
 </tbody> 
</table>

为达到目标，需要提供一个Context结构体和两个回调接口实现类。

**1) ****Contex结构体****ThriftServerContext**

结构体的内容完成自定义，这里定义一个peer成员用来保存客户端的IP和端口号，根据实际需要也可分成两个字段。

<table style="width:426.1pt;"> 
 <tbody> 
 <tr> 
 <td style="vertical-align:top;width:426.1pt;"> struct&nbsp;ThriftServerContext { &nbsp;&nbsp;&nbsp;&nbsp;std::string&nbsp;peer;&nbsp;//&nbsp;客户端的IP和端口号，格式为标准的“IP:PORT” }; </td> 
 </tr> 
 </tbody> 
</table>

**2) ****ServerEvent回调接口实现类****MyServerEventHandler**

<table style="width:426.1pt;"> 
 <tbody> 
 <tr> 
 <td style="vertical-align:top;width:426.1pt;"> class&nbsp;MyServerEventHandler:&nbsp;public&nbsp;apache::thrift::server::TServerEventHandler { private: &nbsp;&nbsp;&nbsp;&nbsp;virtual&nbsp;void*&nbsp;createContext( &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;boost::shared_ptr&lt;apache::thrift::server::TProtocol&gt;&nbsp;input, &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;boost::shared_ptr&lt;apache::thrift::server::TProtocol&gt;&nbsp;output); &nbsp;&nbsp;&nbsp;&nbsp;virtual&nbsp;void&nbsp;deleteContext( &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;void*&nbsp;serverContext, &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;boost::shared_ptr&lt;apache::thrift::server::TProtocol&gt;input, &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;boost::shared_ptr&lt;apache::thrift::server::TProtocol&gt;output); &nbsp;&nbsp;&nbsp;&nbsp;virtual&nbsp;void&nbsp;processContext(void*&nbsp;serverContext,&nbsp;boost::shared_ptr&lt;apache::thrift::server::TTransport&gt;&nbsp;transport); }; </td> 
 </tr> 
 </tbody> 
</table>

**3) ****ProcessorEvent回调接口实现类****MyProcessorEventHandler**

<table style="width:426.1pt;"> 
 <tbody> 
 <tr> 
 <td style="vertical-align:top;width:426.1pt;"> class&nbsp;MyProcessorEventHandler:&nbsp;public&nbsp;apache::thrift::TProcessorEventHandler { private: &nbsp;&nbsp;&nbsp;&nbsp;virtual&nbsp;void*&nbsp;getContext(const&nbsp;char*&nbsp;fn_name,&nbsp;void*&nbsp;serverContext); }; </td> 
 </tr> 
 </tbody> 
</table>

**4) ****相关的实现**

<table style="width:426.1pt;"> 
 <tbody> 
 <tr> 
 <td style="vertical-align:top;width:426.1pt;"> void*&nbsp;MyServerEventHandler::createContext( &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;boost::shared_ptr&lt;apache::thrift::server::TProtocol&gt;&nbsp;input, &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;boost::shared_ptr&lt;apache::thrift::server::TProtocol&gt;&nbsp;output) { &nbsp;&nbsp;&nbsp;&nbsp;//&nbsp;以下针对TNonblockingServer &nbsp;&nbsp;&nbsp;&nbsp;//&nbsp;in_transport和out_transport实际为apache::thrift::server::TMemoryBuffer &nbsp;&nbsp;&nbsp;&nbsp;//boost::shared_ptr&lt;apache::thrift::server::TTransport&gt;&nbsp;in_transport&nbsp;=&nbsp;input-&gt;getTransport(); &nbsp;&nbsp;&nbsp;&nbsp;//boost::shared_ptr&lt;apache::thrift::server::TTransport&gt;&nbsp;output_transport&nbsp;=&nbsp;output-&gt;getTransport(); &nbsp;&nbsp;&nbsp;&nbsp;return&nbsp;new&nbsp;ThriftServerContext;&nbsp;//&nbsp;创建Context，Context每一个客户端连接是一对一的关系 } &nbsp; void&nbsp;MyServerEventHandler::deleteContext( &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;void*&nbsp;serverContext, &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;boost::shared_ptr&lt;apache::thrift::server::TProtocol&gt;input, &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;boost::shared_ptr&lt;apache::thrift::server::TProtocol&gt;output) { &nbsp;&nbsp;&nbsp;&nbsp;delete&nbsp;(ThriftServerContext*)serverContext;&nbsp;//&nbsp;释放Context，否则内存泄漏，连接被关闭时调用 } &nbsp; void&nbsp;MyServerEventHandler::processContext( &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;void*&nbsp;serverContext, &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;boost::shared_ptr&lt;apache::thrift::server::TTransport&gt;&nbsp;transport) { #if&nbsp;1 &nbsp;&nbsp;&nbsp;&nbsp;//&nbsp;如果是TNonblockingServer，则TTransport::getOrigin返回的是IP地址 &nbsp;&nbsp;&nbsp;&nbsp;//MYLOG_DEBUG("Called&nbsp;from&nbsp;%s\n",&nbsp;transport-&gt;getOrigin().c_str()); &nbsp; &nbsp;&nbsp;&nbsp;&nbsp;ThriftServerContext*&nbsp;ctx&nbsp;=&nbsp;(ThriftServerContext*)serverContext; &nbsp;&nbsp;&nbsp;&nbsp;//&nbsp;保存客户端的IP和端口号，以便MyProcessorEventHandler::getContext中可用 &nbsp;&nbsp;&nbsp;&nbsp;ctx-&gt;peer&nbsp;=&nbsp;transport-&gt;getOrigin(); #else &nbsp;&nbsp;&nbsp;&nbsp;//&nbsp;以下针对TNonblockingServer有效 &nbsp;&nbsp;&nbsp;&nbsp;apache::thrift::server::TSocket*&nbsp;socket&nbsp;=&nbsp;dynamic_cast&lt;apache::thrift::server::TSocket*&gt;(transport.get()); &nbsp;&nbsp;&nbsp;&nbsp;if&nbsp;(socket&nbsp;!=&nbsp;NULL) &nbsp;&nbsp;&nbsp;&nbsp;{ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;//&nbsp;TSocket::getPeerAddress返回的是IP地址， &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;//&nbsp;如果调用TSocket::getPeerHost()，则返回的可能是IP对应的hostname &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;MYLOG_DEBUG("Called&nbsp;from&nbsp;%s:%d\n",&nbsp;socket-&gt;getPeerAddress().c_str(),&nbsp;socket-&gt;getPeerPort()); &nbsp;&nbsp;&nbsp;&nbsp;} #endif } &nbsp; //&nbsp;参数fn_name为被调用接口名 //&nbsp;serverContext承载了客户端的IP和端口号数据 // //&nbsp;在getContext中，还可为每个调用创建自己的Context，但注意区别Server的Context void*&nbsp;MyProcessorEventHandler::getContext(const&nbsp;char*&nbsp;fn_name,&nbsp;void*&nbsp;serverContext) { &nbsp;&nbsp;&nbsp;&nbsp;ThriftServerContext*&nbsp;ctx&nbsp;=&nbsp;(ThriftServerContext*)serverContext; &nbsp;&nbsp;&nbsp;&nbsp;MYLOG_INFO("%s&nbsp;called&nbsp;by&nbsp;%s\n",&nbsp;fn_name,&nbsp;ctx-&gt;peer.c_str()); &nbsp;&nbsp;&nbsp;&nbsp;return&nbsp;NULL;&nbsp;//&nbsp;如果为本次调用创建Context，则需要实现freeContext以释放Context } </td> 
 </tr> 
 </tbody> 
</table>

**5) ****应用示例**

<table style="width:426.1pt;"> 
 <tbody> 
 <tr> 
 <td style="vertical-align:top;width:426.1pt;"> class&nbsp;CMyServer { public: &nbsp;&nbsp;CMyServer(); &nbsp;&nbsp;void&nbsp;start(); &nbsp; private: &nbsp;&nbsp;boost::shared_ptr&lt;MyServerEventHandler&gt;&nbsp;_server_event_handler; &nbsp;&nbsp;boost::shared_ptr&lt;MyProcessorEventHandler&gt;&nbsp;_processor_event_handler; &nbsp;&nbsp;mooon::net::CThriftServerHelper&lt;CMyHandler,&nbsp;MyServiceProcessor&gt;&nbsp;_thrift_server; }; &nbsp; CMyServer::CMyServer() &nbsp;&nbsp;:&nbsp;_server_event_handler(new&nbsp;MyServerEventHandler), &nbsp;&nbsp;&nbsp;&nbsp;_processor_event_handler(new&nbsp;MyProcessorEventHandler), &nbsp;&nbsp;&nbsp;&nbsp;_thrift_server(_server_event_handler,&nbsp;_processor_event_handler) { } &nbsp; void&nbsp;CMyServer::start() { &nbsp;&nbsp;//&nbsp;启动Thrift服务， &nbsp;&nbsp;//&nbsp;注意调用线程在这里会阻塞， &nbsp;&nbsp;//&nbsp;直到调用_thrift_server.stop()停止Thrift服务。 &nbsp;&nbsp;_thrift_server.serve( &nbsp;&nbsp;&nbsp;&nbsp;mooon::argument::port-&gt;value(),&nbsp;//&nbsp;监听端口号 &nbsp;&nbsp;&nbsp;&nbsp;mooon::argument::wkthreads-&gt;value(),&nbsp;//&nbsp;工作线程数 &nbsp;&nbsp;&nbsp;&nbsp;mooon::argument::iothreads-&gt;value());&nbsp;//&nbsp;IO线程数 } </td> 
 </tr> 
 </tbody> 
</table>

有关细节请参见《**Thrift结构分析及增加取客户端IP功能实现**》，以及编译thrift文件后生成的Service.cpp文件：

<table style="width:426.1pt;"> 
 <tbody> 
 <tr> 
 <td style="vertical-align:top;width:426.1pt;"> <a href="https://blog.csdn.net/Aquester/article/details/48261609" rel="nofollow">https://blog.csdn.net/Aquester/article/details/48261609</a> </td> 
 </tr> 
 </tbody> 
</table>

查看回调接口**TProcessorEventHandler**和TServerEventHandler可了解更多的使用。

[http_thrift.apache.org]: http://thrift.apache.org
[Thrift_IP]: https://blog.csdn.net/Aquester/article/details/48261609