失效原因

• 经常会在初始化项目的时候配置一个HttpMessageConverter来配置Json序列化器，但是经常配置了过后就导致SB的static-locations配置失效，导致静态文件不显示。

• 配置文件如下：

  @EnableWebMvc
  @Configuration
  public class GlobalConfiguration extends WebMvcConfigurationSupport {
      /**
       * 对象映射器
       *
       * @return {@link ObjectMapper}
       */
      @Bean
      ObjectMapper objectMapper(){
          return new ObjectMapper()
                  .configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);
      }
  
      @Override
      protected void extendMessageConverters(List<HttpMessageConverter<?>> converters) {
          ObjectMapper mapper = getApplicationContext().getBean(ObjectMapper.class);
          HttpMessageConverter<Object> jsonConvert = new MappingJackson2HttpMessageConverter(mapper);
          converters.add(jsonConvert);
      }
  
  }

• 这里继承了WebMvcConfigurationSupport并且作为一个配置的Bean。

• 失效原因：

  • 而SpringBoot对于static-locations配置进行处理的自动配置类是WebMvcAutoConfiguration，这个类有个注解是：@ConditionalOnMissingBean(WebMvcConfigurationSupport.class)，即在缺失WebMvcConfigurationSupport的Bean的时候才会启动自动配置，因此，由于上面我定义了一个WebMvcConfigurationSupport的Bean，所以导致了配置文件失效。
  • 注：@EnableWebMvc也不能有，其也会阻止自动配置的加载
  • 注册静态资源Handler的方法为：WebMvcConfigurerComposite#addResourceHandlers

• 解决方法：

  • 方法1：手动在代码里面添加静态资源映射（不咋推荐），这也是大部分博客给出的解决方法。

    @Override
    protected void addResourceHandlers(ResourceHandlerRegistry registry) {
        registry.addResourceHandler("请求路径").addResourceLocations("资源路径");
        super.addResourceHandlers(registry);
    }

  • 方法2：通过实现WebMvcConfigurer来扩展配置：

    // @EnableWebMvc 注，这个也不能有，也会阻止自动配置的加载
    @Configuration
    public class GlobalConfiguration implements WebMvcConfigurer {
        private ObjectMapper objectMapper;
        /**
         * 对象映射器
         *
         * @return {@link ObjectMapper}
         */
        @Bean
        ObjectMapper objectMapper(){
            this.objectMapper = new ObjectMapper()
                    .configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);
            return objectMapper;
        }
    
        @Override
        public void extendMessageConverters(List<HttpMessageConverter<?>> converters) {
            HttpMessageConverter<Object> jsonConvert = new MappingJackson2HttpMessageConverter(objectMapper);
            converters.add(jsonConvert);
        }
    }

官方文档

• 官方文档关于此处的介绍

总结

• SpringBoot对MVC的配置扩展有两种方式：
  • @EnableWebMvc注解 + 继承WebMvcConfigurationSupport，这将完全屏蔽掉SpringBoot的自动配置。
  • 实现WebMvcConfigurer接口，不会屏蔽掉SpringBoot的自动配置。
• 论看官方文档的重要性