valueList = Arrays.stream(enums)
- .map(e -> e.getValue().toString()).toList();
- schema.setEnum(valueList);
- String enumValueType = DocUtils.getEnumValueTypeAsString(enumClass);
- schema.setType(enumValueType);
- schema.setFormat(DocUtils.resolveFormat(enumValueType));
- }
-
-
- /**
- * 追加枚举描述
- *
- * @param originalDescription 原始描述
- * @param enumClass 枚举类型
- * @return 追加后的描述字符串
- */
- private String appendEnumDescription(String originalDescription, Class enumClass) {
- return originalDescription + "" + DocUtils.getDescMap(enumClass) + "";
- }
-
- /**
- * 解析原始类
- *
- * @param type 类型
- * @return 原始类的 Class 对象
- */
- private Class resolveRawClass(Type type) {
- if (type instanceof SimpleType) {
- return ((SimpleType) type).getRawClass();
- } else if (type instanceof CollectionType) {
- return ((CollectionType) type).getContentType().getRawClass();
- } else {
- return Object.class;
- }
- }
-}
diff --git a/continew-starter-api-doc/src/main/java/top/continew/starter/apidoc/util/DocUtils.java b/continew-starter-api-doc/src/main/java/top/continew/starter/apidoc/util/DocUtils.java
index 1961b7cf..fe4a5efe 100644
--- a/continew-starter-api-doc/src/main/java/top/continew/starter/apidoc/util/DocUtils.java
+++ b/continew-starter-api-doc/src/main/java/top/continew/starter/apidoc/util/DocUtils.java
@@ -1,15 +1,26 @@
+/*
+ * Copyright (c) 2022-present Charles7c Authors. All Rights Reserved.
+ *
+ * Licensed under the GNU LESSER GENERAL PUBLIC LICENSE 3.0;
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.gnu.org/licenses/lgpl.html
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
package top.continew.starter.apidoc.util;
-import cn.hutool.core.collection.CollUtil;
import java.lang.reflect.ParameterizedType;
import java.lang.reflect.Type;
import java.util.Arrays;
-import java.util.Collection;
import java.util.LinkedHashMap;
import java.util.Map;
-import java.util.Objects;
-import java.util.Set;
-import java.util.function.Function;
import java.util.stream.Collectors;
import org.springframework.web.bind.annotation.RestController;
import top.continew.starter.core.enums.BaseEnum;
@@ -17,116 +28,91 @@ import top.continew.starter.core.enums.BaseEnum;
/**
* 接口文档工具类
*
- * @Author echo
- * @date 2024/07/31
+ * @author echo
+ * @since 2.5.2
*/
public class DocUtils {
- private DocUtils() {
- }
+ private DocUtils() {
+ }
- /**
- * 获取枚举值类型
- *
- * @param enumClass 枚举类型
- * @return 枚举值类型
- */
- public static String getEnumValueTypeAsString(Class enumClass) {
- // 获取枚举类实现的所有接口
- Type[] interfaces = enumClass.getGenericInterfaces();
- // 定义枚举值类型的映射
- Map, String> typeMap = Map.of(
- Integer.class, "integer",
- Long.class, "long",
- Double.class, "number",
- String.class, "string"
- );
- // 遍历所有接口
- for (Type type : interfaces) {
- // 检查接口是否为参数化类型并且原始类型为 BaseEnum
- if (type instanceof ParameterizedType parameterizedType && parameterizedType.getRawType() == BaseEnum.class) {
- Type actualType = parameterizedType.getActualTypeArguments()[0];
- // 检查实际类型参数是否为类类型，并返回对应的字符串类型
- if (actualType instanceof Class actualClass) {
- return typeMap.getOrDefault(actualClass, "string");
+ /**
+ * 获取枚举值类型
+ *
+ * @param enumClass 枚举类型
+ * @return 枚举值类型
+ */
+ public static String getEnumValueTypeAsString(Class enumClass) {
+ // 获取枚举类实现的所有接口
+ Type[] interfaces = enumClass.getGenericInterfaces();
+ // 定义枚举值类型的映射
+ Map, String> typeMap = Map
+ .of(Integer.class, "integer", Long.class, "long", Double.class, "number", String.class, "string");
+ // 遍历所有接口
+ for (Type type : interfaces) {
+ // 检查接口是否为参数化类型并且原始类型为 BaseEnum
+ if (type instanceof ParameterizedType parameterizedType && parameterizedType
+ .getRawType() == BaseEnum.class) {
+ Type actualType = parameterizedType.getActualTypeArguments()[0];
+ // 检查实际类型参数是否为类类型，并返回对应的字符串类型
+ if (actualType instanceof Class actualClass) {
+ return typeMap.getOrDefault(actualClass, "string");
+ }
+ }
}
- }
+ // 默认返回 "string" 类型
+ return "string";
}
- // 默认返回 "string" 类型
- return "string";
- }
- /**
- * 解析枚举值的格式
- *
- * @param enumValueType 枚举值类型
- * @return String 格式化类型
- */
- public static String resolveFormat(String enumValueType) {
- return switch (enumValueType) {
- case "integer" -> "int32";
- case "long" -> "int64";
- case "number" -> "double";
- default -> enumValueType;
- };
- }
-
-
- /**
- * 具有RestController 注释 既检查是否继承了BaseController
- *
- * @param clazz clazz
- * @return boolean
- */
- public static boolean hasRestControllerAnnotation(Class clazz) {
- // 如果注释包含 RestController 注解，则返回 true
- if (clazz.isAnnotationPresent(RestController.class)) {
- return true;
+ /**
+ * 解析枚举值的格式
+ *
+ * @param enumValueType 枚举值类型
+ * @return String 格式化类型
+ */
+ public static String resolveFormat(String enumValueType) {
+ return switch (enumValueType) {
+ case "integer" -> "int32";
+ case "long" -> "int64";
+ case "number" -> "double";
+ default -> enumValueType;
+ };
}
- // 递归检查父类
- Class superClass = clazz.getSuperclass();
- // 循环检查父类
- while (superClass != null && !superClass.equals(Object.class)) {
- // 如果父类包含 RestController 注解，则返回 true
- if (hasRestControllerAnnotation(superClass)) {
- return true;
- }
- // 递归检查接口
- superClass = superClass.getSuperclass();
- }
- return false;
- }
- /**
- * 获取枚举描述 Map
- *
- * @param enumClass 枚举类型
- * @return 枚举描述 Map
- */
- public static Map getDescMap(Class enumClass) {
- BaseEnum[] enums = (BaseEnum[]) enumClass.getEnumConstants();
- return Arrays.stream(enums)
- .collect(Collectors.toMap(BaseEnum::getValue, BaseEnum::getDescription, (a, b) -> a, LinkedHashMap::new));
- }
-
- /**
- * 将collection转化为Set集合，但是两者的泛型不同
- * {@code Collection ------> Set }
- *
- * @param collection 需要转化的集合
- * @param function collection中的泛型转化为set泛型的lambda表达式
- * @param collection中的泛型
- * @param Set中的泛型
- * @return 转化后的Set
- */
- public static Set toSet(Collection collection, Function function) {
- if (CollUtil.isEmpty(collection) || function == null) {
- return CollUtil.newHashSet();
+ /**
+ * 具有 RestController 注释，既检查是否继承了BaseController
+ *
+ * @param clazz clazz
+ * @return boolean
+ */
+ public static boolean hasRestControllerAnnotation(Class clazz) {
+ // 如果注释包含 RestController 注解，则返回 true
+ if (clazz.isAnnotationPresent(RestController.class)) {
+ return true;
+ }
+ // 递归检查父类
+ Class superClass = clazz.getSuperclass();
+ // 循环检查父类
+ while (superClass != null && !superClass.equals(Object.class)) {
+ // 如果父类包含 RestController 注解，则返回 true
+ if (hasRestControllerAnnotation(superClass)) {
+ return true;
+ }
+ // 递归检查接口
+ superClass = superClass.getSuperclass();
+ }
+ return false;
+ }
+
+ /**
+ * 获取枚举描述 Map
+ *
+ * @param enumClass 枚举类型
+ * @return 枚举描述 Map
+ */
+ public static Map getDescMap(Class enumClass) {
+ BaseEnum[] enums = (BaseEnum[])enumClass.getEnumConstants();
+ return Arrays.stream(enums)
+ .collect(Collectors.toMap(BaseEnum::getValue, BaseEnum::getDescription, (a, b) -> a, LinkedHashMap::new));
}
- return collection
- .stream()
- .map(function)
- .filter(Objects::nonNull)
- .collect(Collectors.toSet());
- }
}
\ No newline at end of file
diff --git a/continew-starter-web/src/main/java/top/continew/starter/web/autoconfigure/response/ApiDocGlobalResponseHandler.java b/continew-starter-web/src/main/java/top/continew/starter/web/autoconfigure/response/ApiDocGlobalResponseHandler.java
new file mode 100644
index 00000000..a5e99c0a
--- /dev/null
+++ b/continew-starter-web/src/main/java/top/continew/starter/web/autoconfigure/response/ApiDocGlobalResponseHandler.java
@@ -0,0 +1,65 @@
+/*
+ * Copyright (c) 2022-present Charles7c Authors. All Rights Reserved.
+ *
+ * Licensed under the GNU LESSER GENERAL PUBLIC LICENSE 3.0;
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.gnu.org/licenses/lgpl.html
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package top.continew.starter.web.autoconfigure.response;
+
+import org.apache.commons.lang3.reflect.TypeUtils;
+import org.springdoc.core.parsers.ReturnTypeParser;
+import org.springframework.core.MethodParameter;
+import top.continew.starter.apidoc.util.DocUtils;
+import top.continew.starter.web.model.R;
+
+import java.lang.reflect.Type;
+
+/**
+ * SpringDoc 全局响应处理器
+ *
+ * 接口文档全局添加响应格式 {@link R}
+ *
+ *
+ * @author echo
+ * @since 2.5.2
+ */
+public class ApiDocGlobalResponseHandler implements ReturnTypeParser {
+
+ private static final Class R_TYPE = R.class;
+
+ /**
+ * 获取返回类型
+ *
+ * @param methodParameter 方法参数
+ * @return {@link Type }
+ */
+ @Override
+ public Type getReturnType(MethodParameter methodParameter) {
+ // 获取返回类型
+ Type returnType = ReturnTypeParser.super.getReturnType(methodParameter);
+ // 判断是否具有 RestController 注解
+ if (!DocUtils.hasRestControllerAnnotation(methodParameter.getContainingClass())) {
+ return returnType;
+ }
+ // 如果为 R 则直接返回
+ if (returnType.getTypeName().contains("top.continew.starter.web.model.R")) {
+ return returnType;
+ }
+ // 如果是 void类型，则返回 R
+ if (returnType == void.class || returnType == Void.class) {
+ return TypeUtils.parameterize(R_TYPE, Void.class);
+ }
+ // 返回 R
+ return TypeUtils.parameterize(R_TYPE, returnType);
+ }
+}
diff --git a/continew-starter-web/src/main/java/top/continew/starter/web/autoconfigure/response/GlobalResponseAutoConfiguration.java b/continew-starter-web/src/main/java/top/continew/starter/web/autoconfigure/response/GlobalResponseAutoConfiguration.java
index 33da3db5..e07df074 100644
--- a/continew-starter-web/src/main/java/top/continew/starter/web/autoconfigure/response/GlobalResponseAutoConfiguration.java
+++ b/continew-starter-web/src/main/java/top/continew/starter/web/autoconfigure/response/GlobalResponseAutoConfiguration.java
@@ -37,7 +37,6 @@ import top.continew.starter.core.constant.PropertiesConstants;
import top.continew.starter.core.util.GeneralPropertySourceFactory;
import java.util.Locale;
-import top.continew.starter.web.handler.DocGenericResponseHandler;
/**
* 全局响应自动配置
@@ -145,13 +144,14 @@ public class GlobalResponseAutoConfiguration {
}
/**
- * SpringDoc 通用响应处理 - 仅处理 doc 文档响应格式
+ * SpringDoc 全局响应处理器
*
- * @return {@link DocGenericResponseHandler }
+ * @return {@link ApiDocGlobalResponseHandler }
*/
@Bean
- public DocGenericResponseHandler genericResponseHandler() {
- return new DocGenericResponseHandler();
+ @ConditionalOnMissingBean
+ public ApiDocGlobalResponseHandler apiDocGlobalResponseHandler() {
+ return new ApiDocGlobalResponseHandler();
}
@PostConstruct
diff --git a/continew-starter-web/src/main/java/top/continew/starter/web/handler/DocGenericResponseHandler.java b/continew-starter-web/src/main/java/top/continew/starter/web/handler/DocGenericResponseHandler.java
deleted file mode 100644
index 43b75202..00000000
--- a/continew-starter-web/src/main/java/top/continew/starter/web/handler/DocGenericResponseHandler.java
+++ /dev/null
@@ -1,54 +0,0 @@
-package top.continew.starter.web.handler;
-
-
-
-import org.apache.commons.lang3.reflect.TypeUtils;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
-import org.springdoc.core.parsers.ReturnTypeParser;
-import org.springframework.core.MethodParameter;
-import top.continew.starter.apidoc.util.DocUtils;
-import top.continew.starter.web.model.R;
-
-import java.lang.reflect.Type;
-
-/**
- * SpringDoc 通用响应处理程序 --仅处理 doc 文档响应格式
- *
- 全局添加响应格式 {@link R}
- *
- * @Author echo
- * @date 2024/08/12
- */
-public class DocGenericResponseHandler implements ReturnTypeParser {
- private static final Logger log = LoggerFactory.getLogger(DocGenericResponseHandler.class);
-
- private static final Class R_TYPE = R.class;
-
- /**
- * 获取返回类型
- *
- * @param methodParameter 方法参数
- * @return {@link Type }
- */
- @Override
- public Type getReturnType(MethodParameter methodParameter) {
- // 获取返回类型
- Type returnType = ReturnTypeParser.super.getReturnType(methodParameter);
-
- // 判断是否具有RestController 注解
- if (!DocUtils.hasRestControllerAnnotation(methodParameter.getContainingClass())) {
- return returnType;
- }
- // 如果为R 则直接返回
- if (returnType.getTypeName().contains("top.continew.starter.web.model.R")) {
- return returnType;
- }
- // 如果是void类型，则返回R
- if (returnType == void.class || returnType == Void.class) {
- return TypeUtils.parameterize(R_TYPE, Void.class);
- }
- // 返回R
- return TypeUtils.parameterize(R_TYPE, returnType);
- }
-}
diff --git a/continew-starter-web/src/main/java/top/continew/starter/web/model/R.java b/continew-starter-web/src/main/java/top/continew/starter/web/model/R.java
index befcdc12..453e7e57 100644
--- a/continew-starter-web/src/main/java/top/continew/starter/web/model/R.java
+++ b/continew-starter-web/src/main/java/top/continew/starter/web/model/R.java
@@ -23,8 +23,6 @@ import com.feiniaojin.gracefulresponse.data.ResponseStatus;
import io.swagger.v3.oas.annotations.media.Schema;
import top.continew.starter.web.autoconfigure.response.GlobalResponseProperties;
-import java.util.Collections;
-
/**
* 响应信息
*
@@ -49,7 +47,7 @@ public class R implements Response {
/**
* 状态信息
*/
- @Schema(description = "状态信息", example = "操作成功")
+ @Schema(description = "状态信息", example = "ok")
private String msg;
/**