解決springboot 2.x 裡面訪問靜態資源的坑

Posted on by

springboot 2.x 裡面訪問靜態資源的坑

在spring boot的自定義配置類繼承 WebMvcConfigurationSupport 後，發現自動配置的靜態資源路徑

classpath:/META/resources/，classpath:/resources/，classpath:/static/，classpath:/public/

不生效。

首先看一下 自動配置類的定義：

這是因為在 springboot的web自動配置類 WebMvcAutoConfiguration 上有條件註解

@ConditionalOnMissingBean(WebMvcConfigurationSupport.class)

這個註解的意思是在項目類路徑中 缺少 WebMvcConfigurationSupport類型的bean時改自動配置類才會生效，所以繼承 WebMvcConfigurationSupport 後需要自己再重寫相應的方法。

如果想要使用自動配置生效

又要按自己的需要重寫某些方法，比如增加 viewController ，則可以自己的配置類可以繼承 WebMvcConfigurerAdapter 這個類。不過在spring5.0版本後這個類被丟棄瞭 WebMvcConfigurerAdapter ，雖然還可以用，但是看起來不好。

/**
 * 原來是這麼寫的：
 * public class BeanConfiguration extends WebMvcConfigurationSupport
 * 導致默認配置的靜態資源不生效瞭
 */
@Configuration
public class BeanConfiguration implements WebMvcConfigurer {
    @Bean
    public MappingJackson2HttpMessageConverter jackson2HttpMessageConverter() {
        MappingJackson2HttpMessageConverter converter = new MappingJackson2HttpMessageConverter();
        ObjectMapper mapper = new ObjectMapper();
        mapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);
        mapper.setDateFormat(new SimpleDateFormat("yyyy-MM-dd HH:mm:ss"));
        mapper.setTimeZone(TimeZone.getTimeZone("GMT+8"));
        mapper.setDefaultPropertyInclusion(JsonInclude.Include.ALWAYS);
        converter.setObjectMapper(mapper);
        return converter;
    }
    @Override
    public void configureMessageConverters(List<HttpMessageConverter<?>> converters) {
        //將我們定義的時間格式轉換器添加到轉換器列表中,
        //這樣jackson格式化時候但凡遇到Date類型就會轉換成我們定義的格式
        converters.add(jackson2HttpMessageConverter());
        // 添加字符串轉換，否認如果返回字符串，則會報異常，其他converter 
        // 參考：org.springframework.web.servlet.config.annotation.WebMvcConfigurationSupport#addDefaultHttpMessageConverters
        StringHttpMessageConverter stringHttpMessageConverter = new StringHttpMessageConverter();
        stringHttpMessageConverter.setWriteAcceptCharset(false);  // see SPR-7316
        converters.add(stringHttpMessageConverter);
    }
}

SpringBoot2.x過後static下的靜態資源無法訪問

package com.example.thymeleaf.commons; 
import org.springframework.stereotype.Component;
import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
 
/**
 * 配置靜態資源映射
 *
 * @author sunziwen
 * @version 1.0
 * @date 2018-11-16 14:57
 **/
@Component
public class WebMvcConfig implements WebMvcConfigurer {
    /**
     * 添加靜態資源文件，外部可以直接訪問地址
     *
     * @param registry
     */
    @Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {
        registry.addResourceHandler("/static/**").addResourceLocations("classpath:/static/");
    }
}

以上為個人經驗，希望能給大傢一個參考，也希望大傢多多支持WalkonNet。

推薦閱讀：