C++ Thrift服務端記錄調用者IP和被調接口方法

 

Apache開源的Thrift（http://thrift.apache.org）有着普遍的使用，有時候須要知道誰調用了指定的函數，好比在下線一塊兒老的接口以前，須要確保對這些老接口的訪問已所有遷移到新口。Thrift提供了支持，在《Thrift結構分析及增長取客戶端IP功能實現》一文中已作過介紹，但不夠具體。

本文對這個作一個詳細的介紹，過程當中使用到了開源的C++ Thrift服務端的輔助類CThriftServerHelper（對應的客戶端輔助類爲CThriftClientHelper），源代碼網址爲：

https://github.com/eyjian/libmooon/blob/master/include/mooon/net/thrift_helper.h

 

爲達到目標，須要提供一個Context結構體和兩個回調接口實現類。

1) Contex結構體ThriftServerContext

結構體的內容完成自定義，這裏定義一個peer成員用來保存客戶端的IP和端口號，根據實際須要也可分紅兩個字段。

struct ThriftServerContext {     std::string peer; // 客戶端的IP和端口號，格式爲標準的「IP:PORT」 };

 

2) ServerEvent回調接口實現類MyServerEventHandler

class MyServerEventHandler: public apache::thrift::server::TServerEventHandler { private:     virtual void* createContext(             boost::shared_ptr<apache::thrift::server::TProtocol> input,             boost::shared_ptr<apache::thrift::server::TProtocol> output);     virtual void deleteContext(             void* serverContext,             boost::shared_ptr<apache::thrift::server::TProtocol>input,             boost::shared_ptr<apache::thrift::server::TProtocol>output);     virtual void processContext(void* serverContext, boost::shared_ptr<apache::thrift::server::TTransport> transport); };

 

3) ProcessorEvent回調接口實現類MyProcessorEventHandler

class MyProcessorEventHandler: public apache::thrift::TProcessorEventHandler { private:     virtual void* getContext(const char* fn_name, void* serverContext); };

 

4) 相關的實現

void* MyServerEventHandler::createContext(         boost::shared_ptr<apache::thrift::server::TProtocol> input,         boost::shared_ptr<apache::thrift::server::TProtocol> output) {     // 如下針對TNonblockingServer     // in_transport和out_transport實際爲apache::thrift::server::TMemoryBuffer     //boost::shared_ptr<apache::thrift::server::TTransport> in_transport = input->getTransport();     //boost::shared_ptr<apache::thrift::server::TTransport> output_transport = output->getTransport();     return new ThriftServerContext; // 建立Context，Context每個客戶端鏈接是一對一的關係 }   void MyServerEventHandler::deleteContext(         void* serverContext,         boost::shared_ptr<apache::thrift::server::TProtocol>input,         boost::shared_ptr<apache::thrift::server::TProtocol>output) {     delete (ThriftServerContext*)serverContext; // 釋放Context，不然內存泄漏，鏈接被關閉時調用 }   void MyServerEventHandler::processContext(         void* serverContext,         boost::shared_ptr<apache::thrift::server::TTransport> transport) { #if 1     // 若是是TNonblockingServer，則TTransport::getOrigin返回的是IP地址     //MYLOG_DEBUG("Called from %s\n", transport->getOrigin().c_str());       ThriftServerContext* ctx = (ThriftServerContext*)serverContext;     // 保存客戶端的IP和端口號，以便MyProcessorEventHandler::getContext中可用     ctx->peer = transport->getOrigin(); #else     // 如下針對TNonblockingServer有效     apache::thrift::server::TSocket* socket = dynamic_cast<apache::thrift::server::TSocket*>(transport.get());     if (socket != NULL)     {         // TSocket::getPeerAddress返回的是IP地址，         // 若是調用TSocket::getPeerHost()，則返回的多是IP對應的hostname         MYLOG_DEBUG("Called from %s:%d\n", socket->getPeerAddress().c_str(), socket->getPeerPort());     } #endif }   // 參數fn_name爲被調用接口名 // serverContext承載了客戶端的IP和端口號數據 // // 在getContext中，還可爲每一個調用建立本身的Context，但注意區別Server的Context void* MyProcessorEventHandler::getContext(const char* fn_name, void* serverContext) {     ThriftServerContext* ctx = (ThriftServerContext*)serverContext;     MYLOG_INFO("%s called by %s\n", fn_name, ctx->peer.c_str());     return NULL; // 若是爲本次調用建立Context，則須要實現freeContext以釋放Context }

 

5) 應用示例

class CMyServer { public:   CMyServer();   void start();   private:   boost::shared_ptr<MyServerEventHandler> _server_event_handler;   boost::shared_ptr<MyProcessorEventHandler> _processor_event_handler;   mooon::net::CThriftServerHelper<CMyHandler, MyServiceProcessor> _thrift_server; };   CMyServer::CMyServer()   : _server_event_handler(new MyServerEventHandler),     _processor_event_handler(new MyProcessorEventHandler),     _thrift_server(_server_event_handler, _processor_event_handler) { }   void CMyServer::start() {   // 啓動Thrift服務，   // 注意調用線程在這裏會阻塞，   // 直到調用_thrift_server.stop()中止Thrift服務。   _thrift_server.serve(     mooon::argument::port->value(), // 監聽端口號     mooon::argument::wkthreads->value(), // 工做線程數     mooon::argument::iothreads->value()); // IO線程數 }

 

有關細節請參見《Thrift結構分析及增長取客戶端IP功能實現》，以及編譯thrift文件後生成的Service.cpp文件：

https://blog.csdn.net/Aquester/article/details/48261609

 

查看回調接口TProcessorEventHandler和TServerEventHandler可瞭解更多的使用。