关于CPP——JsonCpp库的使用

已于 2024-09-06 13:00:42 修改
阅读量2.5k 收藏 17
点赞数 10
分类专栏： 从零实现Json_Rpc框架 文章标签： json c++
于 2024-09-03 16:11:07 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/m0_75186846/article/details/141817332
版权

目录

一、Json数据格式

二、JsonCpp介绍

2.1 Json::Value

2.2 序列化接口

2.3 反序列化接口

三、JsonCpp的使用

3.1 头文件包含

3.2 序列化

3.3 反序列化

四、补充

Json 是⼀种数据交换格式，它采⽤完全独⽴于编程语⾔的⽂本格式来存储和表示数据。

一、Json数据格式

Json 的数据类型包括对象，数组，字符串，数字等。
• 对象：使⽤花括号 { } 括起来的表⽰⼀个对象
• 数组：使⽤中括号 [ ] 括起来的表⽰⼀个数组
• 字符串：使⽤常规双引号 " " 括起来的表示⼀个字符串
• 数字：包括整形和浮点型，直接使用

C语言 代码表示：

char *name = "张三";
int age = 18;
int score[3] = { 100, 110, 96 };

Json 表示：

{
    "姓名" : "张三",
    "年龄" : 18,
    "成绩" : [100, 110, 96],
    "喜欢的人" ：{
        "姓名" : "小丽",
        "年龄" : "18",
        "成绩" : [ 110, 112, 110]
    }
}

注意，在Json中，每个对象的各个数据用 , 分割，最后一行数据不需要使用 ,  

二、JsonCpp介绍

上述 Json 只是为我们提供了一种格式，具体的实现还需要每种语言配有对应的框架，这里我们就开始认识一下 JsonCpp ，主要学习其中的三个类即可。

2.1 Json::Value

如果要将数据对象进行序列化，就需要先将对象存储到 Json::Value 对象中
如果要将数据传输后进行反序列化，即解析，会将数据对象放入到 Json::Value 对象中

class Json::Value
{
    Value &operator=(const Value &other); //Value重载了[]和=，因此所有的赋值和获取数据都可以通过 = 
    Value& operator[](const std::string& key); //简单的⽅式完成 val["name"] = "xx";
    Value& operator[](const char* key);
    Value removeMember(const char* key); //移除元素
    const Value& operator[](ArrayIndex index) const; //val["score"][0]
    Value& append(const Value& value); //添加数组元素val["score"].append(88);
    ArrayIndex size() const; //获取数组元素个数 val["score"].size();
    std::string asString() const; //转string string name = val["name"].asString();
    const char* asCString() const; //转char* char *name = val["name"].asCString();
    Int asInt() const; //转int int age = val["age"].asInt();
    float asFloat() const; //转float float weight = val["weight"].asFloat();
    bool asBool() const; //转 bool bool ok = val["ok"].asBool();
};

下面简单认识一下其中的部分成员：

= 运算符重载：Value 重载了[]和=，因此所有的赋值和获取数据都可以通过 = 来赋值

[] 运算符重载：Value 重载了[]和=，因此所有的赋值和获取数据都可以通过 = 来赋值

例：val ["name"] = "张三"

[] 运算符重载：使 Value 中的数组成员可以直接使用下标访问

例： val["score"][0]

append 函数：直接追追加 Value 中的数组成员

例： val["score"].append(89) 如果不使用append，89会覆盖上一个score成员！

size 函数：返回 Value 中的数组成员的数量，方便遍历某成员

2.2 序列化接口

class JSON_API StreamWriter 
{
    virtual int write(Value const& root, std::ostream* sout) = 0;
}
class JSON_API StreamWriterBuilder : public StreamWriter::Factory 
{
    virtual StreamWriter* newStreamWriter() const;
}

重点是 StreamWriter::write() 作为序列化函数，

其中，Json::StreamWriterBuilder 是继承自 Json::StreamWriter 的工厂类，用于生产 Json::StreamWriter 对象

write 写入成功时，会返回一个0，不成功则会返回非0

第一个参数指的是要进行序列化的 Json::Value 对象

第二个参数指的是要写入的输出流

2.3 反序列化接口

class JSON_API CharReader 
{
    virtual bool parse(char const* beginDoc, char const* endDoc, Value* root, std::string* errs) = 0;
}
class JSON_API CharReaderBuilder : public CharReader::Factory 
{
    virtual CharReader* newCharReader() const;
}

重点是 Json::CharReader::parse() 作为反序列化函数，

其中，Json::CharReaderBuilder 是继承自 Json::CharReader 的工厂类，用于生产 Json::CharReader 对象

parse 返回值是布尔类型，若 parse 成功返回 true，反之返回 true

第一个参数是要反序列化数据的起始地址

第二个参数是要反序列化数据的末尾地址

第三个参数是反序列化后数据要写入的 Json::Value 对象，要进行地址传参

第四个参数是报错信息，可以定义一个 std::string 对象进行地址传参

三、JsonCpp的使用

3.1 头文件包含

如果你的环境中已经安装了 Json 库，那么我们只需要 jsoncpp/json/json.h 文件，所以头文件如下

#include <iostream>
#include <string>
#include <jsoncpp/json/json.h>

此外，如果使用 makefile ，还需要连接上 jsoncpp ，这里我将序列化和反序列化的 demo 分成了两个文件，如下：

all:Serialize unSerialize
Serialize:Serialize.cpp
	g++ -o $@ $^ -std=c++11 -ljsoncpp
unSerialize:unSerialize.cpp
	g++ -o $@ $^ -std=c++11 -ljsoncpp
.PHONY:clean
clean:
	rm -rf unSerialize Serialize

3.2 序列化

可以先定义变量存储我们需要传入 Json::Value 的值，然后直接定义一个 Json::Value 的对象，并为对象赋值。

随后需要序列化时不能直接使用 Json::StreamWriter ，而是要先定义一个 Json::StreamWriterBuilder 对象，再创建一个 Json::StreamWriter 对象的指针接收由 Json::StreamWriterBuilder 对象调用其 newStreamWriter() 的返回值。

最后，可以使用 writer 函数，并指定输出流对象。

//数据序列化
void Serialize()
{
    const char* name = "XiaoMing";
    const char*sex = "Man";
    int age = 18;
    int score[3] = { 100, 110, 96 };

    Json::Value student;
    student["Name"] = name;
    student["Sex"] = sex;
    student["Age"] = age;
    student["Score"].append(score[0]);
    student["Score"].append(score[1]);
    student["Score"].append(score[2]);

    //定义工厂类对象
    Json::StreamWriterBuilder swb;
    Json::StreamWriter *sw(swb.newStreamWriter());
    sw->write(student, &std::cout);
    std::cout << std::endl;

    delete sw;
}

int main()
{
    Serialize();
    return 0;
}

同时，还需要释放 Json::StreamWriter 对象的内存，以后会进行进一步优化。 

3cc4212340eb467eab45a5eadc20f7e5.png

为了避免内存泄露，可以使用智能指针管理 Json::StreamWriter 对象，同时，为了代码更加简洁，可以对 Serialize() 进一步封装。将要序列化的信息作为传入参数，并使用输出型参数以字符串的方式输出序列化后的信息中，这里要使用到 stringstream 用作数据的缓冲区，用于 Json::Value 格式转换到 std::string 格式。

将序列化后的信息带回到字符串后，可以打印出字符串的信息来查看序列化后的信息。

#include <iostream>
#include <string>
#include <sstream>
#include <memory>
#include <jsoncpp/json/json.h>

//数据序列化
bool Serialize(const Json::Value &val, std::string &body)
{
    //中间缓冲区，将 Json::Value 格式转换为 std::string 格式
    std::stringstream ss;
    //定义工厂类对象
    Json::StreamWriterBuilder swb;
    std::unique_ptr<Json::StreamWriter> sw(swb.newStreamWriter());
    //如果 write 返回值不为零，则错误
    int ret = sw->write(val, &ss);
    if (ret != 0)
    {
        std::cout << "Serialize Error!";
        return false;
    }
    body = ss.str();
    return true;
}

int main()
{
    const char* name = "XiaoMing";
    const char*sex = "Man";
    int age = 18;
    int score[3] = { 100, 110, 96 };

    Json::Value student;
    std::string body;
    student["Name"] = name;
    student["Sex"] = sex;
    student["Age"] = age;
    student["Score"].append(score[0]);
    student["Score"].append(score[1]);
    student["Score"].append(score[2]);
    Serialize(student, body);
    //打印字符串信息
    std::cout << body << std::endl;

    return 0;
}

3cc4212340eb467eab45a5eadc20f7e5.png

可以看到序列化的结果是一样的。

3.3 反序列化

反序列化我们直接使用封装，先定义一个工厂类 Json::CharReaderBuilder，然后使用工厂类生成一个 Json::CharReader 对象，调用该对象的类内方法 parse 进行反序列化。

//数据反序列化
bool unSerialize(std::string &body, Json::Value &val)
{
    //定义工厂类
    Json::CharReaderBuilder crb;
    std::unique_ptr<Json::CharReader> cr(crb.newCharReader());
    //错误信息缓冲区
    std::string errs;
    bool ret = cr->parse(body.c_str(), body.c_str() + body.size(), &val, &errs);
    if (ret == false)
    {
       std::cout << "unSerialize Error!";
       return false; 
    }
    return true;
}

在进行测试时，可以直接自定义一个序列化字符串，在 R"()" 的小括号中定义出序列化的信息，然后使用 Json::Value 进行接收并分别打印：

int main()
{
    //序列化数据
    std::string s = R"({"Name":"XiaoHong", "Sex":"Woman", "Age":18})";
    //反序列化后的结果填入 Json::Value 中
    Json::Value stu;
    bool ret = unSerialize(s, stu);
    if (ret == false)
    {
        return -1;
    }
    std::cout << "Name:" << stu["Name"].asString() << " Sex:" << stu["Sex"].asString() << " Age:" << stu["Age"].asString() << std::endl; 
    return 0;
}

同时，在输出时，可以使用字符串 
cea3dde51cfd4bac80e7ead12c356c38.png

四、补充

4.1 中文乱码

Json 也可以使用中文，如果你使用中文是乱码的话，如下：
de023312a0d84c17a47d37655cfaaad2.png
那你可以在定义工厂类对象后添加以下信息：
081f95e92d0242cc9c59a39a39c75383.png

// 设置 emitUTF8 使其输出原始的 UTF-8 编码而不是转义序列
swb["emitUTF8"] = true;

此时再重新编译，就可以得到不乱码的中文结果：
1469cd888e344ea3a3694e1ad15b38b3.png

4.2 demo 源码

源码链接如下，有需要的可以参考 demo 源码：

从零实现JsonRpc框架: CPP项目——从零实现JsonRpc项目博客链接：https://blog.csdn.net/m0_75186846/category_12772639.html - Gitee.comhttps://gitee.com/bright-and-sparkling-at-night/JsonRpc/tree/master/demo/jsoncpp

 

【C++】开源：jsoncpp库安装与使用入门
DevFrank的博客
05-25 4037
jsoncpp库入门
Jsoncpp 使用方法大全
热门推荐
好记性不如烂笔头
10-07 4万+
JsoncppJson(JavaScript Object Notation ）是一种轻量级的数据交换格式。简而言之，Json组织形式就和python中的字典， C/C++中的map一样，是通过key-value对来组织的，key是任意一个唯一字符串，value可以是bool，int，string 或者嵌套的一个json。关于Json 格式可以参考官方网站。 Jsoncpp 是一个用来处理 Js
json库——jsoncpp
qq_43441284的博客
06-01 1万+
Notation）是一种轻量级的数据交换格式，常用于在不同系统之间传输和存储数据。它具有以下特点：可读性：JSON使用文本格式表示数据，易于阅读和理解。它采用了类似于JavaScript对象的键值对的形式来组织数据。简洁性：JSON的语法非常简洁，相比于其他数据格式（如XML），它的数据表示更为紧凑，节省了传输和存储空间。支持多种数据类型：JSON支持多种基本数据类型，包括字符串、数字、布尔值、数组、对象和null。这使得JSON非常灵活，可以表示各种类型的数据结构。
Jsoncpp 库的使用与实践
最新发布
weixin_72040293的博客
03-29 660
Jsoncpp 是一个强大的 C++库，用于处理 Json 数据。它支持将数据对象序列化为 Json 格式的字符串，以及将 Json 字符串反序列化为数据对象。本文将通过具体示例，展示如何使用 Jsoncpp 库进行数据操作，包括对象和数组的创建、赋值、获取、移除元素以及类型转换等。通过这些示例，读者可以快速掌握 Jsoncpp 的使用方法，并应用于实际项目中。
轻量级数据交换格式:jsoncpp
RNGWGzZs的博客
06-27 676
因此，为了便于人阅读、编写，机器的生成和解析，json、protobuf等常见的数据交换格式接踵而至，在提高可读性的同时，有效提升了网络传输的效率。我想通过网路进行传输，这些从语言上来看定义出的数据，我该用什么样的方式。可是，一旦程序进行编译后，任何数据都是二进制代码，完全不便于人们进行观察。我们完成了简单的json序列化反序列化接口的认识，我们"乘火打劫"，写个简单的序列化反序列化代码。Json的数据类型包括对象，数组，字符串，数字等……⑤ 反序列化后的内容 在Json::Value的对象里。
JsonCpp基本用法
11-09
JsonCpp库在MFC工程中的基本用法，VS2012下C++编译通过，可运行
C++ JsonCpp 使用(含源码下载)
weixin_33857679的博客
01-03 362
前言 JSON是一个轻量级的数据定义格式，比起XML易学易用，而扩展功能不比XML差多少，用之进行数据交换是一个很好的选择JSON的全称为：JavaScript Object Notation ，顾名思义，JSON是用于标记javascript对象的，详情参考http://www.json.org/。本文选择第三方库JsonCpp来解析json,JsonCpp是比较出名的c++解析库,在json...
Jsoncpp库使用
turing__66的博客
07-21 1194
Json是一种轻量级的数据交换格式。Json组织形式就和C/C++中的map一样，是通过key-value对来组织的，key是任意一个唯一字符串，value可以是bool，int，string 或者嵌套的一个json。是一个用来处理 Json文本的开源C++库。
【项目组件】第三方库——Jsoncpp
m0_73904148的博客
11-18 1383
Json是⼀种数据交换格式，它采用完全独立于编程语⾔的⽂本格式来存储和表示数据。例如: 我们想表示⼀个同学的学⽣信息。
【C++】JSON数据解析——jsoncpp的使用（下）
altairdipper的专栏
05-26 3133
版权所有，转载请注明： 上一篇介绍了jsoncpp
VC6环境下jsoncpp库操作JSON数据的使用示例
在VC6中操作JSON数据类型，通常需要借助一个开源库——jsoncpp。jsoncpp是一个用C++编写的库，它能够帮助开发者在C++程序中解析和生成JSON格式的数据。VC6，即Visual C++ 6.0，是微软公司在1998年发布的经典版本的...
第三方库jsoncpp
weixin_66484088的博客
08-02 501
jsoncpp库用于实现json格式的序列化和反序列化，完成将多个数据对象组织成为json格式字符串，以及将json格式字符串解析到多个数据对象的功能。Json::Value类——（使用StreamWriter类进行序列化）——》json格式的字符串。json格式字符串——（使用CharReader类进行反序列化）——》Json::Value类。用于对json格式字符串反序列化，将数据对象存储到一个Json::Value对象中。用于对Json::Value中的数据进行序列化。
JSONCPP介绍
dcldz5007的博客
05-25 338
描述JSON串 如何使用jsoncpp提供的数据结构来存储如下JSON串？ // Configuration options { // Default encoding for text "encoding" : "UTF-8", // Plug-ins loaded at start-up "plug-ins" : [ "python"...
Jsoncpp使用简介
2301_76606232的博客
10-30 1322
表示 JSON 数据中的各种值类型。：用于解析 JSON 字符串。和：用于将对象转换为 JSON 字符串。和：提供了更灵活的 JSON 解析选项。
JsonCpp的使用方法
huanggang982的专栏
03-07 1425
jsoncpp官方网站 http://jsoncpp.sourceforge.net(https://github.com/open-source-parsers/jsoncpp) JsonCpp的简单使用方法 转自：http://www.cnblogs.com/ytjjyy/archive/2012/04/17/2453348.html JsonCpp 是一个C++用来处理JSON
jsoncpp使用方法
Wu_Yimin的博客
06-19 384
//定义json Json::Value json; Json::FastWriter writer; //加字段 json["linewidth"] = 1; Json::Value point; point["topLeft_x"] = 1; //json里加json json["paintdata"] = point; /...
Jsoncpp简单使用
Scl_Diligent的博客
04-15 541
Jsoncpp是个跨平台的C++开源库，提供的类为我们提供了很便捷的操作，而且使用的人也很多。新API使用方法参考（new出内存，新的API如果反复调用的话会产生大量内存碎片）jsoncpp库中的类被定义到了一个Json命名空间中。Value -> 对Json支持的数据类型进行封装/解析。旧API使用方法参考。
jsoncpp 库的使用
qq_42161913的博客
10-12 790
jsoncpp 库的使用
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值