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

1. 閑序

　　游戲服務器之間通信大多采用異步消息通信。而消息打包常用格式有：google protobuff，facebook thrift， 千千萬萬種自定義二進制格式，和JSON。前三種都是二進制格式，針對C++開發者都是非常方便的，效率和包大小（數據冗余度)也比較理想。而JSON是字符串協議，encode和decode需要不小的開銷。500字節json字符串解析大約需要1ms左右。JSON在腳本語言中非常常見，比如WEB應用、Social Game等，原因是web應用通過多進程分攤了JSON解析的CPU開銷，而且這些應用實時性不強。JSON相對於二進制協議有點就是它是自描述的，調試JSON消息非常的方便，如果消息出錯簡單的將消息log到文件，肉眼即可分辨真偽（眼力不行，有工具相幫http://www.jsoneditoronline.org/，更多工具參見http://json.org/）。事實上json由於是字符串，壓縮傳輸也可以達到比較理想的壓縮比。

　　我們的Social Game 客戶端都是Flash，Flash 工程師們非常喜歡使用Json，幾款游戲Flash和Php通信都是使用Json。新的游戲支持實時對戰，后台使用c++實現，我們仍然采用JSON。在后台計算時為了保證實時性，我們一般把json解析放到網絡線程（多線程），解析成c++的struct 特定類型再post到邏輯線程（單線程）處理。這樣Json的解析可以分攤到多個CPU上，並且不浪費主邏輯線程cpu。

　　目前遇到的問題是，如果每增加一個接口，就增加一個struct，再在網絡處理邏輯函數中增加json解析代碼（包括錯誤處理），再跟flash聯調協議。還有一個挺煩人的時接口文檔每次都要更新，如果直接把定義struct的頭文件給flash，但是貌似不太優雅，還是有份文檔比較正式。

　　我參考了一下google protobuf 和 facebook thrift，想設計如下消息定義方式。

2. 定義idl文件

　　interface description language ？其實我只有消息格式描述，並無接口，但是idl比較容易接受。

　　假如說需要一個消息描述student的數據，那么使用 我定義idl描述其內容如下，student.idl

//! 定義student消息格式，版本號1
stuct student_t(version=1)
{
     //! 描述student需要子類型book
　  struct book_t(version=1)
    {
        //! book中包含兩個字段，ages 16位數字，content字符串，可為空，默認值為”oh nice“

        int16  pages;

    　　string content(default="Oh Nice!");
  　}
     //!　定義年齡，分數，姓名，都是基本類型
     //!　定義ｆｒｉｅｎｄｓ為數組，單項類型為字符串，對應ｊｓｏｎ數組
     //!　定義ｂｏｏｋｓ為字典，ｋｅｙ為字符串，項為ｂｏｏｋ結構，對應ｊｓｏｎ對象結構
　　int8  age;
　　float grade(default=0);
　　string name;
　　array<string>  friends;
　　dictionary<string, book_t> books;
};

3. 使用idl 代碼生成器生成消息定義c++ 頭文件

 　　idl_generator.py student.idl -l cpp -o msg_def.h

      生成msg_def.h

      idl_generator.py@ http://ffown.googlecode.com/svn/trunk/fflib/lib/generator/

4. 使用生成的C++ 消息頭文件

　　生成的頭文件內容是：

  

struct student_t
{
    struct book_t
    {
        int16_t     pages;
        string      contents;
    };
    int8_t              age;
    float               grade;
    string              name;
    vector<string>      friends;
    map<string, book_t> books;
};
//! 模板類，T為回調對象類型，每種msg 類型T中都需要定義相應的handle函數， R代表請求的socket類型指針，這里使用泛型表示
template<typename T, typename R>
class msg_dispather_t
{
    typedef runtime_error        msg_exception_t;//!請求格式出錯，拋出異常
    typedef rapidjson::Document  json_dom_t;　　　//! 使用rapidjson庫實現json解析，但是某個時刻可能替換該庫，故typedef
    typedef rapidjson::Value     json_value_t;   //!　rapidjson源代碼：http://code.google.com/p/rapidjson/
    typedef R                    socket_ptr_t;　　//! 請求socket
    typedef int (msg_dispather_t<T, R>::*reg_func_t)(const json_value_t&, socket_ptr_t); //! 消息對應的解析函數
public:
    msg_dispather_t(T& msg_handler_):
        m_msg_handler(msg_handler_)
    {
        m_reg_func["student_t"] = &msg_dispather_t<T, R>::student_t_dispacher;//! 所有的消息都在構造時注冊解析函數，解析函數是通過idl自動生成的
    }
    int dispath(const string& json_, socket_ptr_t sock_);//! 接口函數，使用者只需單點接入dispatch,消息會自動派發到msg_handler特定的handle函數

private:
    int student_t_dispacher(const json_value_t& jval_, socket_ptr_t sock_)//! 每個消息都會自動生成特定的消息解析函數，前綴為消息名稱
    {
        student_t s_val;
        const json_value_t& age      = jval_["age"];
        const json_value_t& grade    = jval_["grade"];
        const json_value_t& name     = jval_["name"];
        const json_value_t& friends  = jval_["friends"];
        const json_value_t& books    = jval_["books"];
        char buff[512];

        if (false == age.IsNumber())
        {
            snprintf(buff, sizeof(buff), "student::age[int] field needed");
            throw msg_exception_t(buff);
        }
        s_val.age = age.GetInt();
        if (false == grade.IsDouble())
        {
            snprintf(buff, sizeof(buff), "student::grade[float] field needed");
            throw msg_exception_t(buff);
        }
        s_val.grade = grade.GetDouble();
        if (false == name.IsString())
        {
            snprintf(buff, sizeof(buff), "student::name[string] field needed");
            throw msg_exception_t(buff);
        }
        s_val.name = name.GetString();
        if (false == friends.IsArray())
        {
            snprintf(buff, sizeof(buff), "student::friends[Array] field needed");
            throw msg_exception_t(buff);
        }
        for (rapidjson::SizeType i = 0; i < friends.Size(); i++)
        {
            const json_value_t& val = friends[i];
            if (false == val.IsString())
            {
                snprintf(buff, sizeof(buff), "student::friends field at[%u] must string", i);
                throw msg_exception_t(buff);
            }
            s_val.friends.push_back(val.GetString());
        }
        if (false == books.IsObject())
        {
            snprintf(buff, sizeof(buff), "student::books[Object] field needed");
            throw msg_exception_t(buff);
        }
        rapidjson::Document::ConstMemberIterator it = books.MemberBegin();
        for (; it != books.MemberEnd(); ++it)
        {
            student_t::book_t book_val;
            const  json_value_t& name = it->name;
            if (false == name.IsString())
            {
                snprintf(buff, sizeof(buff), "student::books[Object] key must [string]");
                throw msg_exception_t(buff);
            }

            const  json_value_t& val = it->value;
            if (false == val.IsObject())
            {
                snprintf(buff, sizeof(buff), "student::books[Object] value must [Object]");
                throw msg_exception_t(buff);
            }

            const  json_value_t& book_pages   = val["pages"];
            const  json_value_t& book_contens = val["contents"];
            if (false == book_pages.IsNumber())
            {
                snprintf(buff, sizeof(buff), "student::books::pages[Number] field needed");
                throw msg_exception_t(buff);
            }
            book_val.pages    = book_pages.GetInt();
            if (false == book_contens.IsString())
            {
                snprintf(buff, sizeof(buff), "student::books::book_contens[String] field needed");
                throw msg_exception_t(buff);
            }
            book_val.contents = book_contens.GetString();
            s_val.books[name.GetString()] = book_val;
        }

        m_msg_handler.handle(s_val, sock_);//! 由於msg_handler中重載了針對所有消息的handle函數，此函數會被正確的派發到邏輯層
        return 0;
    }

private:
    T&                      m_msg_handler;
    map<string, reg_func_t> m_reg_func;
};

template<typename T, typename R>
int msg_dispather_t<T, R>::dispath(const string& json_, socket_ptr_t sock_)
{
    json_dom_t document;  // Default template parameter uses UTF8 and MemoryPoolAllocator.
    if (document.Parse<0>(json_.c_str()).HasParseError())
    {
        throw msg_exception_t("json format not right");
    }
    if (false == document.IsObject() && false == document.Empty())
    {
        throw msg_exception_t("json must has one field");
    }

    const json_value_t& val = document.MemberBegin()->name;
    const char* func_name   = val.GetString();
    typename map<string, reg_func_t>::const_iterator it = m_reg_func.find(func_name);

    if (it == m_reg_func.end())//! 查找解析派發函數是否存在
    {
        char buff[512];
        snprintf(buff, sizeof(buff), "msg not supported<%s>", func_name);
        throw msg_exception_t(buff);
        return -1;
    }
    reg_func_t func = it->second;

    (this->*func)(document.MemberBegin()->value, sock_);
    return 0;
}

 

 5. 邏輯層處理消息

　　邏輯層不需要編寫繁雜的json解析和錯誤處理，只要沒有觸發異常，消息會自動派發到msg_handler中的handle函數，所以邏輯層只需針對每一個消息類型

都重載一個handle函數即可，示例處理代碼如下：

class msg_handler_t
{
public:
    typedef int socket_ptr_t;
public:
    void handle(const student_t& s_,  socket_ptr_t sock_)
    {
        cout  << "msg_handler_t::handle:\n";
        cout  << "age:" << int(s_.age) << " grade:" << s_.grade << " friends:"<< s_.friends.size() << " name:"
              << s_.name << " books:" << s_.books.size() <<"\n";
    }
};

int main(int argc, char* argv[])
{
    try
    {
        string tmp = "{\"student_t\":{\"age\":123,\"grade\":1.2,\"name\":\"bible\",\"friends\":[\"a\",\"b\"],"
                     "\"books\":{\"bible\":{\"pages\":123,\"contents\":\"oh nice\"}}}}";
        msg_handler_t xxx;
        msg_dispather_t<msg_handler_t, msg_handler_t::socket_ptr_t> p(xxx);
        p.dispath(tmp, 0);
    }
    catch(exception& e)
    {
        cout <<"e:"<< e.what() <<"\n";
    }
}

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

6. More 

　　1> json解析目前使用 rapidjson，號稱效率極佳，此處用它最大的好處是只需包含頭文件即可使用

　　2> 分析解析idl 文件程序使用python編寫(正在編寫中)

　　3> idl 定義中支持namespace 為佳，但考慮復雜性，第一版本暫不支持。

 　  4> 本篇只實現了json to struct，實際上 struct to struct 也很容易實現，json 字符串的第一個字符為'{',而如果采用二進制消息，第一個字符表示消息類型的字符串長度（一個字節足以）,如"sdudent_t",那么首字節應該為9，並且設定首字節首位為1，那么描述類型的字符串長度最大為128個字符（足以了）。放到下篇再搞，睡了。