JSON解析器實現（C++）

JSON介紹

JSON(JavaScript Object Notation) 是一種輕量級的數據交換格式。 易於人閱讀和編寫。同時也易於機器解析和生成。 它基於JavaScript Programming Language, Standard ECMA-262 3rd Edition - December 1999的一個子集。 JSON采用完全獨立於語言的文本格式，但是也使用了類似於C語言家族的習慣（包括C, C++, C#, Java, JavaScript, Perl, Python等）。 這些特性使JSON成為理想的數據交換語言。

JSON建構於兩種結構：

• “名稱/值”對的集合（A collection of name/value pairs）。不同的語言中，它被理解為對象（object），紀錄（record），結構（struct），字典（dictionary），哈希表（hash table），有鍵列表（keyed list），或者關聯數組 （associative array）。
• 值的有序列表（An ordered list of values）。在大部分語言中，它被理解為數組（array）。

這些都是常見的數據結構。事實上大部分現代計算機語言都以某種形式支持它們。這使得一種數據格式在同樣基於這些結構的編程語言之間交換成為可能。

 

JSON數據結構

對象是一個無序的“‘名稱/值’對”集合。一個對象以“{”（左括號）開始，“}”（右括號）結束。每個“名稱”后跟一個“:”（冒號）；“‘名稱/值’ 對”之間使用“,”（逗號）分隔。

數組是值（value）的有序集合。一個數組以“[”（左中括號）開始，“]”（右中括號）結束。值之間使用“,”（逗號）分隔。

值（value）可以是雙引號括起來的字符串（string）、數值(number)、true、false、 null、對象（object）或者數組（array）。這些結構可以嵌套。

字符串（string）是由雙引號包圍的任意數量Unicode字符的集合，使用反斜線轉義。一個字符（character）即一個單獨的字符串（character string）。

字符串（string）與C或者Java的字符串非常相似。

數值（number）也與C或者Java的數值非常相似。除去未曾使用的八進制與十六進制格式。除去一些編碼細節。

空白可以加入到任何符號之間。 以下描述了完整的語言。

注意：以上上幾張圖，是我們進行解析的關鍵。

 

定義基本的數據結構

首先定義JSON數據類型：

enum JSONVALUETYPE
{
    JSONVALUETYPE_NULL,   ///< @brief 空類型
    JSONVALUETYPE_BOOL,   ///< @brief 邏輯類型
    JSONVALUETYPE_NUMBER, ///< @brief 數字類型
    JSONVALUETYPE_STRING, ///< @brief 字符串類型
    JSONVALUETYPE_LIST,   ///< @brief 表類型
    JSONVALUETYPE_DICT,   ///< @brief 字典類型
};

接着定義JSON的基本數據結構：

根據上面幾張圖，可知JSON的數據結構有以下幾種：number，string，array，object，給出如下數據結構的定義：

////////////////////////////////////////////////////////////////////////////////
/// @brief JSON值
////////////////////////////////////////////////////////////////////////////////
class JsonValue
{
    friend class JsonString;
    friend class JsonList;
    friend class JsonDict;
    friend class Json;
protected:
    JSONVALUETYPE m_Type;  ///< @brief JSON對象類型
    /// @brief 數據域
    union
    {
        bool m_ValueBool;     ///< @brief 邏輯型
        double m_ValueNumber; ///< @brief 數字型
    };
public:
    /// @brief      寫到字符串
    /// @param[out] OutStr 輸出的目的字符串
    virtual void writeToStr(std::string& OutStr);
public: //用於接口轉換
    virtual JsonString* toString();   ///< @brief 轉換到字符串
    virtual JsonList* toList();       ///< @brief 轉換到數組
    virtual JsonDict* toDict();       ///< @brief 轉換到字典
public: //類型轉換
    JSONVALUETYPE getType();       ///< @brief 返回類型

    bool toNull();                 ///< @brief 轉換到NULL
    ///< @note  true表示NULL，false表示非NULL
    bool toBool();                 ///< @brief 轉換到Bool
    ///< @note  true表示true，false表示非false
    double toNumber();             ///< @brief 到數字
    ///< @brief 非Number型用0表示
public: // 值類型操作，非值類型返回false
    bool setValue();                 ///< @brief 設置為NULL
    ///< @return 如果對象不是值類型，則返回假
    bool setValue(bool Value);         ///< @brief 設置為bool
    ///< @return 如果對象不是值類型，則返回假
    bool setValue(double Value);     ///< @brief 設置為數字
    ///< @return 如果對象不是值類型，則返回假
public: // 用於手動創建
    JsonValue();                       ///< @brief 創建為null值類型
    JsonValue(bool Value);             ///< @brief 創建為bool值類型
    JsonValue(double Value);           ///< @brief 創建為數值類型
    JsonValue(JSONVALUETYPE Type);     ///< @brief 創建為String/List/Dict
    virtual ~JsonValue();
};

////////////////////////////////////////////////////////////////////////////////
/// @brief JSON字符串
////////////////////////////////////////////////////////////////////////////////
class JsonString : public JsonValue
{
protected:
    std::string m_Str;   ///< @brief 字符串字面值
public:
    void writeToStr(std::string& OutStr);
public: //用於接口轉換
    JsonString* toString();   ///< @brief 轉換到字符串
public:
    std::string getStr();           ///< @brief 獲得字符串
    void setStr(std::string Value); ///< @brief 設置字符串
public:
    /// @brief     構造函數
    /// @param[in] Value 字符串值
    JsonString(std::string Value);
    ~JsonString();
};

////////////////////////////////////////////////////////////////////////////////
/// @brief JSON數組
/// @note  JsonList將會負責銷毀子對象
////////////////////////////////////////////////////////////////////////////////
class JsonList : public JsonValue
{
protected:
    std::vector<JsonValue*> m_ObjList;   ///< @brief 內部數組
public:
    void writeToStr(std::string& OutStr);
public: //用於接口轉換
    JsonList* toList();       ///< @brief 轉換到數組

public:
    /// @brief     獲得對象
    /// @param[in] Index 索引
    /// @return    如果索引不存在返回NULL，否則返回對象指針
    JsonValue* getValue(int Index);

    /// @brief     設置對象
    /// @param[in] Index 索引
    /// @param[in] pNew  對象指針
    /// @return    返回操作是否成功
    bool setValue(int Index, JsonValue* pNew);

    /// @brief     往數組末端追加對象
    /// @param[in] pNew 對象指針
    void append(JsonValue* pNew);

    /// @brief 清空
    void clear();

    /// @brief 返回對象數量
    int getCount();
public:
    /// @brief 構造函數
    JsonList();
    ~JsonList();
};

////////////////////////////////////////////////////////////////////////////////
/// @brief JSON字典
////////////////////////////////////////////////////////////////////////////////
class JsonDict : public JsonValue
{
protected:
    std::vector<std::string> m_ObjList;                      ///< @brief 對象數組
    std::unordered_map<std::string, JsonValue*> m_Cache;  ///< @brief 對象字典緩存
public:
    void writeToStr(std::string& OutStr);
public: //用於接口轉換
    JsonDict* toDict();       ///< @brief 轉換到字典
public:
    /// @brief      返回對象
    /// @param[in]  Index 對象索引
    /// @param[out] pKeyOut 鍵
    /// @return     返回對象指針，若索引越界返回NULL
    JsonValue* getValue(int Index, std::string* pKeyOut = NULL);

    /// @brief     返回對象
    /// @param[in] Name 對象鍵名
    /// @return    返回對象指針，若不存在對象返回NULL
    JsonValue* getValue(std::string Name);

    /// @brief     設置對象
    /// @note      如果對象已經存在則會釋放原有對象
    /// @param[in] Name 對象鍵名
    /// @param[in] pNew 對象指針
    void setValue(std::string Name, JsonValue* pNew);

    /// @brief     是否包含對象
    /// @param[in] Name 對象的鍵名
    /// @return    true=包含對象，false=沒包含對象
    bool contain(std::string Name);

    /// @brief     移除對象
    /// @param[in] Index 對象鍵名
    /// @return    true=成功，false=失敗
    bool remove(std::string Index);

    /// @brief 清空
    void clear();

    /// @brief 返回元素個數
    int getCount();
public:
    /// @brief 構造函數
    JsonDict();
    ~JsonDict();
};

 

開始解析JSON

解析string：

根據上圖中string的狀態轉換圖可以實現string數據類型的解析。同理可以實現數組，對象的解析。

JsonString* Json::parseString(Reader& Context)  ///< @brief 解析一個字符串
{
    std::string tRet;
    Context.match('"', true);
    char tChar;
    while ((tChar = Context.readChar()) != '"')
    {
        if (iscntrl(tChar))
        {
            throw ReaderException("Json::parseString", "Unexpected char.", Context.getLine(), Context.getRow());
        }

        if (tChar == '\\')
        {
            tChar = Context.readChar();
            switch (tChar)
            {
            case '"':
                tRet += "\"";
                break;
            case '\\':
                tRet += "\\";
                break;
            case '/':
                tRet += "/";
                break;
            case 'b':
                tRet += "\b";
                break;
            case 'f':
                tRet += "\f";
                break;
            case 'n':
                tRet += "\n";
                break;
            case 'r':
                tRet += "\r";
                break;
            case 't':
                tRet += "\t";
                break;
            case 'u':
                throw ReaderException("Json::parseString", "Unexpected char.", Context.getLine(), Context.getRow());
                break;
            default:
            {
                throw ReaderException("Json::parseString", "Unexpected char.", Context.getLine(), Context.getRow());
                break;
            }
            }
        }
        else
        {
            tRet += tChar;
        }
    }
    return new JsonString(tRet.c_str());
}

 

完整代碼已經發布在github上，如感興趣可以參考學習；水平有限，如有不足，還請批評指正。

貼上項目地址：https://github.com/yongssu/json