Spring Boot 靜態(tài)資源處理，妙！

程序員的成長(zhǎng)之路

互聯(lián)網(wǎng)/程序員/技術(shù)/資料共享 

閱讀本文大概需要 4 分鐘。

來(lái)自：cnblogs.com/paddix/p/8301331.html

做web開(kāi)發(fā)的時(shí)候，我們往往會(huì)有很多靜態(tài)資源，如html、圖片、css等。那如何向前端返回靜態(tài)資源呢？

以前做過(guò)web開(kāi)發(fā)的同學(xué)應(yīng)該知道，我們以前創(chuàng)建的web工程下面會(huì)有一個(gè)webapp的目錄，我們只要把靜態(tài)資源放在該目錄下就可以直接訪問(wèn)。

但是，基于Spring boot的工程并沒(méi)有這個(gè)目錄，那我們應(yīng)該怎么處理？

一、最笨的方式

我們首先來(lái)分享一種最笨的辦法，就是將靜態(tài)資源通過(guò)流直接返回給前端，我們?cè)趍aven工程的resources的根目錄下建立一個(gè)html的目錄，然后我們把html文件放在該目錄下，并且規(guī)定任何訪問(wèn)路徑以/static/開(kāi)頭的即訪問(wèn)該目錄下的靜態(tài)資源，其實(shí)現(xiàn)如下：

@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();
        }
    }

}

其實(shí)現(xiàn)過(guò)程很簡(jiǎn)單，就是先從路徑中分離出來(lái)資源uri，然后從static目錄下讀取文件，并輸出到前端。

因?yàn)橹蛔龊?jiǎn)單演示，所以這里只處理了文本類(lèi)型的文件，圖片文件可以做類(lèi)似的處理。當(dāng)然，我們?cè)趯?shí)際中肯定不會(huì)這么做，Spring Boot 也肯定有更好的解決辦法。

不過(guò)這個(gè)辦法雖然有點(diǎn)笨，但確是最本質(zhì)的東西，無(wú)論框架如何方便的幫我們處理了這類(lèi)問(wèn)題，但是拋開(kāi)框架，我們依然要能夠熟練的寫(xiě)出一個(gè)web項(xiàng)目，只有知道其實(shí)現(xiàn)原理，你才會(huì)在遇到問(wèn)題時(shí)能得心應(yīng)手。

現(xiàn)在我們?cè)賮?lái)看看Spring boot對(duì)靜態(tài)資源的支持。

二、Spring boot默認(rèn)靜態(tài)資源訪問(wèn)方式

Spring boot默認(rèn)對(duì)/**的訪問(wèn)可以直接訪問(wèn)四個(gè)目錄下的文件：

• classpath:/public/
• classpath:/resources/
• classpath:/static/
• classpath:/META-INFO/resouces/

我們現(xiàn)在就在資源文件resources目錄下建立如下四個(gè)目錄：

注意藍(lán)色條下的資源文件夾resources與類(lèi)路徑下的文件夾classpath:/resources是不同的，藍(lán)色條下的resources代表的是該目錄下的文件為資源文件，在打包的時(shí)候會(huì)將該目錄下的文件全部打包的類(lèi)路徑下，這個(gè)名稱(chēng)是可以改的，在pom.xml指定資源目錄即可：

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

而類(lèi)路徑下的resources是spring boot默認(rèn)的靜態(tài)資源文件夾之一，和public、static以及MEAT-INFO/resources的功能相同?，F(xiàn)在我們重啟Spring boot就可以通過(guò):

• http://localhost:8080/1.html
• http://localhost:8080/2.html
• http://localhost:8080/3.html
• http://localhost:8080/4.html

四個(gè)URL訪問(wèn)到四個(gè)目錄下的靜態(tài)資源了。

三、自定義靜態(tài)資源目錄

通過(guò)第二節(jié)內(nèi)容我們已經(jīng)知道了Spring boot默認(rèn)可以訪問(wèn)的靜態(tài)資源的目錄，但是大家肯定會(huì)想，這個(gè)目錄是固定的嗎？我們可不可以自己定義靜態(tài)資源目錄？

答案是肯定的，我們現(xiàn)在就來(lái)自定義一個(gè)靜態(tài)資源目錄，我們定義一個(gè)images的目錄來(lái)存放圖片，所有/image/**的路徑都會(huì)訪問(wèn)images目錄下的資源：

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

這段代碼應(yīng)該比較簡(jiǎn)單，@Configuration 標(biāo)識(shí)一個(gè)配置類(lèi)，這個(gè)在前面的文章中提到過(guò)多次。

WebMvcConfigurerAdapter是Spring提供的一個(gè)配置mvc的適配器，里面有很多配置的方法，addResourceHandlers就是專(zhuān)門(mén)處理靜態(tài)資源的方法，其他方法后續(xù)我們還會(huì)講到。

現(xiàn)在我們?cè)隍?yàn)證上面的配置是否有效。我在images目錄下放了一張spring.jpg的圖片，現(xiàn)在我們通過(guò)http://localhost:8080/image/spring.jpg來(lái)訪問(wèn)圖片：

其實(shí)除了上面的辦法還有一種更簡(jiǎn)單的辦法，就是直接在application.yml中配置即可：

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

static-path-pattern：訪問(wèn)模式，默認(rèn)為/**，多個(gè)可以逗號(hào)分隔

static-locations：資源目錄，多個(gè)目錄逗號(hào)分隔，默認(rèn)資源目錄為classpath:/META-INF/resources/,classpath:/resources/,classpath:/static/,classpath:/public/

注意，這個(gè)配置會(huì)覆蓋Spring boot默認(rèn)的靜態(tài)資源目錄，例如如果按示例中配置，則無(wú)法再訪問(wèn)static、public、resources等目錄下的資源了。

四、總結(jié)

本文主要給大家分享了Spring boot 對(duì)靜態(tài)資源的處理方式，Spring boot 默認(rèn)可以訪問(wèn)

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

四個(gè)目錄下的靜態(tài)資源，我們也可以根據(jù)自己的需要進(jìn)行個(gè)性化配置。

最后，需要說(shuō)明一點(diǎn)的是，如果這四個(gè)目錄中存在相同名稱(chēng)的資源，那會(huì)優(yōu)先返回哪個(gè)目錄下的資源呢？

大家通過(guò)static-locations的默認(rèn)值順序應(yīng)該能猜到，默認(rèn)情況下，Spring boot會(huì)優(yōu)先返回/META-INF/resources下的資源。

當(dāng)然，因?yàn)槲覀兛梢宰远xstatic-locations的值，所以這個(gè)優(yōu)先順序也是可以調(diào)整的。

<END>

推薦閱讀：

鴻蒙OS到底是不是Android套皮？（終于講明白了）

JVM 有 Full GC，為什么還會(huì)出現(xiàn) OutOfMemoryError呢？

最近面試BAT，整理一份面試資料《Java面試BATJ通關(guān)手冊(cè)》，覆蓋了Java核心技術(shù)、JVM、Java并發(fā)、SSM、微服務(wù)、數(shù)據(jù)庫(kù)、數(shù)據(jù)結(jié)構(gòu)等等。

獲取方式：點(diǎn)個(gè)「在看」，點(diǎn)擊上方小卡片，進(jìn)入公眾號(hào)后回復(fù)「面試題」領(lǐng)取，更多內(nèi)容陸續(xù)奉上。

朕已閱