JSONSchema support cycle reference

alibaba · Oct 5, 2023 · 1d99790 · 1d99790
1 parent ed7b039
commit 1d99790
Show file tree

Hide file tree

Showing 4 changed files with 94 additions and 2 deletions.
diff --git a/core/src/main/java/com/alibaba/fastjson2/schema/JSONSchema.java b/core/src/main/java/com/alibaba/fastjson2/schema/JSONSchema.java
@@ -44,6 +44,9 @@ public abstract class JSONSchema {
         this.description = description;
     }
 
+    void addResolveTask(UnresolvedReference.ResolveTask task){
+    }
+
     public static JSONSchema of(JSONObject input, Class objectClass) {
         if (input == null || input.isEmpty()) {
             return null;
@@ -448,7 +451,7 @@ public static JSONSchema of(JSONObject input, JSONSchema parent) {
                             refName = URLDecoder.decode(refName);
                             JSONSchema refSchema = defs.get(refName);
                             if (refSchema == null) {
-                                refSchema = Any.NOT_ANY;
+                                refSchema = new UnresolvedReference(refName);
                             }
                             return refSchema;
                         }
@@ -866,7 +869,8 @@ public enum Type {
         OneOf,
         AllOf,
         AnyOf,
-        Any;
+        Any,
+        UnresolvedReference;
 
         public static Type of(String typeStr) {
             if (typeStr == null) {

diff --git a/core/src/main/java/com/alibaba/fastjson2/schema/ObjectSchema.java b/core/src/main/java/com/alibaba/fastjson2/schema/ObjectSchema.java
@@ -42,6 +42,8 @@ public final class ObjectSchema
     final AnyOf anyOf;
     final OneOf oneOf;
 
+    transient List<UnresolvedReference.ResolveTask> resolveTasks;
+
     public ObjectSchema(JSONObject input) {
         this(input, null);
     }
@@ -72,6 +74,11 @@ public ObjectSchema(JSONObject input, JSONSchema root) {
                 JSONSchema schema = JSONSchema.of(entryValue, root == null ? this : root);
                 this.defs.put(entryKey, schema);
             }
+            if (resolveTasks != null) {
+                for (UnresolvedReference.ResolveTask resolveTask : resolveTasks) {
+                    resolveTask.resolve(this);
+                }
+            }
         }
 
         JSONObject properties = input.getJSONObject("properties");
@@ -88,6 +95,13 @@ public ObjectSchema(JSONObject input, JSONSchema root) {
                     schema = JSONSchema.of((JSONObject) entryValue, root == null ? this : root);
                 }
                 this.properties.put(entryKey, schema);
+                if (schema instanceof UnresolvedReference) {
+                    String refName = ((UnresolvedReference) schema).refName;
+                    UnresolvedReference.PropertyResolveTask task
+                            = new UnresolvedReference.PropertyResolveTask(this.properties, entryKey, refName);
+                    JSONSchema resolveRoot = root == null ? this : root;
+                    resolveRoot.addResolveTask(task);
+                }
             }
         }
 
@@ -199,6 +213,14 @@ public ObjectSchema(JSONObject input, JSONSchema root) {
         oneOf = oneOf(input, null);
     }
 
+    @Override
+    void addResolveTask(UnresolvedReference.ResolveTask task) {
+        if (resolveTasks == null) {
+            resolveTasks = new ArrayList<>();
+        }
+        resolveTasks.add(task);
+    }
+
     @Override
     public Type getType() {
         return Type.Object;

diff --git a/core/src/main/java/com/alibaba/fastjson2/schema/UnresolvedReference.java b/core/src/main/java/com/alibaba/fastjson2/schema/UnresolvedReference.java
@@ -0,0 +1,58 @@
+package com.alibaba.fastjson2.schema;
+
+import java.util.Map;
+
+public class UnresolvedReference
+        extends JSONSchema {
+    final String refName;
+    UnresolvedReference(String refName) {
+        super(null, null);
+        this.refName = refName;
+    }
+
+    @Override
+    public Type getType() {
+        return Type.UnresolvedReference;
+    }
+
+    @Override
+    public ValidateResult validate(Object value) {
+        return JSONSchema.SUCCESS;
+    }
+
+    abstract static class ResolveTask {
+        abstract void resolve(JSONSchema root);
+    }
+
+    static class PropertyResolveTask
+            extends ResolveTask {
+        final Map<String, JSONSchema> properties;
+        final String entryKey;
+        final String refName;
+
+        PropertyResolveTask(Map<String, JSONSchema> properties, String entryKey, String refName) {
+            this.properties = properties;
+            this.entryKey = entryKey;
+            this.refName = refName;
+        }
+
+        @Override
+        void resolve(JSONSchema root) {
+            Map<String, JSONSchema> defs = null;
+            if (root instanceof ObjectSchema) {
+                defs = ((ObjectSchema) root).defs;
+            } else if (root instanceof ArraySchema) {
+                defs = ((ArraySchema) root).defs;
+            }
+
+            if (defs == null) {
+                return;
+            }
+
+            JSONSchema refSchema = defs.get(refName);
+            if (refSchema != null) {
+                properties.put(entryKey, refSchema);
+            }
+        }
+    }
+}
diff --git a/core/src/test/java/com/alibaba/fastjson2/issues_1700/Issue1766.java b/core/src/test/java/com/alibaba/fastjson2/issues_1700/Issue1766.java
@@ -8,6 +8,7 @@
 import org.junit.jupiter.api.Test;
 
 import static org.junit.jupiter.api.Assertions.assertSame;
+import static org.junit.jupiter.api.Assertions.assertTrue;
 
 public class Issue1766 {
     @Test
@@ -37,5 +38,12 @@ public void test() {
         JSONSchema person = schema.getDefs("person");
         ArraySchema personList = (ArraySchema) schema.getDefs("personList");
         assertSame(person, personList.getItemSchema());
+
+        assertTrue(
+                schema.validate(
+                        JSON.parseObject("\n" +
+                                "{\"family\":{\"name\":\"1\",\"children\":[{\"name\":\"2\"}]}}")
+                ).isSuccess()
+        );
     }
 }