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