Merge branch 'new_model' into multi_frame

Author: mini1798

Readme.md

@@ -40,8 +40,8 @@
     <version>${version}</version>
 </dependency>
 ```
-[版本查看](https://central.sonatype.com/artifact/cn.xiaoandcai/json-diff/3.0.3-RC1-RELEASE)
-2022-03-04 最新版本：3.0.3-RC1-RELEASE
+[版本查看](./VersionHistory.md)
+2022-04-19 最新版本：3.1.2-RC1-RELEASE
 
 ```java
 /**
@@ -94,7 +94,6 @@ public class UseExample {
 | mapping          | Map<String, String>            | 将真实字段映射到期望字段，key是真实字段name，value是期望的字段name |
 | ignorePath       | Set\<String\>                  | 当对比的路径完全匹配时会被跳过。遇到数组使用 `[]` 即可。无需填入下标 |
 | ignoreKey        | Set\<String\>                  | 对比object时。或忽略该key。对整个json生效                    |
-| customComparator | Map<String, Class\<JsonNeat\>> | 用户自定义比较器。具体说明见下文                             |
 
 > 在 `2.0.1-RC1-RELEASE` 之后版本中移除了 `keyFunction` 配置参数。可以使用 `ignorePath` 来代替达到同样的效果。
 
@@ -183,9 +182,14 @@ ignoreKey.add("high");
 
 它配置的key是一个 travelPath 。具体格式参照 ignorePath 。value 则是一个自定义比较器。对于自定义比较器需要继承对应的抽象类。并且实现具体的抽象接口。具体如下：
 
+> 从 3.1.1-RC1-RELEASE 版本开始，自定义比较器的设置移至 JsonDiffOption.getJsonNeatFactory()
+> 不再在原先的Option中设置。如果需要使用自定义比较器。请使用 JsonDiffOption.getJsonNeatFactory().addCustomComparator() 进行设置。
+
+```java
+
 对象比较：
 
-需要继承 `me.codeleep.jsondiff.core.handle.array.AbstractArrayJsonNeat` 并且重写以下方法。
+需要继承 `me.codeleep.jsondiff.core.handle.array.AbstractObjectJsonNeat` 并且重写以下方法。
 
 ```java
 /**
@@ -201,7 +205,7 @@ JsonCompareResult detectDiff(JSONObject expect, JSONObject actual);
 
 数组比较：
 
-需要继承 `me.codeleep.jsondiff.core.handle.object.AbstractObjectJsonNeat` 并且重写以下方法。
+需要继承 `me.codeleep.jsondiff.core.handle.object.AbstractArrayJsonNeat` 并且重写以下方法。
 
 ```java
   /**
@@ -307,7 +311,8 @@ this.result.mergeDefects(diff.getDefectsList());
 #### 
 
 ## 三、交流群：710435809
-
+- 如果长时间未通过可发邮件至 codeleep@163.com 与我联系
+- 如果觉得对你有帮助，欢迎star。你的start是对我最大的鼓励。
 
 
 
@@ -359,6 +364,7 @@ this.result.mergeDefects(diff.getDefectsList());
         "ignorePath": ["root[].a"],
         "ignoreKey": ["b"]
       }
+}
 ```
 
 "actual": 实际需要对比的值 类型：测试array文件为array 测试object文件为object   

VersionHistory.md

@@ -0,0 +1,52 @@
+# 版本列表 📃
+
+## 3.X 🌟
+
+-  **3.1.2-RC1-RELEASE**
+    - 修复数组比较数组越界问题
+
+
+-  **3.1.1-RC1-RELEASE**
+    - 支持自定义比较器添加附加数据
+    - 支持替换默认比较器
+    - 更改自定义比较器设置入口为 JsonDiffOption.getJsonNeatFactory()
+
+
+-  **3.0.3-RC1-RELEASE**
+    - 修复自定义比较器接口范围 
+    - 修复数组对比过程不支持比较长度不相等数组
+    - 修复mapping映射
+    - 丰富测试用例
+
+
+-  **3.0.0-RC1-RELEASE**
+    - 支持自定义比较器 
+    - 支持全局配置
+
+
+## 2.X 🌟
+
+-  **2.0.3-RC1-RELEASE**
+    - 解决ignorePath无效 
+    - 解决配置清理问题
+    - 解决大数类型数据 
+    - 支持更详细的路径展示
+    - 修复对象无法发现多个差异
+
+
+-  **2.0.2-RC1-RELEASE**
+    - 摒弃1.x 版本代码，将代码完全重构 
+    - 返回信息描述添加统一清洗 
+    - fastjson版本更新到 2.0.7
+
+
+## 1.X 🌟
+
+-  **1.2.0**
+    - 补充单测
+    - 代码优化
+    - 支持不同数组元素是不同类型的比较
+
+
+-  **1.0.0**
+    - 基本功能支持

json-diff-common/pom.xml

@@ -5,12 +5,12 @@
     <parent>
         <artifactId>json-diff-parent</artifactId>
         <groupId>cn.xiaoandcai</groupId>
-        <version>3.0.3-RC1-RELEASE</version>
+        <version>3.1.2-RC1-RELEASE</version>
     </parent>
     <modelVersion>4.0.0</modelVersion>
 
     <artifactId>json-diff-common</artifactId>
-    <version>3.0.3-RC1-RELEASE</version>
+    <version>3.1.2-RC1-RELEASE</version>
 
     <properties>
         <maven.compiler.source>8</maven.compiler.source>

json-diff-core/pom.xml

@@ -5,12 +5,12 @@
     <parent>
         <artifactId>json-diff-parent</artifactId>
         <groupId>cn.xiaoandcai</groupId>
-        <version>3.0.3-RC1-RELEASE</version>
+        <version>3.1.2-RC1-RELEASE</version>
     </parent>
     <modelVersion>4.0.0</modelVersion>
 
     <artifactId>json-diff-core</artifactId>
-    <version>3.0.3-RC1-RELEASE</version>
+    <version>3.1.2-RC1-RELEASE</version>
 
     <dependencies>
         <dependency>

json-diff-core/src/main/java/me/codeleep/jsondiff/core/DefaultJsonDifference.java

@@ -5,7 +5,7 @@
 import me.codeleep.jsondiff.common.model.JsonCompareResult;
 import me.codeleep.jsondiff.common.model.JsonComparedOption;
 import me.codeleep.jsondiff.common.model.TravelPath;
-import me.codeleep.jsondiff.common.utils.RunTimeDataFactory;
+import me.codeleep.jsondiff.core.utils.RunTimeDataFactory;
 import me.codeleep.jsondiff.core.handle.array.ComplexArrayJsonNeat;
 import me.codeleep.jsondiff.core.handle.object.ComplexObjectJsonNeat;
 

…leep/jsondiff/common/JsonDiffOption.java …jsondiff/core/config/JsonDiffOption.javajson-diff-common/src/main/java/me/codeleep/jsondiff/common/JsonDiffOption.java renamed to json-diff-core/src/main/java/me/codeleep/jsondiff/core/config/JsonDiffOption.java json-diff-common/src/main/java/me/codeleep/jsondiff/common/JsonDiffOption.java renamed to json-diff-core/src/main/java/me/codeleep/jsondiff/core/config/JsonDiffOption.java

@@ -1,6 +1,7 @@
-package me.codeleep.jsondiff.common;
+package me.codeleep.jsondiff.core.config;
 
 import me.codeleep.jsondiff.common.model.JsonComparedOption;
+import me.codeleep.jsondiff.core.utils.JsonNeatFactory;
 
 /**
  * @author: codeleep
@@ -19,6 +20,15 @@ public class JsonDiffOption {
      */
     private static boolean uniqueOption = false;
 
+    /**
+     * 默认的比较器工厂
+     */
+    private final static JsonNeatFactory jsonNeatFactory = new JsonNeatFactory();
+
+    public static JsonNeatFactory getJsonNeatFactory() {
+        return jsonNeatFactory;
+    }
+
 
     public static JsonComparedOption getGloballyUniqueOption() {
         if (globallyUniqueOption == null) {

json-diff-core/src/main/java/me/codeleep/jsondiff/core/handle/array/AbstractArrayJsonNeat.java

@@ -7,7 +7,7 @@
 import me.codeleep.jsondiff.common.model.Defects;
 import me.codeleep.jsondiff.common.model.JsonCompareResult;
 import me.codeleep.jsondiff.common.model.TravelPath;
-import me.codeleep.jsondiff.common.utils.RunTimeDataFactory;
+import me.codeleep.jsondiff.core.utils.RunTimeDataFactory;
 import me.codeleep.jsondiff.core.handle.AbstractTypeCheck;
 import me.codeleep.jsondiff.common.model.neat.ArrayJsonNeat;
 
@@ -57,20 +57,6 @@ public boolean check(Object expect, Object actual, JsonCompareResult result, Tra
             return false;
         }
 
-        int expectSize = ((JSONArray) expect).size();
-        int actualSize = ((JSONArray) actual).size();
-
-        // 长度不一致
-        if (expectSize != actualSize) {
-            Defects defects = new Defects()
-                    .setActual(actualSize)
-                    .setExpect(expectSize)
-                    .setTravelPath(travelPath)
-                    .setIllustrateTemplate(INCONSISTENT_ARRAY_LENGTH, String.valueOf(expectSize), String.valueOf(actualSize));
-            result.addDefects(defects);
-            return false;
-        }
-
         return true;
     }
 

json-diff-core/src/main/java/me/codeleep/jsondiff/core/handle/array/ComplexArrayJsonNeat.java

@@ -4,12 +4,13 @@
 import me.codeleep.jsondiff.common.model.Defects;
 import me.codeleep.jsondiff.common.model.JsonCompareResult;
 import me.codeleep.jsondiff.common.model.TravelPath;
-import me.codeleep.jsondiff.common.utils.RunTimeDataFactory;
+import me.codeleep.jsondiff.core.utils.RunTimeDataFactory;
 import me.codeleep.jsondiff.common.model.neat.JsonNeat;
 import me.codeleep.jsondiff.core.utils.ClassUtil;
 import me.codeleep.jsondiff.core.utils.JsonDiffUtil;
 
 import static me.codeleep.jsondiff.common.model.Constant.DATA_TYPE_INCONSISTENT;
+import static me.codeleep.jsondiff.common.model.Constant.INCONSISTENT_ARRAY_LENGTH;
 
 /**
  * @author: codeleep
@@ -29,6 +30,19 @@ public JsonCompareResult detectDiff(JSONArray expect, JSONArray actual) {
         if (!check(expect, actual, result, travelPath)) {
             return result;
         }
+        // 长度不一致
+        int expectSize = ((JSONArray) expect).size();
+        int actualSize = ((JSONArray) actual).size();
+        if (expectSize != actualSize) {
+            Defects defects = new Defects()
+                    .setActual(actualSize)
+                    .setExpect(expectSize)
+                    .setTravelPath(travelPath)
+                    .setIllustrateTemplate(INCONSISTENT_ARRAY_LENGTH, String.valueOf(expectSize), String.valueOf(actualSize));
+            result.addDefects(defects);
+            return result;
+        }
+
         boolean ignoreOrder = RunTimeDataFactory.getOptionInstance().isIgnoreOrder();
         // 测试
         if (ignoreOrder) {

json-diff-core/src/main/java/me/codeleep/jsondiff/core/handle/custom/AlignArrayJsonDiff.java

@@ -0,0 +1,47 @@
+package me.codeleep.jsondiff.core.handle.custom;
+
+import com.alibaba.fastjson2.JSONArray;
+import me.codeleep.jsondiff.common.model.JsonCompareResult;
+import me.codeleep.jsondiff.core.handle.array.ComplexArrayJsonNeat;
+
+import java.util.Collections;
+
+/**
+ * @author: codeleep
+ * @createTime: 2023/04/25 22:22
+ * @description: 将补齐不整齐的数组
+ */
+public class AlignArrayJsonDiff extends ComplexArrayJsonNeat {
+
+    /**
+     * 比较数组.调用入口。需要自己去分别调用 ignoreOrder 和  keepOrder。
+     * @param expect 期望的json对象
+     * @param actual 实际的json对象
+     * @return 返回比较结果
+     */
+    @Override
+    public JsonCompareResult detectDiff(JSONArray expect, JSONArray actual) {
+        JsonCompareResult result = new JsonCompareResult();
+        // 前置校验失败
+        if (!check(expect, actual, result, travelPath)) {
+            return result;
+        }
+        // 长度不一致
+        int expectSize = ((JSONArray) expect).size();
+        int actualSize = ((JSONArray) actual).size();
+        if (expectSize == actualSize) {
+            return super.detectDiff(expect, actual);
+        }
+        JSONArray expectIts = new JSONArray(expect);
+        JSONArray actualIts = new JSONArray(actual);
+        // 让期望的数组长度和实际的数组长度一致。谁短补齐谁
+        if (expectSize > actualSize) {
+            actualIts.addAll(Collections.nCopies(expectSize - actualSize, null));
+        } else {
+            expectIts.addAll(Collections.nCopies(actualSize - expectSize, null));
+        }
+        return super.detectDiff(expectIts, actualIts);
+    }
+
+
+}

json-diff-core/src/main/java/me/codeleep/jsondiff/core/handle/object/AbstractObjectJsonNeat.java

@@ -6,7 +6,7 @@
 import me.codeleep.jsondiff.common.exception.JsonDiffException;
 import me.codeleep.jsondiff.common.model.JsonCompareResult;
 import me.codeleep.jsondiff.common.model.TravelPath;
-import me.codeleep.jsondiff.common.utils.RunTimeDataFactory;
+import me.codeleep.jsondiff.core.utils.RunTimeDataFactory;
 import me.codeleep.jsondiff.core.handle.AbstractTypeCheck;
 import me.codeleep.jsondiff.common.model.neat.ObjectJsonNeat;