C++中消息自動派發之三 About JSON Encode

　　《C++ 消息自動派發》系列上篇介紹了IDL解析器，生成的C++代碼只支持JSON轉C++ struct。 經過新的重構，這次增加了對C++ struct 轉JSON的支持。IDL解析器自動為C++ struct生成兩個方法。

　　decode：實現json 轉C++ struct 轉。

　　encode：實現C++ struct 轉json字符串。

　　現實應用中，網絡服務器程序處理流程如下：

　　1> 網絡層異步接收Client消息（本文討論的應用都是基於json協議）

　　2> 對消息進行解析，如判斷消息類型，消息體字段檢查、解析、賦值等。將解析完成的結果封裝到特定的struct中（每一個消息類型定義單獨一個struct）。注：JSON解析、檢查、取值都是再網絡線程完成（多線程），通常服務器程序的核心邏輯都是在單線程中完成，故邏輯線程應重點”保護“之。待消息轉成struct后，邏輯線程直接操作二進制，盡最大程度提高邏輯線程的實時性、吞吐量。

　　3> 邏輯線程處理完請求，一般會產生特定的響應結果（有時是一個，如rpc請求，有時多個，如廣播消息）。響應結果仍然要同過json協議發送給client。

　　4> 邏輯成生成的響應結果為二進制struct，需要轉換成json字符串。同樣這些耗時的、與邏輯無關的操作應該放到網絡線程。道理還是一樣，盡最大程度保證

　　　　邏輯層的效率。

　　完整示例代碼 svn co http://ffown.googlecode.com/svn/trunk/fflib/lib/generator/

1. 用例

　　假設一個玩家查詢好友信息接口。client發送get_friends_req請求，參數為uid，服務器查詢該user的好友，生成好友列表list，返回消息結果。

　　首先定義IDL文件，其中有兩個消息體：

//! 定義請求消息類型：
struct get_friends_req_t
{
    uint32 uid;
};

//! 定義服務器響應結果消息體類型, ret_t 結尾，代表此消息為響應消息，服務器不需要處理此消息的請求

struct all_friends_ret_t
{
    array<uint32> friends;
};

     對應的服務器實現代碼如下所示，稍微做些解釋：

　　1> socket_t 封裝linux socket 文件描述符操作，這里只是個示例，其提供async_write接口，使用preactor模式發送數據。其接受所有消息的基類指針，並且該指針為智能指針，無需手動析構。消息體基類支持encode接口，講二進制struct轉成json字符串，socket則將json字符串通過write系統調用發送給client。

　　2> logic_service_t 邏輯層，處理所有的消息請求。針對每一個消息定義重載一個handle函數，為了避免網絡層消息傳到邏輯層的內存拷貝，這里使用智能指針，同時避免了手動管理。

　　3> msg_dispather_t, 這個類是由idl 解析器自動生成的，在生產環境，應該有網絡層調用此對象。由於本文只是示例，故忽略網絡層，由main模擬網絡層調用。

　　

class socket_t
{
public:
    void async_write(msg_ptr_t msg_)
    {
        //! TODO do io write
        cout <<"wile send:" << msg_->encode_json() <<"\n";
    }
};

typedef socket_t* socket_ptr_t;

class logic_service_t
{
public:
    void handle(shared_ptr_t<get_friends_req_t> req_,  socket_ptr_t sock_)
    {
        cout << "req uid:" << req_->uid <<"\n";
        //! DO some logic code
        shared_ptr_t<all_friends_ret_t> msg(new all_friends_ret_t());

        for (int i = 0; i < 10; ++i)
            msg->friends.push_back(i);

        sock_->async_write(msg);
    }
};


int main(int argc, char* argv[])
{
    try
    {
        string tmp = "{\"get_friends_req_t\":{\"uid\":12345}}";
        logic_service_t logic_service;
        msg_dispather_t<logic_service_t, socket_ptr_t> msg_dispather(logic_service);
        //! 這里實際上應該被網絡層調用
        socket_ptr_t sock = new socket_t();
        msg_dispather.dispath(tmp, sock);
    }
    catch(exception& e)
    {
        cout <<"e:"<< e.what() <<"\n";
    }
    cout <<"main end ok\n";
}

2. 使用IDL 生成 C++ 代碼：

　　idl_generator.py  example.idl msg_def.h

　　前面定義的example.idl 經過idl_generator.py 分析后生成頭文件msg_def.h, 其中包括 msg_dispather_t 的實現，其主要代碼為：

struct all_friends_ret_t : public msg_t {
    vector<uint32> friends;
    int parse(const json_value_t& jval_) {

            json_instream_t in("all_friends_ret_t");
            in.decode("friends", jval_["friends"], friends);
        return 0;
    }

    string encode_json() const
    {
        rapidjson::Document::AllocatorType allocator;
        rapidjson::StringBuffer            str_buff;
        json_value_t                       ibj_json(rapidjson::kObjectType);
        json_value_t                       ret_json(rapidjson::kObjectType);

        this->encode_json_val(ibj_json, allocator);
        ret_json.AddMember("all_friends_ret_t", ibj_json, allocator);

        rapidjson::Writer<rapidjson::StringBuffer> writer(str_buff, &allocator);
        ret_json.Accept(writer);
        string output(str_buff.GetString(), str_buff.Size());
        return output;
    }
        
    int encode_json_val(json_value_t& dest, rapidjson::Document::AllocatorType& allocator) const{

        json_outstream_t out(allocator);
        out.encode("friends", dest, friends);
        return 0;
    }

};

3. encode 和 decode 如何實現

　　通過不斷開發IDL解析器，進一步優化了json的解析和編碼。其中：

　　1> json_instream.h 完成json的decode，依次遍歷struct中的字段，為其賦值。json_instream_t中重載了支持所有類型參數的decode參數。

　　2> json_outstream.h 完成struct 轉json，依次遍歷struct中的字段，將其轉為json value，其重載了支持所有基本類型的encode參數。

　　示例代碼：

    json_outstream_t& encode(const char* filed_name_, json_value_t& jval_, int8_t dest_);
    json_outstream_t& encode(const char* filed_name_, json_value_t& jval_, uint8_t dest_);
    json_outstream_t& encode(const char* filed_name_, json_value_t& jval_, int16_t dest_);
    json_outstream_t& encode(const char* filed_name_, json_value_t& jval_, uint16_t dest_);
    json_outstream_t& encode(const char* filed_name_, json_value_t& jval_, int32_t dest_);
    json_outstream_t& encode(const char* filed_name_, json_value_t& jval_, uint32_t dest_);
    json_outstream_t& encode(const char* filed_name_, json_value_t& jval_, int64_t dest_);
    json_outstream_t& encode(const char* filed_name_, json_value_t& jval_, uint64_t dest_);
    json_outstream_t& encode(const char* filed_name_, json_value_t& jval_, bool dest_);
    json_outstream_t& encode(const char* filed_name_, json_value_t& jval_, float dest_);
    json_outstream_t& encode(const char* filed_name_, json_value_t& jval_, const string& dest_);

 4. TODO 

 　　1. IDL 解析器已經實現了基本功能，下次准備利用此IDL 解析器實現一個聊天服務器。

　　 2. IDL 解析器添加對二進制encode/decode的支持。