天天看點

Spring Boot 靜态資源處理,妙!

做web開發的時候,我們往往會有很多靜态資源,如html、圖檔、css等。那如何向前端傳回靜态資源呢?

以前做過web開發的同學應該知道,我們以前建立的web工程下面會有一個webapp的目錄,我們隻要把靜态資源放在該目錄下就可以直接通路。

但是,基于Spring boot的工程并沒有這個目錄,那我們應該怎麼處理?

一、最笨的方式

我們首先來分享一種最笨的辦法,就是将靜态資源通過流直接傳回給前端,我們在maven工程的resources的根目錄下建立一個html的目錄,然後我們把html檔案放在該目錄下,并且規定任何通路路徑以/static/開頭的即通路該目錄下的靜态資源,其實作如下:

@Controller
public class StaticResourceController {

    @RequestMapping("/static/**")
    public void getHtml(HttpServletRequest request, HttpServletResponse response) {
        String uri = request.getRequestURI();
        String[] arr = uri.split("static/");
        String resourceName = "index.html";
        if (arr.length > 1) {
            resourceName = arr[1];
        }
        String url = StaticResourceController.class.getResource("/").getPath() + "html/" + resourceName;
        try {
            FileReader reader = new FileReader(new File(url));
            BufferedReader br = new BufferedReader(reader);
            StringBuilder sb = new StringBuilder();
            String line = br.readLine();
            while (line != null) {
                sb.append(line);
                line = br.readLine();
            }
            response.getOutputStream().write(sb.toString().getBytes());
            response.flushBuffer();
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
}      

其實作過程很簡單,就是先從路徑中分離出來資源uri,然後從static目錄下讀取檔案,并輸出到前端。

因為隻做簡單示範,是以這裡隻處理了文本類型的檔案,圖檔檔案可以做類似的處理。當然,我們在實際中肯定不會這麼做,Spring Boot 也肯定有更好的解決辦法。

不過這個辦法雖然有點笨,但确是最本質的東西,無論架構如何友善的幫我們處理了這類問題,但是抛開架構,我們依然要能夠熟練的寫出一個web項目,隻有知道其實作原理,你才會在遇到問題時能得心應手。

現在我們再來看看Spring boot對靜态資源的支援。

二、Spring boot預設靜态資源通路方式

Spring boot預設對/**的通路可以直接通路四個目錄下的檔案:

classpath:/public/

classpath:/resources/

classpath:/static/

classpath:/META-INFO/resouces/

我們現在就在資源檔案resources目錄下建立如下四個目錄:

Spring Boot 靜态資源處理,妙!

注意藍色條下的資源檔案夾resources與類路徑下的檔案夾classpath:/resources是不同的,藍色條下的resources代表的是該目錄下的檔案為資源檔案,在打包的時候會将該目錄下的檔案全部打包的類路徑下,這個名稱是可以改的,在pom.xml指定資源目錄即可:

<resources>
     <resource>
         <directory>src/main/resources</directory>
     </resource>
</resources>      

而類路徑下的resources是spring boot預設的靜态資源檔案夾之一,和public、static以及MEAT-INFO/resources的功能相同。現在我們重新開機Spring boot就可以通過:

http://localhost:8080/1.html

http://localhost:8080/2.html

http://localhost:8080/3.html

http://localhost:8080/4.html

四個URL通路到四個目錄下的靜态資源了。

三、自定義靜态資源目錄

通過第二節内容我們已經知道了Spring boot預設可以通路的靜态資源的目錄,但是大家肯定會想,這個目錄是固定的嗎?我們可不可以自己定義靜态資源目錄?

答案是肯定的,我們現在就來自定義一個靜态資源目錄,我們定義一個images的目錄來存放圖檔,所有/image/**的路徑都會通路images目錄下的資源:

@Configuration
public class ImageMvcConfig extends WebMvcConfigurerAdapter {

    @Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {
        registry.addResourceHandler("/image/**")
                .addResourceLocations("classpath:/images/");
    }
}      

這段代碼應該比較簡單,@Configuration辨別一個配置類,這個在前面的文章中提到過多次。推薦閱讀:Spring零配置之@Configuration注解詳解。

WebMvcConfigurerAdapter是Spring提供的一個配置mvc的擴充卡,裡面有很多配置的方法,addResourceHandlers就是專門處理靜态資源的方法,其他方法後續我們還會講到。

現在我們在驗證上面的配置是否有效。我在images目錄下放了一張spring.jpg的圖檔,現在我們通過http://localhost:8080/image/spring.jpg來通路圖檔:

Spring Boot 靜态資源處理,妙!

其實除了上面的辦法還有一種更簡單的辦法,就是直接在application.yml中配置即可:

spring:
  mvc:
    static-path-pattern: /image/**
  resources:
    static-locations: classpath:/images/      

static-path-pattern:通路模式,預設為/**,多個可以逗号分隔

static-locations:資源目錄,多個目錄逗号分隔,預設資源目錄為classpath:/META-INF/resources/,classpath:/resources/,classpath:/static/,classpath:/public/

注意,這個配置會覆寫Spring boot預設的靜态資源目錄,例如如果按示例中配置,則無法再通路static、public、resources等目錄下的資源了。

四、總結

本文主要給大家分享了Spring boot 對靜态資源的處理方式,Spring boot 預設可以通路

classpath:/META-INF/resources/,classpath:/resources/,classpath:/static/,classpath:/public/

四個目錄下的靜态資源,我們也可以根據自己的需要進行個性化配置。

最後,需要說明一點的是,如果這四個目錄中存在相同名稱的資源,那會優先傳回哪個目錄下的資源呢?

大家通過static-locations的預設值順序應該能猜到,預設情況下,Spring boot會優先傳回/META-INF/resources下的資源。

當然,因為我們可以自定義static-locations的值,是以這個優先順序也是可以調整的。