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 input,
boost::shared_ptr output);
virtual void deleteContext(
void* serverContext,
boost::shared_ptrinput,
boost::shared_ptroutput);
virtual void processContext(void* serverContext, boost::shared_ptr 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 input,
boost::shared_ptr output)
{
// 以下针对TNonblockingServer
// in_transport和out_transport实际为apache::thrift::server::TMemoryBuffer
//boost::shared_ptr in_transport = input->getTransport();
//boost::shared_ptr output_transport = output->getTransport();
return new ThriftServerContext; // 创建Context,Context每一个客户端连接是一对一的关系
}
void MyServerEventHandler::deleteContext(
void* serverContext,
boost::shared_ptrinput,
boost::shared_ptroutput)
{
delete (ThriftServerContext*)serverContext; // 释放Context,否则内存泄漏,连接被关闭时调用
}
void MyServerEventHandler::processContext(
void* serverContext,
boost::shared_ptr 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(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 _server_event_handler;
boost::shared_ptr _processor_event_handler;
mooon::net::CThriftServerHelper _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可了解更多的使用。

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

发表于

我来说两句

0 条评论
登录 后参与评论

扫码关注云+社区

领取腾讯云代金券