从零开始的JSON库教程（一）

news2024/10/6 20:27:10

本文是学习github大佬miloyip而做的读书笔记，项目点此进入

目录

1、JSON是什么

2、搭建编译环境

3、头文件与API设计

4、JSON的语法子集

5、单元测试

6、宏的编写技巧

7、实现解析器

8、关于断言

1、JSON是什么

JSON（JavaScript Object Notation）是一个用于数据交换的文本格式

例如，一个动态网页想从服务器获得数据时，服务器会从数据库查找数据，然后把数据转换成 JSON 文本格式，JSON库通常提供了一些常用的功能，例如将对象、数组、字符串和数字转换为JSON格式，以及将JSON数据解析为对象、数组等。

JSON是树状结构，而 JSON 只包含 6 种数据类型：

  • null: 表示为 null

  • boolean: 表示为 true 或 false

  • number: 一般的浮点数表示方式，在下一单元详细说明

  • string: 表示为 "..."

  • array: 表示为 [ ... ]

  • object: 表示为 { ... }

我们要实现的 JSON 库，主要是完成 3 个需求：

  1. 把 JSON 文本解析为一个树状数据结构（parse）。

  2. 提供接口访问该数据结构（access）。

  3. 把数据结构转换成 JSON 文本（stringify）。

img

2、搭建编译环境

安装cmake环境

3、头文件与API设计

已知JSON中只包含6种数据类型，如果把 true 和 false 当作两个类型就是 7 种，为此声明一个枚举类型：

typedef enum { LEPT_NULL, LEPT_FALSE, LEPT_TRUE, LEPT_NUMBER, LEPT_STRING, LEPT_ARRAY, LEPT_OBJECT } lept_type;

因为 C 语言没有 C++ 的命名空间（namespace）功能，一般会使用项目的简写作为标识符的前缀。通常枚举值用全大写（如 LEPT_NULL），而类型及函数则用小写（如 lept_type）。

接下来，声明 JSON 的数据结构。JSON 是一个树形结构，我们最终需要实现一个树的数据结构，每个节点使用 lept_value 结构体表示，我们会称它为一个 JSON 值（JSON value）。

typedef struct {
    lept_type type;
}lept_value;

在此单元中，我们只需要实现 null, true 和 false 的解析，因此该结构体只需要存储一个 lept_type。之后的单元会逐步加入其他数据。

然后，我们现在只需要两个 API 函数，一个是解析 JSON，一个是获取访问结果类型的函数

int lept_parse(lept_value* v, const char* json);
​
lept_type lept_get_type(const lept_value* v);

由于传入的JSON文本是一个C字符串，我们不用改动该字符串，所以使用const类型

传入的v是由使用方负责分配的，类型即是lept_value

使用方法如下：

lept_value v;
const char json[] = ...;
int ret = lept_parse(&v, json);

lept_get_type，即是获取访问结果的函数，具体就是获取其类型

4、JSON的语法子集

下面是此单元的 JSON 语法子集，使用 RFC7159 中的 ABNF 表示：

JSON-text = ws value ws
ws = *(%x20 / %x09 / %x0A / %x0D)
value = null / false / true 
null  = "null"
false = "false"
true  = "true"

那么第一行的意思是，JSON 文本由 3 部分组成，首先是空白（whitespace），接着是一个值，最后是空白。

当中 %xhh 表示以 16 进制表示的字符，/ 是多选一，* 是零或多个，() 用于分组。 第二行告诉我们，所谓空白，是由零或多个空格符（space U+0020）、制表符（tab U+0009）、换行符（LF U+000A）、回车符（CR U+000D）所组成。

第三行是说，我们现时的值只可以是 null、false 或 true，它们分别有对应的字面值（literal）。

我们的解析器应能判断输入是否一个合法的 JSON。如果输入的 JSON 不合符这个语法，我们要产生对应的错误码，方便使用者追查问题。

在这个 JSON 语法子集下，我们定义 3 种错误码：

  • 若一个 JSON 只含有空白，传回 LEPT_PARSE_EXPECT_VALUE。例如：" "

  • 若一个值之后，在空白之后还有其他字符，传回 LEPT_PARSE_ROOT_NOT_SINGULAR。例如：“true abc”

  • 若值不是那三种字面值，传回 LEPT_PARSE_INVALID_VALUE。例如：“hello”

5、单元测试

单元测试概念

一般我们在做练习题时，都是以printf / cout打印结果，再用肉眼对比结果看是否符合预期，但当软件项目越来越复杂，这总做法会越来越低效，于是我们引入了一种新的自动的测试方法。单元测试，单元测试也能确保其他人修改代码后，原来的功能维持正确，这称为回归测试 / regression testing

常见的单元测试框架有xUnit系列，如C++的Google Test、C#的NUnit。而我们为了举例，会编写一个极其简单的单元测试方法。

一般来说，软件开发是以周期进行的。例如，加入一个功能，再写关于该功能的单元测试。但也有另一种软件开发方法论，称为测试驱动开发（test-driven development, TDD），它的主要循环步骤是：

  1. 加入一个测试。

  2. 运行所有测试，新的测试应该会失败。

  3. 编写实现代码。

  4. 运行所有测试，若有测试失败回到3。

  5. 重构代码。

  6. 回到 1。

TDD 是先写测试，再实现功能。好处是实现只会刚好满足测试，而不会写了一些不需要的代码，或是没有被测试的代码。

但是无论是采用TOD还是先实现后测试，都要尽量加入足够覆盖率的单元测试

6、宏的编写技巧

如果宏里有多过一个语句（statement），就需要用 do { /*...*/ } while(0) 包裹成单个语句

7、实现解析器

有了 API 的设计、单元测试，终于要实现解析器了。

首先为了减少解析函数之间传递多个参数，我们把这些数据都放进一个 lept_context 结构体：

typedef struct {
    const char* json;
}lept_context;
​
/* ... */
​
/* 提示：这里应该是 JSON-text = ws value ws */
/* 以下实现没处理最后的 ws 和 LEPT_PARSE_ROOT_NOT_SINGULAR */
int lept_parse(lept_value* v, const char* json) {
    lept_context c;
    assert(v != NULL);
    c.json = json;
    v->type = LEPT_NULL;
    lept_parse_whitespace(&c);
    return lept_parse_value(&c, v);
}

由于 JSON 语法特别简单，我们不需要写分词器（tokenizer），只需检测下一个字符，便可以知道它是哪种类型的值，然后调用相关的分析函数。对于完整的 JSON 语法，跳过空白后，只需检测当前字符：

  • n ➔ null

  • t ➔ true

  • f ➔ false

  • " ➔ string

  • 0-9/- ➔ number

  • [ ➔ array

  • { ➔ object

8、关于断言

断言（assertion）是 C 语言中常用的防御式编程方式，减少编程错误。最常用的是在函数开始的地方，检测所有参数。有时候也可以在调用函数后，检查上下文是否正确。

C 语言的标准库含有 assert() 这个宏（需 #include <assert.h>），提供断言功能。当程序以 release 配置编译时（定义了 NDEBUG 宏），assert() 不会做检测；而当在 debug 配置时（没定义 NDEBUG 宏），则会在运行时检测 assert(cond) 中的条件是否为真（非 0），断言失败会直接令程序崩溃。

何时使用断言？何时处理运行时错误？

简单的答案是，如果那个错误是由于程序员错误编码所造成的（例如传入不合法的参数），那么应用断言；如果那个错误是程序员无法避免，而是由运行时的环境所造成的，就要处理运行时错误（例如开启文件失败）。

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

如若内容造成侵权/违法违规/事实不符，请联系多彩编程网进行投诉反馈，一经查实，立即删除！

相关文章

构建mono-repo风格的脚手架库

构建mono-repo风格的脚手架库

前段时间阅读了 https://juejin.cn/post/7260144602471776311#heading-25 这篇文章&#xff1b;本文做一个梳理和笔记&#xff1b; 主要聚焦的知识点如下&#xff1a; 如何搭建脚手架工程如何开发调试如何处理命令行参数如何实现用户交互如何拷贝文件夹或文件如何动态生成文件…
阅读更多...
TSINGSEE渔业水产养殖智能视频监管系统方案

TSINGSEE渔业水产养殖智能视频监管系统方案

一、背景需求 我国作为海洋资源丰富的国家之一&#xff0c;渔场养殖基地众多&#xff0c;但是养殖场也存在着开放度高、覆盖面积广&#xff0c;不易实时管理等监管难题&#xff0c;加上偷捕盗捕现象严重&#xff0c;这不仅给我们养殖户带来巨大的损失&#xff0c;一定程度上还…
阅读更多...
阿里巴巴矢量图标转化为字体图标教程

阿里巴巴矢量图标转化为字体图标教程

第一步&#xff1a;打开阿里巴巴矢量图标网站&#xff0c;搜索想要的icon https://www.iconfont.cn/?spma313x.search_index.i3.2.19f33a81gfo5r0 第二步&#xff1a;添加购物车&#xff0c;并且下载代码。如下图&#xff1a; 下载代码解压后得到一下文件&#xff1a; 第三步…
阅读更多...
LeetCode题：21合并两个有序链表

LeetCode题：21合并两个有序链表

21合并两个有序链表 题目描述 将两个升序链表合并为一个新的 升序 链表并返回。新链表是通过拼接给定的两个链表的所有节点组成的。 示例 1&#xff1a; 输入&#xff1a;l1 [1,2,4], l2 [1,3,4] 输出&#xff1a;[1,1,2,3,4,4]示例 2&#xff1a; 输入&#xff1a;l1 [], …
阅读更多...
【Java 进阶篇】Java ServletContext功能：获取文件服务器路径

【Java 进阶篇】Java ServletContext功能：获取文件服务器路径

Java ServletContext是Java EE中的一个核心接口&#xff0c;用于与Servlet容器进行通信&#xff0c;提供了许多有用的功能&#xff0c;包括获取文件服务器路径。在本文中&#xff0c;我们将详细介绍如何使用ServletContext来获取文件服务器路径&#xff0c;并提供示例代码以帮助…
阅读更多...
如何提高项目团队资源利用率？5大注意事项

如何提高项目团队资源利用率？5大注意事项

项目团队的资源是有限的&#xff0c;这包括人力、时间、资金、设备等。如果这些资源利用率低下或者浪费&#xff0c;这直接会导致项目成本的增加&#xff0c;不利于产品在竞争激烈的商业环境中保持优势。 因此我们需要提高团队资源利用率&#xff0c;降低项目成本&#xff0c;避…
阅读更多...
ArmSom------摄像头开发指南(二)

ArmSom------摄像头开发指南(二)

一. 简介 RK3588从入门到精通 开发板&#xff1a;ArmSoM-W3 Kernel&#xff1a;5.10.160 OS&#xff1a;Debian11 上篇文档介绍了rockchip平台怎么配置MIPI-CSI的通路&#xff0c;本⽂主要介绍在Rockchip平台下Camera相关测试命令 二. 摄像头连接 ArmSoM-W3开发板与imx41…
阅读更多...
STM32-高级定时器

STM32-高级定时器

以STM32F407为例。 高级定时器 高级定时器比通用定时器增加了可编程死区互补输出、重复计数器、带刹车&#xff08;断路&#xff09;功能&#xff0c;这些功能都是针对工业电机控制方面。 功能框图 16位向上、向下、向上/向下自动重装载计数器。 16位可编程预分频器&#xff0c…
阅读更多...
精品基于Python的气象预报系统-爬虫

精品基于Python的气象预报系统-爬虫

《[含文档PPT源码等]精品基于Python的气象预报系统-爬虫》该项目含有源码、文档、PPT、配套开发软件、软件安装教程、项目发布教程、包运行成功&#xff01; 软件开发环境及开发工具&#xff1a; 开发语言&#xff1a;python 使用框架&#xff1a;Django 前端技术&#xff…
阅读更多...
第六讲:VBA与ACCESS的ADO连接中，所涉及的对象

第六讲:VBA与ACCESS的ADO连接中，所涉及的对象

《VBA数据库解决方案》教程&#xff08;10090845&#xff09;是我推出的第二套教程&#xff0c;目前已经是第二版修订了。这套教程定位于中级&#xff0c;是学完字典后的另一个专题讲解。数据库是数据处理的利器&#xff0c;教程中详细介绍了利用ADO连接ACCDB和EXCEL的方法和实…
阅读更多...
安装anaconda时控制台conda-version报错

安装anaconda时控制台conda-version报错

今天根据站内的一篇博客教程博客在此安装anaconda时&#xff0c;检查conda版本时报错如下&#xff1a; >>>>>>>>>>>> ERROR REPORT <<<<<<<<<<<< Traceback (most recent call last): File “D:\An…
阅读更多...
众佰诚：新手如何在抖音电商中脱颖而出

众佰诚：新手如何在抖音电商中脱颖而出

在这个信息爆炸的时代&#xff0c;短视频平台抖音已经成为了人们获取信息、娱乐和购物的重要渠道。越来越多的商家开始在抖音上开设店铺&#xff0c;希望通过这个平台实现销售增长。然而&#xff0c;对于新手来说&#xff0c;如何在众多的竞争对手中脱颖而出&#xff0c;成为了…
阅读更多...
ardupilot开发 --- 避障方案、SLAM方案探索 篇

ardupilot开发 --- 避障方案、SLAM方案探索 篇

0. 无意间发现一张好看的图 1. 无人机避障技术 目前&#xff0c;无人机的避障技术中最为常见的是红外线传感器、超声波传感器、激光传感器以及视觉传感器。那为什么大疆的前视避障首先选择了双目视觉呢&#xff1f; 红外线传感器超声波传感器激光传感器视觉传感器。 参考&am…
阅读更多...
unity工程

unity工程

1首先我们来熟悉一下Unity每个文件夹的作用 1.assets&#xff1a;工程资源文件夹 2.library&#xff1a;库文件夹 3.logs&#xff1a;日志文件夹 4.obj&#xff1a;编译产生中间文件 5.packages&#xff1a;包配置信息 6&#xff1a;projectsettings&#xff1a;工程设置…
阅读更多...
【小白福音】手把手教学搭建Vue+SpringBoot开发环境完整教程

【小白福音】手把手教学搭建Vue+SpringBoot开发环境完整教程

前言：在很多新手小白在准备开发一个属于自己的前后端分离项目的时候需要准备一些例如Java环境配置、Node.Js配置、Maven配置以及软件安装等等，于本次博主亲自录制了一套完整的安装配置教程，提供到最后给大家进行下载。 注：本教程仅适用于小白，每一节课都是博主原创录制的，…
阅读更多...
selenium元素定位 —— 提高篇 xpath定位元素

selenium元素定位 —— 提高篇 xpath定位元素

XPath 最初是用来在 XML 文档中定位 DOM 节点的语言&#xff0c;由于 HTML 也可以算作 XML 的一种实现&#xff0c;所以 Selenium 也可以利用 XPath 这一强大的语言来定位 Web 元素。xpath的强大在于它可以通过父节点或者兄弟节点&#xff0c;根据html元素的前后关联性定位到元…
阅读更多...
tmux工具

tmux工具

B站学习地址&#xff1a;tmux教程
阅读更多...
烂大街的测试左移和右移！

烂大街的测试左移和右移！

01、测试左移与右移的定义 通俗的讲&#xff1a;左移是往开发阶段移&#xff0c;右移是往发布之后移。 正常测试&#xff1a;提测后的测试工作——到——发布验证完成阶段。 测试左移&#xff1a;提测之前的测试。 如&#xff1a;代码单元测试&#xff0c;代码质量检测&…
阅读更多...
家庭用洗地机哪个最好？家用洗地机选购

家庭用洗地机哪个最好？家用洗地机选购

家里日常打扫&#xff0c;维持地面的清洁&#xff0c;清洁干湿垃圾这时候必不可缺的就是洗地机了&#xff0c;由于近年来洗地机行业的热度高涨&#xff0c;涌现了很多洗地机品牌&#xff0c;这也让消费者在挑选的时候无从下手&#xff0c;今天笔者就给大家讲讲洗地机挑选需要主…
阅读更多...
数据结构笔记——查找、排序（王道408）

数据结构笔记——查找、排序（王道408）

文章目录 查找基本概念线性表查找顺序查找折半查找&#xff08;二分&#xff09;分块查找 树查找二叉排序树&#xff08;BST&#xff09;平衡二叉树&#xff08;AVL&#xff09;的插入平衡化复杂度分析 平衡二叉树的删除 红黑树红黑树的定义和性质红黑树定义红黑树性质 红黑树的…
阅读更多...
推荐文章
最新文章

Copyright @ 2022~2023