做web開發(fā)的時候望门,我們往往會有很多靜態(tài)資源唇聘,如html肮街、圖片酬屉、css等陶衅。那如何向前端返回靜態(tài)資源呢匀伏?以前做過web開發(fā)的同學應該知道昂拂,我們以前創(chuàng)建的web工程下面會有一個webapp的目錄碟绑,我們只要把靜態(tài)資源放在該目錄下就可以直接訪問单默。但是碘举,基于Spring boot的工程并沒有這個目錄,那我們應該怎么處理搁廓?
一殴俱、最笨的方式
我們首先來分享一種最笨的辦法,就是將靜態(tài)資源通過流直接返回給前端枚抵,我們在maven工程的resources的根目錄下建立一個html的目錄线欲,然后我們把html文件放在該目錄下,并且規(guī)定任何訪問路徑以/static/開頭的即訪問該目錄下的靜態(tài)資源汽摹,其實現(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();
}
}
}
其實現(xiàn)過程很簡單李丰,就是先從路徑中分離出來資源uri,然后從static目錄下讀取文件逼泣,并輸出到前端趴泌。因為只做簡單演示,所以這里只處理了文本類型的文件拉庶,圖片文件可以做類似的處理嗜憔。當然,我們在實際中肯定不會這么做氏仗,Spring Boot 也肯定有更好的解決辦法吉捶。不過這個辦法雖然有點笨,但確是最本質的東西皆尔,無論框架如何方便的幫我們處理了這類問題呐舔,但是拋開框架,我們依然要能夠熟練的寫出一個web項目慷蠕,只有知道其實現(xiàn)原理珊拼,你才會在遇到問題時能得心應手。現(xiàn)在我們再來看看Spring boot對靜態(tài)資源的支持流炕。
二澎现、Spring boot默認靜態(tài)資源訪問方式
Spring boot默認對/**的訪問可以直接訪問四個目錄下的文件:
- classpath:/public/
- classpath:/resources/
- classpath:/static/
- classpath:/META-INFO/resouces/
我們現(xiàn)在就在資源文件resources目錄下建立如下四個目錄:
注意藍色條下的資源文件夾resources與類路徑下的文件夾classpath:/resources是不同的仅胞,藍色條下的resources代表的是該目錄下的文件為資源文件,在打包的時候會將該目錄下的文件全部打包的類路徑下剑辫,這個名稱是可以改的饼问,在pom.xml指定資源目錄即可:
<resources>
<resource>
<directory>src/main/resources</directory>
</resource>
</resources>
而類路徑下的resources是spring boot默認的靜態(tài)資源文件夾之一,和public揭斧、static以及MEAT-INFO/resources的功能相同。現(xiàn)在我們重啟Spring boot就可以通過:
- http://localhost:8080/1.html
- http://localhost:8080/2.html
- http://localhost:8080/3.html
- http://localhost:8080/4.html
四個URL訪問到四個目錄下的靜態(tài)資源了峻堰。
三讹开、自定義靜態(tài)資源目錄
通過第二節(jié)內容我們已經知道了Spring boot默認可以訪問的靜態(tài)資源的目錄,但是大家肯定會想捐名,這個目錄是固定的嗎旦万?我們可不可以自己定義靜態(tài)資源目錄?答案是肯定的镶蹋,我們現(xiàn)在就來自定義一個靜態(tài)資源目錄成艘,我們定義一個images的目錄來存放圖片,所有/image/**的路徑都會訪問images目錄下的資源:
@Configuration
public class ImageMvcConfig extends WebMvcConfigurerAdapter {
@Override
public void addResourceHandlers(ResourceHandlerRegistry registry) {
registry.addResourceHandler("/image/**")
.addResourceLocations("classpath:/images/");
}
}
這段代碼應該比較簡單贺归,@Configuration 標識一個配置類淆两,這個在前面的文章中提到過多次。WebMvcConfigurerAdapter是Spring提供的一個配置mvc的適配器拂酣,里面有很多配置的方法秋冰,addResourceHandlers就是專門處理靜態(tài)資源的方法,其他方法后續(xù)我們還會講到∩舭荆現(xiàn)在我們在驗證上面的配置是否有效剑勾。我在images目錄下放了一張spring.jpg的圖片,現(xiàn)在我們通過http://localhost:8080/image/spring.jpg來訪問圖片:
其實除了上面的辦法還有一種更簡單的辦法赵颅,就是直接在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默認的靜態(tài)資源目錄募寨,例如如果按示例中配置叠萍,則無法再訪問static、public绪商、resources等目錄下的資源了苛谷。
四、總結
本文主要給大家分享了Spring boot 對靜態(tài)資源的處理方式格郁,Spring boot 默認可以訪問
classpath:/META-INF/resources/,classpath:/resources/,classpath:/static/,classpath:/public/
四個目錄下的靜態(tài)資源腹殿,我們也可以根據(jù)自己的需要進行個性化配置独悴。最后,需要說明一點的是锣尉,如果這四個目錄中存在相同名稱的資源刻炒,那會優(yōu)先返回哪個目錄下的資源呢?大家通過static-locations的默認值順序應該能猜到自沧,默認情況下坟奥,Spring boot會優(yōu)先返回/META-INF/resources下的資源。當然拇厢,因為我們可以自定義static-locations的值爱谁,所以這個優(yōu)先順序也是可以調整的。
本人免費整理了Java高級資料孝偎,涵蓋了Java访敌、Redis、MongoDB衣盾、MySQL寺旺、Zookeeper、Spring Cloud势决、Dubbo高并發(fā)分布式等教程阻塑,一共30G,需要自己領取果复。