chore(web): BaseEnumConverterAutoConfiguration => WebMvcAutoConfiguration

continew-starter-web/src/main/java/top/continew/starter/web/autoconfigure/converter/BaseEnumConverterAutoConfiguration.java

@@ -1,48 +0,0 @@
-/*
- * Copyright (c) 2022-present Charles7c Authors. All Rights Reserved.
- * <p>
- * 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
- * <p>
- * http://www.gnu.org/licenses/lgpl.html
- * <p>
- * 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.converter;
-
-import jakarta.annotation.PostConstruct;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
-import org.springframework.boot.autoconfigure.AutoConfiguration;
-import org.springframework.format.FormatterRegistry;
-import org.springframework.web.servlet.config.annotation.EnableWebMvc;
-import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
-
-/**
- * BaseEnum 参数转换自动配置
- *
- * @author Charles7c
- * @since 2.4.0
- */
-@EnableWebMvc
-@AutoConfiguration
-public class BaseEnumConverterAutoConfiguration implements WebMvcConfigurer {
-
-    private static final Logger log = LoggerFactory.getLogger(BaseEnumConverterAutoConfiguration.class);
-
-    @Override
-    public void addFormatters(FormatterRegistry registry) {
-        registry.addConverterFactory(new BaseEnumConverterFactory());
-    }
-
-    @PostConstruct
-    public void postConstruct() {
-        log.debug("[ContiNew Starter] - Auto Configuration 'Web-BaseEnum Converter' completed initialization.");
-    }
-}

continew-starter-web/src/main/java/top/continew/starter/web/autoconfigure/mvc/BaseEnumConverter.java

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package top.continew.starter.web.autoconfigure.converter;
+package top.continew.starter.web.autoconfigure.mvc;
 
 import org.springframework.core.convert.converter.Converter;
 import top.continew.starter.core.enums.BaseEnum;

continew-starter-web/src/main/java/top/continew/starter/web/autoconfigure/mvc/BaseEnumConverterFactory.java

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package top.continew.starter.web.autoconfigure.converter;
+package top.continew.starter.web.autoconfigure.mvc;
 
 import org.springframework.core.convert.converter.Converter;
 import org.springframework.core.convert.converter.ConverterFactory;

continew-starter-web/src/main/java/top/continew/starter/web/autoconfigure/mvc/WebMvcAutoConfiguration.java

@@ -0,0 +1,81 @@
+/*
+ * Copyright (c) 2022-present Charles7c Authors. All Rights Reserved.
+ * <p>
+ * 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
+ * <p>
+ * http://www.gnu.org/licenses/lgpl.html
+ * <p>
+ * 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.mvc;
+
+import jakarta.annotation.PostConstruct;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.springframework.boot.autoconfigure.AutoConfiguration;
+import org.springframework.format.FormatterRegistry;
+import org.springframework.http.converter.ByteArrayHttpMessageConverter;
+import org.springframework.http.converter.HttpMessageConverter;
+import org.springframework.http.converter.json.MappingJackson2HttpMessageConverter;
+import org.springframework.scheduling.concurrent.ThreadPoolTaskExecutor;
+import org.springframework.web.servlet.config.annotation.EnableWebMvc;
+import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
+
+import java.util.List;
+import java.util.Objects;
+
+/**
+ * Web MVC 自动配置
+ *
+ * @author Charles7c
+ * @since 2.4.0
+ */
+@EnableWebMvc
+@AutoConfiguration
+public class WebMvcAutoConfiguration implements WebMvcConfigurer {
+
+    private static final Logger log = LoggerFactory.getLogger(WebMvcAutoConfiguration.class);
+    private final MappingJackson2HttpMessageConverter mappingJackson2HttpMessageConverter;
+
+    public WebMvcAutoConfiguration(MappingJackson2HttpMessageConverter mappingJackson2HttpMessageConverter,
+                                   ThreadPoolTaskExecutor threadPoolTaskExecutor) {
+        this.mappingJackson2HttpMessageConverter = mappingJackson2HttpMessageConverter;
+    }
+
+    /**
+     * 解决 Jackson2ObjectMapperBuilderCustomizer 配置不生效的问题
+     * <p>
+     * MappingJackson2HttpMessageConverter 对象在程序启动时创建了多个，移除多余的，保证只有一个
+     * </p>
+     */
+    @Override
+    public void extendMessageConverters(List<HttpMessageConverter<?>> converters) {
+        converters.removeIf(MappingJackson2HttpMessageConverter.class::isInstance);
+        if (Objects.isNull(mappingJackson2HttpMessageConverter)) {
+            converters.add(0, new MappingJackson2HttpMessageConverter());
+        } else {
+            converters.add(0, mappingJackson2HttpMessageConverter);
+        }
+        // 自定义 converters 时，需要手动在最前面添加 ByteArrayHttpMessageConverter
+        // 否则 Spring Doc OpenAPI 的 /*/api-docs/**（例如：/v3/api-docs/default）接口响应内容会变为 Base64 编码后的内容，最终导致接口文档解析失败
+        // 详情请参阅：https://github.com/springdoc/springdoc-openapi/issues/2143
+        converters.add(0, new ByteArrayHttpMessageConverter());
+    }
+
+    @Override
+    public void addFormatters(FormatterRegistry registry) {
+        registry.addConverterFactory(new BaseEnumConverterFactory());
+    }
+
+    @PostConstruct
+    public void postConstruct() {
+        log.debug("[ContiNew Starter] - Auto Configuration 'Web MVC' completed initialization.");
+    }
+}

continew-starter-web/src/main/resources/META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports

@@ -1,4 +1,4 @@
-top.continew.starter.web.autoconfigure.converter.BaseEnumConverterAutoConfiguration
+top.continew.starter.web.autoconfigure.mvc.WebMvcAutoConfiguration
 top.continew.starter.web.autoconfigure.cors.CorsAutoConfiguration
 top.continew.starter.web.autoconfigure.trace.TraceAutoConfiguration
 top.continew.starter.web.autoconfigure.xss.XssAutoConfiguration