修复 solon-swagger2-knife4j 插件，递归类型的数据模型会栈溢出的问题

opensolon · Jul 19, 2023 · 8430856 · 8430856
1 parent 42f024a
commit 8430856
Show file tree

Hide file tree

Showing 4 changed files with 49 additions and 11 deletions.
diff --git a/UPDATE_LOG.md b/UPDATE_LOG.md
@@ -44,7 +44,7 @@
 * 优化 Nami 编码器匹配策略及头同步策略，尤其是仅单编码包引入时
 * 优化 AbstractRoutingDataSource 的关闭处理
 * 优化 ShardingDataSource 增加 Closeable 接口支持
-* 修复 solon-swagger2-knife4j 插件，递归类型的数据结构会栈溢出的问题???
+* 修复 solon-swagger2-knife4j 插件，递归类型的数据模型会栈溢出的问题
 * dbvisitor 升为 5.3.3
 * mybatis-flex 升为 1.5.0
 * fastmybatis 升为 2.8.1

diff --git a/...ts/solon-base/solon.docs/src/main/java/org/noear/solon/docs/openapi2/Swagger2Builder.java b/...ts/solon-base/solon.docs/src/main/java/org/noear/solon/docs/openapi2/Swagger2Builder.java
@@ -629,10 +629,16 @@ private Model parseSwaggerModel(Class<?> clazz, Type type) {
                     }
 
                     if (itemClazz instanceof Class) {
-                        ModelImpl swaggerModel = (ModelImpl) this.parseSwaggerModel((Class<?>) itemClazz, itemClazz);
-
-                        RefProperty itemPr = new RefProperty(swaggerModel.getName(), RefFormat.INTERNAL);
-                        fieldPr.setItems(itemPr);
+                        if(itemClazz.equals(type)){
+                            //避免出现循环依赖，然后 oom
+                            RefProperty itemPr = new RefProperty(modelName, RefFormat.INTERNAL);
+                            fieldPr.setItems(itemPr);
+                        }else {
+                            ModelImpl swaggerModel = (ModelImpl) this.parseSwaggerModel((Class<?>) itemClazz, itemClazz);
+
+                            RefProperty itemPr = new RefProperty(swaggerModel.getName(), RefFormat.INTERNAL);
+                            fieldPr.setItems(itemPr);
+                        }
                     }
 
 
@@ -643,14 +649,24 @@ private Model parseSwaggerModel(Class<?> clazz, Type type) {
 
 
             if (BuilderHelper.isModel(typeClazz)) {
-                ModelImpl swaggerModel = (ModelImpl) this.parseSwaggerModel(typeClazz, typeClazz);
+                if(typeClazz.equals(type)){
+                    //避免出现循环依赖，然后 oom
+                    RefProperty fieldPr = new RefProperty(modelName, RefFormat.INTERNAL);
+                    if (apiField != null) {
+                        fieldPr.setDescription(apiField.value());
+                    }
 
-                RefProperty fieldPr = new RefProperty(swaggerModel.getName(), RefFormat.INTERNAL);
-                if (apiField != null) {
-                    fieldPr.setDescription(apiField.value());
-                }
+                    fieldList.put(field.getName(), fieldPr);
+                }else {
+                    ModelImpl swaggerModel = (ModelImpl) this.parseSwaggerModel(typeClazz, typeClazz);
 
-                fieldList.put(field.getName(), fieldPr);
+                    RefProperty fieldPr = new RefProperty(swaggerModel.getName(), RefFormat.INTERNAL);
+                    if (apiField != null) {
+                        fieldPr.setDescription(apiField.value());
+                    }
+
+                    fieldList.put(field.getName(), fieldPr);
+                }
             } else {
                 ObjectProperty fieldPr = new ObjectProperty();
                 fieldPr.setName(field.getName());

diff --git a/.../solon-swagger2-knife4j/src/test/java/com/swagger/demo/controller/app/DemoController.java b/.../solon-swagger2-knife4j/src/test/java/com/swagger/demo/controller/app/DemoController.java
@@ -1,6 +1,7 @@
 package com.swagger.demo.controller.app;
 
 
+import com.swagger.demo.model.bean.Node;
 import io.swagger.annotations.Api;
 import io.swagger.annotations.ApiImplicitParam;
 import io.swagger.annotations.ApiImplicitParams;
@@ -36,4 +37,10 @@ public class DemoController {
     public Map test2() {
         return new HashMap();
     }
+
+    @ApiOperation("复杂返回树")
+    @Mapping("test3")
+    public Node test3(){
+        return new Node();
+    }
 }
diff --git a/...cts/solon-tool/solon-swagger2-knife4j/src/test/java/com/swagger/demo/model/bean/Node.java b/...cts/solon-tool/solon-swagger2-knife4j/src/test/java/com/swagger/demo/model/bean/Node.java
@@ -0,0 +1,15 @@
+package com.swagger.demo.model.bean;
+
+import java.util.List;
+
+/**
+ * @author noear 2023/7/19 created
+ */
+public class Node {
+    int id;
+    int pid;
+
+    List<Node> children;
+
+    Node last;
+}