Jsoncpp 使用方法大全

Json(JavaScript Object Notation ）是一种轻量级的数据交换格式。简而言之，Json组织形式就和python中的字典， C/C++中的map一样，是通过key-value对来组织的，key是任意一个唯一字符串，value可以是bool，int，string 或者嵌套的一个json。关于Json 格式可以参考官方网站。 
Jsoncpp 是一个用来处理 Json文本的开源C++库，下面就简单介绍使用Jsoncpp对Json文件的常见操作。

---

Jsoncpp 常用变量介绍

在Jsoncpp中，有几个常用的变量特别重要，首先介绍一下。

Json::Value

Json::Value 用来表示Json中的任何一种value抽象数据类型，具体来说，Json中的value可以是一下数据类型：

• 有符号整数 signed integer [range: Value::minInt - Value::maxInt]
• 无符号整数 unsigned integer (range: 0 - Value::maxUInt)
• 双精度浮点数 double
• 字符串 UTF-8 string
• 布尔型 boolean
• 空 ‘null’
• 一个Value的有序列表 an ordered list of Value
• collection of name/value pairs (javascript object)

可以通过 [] 的方法来取值。

//Examples:
Json::Value null_value; // null
Json::Value arr_value(Json::arrayValue); // []
Json::Value obj_value(Json::objectValue); // {}

 
 
1
2
3
4
5

Json::Reader

Json::Reader可以通过对Json源目标进行解析，得到一个解析好了的Json::Value，通常字符串或者文件输入流可以作为源目标。

假设现在有一个example.json文件

{
    "encoding" : "UTF-8",
    "plug-ins" : [
        "python",
        "c++",
        "ruby"
        ],
    "indent" : { "length" : 3, "use_space": true }
}
 
 
1
2
3
4
5
6
7
8
9

使用Json::Reader对Json文件进行解析：

bool parse (const std::string &document, Value &root, bool collectComments=true)
bool parse (std::istream &is, Value &root, bool collectComments=true)
 
 
1
2

Json::Value root;
Json::Reader reader;
std::ifstream ifs("example.json");//open file example.json

if(!reader.parse(ifs, root)){
   // fail to parse
}
else{
   // success
   std::cout<<root["encoding"].asString()<<endl;
   std::cout<<root["indent"]["length"].asInt()<<endl;
}
 
 
1
2
3
4
5
6
7
8
9
10
11
12
13

使用Json::Reader对字符串进行解析

bool Json::Reader::parse ( const char * beginDoc,
        const char * endDoc,
        Value & root,
        bool collectComments = true 
    )   
 
 
1
2
3
4
5

  Json::Value root;
  Json::Reader reader;
  const char* s = "{\"uploadid\": \"UP000000\",\"code\": 100,\"msg\": \"\",\"files\": \"\"}"; 
  if(!reader.parse(s, root)){
    // "parse fail";
  }
  else{
      std::cout << root["uploadid"].asString();//print "UP000000"
  }
 
 
1
2
3
4
5
6
7
8
9

Json::Writer

Json::Writer 和 Json::Reader相反，是把Json::Value对象写到string对象中，而且Json::Writer是个抽象类，被两个子类Json::FastWriter和Json::StyledWriter继承。 
简单来说FastWriter就是无格式的写入，这样的Json看起来很乱没有格式，而StyledWriter就是带有格式的写入，看起来会比较友好。

Json::Value root;
Json::Reader reader;
Json::FastWriter fwriter;
Json::StyledWriter swriter;

if(! reader.parse("example.json", root)){
// parse fail
    return 0;
}
std::string str = fwriter(root);
std::ofstream ofs("example_fast_writer.json");
ofs << str;
ofs.close();

str = swriter(root);
ofs.open("example_styled_writer.json");
ofs << str;
ofs.close();

 
 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

结果： 
example_styled_writer.json

{
    "encoding" : "UTF-8",
    "plug-ins" : [
        "python",
        "c++",
        "ruby"
        ],
    "indent" : { "length" : 3, "use_space": true }
}
 
 
1
2
3
4
5
6
7
8
9

example_fast_writer.json

{"encoding" : "UTF-8","plug-ins" : ["python","c++","ruby"],"indent" : { "length" : 3, "use_space": true}}
 
 
1

---

Jsoncpp 其他操作

通过前面介绍的Json::value, Json::Reader, Json::Reader 可以实现对Json文件的基本操作，下面介绍一些其他的常用的操作。

判断key是否存在

bool Json::Value::isMember ( const char * key) const

Return true if the object has a member named key.

Note
    'key' must be null-terminated. 

bool Json::Value::isMember ( const std::string &  key) const
bool Json::Value::isMember ( const char* key, const char * end ) const

 
 
1
2
3
4
5
6
7
8
9
10

// print "encoding is a member"
if(root.isMember("encoding")){
    std::cout<<"encoding is a member"<<std::endl;
}
else{
    std::cout<<"encoding is not a member"<<std::endl;
}

// print "encode is not a member"
if(root.isMember("encode")){
    std::cout<<"encode is a member"<<std::endl;
}
else{
    std::cout<<"encode is not a member"<<std::endl;
}
 
 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

判断Value是否为null

首先要给example.json添加一个key-value对：

{
    "encoding" : "UTF-8",
    "plug-ins" : [
        "python",
        "c++",
        "ruby"
    ],
    "indent" : { "length" : 3, "use_space": true },
    "tab-length":[],
    "tab":null
}
 
 
1
2
3
4
5
6
7
8
9
10
11

判断是否为null的成员函数

bool Json::Value::isNull ( ) const
 
 
1

if(root["tab"].isNull()){
    std::cout << "isNull" <<std::endl;//print isNull
}
 
 
1
2
3

if(root.isMember("tab-length")){//true
    if(root["tab-length"].isNull()){
      std::cout << "isNull" << std::endl;
    }
    else std::cout << "not Null"<<std::endl;
    // print "not Null", there is a array object([]), through this array object is empty
    std::cout << "empty: " << root["tab-length"].empty() << std::endl;//print empty: 1
    std::cout << "size: " << root["tab-length"].size() << std::endl;//print size: 0
  }
 
 
1
2
3
4
5
6
7
8
9

另外值得强调的是，Json::Value和C++中的map有一个共同的特点，就是当你尝试访问一个不存在的 key 时，会自动生成这样一个key-value默认为null的值对。也就是说

 root["anything-not-exist"].isNull(); //false
 root.isMember("anything-not-exist"); //true
 
 
1
2

总结就是要判断是否含有key，使用isMember成员函数，value是否为null使用isNull成员函数，value是否为空可以用empty() 和 size()成员函数。

得到所有的key

typedef std::vector<std::string> Json::Value::Members

Value::Members Json::Value::getMemberNames ( ) const

Return a list of the member names.

If null, return an empty list.

Precondition
    type() is objectValue or nullValue 

Postcondition
    if type() was nullValue, it remains nullValue 


 
 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

可以看到Json::Value::Members实际上就是一个值为string的vector，通过getMemberNames得到所有的key。

删除成员

Value Json::Value::removeMember( const char* key)   

Remove and return the named member.
Do nothing if it did not exist.

Returns
    the removed Value, or null. 

Precondition
    type() is objectValue or nullValue 

Postcondition
    type() is unchanged 

Value Json::Value::removeMember( const std::string & key)   

bool Json::Value::removeMember( std::string const &key, Value *removed)         

Remove the named map member.
Update 'removed' iff removed.

Parameters
    key may contain embedded nulls.

Returns
    true iff removed (no exceptions) 


 
 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28

---

参考

http://open-source-parsers.github.io/jsoncpp-docs/doxygen/index.html