json-diff详细设计

一、简介

json-diff是一款强大的，由java编写的json差异发现工具。他可以发现任何结构的json差异，并且将差异信息反馈给用户。

gitee: https://gitee.com/codeleep/json-diff

教程：https://juejin.cn/post/7210003299109109818

给大家提供一个设计json-diff的实现思路，用于发现json的差异，对比json。

二、需求

• 精准定位差异所在

• 详细的差异位置

• 能支持丰富的差异过程控制

1. 基础设计

1.1 json 结构抽象

我们知道，在 json 中，只存在三种结构。

• 数组[] ：数组元素可以由任意 json 结构组成。

• 对象{}：对象是一个 key-value 的列表。key 只由字符串组成, value 可由任意 json 结构组成

• 数据单元: 一个最小数据单元。可以是 String , Number等基础结构

为了简化，我们简单的认为 对象的 key 只由字符串组成，value 可由任意 json 结构组成

这样我们就得到了一个基础的概念。json 结构中，只有 数组的 item 和 对象的 value 存在变化。且变化范围是 json 结构，也就是上述三种结构。

1.2 遍历模型抽象

为了将复杂的问题拆解成若干个小问题，我们就需要高度抽象整个过程重复过程。

既然上述将数据抽象成一个规范的结果，也明确知道只有 数组的 item 和 对象的 value 存在变化。那我们对不变化的部分做硬编码，对变化的部分做适配即可。

也就是，我们需要抽象出三种数据结构的处理器：

• 数组处理器 (ComplexArrayJsonNeat)：处理json数组结构。遍历数组，比较元素
• 对象处理器 (ComplexObjectJsonNeat)：处理json对象结构。遍历所有key，比较value
• 数据单元处理器 (PrimitiveTypeJsonNeat)：直接对比两个数据单元是否一致。不可向下拆分

有了三种处理器之后，我们就可以设计出以下这种遍历结构。

上图中的遍历结构结束的条件只有遍历出所有的基础单元，这就是工具最核心的设计。其实看起来就很简单。

图中有一个 Json结构处理器 其实内部很简单，根据传入的 expect节点 和 actual节点 判断需要以什么类型处理器进行处理。当然避免不了多个 if 。

这样设计的好处是我们可以将所有的节点在方法栈中独立，就不会存在数据污染问题，也会将问题简化。但所带来的开销即是需要创建较多的相同对象。

2. 功能丰富

基于上述的遍历模型，可以在其过程中进行很多外在干预。

2.1 数组

• 忽略数组顺序：对于数组遍历 item 过程可以将数组顺序忽略。

2.2 对象

• key 映射：可以支持 expect节点 和 actual节点 中使用不同的 key 的 value 进行对比。比如将 expect 对象中的 a 字段与 actual 对象的 b 字段进行对比
• key 忽略：如果不想关注某个 key ，可以支持该需求

2.3 基础单元

• 支持所有java中的基础类型，即jdk中重写了eques的类

2.4 处理器前置检测

• 忽略路径：指定的路径不比较

2.5 其他

• 支持自定义处理器
• 支持只关心结构变化

本文由博客一文多发平台 OpenWrite 发布！