SpringBoot2.X 遭遇 No converter found for return value of type: class java.util.LinkedHashMap

Love The Way You Lie 2022-05-11 13:36 255阅读 0赞

前几天，在项目上线时遭遇了 No converter found for return value of type: class java.util.LinkedHashMap 异常，异常的糟心唉。。。

场景重现：
return 基本类型木有问题，但是return 对象的时候就报出了该问题，
网上答案汇总：
1、缺失Jackson 依赖，如果有 spring-boot-starter-web依赖可排除该问题
2、是否是 POJO （get set 方法是否有）
注： 我使用lombok插件，同样排除了此项可能性
3、注解是否是 @RestController

以上可能性完全排除，由于上线紧急，暂时采用了
HttpServletReponse.getWriter().print() 的方式

昨天在朋友帮助下，推测出是Swagger2 的问题，便没有在继续进行下去，然而一小时前采用一个demo进行测试排查是，发现并不是，继续昨天的思路，问题可能出现在拦截器那里，于是乎，开始从拦截器分析，就在刚刚，终于分析出了问题所在…

— 2018/11/07 凌晨 00:30 重新改写，(上周，今晚抽空改写)在一位网友(微信昵称 rookie_cc )的帮助下发现之前的文章存在巨大漏洞

问题出现原因：
extends WebMvcConfigurationSupport，这种方式会屏蔽springboot @EnableAutoConfiguration中的设置

我的源码是这样的：

  1. /**
  2.  * 国际化默认语言配置及编码方式修改
  3.  * @author fxbin
  4.  * @version v1.0
  5.  * @since 2018/10/23 14:38
  6.  */
  7. @Configuration
  8. public class I18nConfig extends WebMvcConfigurationSupport {
  10.     @Bean
  11.     public LocaleResolver localeResolver() {
  12.         CookieLocaleResolver localeResolver = new CookieLocaleResolver();
  13.         //localeResolver.setCookieName("lang");
  14.         //设置默认区域
  15.         localeResolver.setDefaultLocale(new Locale("en", "US"));
  16.         //设置cookie有效期.
  17.         localeResolver.setCookieMaxAge(-1);
  19.         return localeResolver;
  20.     }
  22.     @Bean
  23.     public HttpMessageConverter<String> responseBodyConverter() {
  24.         StringHttpMessageConverter converter = new StringHttpMessageConverter(
  25.                 Charset.forName("UTF-8"));
  26.         return converter;
  27.     }
  29.     @Override
  30.     protected void configureMessageConverters(List<HttpMessageConverter<?>> converters) {
  31.         super.configureMessageConverters(converters);
  32.         converters.add(responseBodyConverter());
  33.     }
  35.     /**
  36.      * 解决SpringBoot2.X 加入拦截器后swagger2不能访问问题
  37.      * @author fxbin
  38.      * @param registry
  39.      */
  40.     @Override
  41.     public void addInterceptors(InterceptorRegistry registry) {
  42.         registry.addInterceptor(new LocaleChangeInterceptor())
  43.                 .excludePathPatterns("/swagger-resources/**", "/webjars/**", "/v2/**", "/swagger-ui.html/**");
  44.     }
  46.     @Override
  47.     public void addResourceHandlers(ResourceHandlerRegistry registry) {
  48.         registry.addResourceHandler("swagger-ui.html")
  49.                 .addResourceLocations("classpath:/META-INF/resources/");
  50.         registry.addResourceHandler("/webjars/**")
  51.                 .addResourceLocations("classpath:/META-INF/resources/webjars/");
  52.     }
  53. }

查看Spring Boot启动WebMVC自动配置的条件发现 ：

  1. @Configuration
  2. @ConditionalOnWebApplication(type = Type.SERVLET)
  3. @ConditionalOnClass({ Servlet.class, DispatcherServlet.class, WebMvcConfigurer.class })
  4. @ConditionalOnMissingBean(WebMvcConfigurationSupport.class)
  5. @AutoConfigureOrder(Ordered.HIGHEST_PRECEDENCE + 10)
  6. @AutoConfigureAfter({ DispatcherServletAutoConfiguration.class,
  7.         ValidationAutoConfiguration.class })
  8. public class WebMvcAutoConfiguration {

@ConditionalOnMissingBean(WebMvcConfigurationSupport.class)，只有当容器中没有WebMvcConfigurationSupport这个类型的组件的时候，才会启动自动配置。

所以当我们继承WebMvcConfigurationSupport之后，除非在继承类中重写了一系列有关WebMVC的配置，否则可能就会遇到静态资源访问不到，返回数据不成功这些一系列问题了。

鉴于SpringBoot2.X 中 WebMvcConfigurerAdapter 已经过时，所以可以实现 WebMvcConfigurer 接口来达到相同的目的
在这里插入图片描述

我的实现代码如下

  1. /**
  2.  * 国际化默认语言配置及编码方式修改
  3.  * @author fxbin
  4.  * @version v1.1
  5.  * @since 2018/8/23 14:38
  6.  * @see org.springframework.boot.autoconfigure.web.servlet.WebMvcAutoConfiguration
  7.  * @see org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter
  8.  */
  9. @Configuration
  10. public class I18nConfig implements WebMvcConfigurer {
  12.     @Bean
  13.     public LocaleResolver localeResolver() {
  14.         CookieLocaleResolver localeResolver = new CookieLocaleResolver();
  15.         //localeResolver.setCookieName("lang");
  16.         //设置默认区域
  17.         localeResolver.setDefaultLocale(new Locale("en", "US"));
  18.         //设置cookie有效期.
  19.         localeResolver.setCookieMaxAge(-1);
  21.         return localeResolver;
  22.     }
  24.     @Bean
  25.     public HttpMessageConverter<String> responseBodyConverter() {
  26.         StringHttpMessageConverter converter = new StringHttpMessageConverter(
  27.                 Charset.forName("UTF-8"));
  28.         return converter;
  29.     }
  31.     @Override
  32.     public void configureMessageConverters(List<HttpMessageConverter<?>> converters) {
  33.         converters.add(responseBodyConverter());
  34.     }
  35. }

总结：
1、@EnableWebMvc=WebMvcConfigurationSupport，使用了@EnableWebMvc注解等于扩展了WebMvcConfigurationSupport但是没有重写任何方法。@EnableWebMvc 和WebMvcConfigurationSupport 二者只能选一个，如果同时实现，则会失效 （感谢一位网友热心帮助，开始忽略了这个问题）
2、继承WebMvcConfigurationSupport， 需要重写一系列有关WebMVC的配置，否则可能就会遇到静态资源访问不到，返回数据不成功这些一系列问题了（我就是掉在此坑），
因为springboot已经实例化了WebMvcConfigurationSupport， 如果使用@EnableWebMvc 注解或者继承WebMvcConfigurationSupport会覆盖默认实现， 一般建议还是不覆盖默认的好
3、实现WebMvcConfigurer 接口
示例：

  1. import com.alibaba.fastjson.serializer.SerializerFeature;
  2. import com.alibaba.fastjson.support.config.FastJsonConfig;
  3. import com.alibaba.fastjson.support.spring.FastJsonHttpMessageConverter;
  4. import org.springframework.context.annotation.Configuration;
  5. import org.springframework.format.FormatterRegistry;
  6. import org.springframework.format.datetime.DateFormatter;
  7. import org.springframework.http.MediaType;
  8. import org.springframework.http.converter.HttpMessageConverter;
  9. import org.springframework.web.servlet.ModelAndView;
  10. import org.springframework.web.servlet.config.annotation.CorsRegistry;
  11. import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
  12. import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
  13. import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
  14. import org.springframework.web.servlet.handler.HandlerInterceptorAdapter;
  16. import javax.servlet.http.HttpServletRequest;
  17. import javax.servlet.http.HttpServletResponse;
  18. import java.time.LocalDate;
  19. import java.util.ArrayList;
  20. import java.util.List;
  22. /**
  23.  * 实现WebMvcConfigurer接口的部分示例...
  24.  *
  25.  * @author fxbin
  26.  * @version v1.0
  27.  * @since 2018/11/7 1:21
  28.  */
  29. @Configuration
  30. public class WebConfig implements WebMvcConfigurer {
  32.     /**
  33.      * 添加类型转换器和格式化器
  34.      * @author fxbin
  35.      * @param registry
  36.      */
  37.     @Override
  38.     public void addFormatters(FormatterRegistry registry) {
  39.         registry.addFormatterForFieldType(LocalDate.class, new DateFormatter());
  40.     }
  42.     /**
  43.      * 跨域支持
  44.      * @author fxbin
  45.      * @param registry
  46.      */
  47.     @Override
  48.     public void addCorsMappings(CorsRegistry registry) {
  49.         registry.addMapping("/**")
  50.                 .allowedOrigins("*")
  51.                 .allowCredentials(true)
  52.                 .allowedMethods("GET", "POST", "DELETE", "PUT")
  53.                 .maxAge(3600 * 24);
  54.     }
  56.     /**
  57.      * 添加静态资源--过滤swagger-api (开源的在线API文档)
  58.      * @author fxbin
  59.      * @param registry
  60.      */
  61.     @Override
  62.     public void addResourceHandlers(ResourceHandlerRegistry registry) {
  63.         //过滤swagger
  64.         registry.addResourceHandler("swagger-ui.html")
  65.                 .addResourceLocations("classpath:/META-INF/resources/");
  67.         registry.addResourceHandler("/webjars/**")
  68.                 .addResourceLocations("classpath:/META-INF/resources/webjars/");
  70.         registry.addResourceHandler("/swagger-resources/**")
  71.                 .addResourceLocations("classpath:/META-INF/resources/swagger-resources/");
  73.         registry.addResourceHandler("/swagger/**")
  74.                 .addResourceLocations("classpath:/META-INF/resources/swagger*");
  76.         registry.addResourceHandler("/v2/api-docs/**")
  77.                 .addResourceLocations("classpath:/META-INF/resources/v2/api-docs/");
  79.     }
  81.     /**
  82.      * 配置消息转换器--这里我用的是alibaba 开源的 fastjson
  83.      * @author fxbin
  84.      * @param converters
  85.      */
  86.     @Override
  87.     public void configureMessageConverters(List<HttpMessageConverter<?>> converters) {
  88.         //1.需要定义一个convert转换消息的对象;
  89.         FastJsonHttpMessageConverter fastJsonHttpMessageConverter = new FastJsonHttpMessageConverter();
  90.         //2.添加fastJson的配置信息，比如：是否要格式化返回的json数据;
  91.         FastJsonConfig fastJsonConfig = new FastJsonConfig();
  92.         fastJsonConfig.setSerializerFeatures(SerializerFeature.PrettyFormat,
  93.                 SerializerFeature.WriteMapNullValue,
  94.                 SerializerFeature.WriteNullStringAsEmpty,
  95.                 SerializerFeature.DisableCircularReferenceDetect,
  96.                 SerializerFeature.WriteNullListAsEmpty,
  97.                 SerializerFeature.WriteDateUseDateFormat);
  98.         //3处理中文乱码问题
  99.         List<MediaType> fastMediaTypes = new ArrayList<>();
  100.         fastMediaTypes.add(MediaType.APPLICATION_JSON_UTF8);
  101.         //4.在convert中添加配置信息.
  102.         fastJsonHttpMessageConverter.setSupportedMediaTypes(fastMediaTypes);
  103.         fastJsonHttpMessageConverter.setFastJsonConfig(fastJsonConfig);
  104.         //5.将convert添加到converters当中.
  105.         converters.add(fastJsonHttpMessageConverter);
  106.     }
  108.     /**
  109.      * 添加自定义的拦截器
  110.      * @author fxbin
  111.      * @param registry
  112.      */
  113.     @Override
  114.     public void addInterceptors(InterceptorRegistry registry) {
  115.         registry.addInterceptor(new MyInterceptor()).addPathPatterns("/**");
  116.     }
  117. }
  120. /**
  121.  * 拦截器
  122.  * @author fxbin
  123.  * @version v1.0
  124.  * @since 2018/11/7 1:25
  125.  */
  126. class MyInterceptor extends HandlerInterceptorAdapter {
  127.     @Override
  128.     public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
  129.         System.out.println("Interceptor preHandler method is running !");
  130.         return super.preHandle(request, response, handler);
  131.     }
  133.     @Override
  134.     public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
  135.         System.out.println("Interceptor postHandler method is running !");
  136.         super.postHandle(request, response, handler, modelAndView);
  137.     }
  139.     @Override
  140.     public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
  141.         System.out.println("Interceptor afterCompletion method is running !");
  142.         super.afterCompletion(request, response, handler, ex);
  143.     }
  145.     @Override
  146.     public void afterConcurrentHandlingStarted(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
  147.         System.out.println("Interceptor afterConcurrentHandlingStarted method is running !");
  148.         super.afterConcurrentHandlingStarted(request, response, handler);
  149.     }
  150. }

— end —

如有问题，请在评论区留言交流，谢谢

发表评论

表情：
评论列表 （有 0 条评论，255人围观）

还没有评论，来说两句吧...

相关阅读