Spring Boot 靜態資源配置 A卷

胖先森發表於2018-12-28
Spring Boot

Spring Boot 靜態資原始檔配置

說在前面的話：

  • 建立SpringBoot應用，選中我們需要的模組

  • SpringBoot已經預設將這些場景配置好了，只需要在配置檔案中指定少量配置就可以執行起來

  • 自己編寫業務程式碼

由於 Spring Boot 採用了”約定優於配置”這種規範，所以在使用靜態資源的時候也很簡單。

SpringBoot本質上是為微服務而生的，以JAR的形式啟動執行，但是有時候靜態資源的訪問是必不可少的，比如：image、js、css 等資源的訪問

1.webjars配置靜態路徑

簡單瞭解即可，感覺實用性不大，

public class WebMvcAutoConfiguration {
	     public void addResourceHandlers(ResourceHandlerRegistry registry) {
            if (!this.resourceProperties.isAddMappings()) {
                logger.debug("Default resource handling disabled");
            } else {
                Duration cachePeriod = this.resourceProperties.getCache().getPeriod();
                CacheControl cacheControl = this.resourceProperties.getCache().getCachecontrol().toHttpCacheControl();
                if (!registry.hasMappingForPattern("/webjars/**")) {
                    this.customizeResourceHandlerRegistration(registry.addResourceHandler(new String[]{"/webjars/**"}).addResourceLocations(new String[]{"classpath:/META-INF/resources/webjars/"}).setCachePeriod(this.getSeconds(cachePeriod)).setCacheControl(cacheControl));
                }

                String staticPathPattern = this.mvcProperties.getStaticPathPattern();
                if (!registry.hasMappingForPattern(staticPathPattern)) {
                    this.customizeResourceHandlerRegistration(registry.addResourceHandler(new String[]{staticPathPattern}).addResourceLocations(getResourceLocations(this.resourceProperties.getStaticLocations())).setCachePeriod(this.getSeconds(cachePeriod)).setCacheControl(cacheControl));
                }

            }
        }
}
複製程式碼

程式碼分析: 所有 /webjars/**，都去classpath:/META-INF/resources/webjars/找資源；webjars：以jar包的方式引入靜態資源； webjars提供的依賴官網

Spring Boot 靜態資源配置 A卷

<dependency>
    <groupId>org.webjars</groupId>
    <artifactId>jquery</artifactId>
    <version>1.12.4</version>
</dependency>
複製程式碼

Spring Boot 靜態資源配置 A卷

啟動服務，測試訪問靜態地址http://127.0.0.1:8001/hp/webjars/jquery/1.12.4/jquery.js

2.預設靜態資源路徑

@ConfigurationProperties(
    prefix = "spring.resources",
    ignoreUnknownFields = false
)
public class ResourceProperties {
    private static final String[] CLASSPATH_RESOURCE_LOCATIONS = new String[]{"classpath:/META-INF/resources/", "classpath:/resources/", "classpath:/static/", "classpath:/public/"};
    private String[] staticLocations;
    private boolean addMappings;
    private final ResourceProperties.Chain chain;
    private final ResourceProperties.Cache cache;

    public ResourceProperties() {
        this.staticLocations = CLASSPATH_RESOURCE_LOCATIONS;
        this.addMappings = true;
        this.chain = new ResourceProperties.Chain();
        this.cache = new ResourceProperties.Cache();
    }

    public String[] getStaticLocations() {
        return this.staticLocations;
    }
}
複製程式碼

摘抄了部分原始碼，算是為了增加篇幅，從上述程式碼中我們可以看到，提供了幾種預設的配置方式

classpath:/static
classpath:/public
classpath:/resources
classpath:/META-INF/resources
備註說明: "/"=>當前專案的根路徑
複製程式碼

我們在src/main/resources目錄下新建 public、resources、static 、META-INF等目錄目錄，並分別放入 1.jpg 2.jpg 3.jpg 4.jpg 5.jpg 五張圖片。

Spring Boot 靜態資源配置 A卷

**注意:**需要排除webjars的形式，將pom.xml中的程式碼去掉，在進行測試結果結果如下

Spring Boot 靜態資源配置 A卷

3.新增靜態資源路徑

我們在spring.resources.static-locations後面追加一個配置classpath:/os/：

# 靜態檔案請求匹配方式
spring.mvc.static-path-pattern=/**
# 修改預設的靜態定址資源目錄 多個使用逗號分隔
spring.resources.static-locations = classpath:/META-INF/resources/,classpath:/resources/,classpath:/static/,classpath:/public/,classpath:/os/
複製程式碼

4.自定義靜態資源對映

在實際開發中，我們可能需要自定義靜態資源訪問以及上傳路徑，特別是檔案上傳，不可能上傳的執行的JAR服務中，那麼可以通過繼承WebMvcConfigurerAdapter來實現自定義路徑對映。

application.properties 檔案配置：

# 圖片音訊上傳路徑配置(win系統自行變更本地路徑)
web.upload.path=D:/upload/attr/
複製程式碼

Demo05BootApplication.java 啟動配置：

package com.hanpang;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

@SpringBootApplication
public class Demo05BootApplication implements WebMvcConfigurer {
    private final static Logger LOGGER = LoggerFactory.getLogger(Demo05BootApplication.class);

    @Value("${web.upload.path}")
    private String uploadPath;

    @Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {
        registry.addResourceHandler("/uploads/**").addResourceLocations(
                "file:" + uploadPath);
        LOGGER.info("自定義靜態資源目錄、此處功能用於檔案對映");
    }

    public static void main(String[] args) {
        
        SpringApplication.run(Demo05BootApplication.class, args);
    }

}
複製程式碼

5.設定歡迎介面

依然從原始碼出手來解決這個問題

public class WebMvcAutoConfiguration {
            private Optional<Resource> getWelcomePage() {
            String[] locations = getResourceLocations(this.resourceProperties.getStaticLocations());
            return Arrays.stream(locations).map(this::getIndexHtml).filter(this::isReadable).findFirst();
        }

        private Resource getIndexHtml(String location) {
            return this.resourceLoader.getResource(location + "index.html");
        }
}
複製程式碼

5.1 直接設定靜態預設頁面

歡迎頁； 靜態資原始檔夾下的所有index.html頁面，被"/**"對映；

Spring Boot 靜態資源配置 A卷

5.2 增加控制器的方式

  • 新增模版引擎的支援

    <dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-thymeleaf</artifactId>
</dependency>
複製程式碼

  • 配置核心檔案application.properties

    server.port=8001
server.servlet.context-path=/hp
spring.mvc.view.prefix=classpath:/templates/
複製程式碼

    沒有去設定字尾名

  • 設定增加路由

    @Controller
public class IndexController {
    @GetMapping({"/","/index"})
    public String index(){
        return "default";
    }
}
複製程式碼

  • 訪問http://127.0.0.1:8001/hp/

5.3 設定預設的View跳轉頁面

  • 新增模版引擎的支援

    <dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-thymeleaf</artifactId>
</dependency>
複製程式碼

  • 配置核心檔案application.properties

    server.port=8001
server.servlet.context-path=/hp
spring.mvc.view.prefix=classpath:/templates/
複製程式碼

    沒有去設定字尾名

  • 啟動檔案的修改如下

    @SpringBootApplication
public class Demo05BootApplication implements WebMvcConfigurer {
    @Override
    public void addViewControllers(ViewControllerRegistry registry) {
        registry.addViewController("/").setViewName("default");
        registry.addViewController("/index1").setViewName("default");
        registry.setOrder(Ordered.HIGHEST_PRECEDENCE);
    }

    public static void main(String[] args) {

        SpringApplication.run(Demo05BootApplication.class, args);
    }

}
複製程式碼

6. Favicon設定

 @Configuration
        @ConditionalOnProperty(
            value = {"spring.mvc.favicon.enabled"},
            matchIfMissing = true
        )
        public static class FaviconConfiguration implements ResourceLoaderAware {
            private final ResourceProperties resourceProperties;
            private ResourceLoader resourceLoader;

            public FaviconConfiguration(ResourceProperties resourceProperties) {
                this.resourceProperties = resourceProperties;
            }

            public void setResourceLoader(ResourceLoader resourceLoader) {
                this.resourceLoader = resourceLoader;
            }

            @Bean
            public SimpleUrlHandlerMapping faviconHandlerMapping() {
                SimpleUrlHandlerMapping mapping = new SimpleUrlHandlerMapping();
                mapping.setOrder(-2147483647);
                mapping.setUrlMap(Collections.singletonMap("**/favicon.ico", this.faviconRequestHandler()));
                return mapping;
            }

            @Bean
            public ResourceHttpRequestHandler faviconRequestHandler() {
                ResourceHttpRequestHandler requestHandler = new ResourceHttpRequestHandler();
                requestHandler.setLocations(this.resolveFaviconLocations());
                return requestHandler;
            }

            private List<Resource> resolveFaviconLocations() {
                String[] staticLocations = WebMvcAutoConfiguration.WebMvcAutoConfigurationAdapter.getResourceLocations(this.resourceProperties.getStaticLocations());
                List<Resource> locations = new ArrayList(staticLocations.length + 1);
                Stream var10000 = Arrays.stream(staticLocations);
                ResourceLoader var10001 = this.resourceLoader;
                var10001.getClass();
                var10000.map(var10001::getResource).forEach(locations::add);
                locations.add(new ClassPathResource("/"));
                return Collections.unmodifiableList(locations);
            }
        }
複製程式碼

SpringBoot 預設是開啟Favicon，並且提供了一個預設的Favicon，如果想關閉Favicon，只需要在application.properties中新增

spring.mvc.favicon.enabled=false
複製程式碼

如果想更改Favicon，只需要將自己的Favicon.ico（檔名不能改動），放置到類路徑根目錄、類路徑META_INF/resources/下、類路徑resources/下、類路徑static/下或者類路徑public/下。

5.附錄

A.WebMvcConfigurerAdapter過時

在Springboot中配置WebMvcConfigurerAdapter的時候發現這個類過時了。所以看了下原始碼，發現官方在spring5棄用了WebMvcConfigurerAdapter，因為springboot2.0使用的spring5，所以會出現過時。

WebMvcConfigurerAdapter已經過時，在新版本中被廢棄，以下是比較常用的重寫介面：

/** 解決跨域問題 **/
public void addCorsMappings(CorsRegistry registry) ;
/** 新增攔截器 **/
void addInterceptors(InterceptorRegistry registry);
/** 這裡配置檢視解析器 **/
void configureViewResolvers(ViewResolverRegistry registry);
/** 配置內容裁決的一些選項 **/
void configureContentNegotiation(ContentNegotiationConfigurer configurer);
/** 檢視跳轉控制器 **/
void addViewControllers(ViewControllerRegistry registry);
/** 靜態資源處理 **/
void addResourceHandlers(ResourceHandlerRegistry registry);
/** 預設靜態資源處理器 **/
void configureDefaultServletHandling(DefaultServletHandlerConfigurer configurer);
複製程式碼

方案1：直接實現WebMvcConfigurer

@Configuration
public class WebMvcConfg implements WebMvcConfigurer {
    @Override
    public void addViewControllers(ViewControllerRegistry registry) {
        registry.addViewController("/index").setViewName("index");
    }
}
複製程式碼

方案2：直接繼承WebMvcConfigurationSupport

@Configuration
public class WebMvcConfg extends WebMvcConfigurationSupport {
    @Override
    public void addViewControllers(ViewControllerRegistry registry) {
        registry.addViewController("/index").setViewName("index");
    }
}
複製程式碼

其實，原始碼下WebMvcConfigurerAdapter是實現WebMvcConfigurer介面，所以直接實現WebMvcConfigurer介面也可以；WebMvcConfigurationSupport與WebMvcConfigurerAdapter、介面WebMvcConfigurer處於同一個目錄下WebMvcConfigurationSupport包含WebMvcConfigurer裡面的方法，由此看來版本中應該是推薦使用WebMvcConfigurationSupport類的，WebMvcConfigurationSupport應該是新版本中對WebMvcConfigurerAdapter的替換和擴充套件

B.關於載入目錄問題

// 可以直接使用addResourceLocations 指定磁碟絕對路徑，同樣可以配置多個位置，注意路徑寫法需要加上file:
registry.addResourceHandler("/myimgs/**").addResourceLocations("file:H:/myimgs/");
複製程式碼
// 訪問myres根目錄下的fengjing.jpg 的URL為 http://localhost:8080/fengjing.jpg （/** 會覆蓋系統預設的配置）
registry.addResourceHandler("/**").addResourceLocations("classpath:/myres/").addResourceLocations("classpath:/static/");
複製程式碼

相關文章