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):直接对比两个数据单元是否一致。不可向下拆分

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

image-20230314213858281

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

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

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

2. 功能丰富

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

2.1 数组

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

2.2 对象

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

2.3 基础单元

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

2.4 处理器前置检测

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

2.5 其他

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

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

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 213,992评论 6 493
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,212评论 3 388
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 159,535评论 0 349
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,197评论 1 287
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,310评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,383评论 1 292
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,409评论 3 412
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,191评论 0 269
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,621评论 1 306
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,910评论 2 328
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,084评论 1 342
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,763评论 4 337
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,403评论 3 322
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,083评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,318评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,946评论 2 365
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,967评论 2 351

推荐阅读更多精彩内容