【基础】利用thrift实现一个非阻塞带有回调机制的客户端

假设读者对thrift有一定了解。

　　客户端有时需要非阻塞的去发送请求，给定服务端一个请求，要求其返回一个计算结果。但是客户端不想等待服务端处理完，而是想发送完这个指令后自己去做其他事情，当结果返回时自动的去处理。

　　比如举个形象点的例子：饭店的Boss让小弟A把本周店里的欠条收集起来放到自己桌子上，然后又告诉自己的小秘书坐在自己办公室等着小弟A把欠条拿过来，然后统计一下一共有多少，然后Boss自己出去半点事儿。

　　Boss相当于client，小弟A相当于server，而小秘书相当于client端的回调函数（callback）。怎么讲呢？Boss不想等待小弟处理完，因为他老人家公务繁忙，还要去干别的呢。于是他把接下来处理欠条的任务托管给了小秘书，于是自己一个人出去了。

　　OK，那么我们基本了解了整个工作流程，来看看实现的方法。thrift去实现client异步+回调的方法关键点在于：thrift生成的client中有个send_XXX()和recv_XXX()方法。send_XXX()相当于告知server去处理东西，可以立即返回；而调用recv_XXX就是个阻塞的方法了，直到server返回结果。所以，我们可以在主线程调用完send_XXX()之后，然后另开一个线程去调用send_XXX()，该线程在等到server回复后自动调用callback方法，对结果进行一些处理（当然callback在修改client状态时需要进行同步操作）。这样的模式下，我们可以做很多事情，比如分布式环境下的观察者模式。当然了需要注意的一点就是，各个线程接受到结果的顺序跟请求顺序不一定一样，因为server处理不通请求时间不通或者网络环境的影响都可能导致这种情形。所以如果你对接受这些结果时不是幂等操作时需要注意一下。

thrift脚本：

//只有一个方法，client发送一个消息，server换回一个消息
service TestServ{
    string ping(1: string message),
}

server端采用TNBlockingServer实现

#include "TestServ.h"

#include <iostream>

#include <thrift/protocol/TBinaryProtocol.h>
#include <thrift/server/TNonblockingServer.h>
#include <thrift/transport/TServerSocket.h>
#include <thrift/transport/TBufferTransports.h>
#include <thrift/concurrency/PosixThreadFactory.h>

using namespace std;

using namespace ::apache::thrift;
using namespace ::apache::thrift::protocol;
using namespace ::apache::thrift::transport;
using namespace ::apache::thrift::server;
using namespace ::apache::thrift::concurrency;

using boost::shared_ptr;

class TestServHandler : virtual public TestServIf {
 public:
  TestServHandler() {
    // Your initialization goes here
  }

  void ping(std::string& _return, const std::string& message) {
      _return = "hello, i am server! ";
      sleep(3);// do something time-consuming/ 这里我们在server端加一些耗时的操作
      cout<<"Request from client: "<<message<<endl;
  }

};

int main(int argc, char **argv) {
  int port = 9090;

  shared_ptr<TestServHandler> handler(new TestServHandler());
  shared_ptr<TProcessor> processor(new TestServProcessor(handler));
  shared_ptr<TProtocolFactory> protocolFactory(new TBinaryProtocolFactory());  
  shared_ptr<ThreadManager> threadManager = ThreadManager::newSimpleThreadManager(15);  
  shared_ptr<PosixThreadFactory> threadFactory = shared_ptr<PosixThreadFactory > (new PosixThreadFactory());  
  threadManager->threadFactory(threadFactory);  
  threadManager->start();  
  TNonblockingServer server(processor, protocolFactory, port, threadManager);  
  server.serve();  
  return 0;
}

client端实现：

#include "TestServ.h"

#include <iostream>
#include <thrift/protocol/TBinaryProtocol.h>
#include <thrift/transport/TSocket.h>
#include <thrift/transport/TBufferTransports.h>

#include "test_constants.h"

using namespace std;
using namespace ::apache::thrift;
using namespace ::apache::thrift::protocol;
using namespace ::apache::thrift::transport;
using boost::shared_ptr;

class AsynTestClient;
void * wait_recv(void * parg );
struct PARG {
    AsynTestClient * pthis;
    string message;
};

class AsynTestClient {
private:
    unsigned int d_cnt_recv;//< 客户端接受到server响应次数的计数器.

    pthread_rwlock_t m_cnt_recv;//< 计数器的读写锁.
    vector<pthread_t> m_ids;

public:
    TestServClient * d_client;
    void call_back(string & _return){
    //输出服务器返回信息并把返回计数加1
    cout<<"server msg: "<<_return<<endl;
    pthread_rwlock_wrlock( &m_cnt_recv );
    d_cnt_recv ++;
    pthread_rwlock_unlock( &m_cnt_recv );
    }
    explicit AsynTestClient(boost::shared_ptr<TProtocol> & protocol){
    pthread_rwlock_init( &m_cnt_recv, NULL );
    d_cnt_recv = 0;
    d_client = new TestServClient( protocol );
    }

    ~AsynTestClient(){
    delete d_client;
    pthread_rwlock_destroy( &m_cnt_recv );
    }

    void asyn_ping( const string & message) {
    //发送请求
    d_client->send_ping(message);
    //初始化每个等待回调线程的参数
    PARG * parg = new PARG;
    parg->pthis = this;
    parg->message = message;
    //把新生成的线程id放入全局数组维护
    pthread_t m_id;
    m_ids.push_back(m_id);
    //启动线程，从此只要接受到服务器的返回结果就调用回调函数。
    if( 0 != pthread_create( &m_id, NULL, wait_recv, reinterpret_cast< void * > (parg) ) ) {
        return;
    }
    }
};
int main(int argc, char **argv) {

    boost::shared_ptr<TSocket> socket(new TSocket("localhost", 9090));  
    boost::shared_ptr<TTransport> transport(new TFramedTransport(socket));  
    boost::shared_ptr<TProtocol> protocol(new TBinaryProtocol(transport));  

    //TestServClient client(protocol);  

    transport->open();  
    AsynTestClient client(protocol);
    string message = "hello, i am client! ";
    client.asyn_ping(message);

    while(true){
    sleep(1);//这里相当于client去做别的事情了
    }

    transport->close();  
    return 0;  
}
void * wait_recv(void * parg ) {
    PARG * t_parg = reinterpret_cast< PARG * >(parg);//强制转化线程参数
    string _return;
    t_parg->pthis->d_client->recv_ping(_return);
    t_parg->pthis->call_back(_return);
}

　　其实大家可以注意到，我并没有使用asyn_ping(const string & message, void(*)call_back(void));这种方式去定义它，这是因为asyn_ping本身可以获取callback函数的指针。回调的本质是任务的托管、时间的复用，也就是说等待结果返回后自动去调用一段代码而已，所以本质上上面就是回调机制。如果你想使用传函数指针的方式，也可以实现出来。

　　注意：编译时需要-L$(LIB_DIR) -lthrift -lthriftnb -levent。