Rapidjson 实战

Rapidjson 是一款 C++ 的 json 库. 支持处理 json 格式的文档. 其设计风格是头文件库, 包含头文件即可使用, 小巧轻便并且性能强悍. 本文结合样例来介绍 Rapidjson 一些常见的用法.

环境要求

有如何的几种方法可以将 Rapidjson 集成到您的项目中.

  1. Vcpkg安装: 使用 vcpkg install rapidjson即可. 如果不熟悉 vcpkg 请参考我的文章: [C++包管理工具-Vcpkg 简介]({{< relref “2024-07-29-cpp-package-management.md” >}}).

  2. CMake 的FetchContent_Declare方法.

    # 引入 FetchContent 模块
include(FetchContent)

# 设置 Rapidjson 编译选项
set(RAPIDJSON_BUILD_TESTS OFF CACHE INTERNAL "")
set(RAPIDJSON_BUILD_DOC OFF CACHE INTERNAL "")
set(RAPIDJSON_BUILD_EXAMPLES OFF CACHE INTERNAL "")
set(RAPIDJSON_BUILD_CXX20 ON CACHE INTERNAL "")

FetchContent_Declare(
    rapidjson
    URL https://github.com/Tencent/rapidjson/archive/refs/tags/v1.1.0.zip
)
FetchContent_MakeAvailable(rapidjson)

  3. 源码安装: 下载源码并将其路径加入include目录列表中: gcc -I /path/to/rapidjson

基础用法

解析 json

auto input = R"({"name": "华安", "id": 9527})";
rapidjson::Document doc;

doc.Parse(input);
if (doc.HasParseError()) {
  return -1;
}

访问元素

检查并获取

HasMember 查询 key 是否存在, 然后使用Is方法来判断类型是否兼容, 最后用Get方法来获取对应的值.

if (doc.HasMember("name") && doc["name"].IsString()) {
  std::string name = doc["name"].GetString();
  std::cout << "name is: " << name << std::endl;
}
if (doc.HasMember("id") && doc["id"].IsInt()) {
  int id = doc["id"].GetInt();
  std::cout << "id is: " << id << std::endl;
}
使用FindMember减少查询开销

上述示例中, doc["name"]被使用了两次, 相当于创建了两个临时变量. 使用FindMember方法则可以减少这种额外开销.

if (auto it = doc.FindMember("name");
    it != doc.MemberEnd() && it->value.IsString()) {
  std::string name = it->value.GetString();
  std::cout << "name is: " << name << std::endl;
}

if (auto it = doc.FindMember("id");
    it != doc.MemberEnd() && it->value.IsInt()) {
  auto id = it->value.GetInt();
  std::cout << "id is: " << id << std::endl;
}
访问对象(Object)

查询方法与前面的基础类型相似. 需要注意的是, GetObject()方法返回的是一个const引用.
Rapidjson 为了提高效率, 接口的设计上避免使用对象拷贝.

auto response =
    R"({"code":200,"data":{"total":200,"curr":[12345,23456,34564]}})";

rapidjson::Document doc;

if (doc.Parse(response).HasParseError()) {
  return -1;
}

if (auto it = doc.FindMember("data");
    it != doc.MemberEnd() && it->value.IsObject()) {
  const auto& data = it->value.GetObject();
  // ...
}
访问数组(Array)

我们用IsArray()和GetArray()来判断和获取对应的数据.

需要注意的是: json 中的数组是允许多个不同类型的, 如下是一个合法的 json:

{
  "array": ["string", true, null, [], {}, 123]
}

但是 C++ 的数组或者容器vector仅支持相同的元素, 所以我们在获取数组元素时需要注意判断元素类型.

for (auto it = curr.Begin(); it != curr.End(); ++it) {
  if (it->IsInt()) {
    std::cout << it->GetInt() << std::endl;
  }
}

由于 rapidjson 支持range based for, 我们可以这样写:

for (const auto& item : curr) {
  if (item.IsInt()) {
    std::cout << item.GetInt() << std::endl;
  }
}

生成 json 对象

基础类型

对于基础类型(整型, 布尔值, 浮点数)我们可以直接使用AddMember添加, 需要注意的是接口中需要指定一个Allocator.

rapidjson::Document doc(rapidjson::kObjectType);
doc.AddMember("name", "华安", doc.GetAllocator());
doc.AddMember("id", 9527, doc.GetAllocator());
doc.AddMember("is_intern", true, doc.GetAllocator());

此时doc的内容为:

{ "name": "华安", "id": 9527, "is_intern": true }

为了减少对GetAllocator()的调用, 可以使用一个变量保存该结果, 见后续代码.

添加对象

一个 Object 对象可以用rapidjson::Value表示. 其添加成员的方法是AddMember(rapidjson::Document是rapidjson::Value的衍生类).

对于特殊值null, 我们可以使用SetNull()方法或者在构造函数中指定rapidjson::kNullType来实现.

rapidjson::Value contact(rapidjson::kObjectType);

rapidjson::Value email;
email.SetNull();  // 设置为null
contact.AddMember("email", email, allocator);

contact.AddMember("twitter", rapidjson::Value(rapidjson::kNullType),
                  allocator);

doc.AddMember("contact", contact, allocator);

此时的doc为:

{
  "name": "华安",
  "id": 9527,
  "is_intern": true,
  "contact": { "email": null, "twitter": null }
}

添加数组

Array 类型的创建和添加如下所示.

auto& allocator = doc.GetAllocator();

rapidjson::Value friends(rapidjson::kArrayType);
friends.PushBack("祝枝山", allocator);
friends.PushBack("文征明", allocator);
friends.PushBack("徐祯卿", allocator);

doc.AddMember("friends", friends, allocator);

此时doc为:

{
  "name": "华安",
  "id": 9527,
  "is_intern": true,
  "contact": { "email": null, "twitter": null },
  "friends": ["祝枝山", "文征明", "徐祯卿"]
}

序列化 json 对象

#include <rapidjson/document.h>
#include <rapidjson/filewritestream.h>
#include <rapidjson/writer.h>

#include <iostream>

void print(rapidjson::Value& value) {
  rapidjson::StringBuffer buffer;
  rapidjson::Writer<rapidjson::StringBuffer> writer(buffer);
  value.Accept(writer);
  std::cout << buffer.GetString() << std::endl;
}

进阶用法

使用函数模板简化解析

从前面解析的例子我们可以看到, 对每一个字段都要解析代码, 这样会存在很多的代码冗余.

可以通过模板函数来实现一个解析代码. 我们用std::variant来存储不同的解析类型, 比如:int*, double*, std::string*等.

接着我们用std::visit来访问std::variant, 针对不同类型做不同的解析, 对目前尚不支持的类型则报错.

template <typename... T>
bool Parse(rapidjson::Value& data, const char* name,
           std::variant<T...>& target) {
  auto it = data.FindMember(name);
  if (it == data.MemberEnd()) {
    std::cerr << "key not found: " << name << std::endl;
    return false;  // 字段不存在
  }

  // 使用 std::visit 处理 std::variant
  return std::visit(
      [&](auto value) {
        using ValueType = std::remove_pointer_t<decltype(value)>;

        if constexpr (std::is_same_v<ValueType, std::string>) {
          if (!it->value.IsString()) {
            std::cerr << "string not match: " << name << std::endl;
            return false;  // 类型不匹配
          }
          *value = std::string(it->value.GetString(), it->value.GetStringLength());
        } else if constexpr (std::is_integral_v<ValueType> ||
                             std::is_floating_point_v<ValueType>) {
          if (!it->value.Is<ValueType>()) {
            std::cerr << "integer not found: " << name << std::endl;

            return false;  // 类型不匹配
          }
          *value = it->value.Get<ValueType>();
        } else {
          std::cerr << "unsupported type\n";
          return false;  // 不支持的类型
        }

        return true;  // 解析成功
      },
      target);
}

如何使用呢? 此处以解析一个结构体为例:

struct Person {
  bool married = false;
  int id = 0;
  int age = 0;
  double point = 0;
  std::string name;
  std::string email;
};

bool ParsePerson(Person* person, rapidjson::Value& json) {
  std::vector<
      std::tuple<const char*, std::variant<int*, std::string*, double*, bool*>>>
      list = {
          {"id", &person->id},           {"age", &person->age},
          {"name", &person->name},       {"email", &person->email},
          {"married", &person->married}, {"point", &person->point},
      };

  for (auto& [name, variant] : list) {
    if (!Parse(json, name, variant)) {
      return false;  // 解析失败
    }
  }

  return true;  // 解析成功
}

完整示例请参考仓库代码: parse.cpp

处理多重嵌套

在工作中我们有时候会遇到嵌套很深的 json 文档. 比如给定这样一个 json 文档, 现在我们要获取/data/avatar/image/thumbnail如何操作?

{
  "code": 200,
  "data": {
    "avatar": {
      "image": {
        "medium": "https://image.com/hua.an.jpg",
        "thumbnail": "https://image.com/hua.an-thumbnail.jpg"
      }
    }
  }
}

如果按照之前的写法层层解析, 那么必然是个很深的嵌套. 但是现在有个更好的解决办法, 就是JSONPath, 在 rapidjson 里面就是 Pointer类, 参考如下写法:

rapidjson::Document doc;

if (doc.Parse(response).HasParseError()) {
  std::cerr << "JSON parse error!" << std::endl;
  return -1;
}

// 使用 RapidJSON 的 Pointer 解析 JSONPath
const char* jsonpath = "/data/avatar/image/thumbnail";
rapidjson::Pointer pointer(jsonpath);

// 获取 JSONPath 对应的值
if (rapidjson::Value* value = pointer.Get(doc)) {
  if (value->IsString()) {
    std::cout << "Thumbnail URL: " << value->GetString() << std::endl;
  } else {
    std::cerr << "Thumbnail is not a string!" << std::endl;
  }
} else {
  std::cerr << "Thumbnail not found!" << std::endl;
}

完整的代码请参考: jsonpath.cpp

总结

本文通过示例介绍了一些 rapidjson 的使用方法, 包括解析,生成,以及如何做代码优化. 希望能给读者带来一些帮助.

如果您觉得有用, 希望您点赞收藏关注, 感激不尽.

源码链接

  • 源码链接
  • Rapidjson 官网
  • Rapidjson Pointer

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：/a/965032.html

如若内容造成侵权/违法违规/事实不符，请联系我们进行投诉反馈qq邮箱809451989@qq.com，一经查实，立即删除！

相关文章

Java 大视界 -- 深度洞察 Java 大数据安全多方计算的前沿趋势与应用革新（52）

Java 大视界 -- 深度洞察 Java 大数据安全多方计算的前沿趋势与应用革新（52）

&#x1f496;&#x1f496;&#x1f496;亲爱的朋友们&#xff0c;热烈欢迎你们来到 青云交的博客&#xff01;能与你们在此邂逅&#xff0c;我满心欢喜&#xff0c;深感无比荣幸。在这个瞬息万变的时代&#xff0c;我们每个人都在苦苦追寻一处能让心灵安然栖息的港湾。而 我的…
阅读更多...
Docker使用指南（二）——容器相关操作详解（实战案例教学，创建/使用/停止/删除）

Docker使用指南（二）——容器相关操作详解（实战案例教学，创建/使用/停止/删除）

目录 1.容器操作相关命令​编辑 案例一&#xff1a; 案例二&#xff1a; 容器常用命令总结&#xff1a; 1.查看容器状态&#xff1a; 2.删除容器&#xff1a; 3.进入容器&#xff1a; 二、Docker基本操作——容器篇 1.容器操作相关命令 下面我们用两个案例来具体实操一…
阅读更多...
【C++】STL——list的使用

【C++】STL——list的使用

目录 &#x1f495;1.带头双向链表List &#x1f495;2.list用法介绍 &#x1f495;3.list的初始化 &#x1f495;4.size函数与resize函数 &#x1f495;5.empty函数 &#x1f495;6.front函数与back函数 &#x1f495;7.push_front,push_back,pop_front,pop_back函数…
阅读更多...
Java面试题集合篇5：10道基础面试题

Java面试题集合篇5：10道基础面试题

文章目录 前言41、多线程使用 ArrayList42、List 和 Set 区别43、HashSet 实现原理44、HashSet检查重复和保证数据不可重复45、BlockingQueue46、Map接口46.1、HashMap实现原理46.2、HashMap在JDK1.7和JDK1.8中不同点46.3、JDK1.7 VS JDK1.8 比较 47、HashMap的put方法流程48、…
阅读更多...
控件【QT】

控件【QT】

文章目录 控件QWidgetenabledgeometrysetGeometry qrcwindowOpacityQPixmapfonttoolTipfocusPolicystyleSheetQPushButtonRadio ButtionCheck Box显示类控件QProgressBarcalendarWidget 控件 Qt中已经提供了很多内置的控件了(按钮,文本框,单选按钮,复选按钮&#xff0c;下拉框…
阅读更多...
docker pull Error response from daemon问题

docker pull Error response from daemon问题

里面填写 里面解决方案就是挂代理。 以虚拟机为例&#xff0c;将宿主机配置端口设置&#xff0c;https/http端口设为7899 配置虚拟机的http代理&#xff1a; vim /etc/systemd/system/docker.service.d/http-proxy.conf里面填写&#xff0c;wq保存 [Service] Environment…
阅读更多...
linux 进程补充

linux 进程补充

环境变量 基本概念 环境变量(environment variables)一般是指在操作系统中用来指定操作系统运行环境的一些参数 如&#xff1a;我们在编写C/C代码的时候&#xff0c;在链接的时候&#xff0c;从来不知道我们的所链接的动态静态库在哪 里&#xff0c;但是照样可以链接成功&#…
阅读更多...
一文解释pytorch 中的 squeeze() 和 unsqueeze()函数（全网最详细版）

一文解释pytorch 中的 squeeze() 和 unsqueeze()函数（全网最详细版）

&#x1f308; 个人主页&#xff1a;十二月的猫-CSDN博客 &#x1f525; 系列专栏&#xff1a; &#x1f3c0;零基础入门PyTorch框架_十二月的猫的博客-CSDN博客 &#x1f4aa;&#x1f3fb; 十二月的寒冬阻挡不了春天的脚步&#xff0c;十二点的黑夜遮蔽不住黎明的曙光 目录 …
阅读更多...
QT:对象树

QT:对象树

1.概念 Qt 中的对象树是一种以树形结构组织 Qt 对象的方式。当创建一个QObject&#xff08;Qt 中大多数类的基类&#xff09;或其派生类的对象时&#xff0c;可以为其指定一个父对象&#xff08;parent&#xff09;。这个对象就会被添加到其父对象的子对象列表中&#xff0c;形…
阅读更多...
labview通过时间计数器来设定采集频率

labview通过时间计数器来设定采集频率

在刚接触labview的时候&#xff0c;笔者通常用定时里的等待函数来实现指令的收发&#xff0c;但是当用到的收发消息比较多时就出现了卡顿&#xff0c;卡死的情况&#xff0c;这是因为当用队列框架时&#xff0c;程序卡在了其中的一个分支里&#xff0c;等通过相应的延时后才可以…
阅读更多...
2024最新前端面试题（附答案及解析）

2024最新前端面试题（附答案及解析）

文章目录 HTML篇1、HTML5有哪些新特性&#xff1f;2、介绍下 BFC 及其应用3、内元素和块级元素的区别&#xff1f;4、Doctype作用&#xff1f;标准模式与混杂模式如何区分&#xff1f;5、引入样式时&#xff0c;link和import的区别&#xff1f;6、介绍一下你对浏览器内核的理解…
阅读更多...
Linux：文件系统（软硬链接）

Linux：文件系统（软硬链接）

目录 inode ext2文件系统 Block Group 超级块&#xff08;Super Block&#xff09; GDT&#xff08;Group Descriptor Table&#xff09; 块位图&#xff08;Block Bitmap&#xff09; inode位图&#xff08;Inode Bitmap&#xff09; i节点表&#xff08;inode Tabl…
阅读更多...
Java基础面试题50题

Java基础面试题50题

1&#xff0c;""空字符串的作用 package com.neuedu.nineteen;public class Test {public static void main(String[] args) {String s"";for (char i a; i < d; i) {ssi;//输出abc // sis;//输出cba}System.out.println(s);} }如题所示&…
阅读更多...
【技海登峰】Kafka漫谈系列（二）Kafka高可用副本的数据同步与选主机制

【技海登峰】Kafka漫谈系列（二）Kafka高可用副本的数据同步与选主机制

【技海登峰】Kafka漫谈系列（二）Kafka高可用副本的数据同步与选主机制 一. 数据同步 在之前的学习中有了副本Replica的概念，解决了数据备份的问题。我们还需要面临一个设计难题即：如何处理分区中Leader与Follwer节点数据同步不匹配问题所带来的风险，这也是保证数据高可用的…
阅读更多...
GB/T 44721-2024 与 L3 自动驾驶：自动驾驶新时代的基石与指引

GB/T 44721-2024 与 L3 自动驾驶：自动驾驶新时代的基石与指引

1.前言 在智能网联汽车飞速发展的当下&#xff0c;自动驾驶技术成为了行业变革的核心驱动力。从最初的辅助驾驶功能&#xff0c;到如今不断迈向高度自动化的征程&#xff0c;每一步都凝聚着技术的创新与突破。而在这一进程中&#xff0c;标准的制定与完善对于自动驾驶技术的规…
阅读更多...
大语言模型的个性化综述 ——《Personalization of Large Language Models: A Survey》

大语言模型的个性化综述 ——《Personalization of Large Language Models: A Survey》

摘要&#xff1a; 本文深入解读了论文“Personalization of Large Language Models: A Survey”&#xff0c;对大语言模型&#xff08;LLMs&#xff09;的个性化领域进行了全面剖析。通过详细阐述个性化的基础概念、分类体系、技术方法、评估指标以及应用实践&#xff0c;揭示了…
阅读更多...
SpringBoot使用 easy-captcha 实现验证码登录功能

SpringBoot使用 easy-captcha 实现验证码登录功能

文章目录 一、 环境准备1. 解决思路2. 接口文档3. redis下载 二、后端实现1. 引入依赖2. 添加配置3. 后端代码实现4. 前端代码实现 在前后端分离的项目中&#xff0c;登录功能是必不可少的。为了提高安全性&#xff0c;通常会加入验证码验证。 easy-captcha 是一个简单易用的验…
阅读更多...
国产编辑器EverEdit - 工具栏说明

国产编辑器EverEdit - 工具栏说明

1 工具栏 1.1 应用场景 当用户想显示/隐藏界面的标签栏、工具栏、状态栏、主菜单等界面元素时&#xff0c;可以通过EverEdit的菜单选项进行设置。 1.2 使用方法 选择菜单查看 -> 工具栏&#xff0c;在工具栏的子菜单中选择勾选或去掉勾选对应的选项。 标签栏&#xff1…
阅读更多...
Redis的通用命令

Redis的通用命令

⭐️前言⭐️ 本文主要介绍Redis的通用命令 &#x1f349;欢迎点赞 &#x1f44d; 收藏 ⭐留言评论 &#x1f349;博主将持续更新学习记录收获&#xff0c;友友们有任何问题可以在评论区留言 &#x1f349;博客中涉及源码及博主日常练习代码均已上传GitHub &#x1f4cd;内容导…
阅读更多...
机器学习专业毕设选题推荐合集 人工智能

机器学习专业毕设选题推荐合集 人工智能

目录 前言 毕设选题 开题指导建议 更多精选选题 选题帮助 最后 前言 大家好,这里是海浪学长毕设专题! 大四是整个大学期间最忙碌的时光&#xff0c;一边要忙着准备考研、考公、考教资或者实习为毕业后面临的升学就业做准备,一边要为毕业设计耗费大量精力。学长给大家整理…
阅读更多...
最新文章

Copyright @ 2022~2023