Merge pull request #10 from codeleep/dev_4.x

Dev 4.x

Author: codeleep

Readme.md

@@ -41,7 +41,7 @@
 </dependency>
 ```
 [版本查看](./VersionHistory.md)
-2022-04-19 最新版本：3.1.2-RC1-RELEASE
+2024-04-11 最新版本：4.0.6-RC1-RELEASE
 
 ```java
 /**
@@ -58,7 +58,7 @@ public class UseExample {
         JsonComparedOption jsonComparedOption = new JsonComparedOption().setIgnoreOrder(true);
         JsonCompareResult jsonCompareResult = new DefaultJsonDifference()
                 .option(jsonComparedOption)
-                .detectDiff(JSON.parseArray(array1), JSON.parseArray(array2));
+                .detectDiff(array1, array2);
         System.out.println(JSON.toJSONString(jsonCompareResult));
     }
 }
@@ -178,105 +178,19 @@ ignoreKey.add("high");
 
 #### 3.5 自定义比较器
 
-在我们一个大json文件下。可能遇到某些节点希望实现自定义比较。可以通过 `customComparator` 来进行实现。
+在某些特俗场景下，我们需要自己实现比较器。这时可以通过 `me.codeleep.jsondiff.core.handle.HandleFactory` 来进行实现。可以参考 `me.codeleep.jsondiff.core.handle.AbstractHandleFactory` 实现
 
-它配置的key是一个 travelPath 。具体格式参照 ignorePath 。value 则是一个自定义比较器。对于自定义比较器需要继承对应的抽象类。并且实现具体的抽象接口。具体如下：
+将我们的实现设置到JsonComparedOption中即可生效。
 
-> 从 3.1.1-RC1-RELEASE 版本开始，自定义比较器的设置移至 JsonDiffOption.getJsonNeatFactory()
-> 不再在原先的Option中设置。如果需要使用自定义比较器。请使用 JsonDiffOption.getJsonNeatFactory().addCustomComparator() 进行设置。
+对于各个类型的比较器可以尝试继承系统比较器来进行使用：
 
-```java
-
-对象比较：
-
-需要继承 `me.codeleep.jsondiff.core.handle.array.AbstractObjectJsonNeat` 并且重写以下方法。
-
-```java
-/**
-* 比较对象
-* @param expect 期望的json对象
-* @param actual 实际的json对象
-* @return 返回比较结果
-* @throws IllegalAccessException 发生异常直接抛出
-*/
-JsonCompareResult detectDiff(JSONObject expect, JSONObject actual);
-
-```
-
-数组比较：
-
-需要继承 `me.codeleep.jsondiff.core.handle.object.AbstractArrayJsonNeat` 并且重写以下方法。
-
-```java
-  /**
- * 比较数组.调用入口。需要自己去分别调用 ignoreOrder 和  keepOrder。
- * @param expect 期望的json对象
- * @param actual 实际的json对象
- * @return 返回比较结果
- */
-JsonCompareResult detectDiff(JSONArray expect, JSONArray actual);
-
-// 忽略顺序的比较
-JsonCompareResult ignoreOrder(JSONArray expect, JSONArray actual);
-
-// 保持顺序比较
-JsonCompareResult keepOrder(JSONArray expect, JSONArray actual);
-
-```
-
-基本类型比较：
-
-基本类型指的是java基础类型的包装类型以及Number的实现类型。
-
-需要继承 `me.codeleep.jsondiff.core.handle.primitive.AbstractPrimitiveJsonNeat` 并且重写以下方法。
-
-```java
-   /**
-     * 比较数组
-     * @param expect 基础类型对象
-     * @param actual 基础类型对象
-     * @return 返回比较结果
-     */
-    JsonCompareResult detectDiff(Object expect, Object actual);
-```
-
-
-
-用户可以自己根据 travelPath 来决定使用何种自定义比较。三种比较器都返回 JsonCompareResult 对象作为当前节点的比较结果。对于JsonCompareResult对象。需要填入以下信息：
-
-```java
-// 示例
-JsonCompareResult result = new JsonCompareResult();
-Defects defects = new Defects()
-                  .setActual(actualDiffJson)
-                  .setExpect(expectDiffJson)
-                  .setTravelPath(nextTravelPath)
-                  .setIllustrateTemplate(DATA_TYPE_INCONSISTENT, ClassUtil.getClassName(expectDiffJson), ClassUtil.getClassName(actualDiffJson));
-result.addDefects(defects);
-```
-
-
-
-如果遇到在自定义节点中，还需要使用系统自带的比较器时。
-
-```java
-// 该值可以在上述三个抽象类中获得。但需要经自行处理
-String abstractTravelPath = "root";
-// 下一级是对象
-TravelPath nextTravelPath = new TravelPath(abstractTravelPath, mappingKey);
-// 下一级是数组
-TravelPath nextTravelPath = new TravelPath(abstractTravelPath, expectIndex, actualIndex);
-// 获得比较器
-JsonDiffUtil.getJsonNeat(expectDiffJson, actualDiffJson, nextTravelPath);
-// 执行比较获得结果
-JsonCompareResult diff = jsonNeat.diff(expectDiffJson, actualDiffJson, nextTravelPath);
-// 本级创建的 JsonCompareResult result 将下一级结果合并
-this.result.mergeDefects(diff.getDefectsList());
-```
+- me.codeleep.jsondiff.core.handle.array.ComplexArrayJsonNeat
+- me.codeleep.jsondiff.core.handle.object.ComplexObjectJsonNeat
+- me.codeleep.jsondiff.core.handle.other.ComplexOtherJsonNeat
+- me.codeleep.jsondiff.core.handle.primitive.ComplexPrimitiveJsonNeat
 
-可以使用上述代码获取系统自带的比较器。
+在工具中，目前提供了一个 me.codeleep.jsondiff.core.handle.custom.AlignArrayJsonDiff 来实现当数组长度不一致时，进行补齐，从而避免直接返回错误信息。
 
-> 自定义比较器值得注意的是: 从匹配到 travelPath 之后，根据不再接管比较操作。一切行为由用户自行定义。但工具依然预留默认的比较器给用户处理后续字段。这需要用户自行进行组合调用。
 
 
 

json-diff-common/src/main/java/me/codeleep/jsondiff/common/model/neat/JsonBuilder.java

@@ -0,0 +1,12 @@
+package me.codeleep.jsondiff.common.model.neat;
+
+/**
+ * @author: codeleep
+ * @createTime: 2024/04/11 下午7:08
+ * @description:
+ */
+public interface JsonBuilder {
+
+    JsonDiff builder(String json);
+
+}

json-diff-common/src/main/java/me/codeleep/jsondiff/common/utils/ImplType.java

@@ -0,0 +1,50 @@
+package me.codeleep.jsondiff.common.utils;
+
+import me.codeleep.jsondiff.common.exception.JsonDiffException;
+import me.codeleep.jsondiff.common.model.neat.JsonBuilder;
+
+/**
+ * @author: codeleep
+ * @createTime: 2023/04/16 20:42
+ * @description: 实现类型
+ */
+public enum ImplType {
+
+    FASTJSON("fastjson", "me.codeleep.jsondiff.impl.fastjson.FastJsonBuilder"),
+    FASTJSON2("fastjson2", "me.codeleep.jsondiff.impl.fastjson2.FastJson2Builder"),
+    JACKSON("jackson", "me.codeleep.jsondiff.impl.gson.GsonBuilder"),
+    GSON("gson", "me.codeleep.jsondiff.impl.jackson.JacksonBuilder");
+
+    private String type;
+
+    private String builderClassName;
+
+    ImplType(String type, String builderClassName) {
+        this.type = type;
+        this.builderClassName = builderClassName;
+    }
+
+    public JsonBuilder getBuilder() {
+        try {
+            return (JsonBuilder) Class.forName(builderClassName).newInstance();
+        } catch (Exception e) {
+            throw new JsonDiffException("Failed to create JsonBuilder instance for " + type, e);
+        }
+    }
+
+    /**
+     * 检测使用哪个json框架
+     * @return
+     */
+    public static ImplType detectJsonParser() {
+        for (ImplType implType : ImplType.values()) {
+            try {
+                Class.forName(implType.builderClassName);
+                return implType;
+            } catch (ClassNotFoundException e) {
+                // Ignore the exception and try the next class name
+            }
+        }
+        throw new JsonDiffException("No JSON parsing framework found, at least one of which implements. fastjson,fastjson2,jackson,gson");
+    }
+}

json-diff-core/pom.xml

@@ -19,12 +19,6 @@
             <version>${project.version}</version>
             <scope>compile</scope>
         </dependency>
-        <dependency>
-            <groupId>cn.xiaoandcai</groupId>
-            <artifactId>json-diff-impl</artifactId>
-            <version>${project.version}</version>
-            <scope>compile</scope>
-        </dependency>
     </dependencies>
 
     <properties>

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

@@ -1,6 +1,6 @@
 package me.codeleep.jsondiff.core.config;
 
-import me.codeleep.jsondiff.impl.ImplType;
+import me.codeleep.jsondiff.common.utils.ImplType;
 
 /**
  * @author: codeleep

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

@@ -2,8 +2,9 @@
 
 import me.codeleep.jsondiff.common.model.neat.JsonDiff;
 import me.codeleep.jsondiff.core.config.JsonDiffOption;
-import me.codeleep.jsondiff.impl.FrameworkImplUtil;
-import me.codeleep.jsondiff.impl.ImplType;
+import me.codeleep.jsondiff.common.utils.ImplType;
+
+import static me.codeleep.jsondiff.common.utils.ImplType.*;
 
 /**
  * @author: codeleep
@@ -15,10 +16,10 @@ public class JsonDiffBuilder {
     public static JsonDiff buildObject(String jsonStr) {
         ImplType defaultJsonFramework = JsonDiffOption.getDefaultJsonFramework();
         switch (defaultJsonFramework) {
-            case FASTJSON: return FrameworkImplUtil.fastJson(jsonStr);
-            case FASTJSON2: return FrameworkImplUtil.fastJson2(jsonStr);
-            case GSON: return FrameworkImplUtil.gson(jsonStr);
-            case JACKSON: return FrameworkImplUtil.jackson(jsonStr);
+            case FASTJSON: return FASTJSON.getBuilder().builder(jsonStr);
+            case FASTJSON2: return FASTJSON2.getBuilder().builder(jsonStr);
+            case GSON: return GSON.getBuilder().builder(jsonStr);
+            case JACKSON: return JACKSON.getBuilder().builder(jsonStr);
         }
         return null;
     }

json-diff-impl/json-diff-impl-fastjson/pom.xml

@@ -0,0 +1,35 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+    <parent>
+        <groupId>cn.xiaoandcai</groupId>
+        <artifactId>json-diff-parent</artifactId>
+        <version>4.0.5-RC1-RELEASE</version>
+        <relativePath>../../pom.xml</relativePath>
+    </parent>
+
+    <version>4.0.5-RC1-RELEASE</version>
+    <artifactId>json-diff-impl-fastjson</artifactId>
+
+    <properties>
+        <maven.compiler.source>8</maven.compiler.source>
+        <maven.compiler.target>8</maven.compiler.target>
+        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+    </properties>
+
+    <dependencies>
+        <dependency>
+            <groupId>cn.xiaoandcai</groupId>
+            <artifactId>json-diff-core</artifactId>
+            <version>${project.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>com.alibaba</groupId>
+            <artifactId>fastjson</artifactId>
+            <version>1.2.74</version>
+        </dependency>
+    </dependencies>
+
+</project>

…sondiff/impl/fastjson/FastJsonArray.java …sondiff/impl/fastjson/FastJsonArray.javajson-diff-impl/src/main/java/me/codeleep/jsondiff/impl/fastjson/FastJsonArray.java renamed to json-diff-impl/json-diff-impl-fastjson/src/main/java/me/codeleep/jsondiff/impl/fastjson/FastJsonArray.java json-diff-impl/src/main/java/me/codeleep/jsondiff/impl/fastjson/FastJsonArray.java renamed to json-diff-impl/json-diff-impl-fastjson/src/main/java/me/codeleep/jsondiff/impl/fastjson/FastJsonArray.java

@@ -0,0 +1,23 @@
+package me.codeleep.jsondiff.impl.fastjson;
+
+import me.codeleep.jsondiff.common.model.neat.JsonDiff;
+import me.codeleep.jsondiff.common.model.neat.JsonBuilder;
+
+/**
+ * @author: codeleep
+ * @createTime: 2024/04/11 下午7:10
+ * @description:
+ */
+public class FastJsonBuilder implements JsonBuilder {
+    @Override
+    public JsonDiff builder(String json) {
+        Object parse = com.alibaba.fastjson.JSON.parse(json);
+        if (parse instanceof com.alibaba.fastjson.JSONObject) {
+            return new FastJsonObject((com.alibaba.fastjson.JSONObject)parse);
+        }
+        if (parse instanceof com.alibaba.fastjson.JSONArray) {
+            return new FastJsonArray((com.alibaba.fastjson.JSONArray)parse);
+        }
+        return null;
+    }
+}

json-diff-impl/json-diff-impl-fastjson/src/main/java/me/codeleep/jsondiff/impl/fastjson/FastJsonBuilder.java

@@ -1,12 +1,10 @@
 package me.codeleep.jsondiff.impl.fastjson;
 
-import com.alibaba.fastjson.JSONArray;
+import com.alibaba.fastjson.JSON;
 import com.alibaba.fastjson.JSONObject;
-import com.alibaba.fastjson2.JSON;
 import me.codeleep.jsondiff.common.model.neat.JsonDiff;
 import me.codeleep.jsondiff.common.model.neat.JsonDiffObject;
 
-import java.util.HashMap;
 import java.util.HashSet;
 import java.util.Set;
 
@@ -41,7 +39,7 @@ public Set<String> keySet() {
 
     @Override
     public Object format() {
-        return JSON.to(HashMap.class, jsonObject);
+        return JSON.toJSONString(jsonObject);
     }
 
     @Override