jsoncpp初探

1.jsoncpp简介

首先说一下JSON。JSON(JavaScript Object Notation) 是一种轻量级的数据交换格式。它基于ECMAScript的一个子集。 JSON采用完全独立于语言的文本格式，这些特性使JSON成为理想的数据交换语言，易于人阅读和编写，同时也易于机器解析和生成，一般用于网络传输。

jsoncpp就是用于生成和解析json的C++开源代码库。 官网见：here，源代码托管在github：here。

除了jsoncpp，可供我们选择的第三方开源的用于解析和生成json的C++库还有很多。比如SimpleJSON、json-spirit和腾讯的RapidJSON，当然还有C语言的cJSON和libJSON。这里之所以介绍jsoncpp是因为我周边的人用的比较多，相比腾讯的RapidJSON，本来是想用RapidJSON，但是到github上一看，被那纷杂的头文件给吓到了，虽然jsoncpp的头文件也很多，但是相对来说还是少很多。还有一点，jsoncpp用的人多，网上解决问题的资源也就相对多一点。

这里贴一张RapidJSON的作者Milo Yip对网上开源的json库的测评图，测试环境[email protected]_mac64_clang6.1_1。

解析json字符串的时间：

具体参见github Milo Yip native-json benchmark。

1.1jsoncpp的内容

(1)JsonCpp主要包含三种类型：Value、Reader和Writer;

Json::Value是jsoncpp 中最基本、最重要的类，用于表示各种类型的对象，jsoncpp 支持的对象类型可见 Json::ValueType 枚举值。

Json::Reader是用于读取的，说的确切点，是用于将字符串转换为 Json::Value 对象的。

Json::Writer类是一个纯虚类，并不能直接使用。在此我们使用 Json::Writer 的子类：Json::FastWriter、Json::StyledWrite、Json::StyledStreamWriter。

(2)Jsoncpp中所有对象、类名都在namespace json中，包含json.h即可

2.jsoncpp下载与编译

第一步：请到github上下载jsoncpp源码，点击这里。

github上托管的是jsoncpp整个项目，包括了很多乱七八糟的文件，比如说明文件README.md，示例代码，构建文件cmake.txt，还有各种乱起八糟的脚本文件，不得不吐槽一下，真的很乱。我们需要的仅仅只是其源码，在说明文件中还没有显明的指出源码的所在目录，这点做的不好啊，看了很多其它的开源项目，不仅仅是jsoncpp没有说明，很多都没有说明。还要自己去摸索，筛选自己真真需要的那几个源码文件，真的很令人头痛。

好了，我们需要的源码文件有目录/include/json/ 下的所有头文件，还有目录/src/lib_json/ 下的源文件。这里我又要吐槽一下（可能我有简洁强迫症），源文件目录下还放scon脚本做甚，更有甚者，还放了个头文件json_tool.h。作者对项目文件的组织管理能力我真不敢恭维啊！要是我，源文件目录绝对只放源文件，还参杂其它的文件做咩。

源文件目录/src/lib_json/ 不需要要的文件见下图的红框，请把它删掉吧，碍眼！

其中CMakeLists.txt是CMake用于构建项目的脚本，sconscript是scons构建项目的脚本，version.h.in是github自动生成的版本信息。删删删，统统删了，用不到。当然你如果使用cmake来构建项目的话， CMakeLists.txt还是有用的。Linux下，我是不用cmake，虽然它简单好用，但是在每个目录下都要加个CMakeLists.txt，真的很碍眼（个人感觉）。而且CMake最终也是要生成makefile来构建项目，为何不手写一个makefile全部搞定。

第二步： 编译。将上面说明的我们需要的源文件和头文件包含到自己的项目中就可以使用啦。当然你也可以单独将jsoncpp编译成静态链接库或者动态链接库来使用。这里贴一下我用于编译的makefile，喜欢手写makefile的朋友可以通通交流。

##################################
# @brief:make scripts
# @date:2016.06.25
# @author:dablelv
##################################

#environment var
VPATH+=src:src/lib_json

CC:=g++
FLAGS=-g -Wall -std=c++11
INC+=-Iinc
LIBDIR+=

CPPDIRS=src src/lib_json

TARGET:=jsoncpptest.out

CPPS=$(shell for dir in ${CPPDIRS};do echo $${dir}/*.cpp;done)

OBJDIR=obj
OBJS=$(patsubst %.cpp,${OBJDIR}/%.o,$(notdir ${CPPS}))

${TARGET}:${OBJS}
    ${CC} ${FLAGS} ${OBJS} -o $@ ${LIBDIR}

${OBJDIR}/%.o:%.cpp
    ${CC} ${FLAGS} ${INC} -o $@ -c $<

.PHONY:clean
clean:
    rm -f ${TARGET} ${OBJDIR}/*

3.jsoncpp使用实例

下面直接上代码。

#include <string.h>

#include <string>
#include <iostream>
using namespace std;

#include "json/json.h"

struct Student{
    char ID[20];
    char name[10];
    int age;
    int gender;
    char major[10]; 
};

string serializeToJson(const Student& student);
Student deserializeToObj(const string& strJson);

int main(int argc, char** argv) {

    Student student;
    strcpy(student.ID,"312822199204085698");
    strcpy(student.name,"dablelv");
    student.age=18;
    student.gender=0;
    strcpy(student.major,"math");

    string strJson=serializeToJson(student);
    cout<<"strJson:"<<strJson<<endl;

    string strJsonNew="{\"ID\":\"201421031059\",\"name\":\"lvlv\",\"age\":18,\"gender\":0}";
    Student resStudent=deserializeToObj(strJsonNew);
    cout<<"resStudent:"<<endl;
    cout<<"ID:"<<resStudent.ID<<endl;
    cout<<"name:"<<resStudent.name<<endl;
    cout<<"age:"<<resStudent.age<<endl;
    cout<<"gender:"<<resStudent.gender<<endl;
    cout<<"major:"<<resStudent.major<<endl;

    return 0;
}

//@brief:将给定的学生对象序列化为json字符串
//@param:student:学生对象
//@ret:json字符串
string serializeToJson(const Student& student){
    //Json::Value root;
    Json::FastWriter writer;
    Json::Value person;

    person["ID"] = student.ID;
    person["name"] = student.name;
    person["age"]=student.age;
    person["gender"]=student.gender;
    person["major"]=student.major;
    //root.append(person);

    string strJson=writer.write(root);
    return strJson;
}

//@brief:将给定的json字符串反序列化为学生对象
//@param:strJson:json字符串
//@ret:学生对象
Student deserializeToObj(const string& strJson){
    Json::Reader reader;
    Json::Value value;
    Student student;
    memset(&student,0,sizeof(Student));

    if (reader.parse(strJson, value)){
        strcpy(student.ID,value["ID"].asString().c_str());
        strcpy(student.name,value["name"].asString().c_str()); 
        student.age=value["age"].asInt(); 
        student.gender=value["gender"].asInt();
        strcpy(student.major,value["major"].asString().c_str());
    }
    return student;
}

程序输出结果：

上面的major输出之所以为空，是因为json字符串中没有major字段。

参考文献

[1]jsoncpp官网
[2]jsoncpp github
[3]native-json benchmark
[4]C++ Jsoncpp源代码编译与解析Json