8.8 Spring Boot靜態(tài)資源處理
當(dāng)使用Spring Boot來(lái)開(kāi)發(fā)一個(gè)完整的系統(tǒng)時(shí)芍阎，我們往往需要用到前端頁(yè)面，這就不可或缺地需要訪問(wèn)到靜態(tài)資源辖佣，比如圖片霹抛、css、js等文件卷谈。
Spring Boot使用 WebMvcAutoConfiguration 中的配置各種屬性, 默認(rèn)為我們提供了靜態(tài)資源處理杯拐。如果需要特殊處理的再通過(guò)配置進(jìn)行修改。
我們來(lái)看一下WebMvcAutoConfiguration類里面的默認(rèn)配置世蔗。
靜態(tài)資源默認(rèn)配置WebMvcAutoConfiguration
在WebMvcAutoConfiguration類里面有個(gè)addResourceHandlers方法：
@Override
public void addResourceHandlers(ResourceHandlerRegistry registry) {
if (!this.resourceProperties.isAddMappings()) {
logger.debug("Default resource handling disabled");
return;
}
Integer cachePeriod = this.resourceProperties.getCachePeriod();
if (!registry.hasMappingForPattern("/webjars/**")) {
customizeResourceHandlerRegistration(
registry.addResourceHandler("/webjars/**")
.addResourceLocations(
"classpath:/META-INF/resources/webjars/")
.setCachePeriod(cachePeriod));
}
String staticPathPattern = this.mvcProperties.getStaticPathPattern();
if (!registry.hasMappingForPattern(staticPathPattern)) {
customizeResourceHandlerRegistration(
registry.addResourceHandler(staticPathPattern)
.addResourceLocations(
this.resourceProperties.getStaticLocations())
.setCachePeriod(cachePeriod));
}
}
其中端逼，針對(duì)webjars做了默認(rèn)的處理：
registry.addResourceHandler("/webjars/**")
.addResourceLocations(
"classpath:/META-INF/resources/webjars/")
其中，如果當(dāng)前的ResourceHandlerRegistry里面資源映射沒(méi)有 “/**”污淋， 則啟用SpringBoot內(nèi)置默認(rèn)的靜態(tài)資源處理：
String staticPathPattern = this.mvcProperties.getStaticPathPattern();//"/**"
if (!registry.hasMappingForPattern(staticPathPattern)) {
customizeResourceHandlerRegistration(
registry.addResourceHandler(staticPathPattern)
.addResourceLocations(
this.resourceProperties.getStaticLocations())
.setCachePeriod(cachePeriod));
}
默認(rèn)的靜態(tài)資源映射路徑在ResourceProperties類里面顶滩，相關(guān)代碼如下：
private static final String[] CLASSPATH_RESOURCE_LOCATIONS = {
"classpath:/META-INF/resources/", "classpath:/resources/",
"classpath:/static/", "classpath:/public/" };
private static final String[] RESOURCE_LOCATIONS;
static {
RESOURCE_LOCATIONS = new String[CLASSPATH_RESOURCE_LOCATIONS.length
+ SERVLET_RESOURCE_LOCATIONS.length];
System.arraycopy(SERVLET_RESOURCE_LOCATIONS, 0, RESOURCE_LOCATIONS, 0,
SERVLET_RESOURCE_LOCATIONS.length);
System.arraycopy(CLASSPATH_RESOURCE_LOCATIONS, 0, RESOURCE_LOCATIONS,
SERVLET_RESOURCE_LOCATIONS.length, CLASSPATH_RESOURCE_LOCATIONS.length);
}
/**
* Locations of static resources. Defaults to classpath:[/META-INF/resources/,
* /resources/, /static/, /public/] plus context:/ (the root of the servlet context).
*/
private String[] staticLocations = RESOURCE_LOCATIONS;
即默認(rèn)配置的 /** 映射到如下目錄：
classpath:/META-INF/resources/
classpath:/resources/
classpath:/static/
classpath:/public/
綜上所述，Spring Boot 默認(rèn)配置為：
| 頁(yè)面請(qǐng)求路徑模式 | 靜態(tài)資源在工程的路徑 | 優(yōu)先級(jí) |
|---|---|---|
| /** | classpath:/META-INF/resources/ | 第1優(yōu)先 |
| /** | classpath:/resources/ | 第2優(yōu)先 |
| /** | classpath:/META-INF/resources/ | 第3優(yōu)先 |
| /** | classpath:/static/ | 第4優(yōu)先 |
| /webjars/** | classpath:/META-INF/resources/webjars/ | - |
自定義靜態(tài)資源映射
在SpringBoot集成Swagger的時(shí)候寸爆，我們需要增加swagger-ui.html映射到classpath:/META-INF/resources/礁鲁，我們自定義配置類浊吏，繼承WebMvcConfigurerAdapter，然后重寫(xiě)addResourceHandlers方法：
@Configuration
//@EnableWebMvc //這個(gè)注解會(huì)覆蓋掉SpringBoot的默認(rèn)的靜態(tài)資源映射配置
class WebMvcConfig extends WebMvcConfigurerAdapter {
@Override
void addResourceHandlers(ResourceHandlerRegistry registry) {
//Swagger ui Mapping
registry.addResourceHandler("swagger-ui.html")
.addResourceLocations("classpath:/META-INF/resources/")
}
}
如果想要自己完全控制WebMVC（完全覆蓋SpringBoot默認(rèn)配置）救氯，就需要在@Configuration注解的配置類上增加@EnableWebMvc，當(dāng)增加@EnableWebMvc注解以后歌憨，WebMvcAutoConfiguration中配置就不會(huì)生效着憨，會(huì)自動(dòng)覆蓋了官方給出的/static, /public, META-INF/resources, /resources等存放靜態(tài)資源的目錄。而將靜態(tài)資源定位于src/main/webapp务嫡。
在spring-boot-features.adoc中指出甲抖，如果你的應(yīng)用要打成jar形式來(lái)運(yùn)行的話，不要把靜態(tài)資源放到src/main/webapp目錄心铃，雖然這是標(biāo)準(zhǔn)目錄准谚，但是僅在打war包的時(shí)候起作用。因?yàn)榇蠖鄶?shù)的構(gòu)建工具在打jar包的時(shí)候去扣，會(huì)默認(rèn)忽略此目錄：
TIP: Do not use the
src/main/webappdirectory if your application will be packaged as a
jar. Although this directory is a common standard, it will only work with war packaging
and it will be silently ignored by most build tools if you generate a jar.
當(dāng)需要重新定義好資源所在目錄時(shí)柱衔，則需要主動(dòng)添加上述的那個(gè)配置類，來(lái)Override addResourceHandlers方法愉棱。你需要自己來(lái)配置需要的每一項(xiàng)唆铐。
這種方式會(huì)在默認(rèn)的基礎(chǔ)上增加
swagger-ui.html映射到classpath:/META-INF/resources/
不會(huì)影響默認(rèn)的方式，可以同時(shí)使用奔滑。
前端資源的引用方法
在index.ftl中該如何引用上面的靜態(tài)資源呢艾岂？
推薦默認(rèn)的寫(xiě)法如下：
<link rel="stylesheet" type="text/css" href="/css/index.css">
<script type="text/javascript" src="/js/index.js"></script>
注意：默認(rèn)配置的/**映射到/static（或/public ，/resources朋其，/META-INF/resources）
當(dāng)請(qǐng)求/css/index.css的時(shí)候王浴，Spring MVC 會(huì)在/static/目錄下面找到。
如果配置為/static/js/index.js
<script src="${request.contextPath}/static/js/index.js"></script>
那么上面配置的幾個(gè)目錄下面都沒(méi)有/static目錄梅猿，因此會(huì)找不到資源文件氓辣。
這個(gè)時(shí)候，就需要另外添加自定義的映射了：
registry.addResourceHandler("/static/**")
.addResourceLocations("classpath:/static/")
所以袱蚓，當(dāng)我們使用SpringBoot默認(rèn)靜態(tài)資源配置的時(shí)候筛婉，寫(xiě)靜態(tài)資源位置不要帶上映射的目錄名（如/static/，/public/ 癞松，/resources/爽撒，/META-INF/resources/）。
使用WebJars
Spring Boot 在支持 Spring MVC的靜態(tài)資源處理的特性的同時(shí), 允許使用jar包版本的靜態(tài)資源和使用版本無(wú)關(guān)的URL的靜態(tài)資源的引用响蓉。它就是Webjars[1]硕勿。
例如，使用jQuery枫甲，添加依賴：
compile group: 'org.webjars.bower', name: 'jquery', version: '3.2.1'
然后源武，在前端html代碼中扼褪，就可以直接如下使用：
<script type="text/javascript" src="/webjars/jquery/3.2.1/jquery.js"></script>
你可能注意到href中的1.11.3版本號(hào)了，如果僅僅這么使用粱栖，那么當(dāng)我們切換版本號(hào)的時(shí)候還要手動(dòng)修改href话浇，比較麻煩。我們完全可以約定一套目錄規(guī)則闹究，把后端webjars的依賴版本幔崖，直接傳遞到后端。而負(fù)責(zé)完成維護(hù)管理這套目錄規(guī)則的人就是webjars-locator渣淤。webjars-locator通過(guò)在classpath中尋找需要加載的靜態(tài)資源赏寇，然后引入前端頁(yè)面。查找路徑的邏輯的方法是WebJarAssetLocator類里的getFullPath方法价认。
我們要想使用webjars-locator嗅定，先要添加依賴：
//Group: org.webjars.bower
// https://mvnrepository.com/artifact/org.webjars/webjars-locator
compile group: 'org.webjars', name: 'webjars-locator', version: '0.32'
然后，增加一個(gè)WebJarController：
package com.easy.springboot.h5perf.controller
import org.springframework.core.io.ClassPathResource
import org.springframework.http.HttpStatus
import org.springframework.http.ResponseEntity
import org.springframework.stereotype.Controller
import org.springframework.web.bind.annotation.PathVariable
import org.springframework.web.bind.annotation.RequestMapping
import org.springframework.web.bind.annotation.ResponseBody
import org.springframework.web.servlet.HandlerMapping
import org.webjars.WebJarAssetLocator
import javax.servlet.http.HttpServletRequest
/**
* Created by jack on 2017/4/22.
*/
@Controller
class WebJarsController {
WebJarAssetLocator assetLocator = new WebJarAssetLocator();
@ResponseBody
@RequestMapping("/webjarslocator/{webjar}/**")
def ResponseEntity<?> locateWebjarAsset(@PathVariable String webjar, HttpServletRequest request) {
try {
String mvcPrefix = "/webjarslocator/" + webjar + "/"; // This prefix must match the mapping path!
String mvcPath = (String) request.getAttribute(HandlerMapping.PATH_WITHIN_HANDLER_MAPPING_ATTRIBUTE);
String fullPath = assetLocator.getFullPath(webjar, mvcPath.substring(mvcPrefix.length()));
return new ResponseEntity<>(new ClassPathResource(fullPath), HttpStatus.OK);
} catch (Exception e) {
return new ResponseEntity<>(HttpStatus.NOT_FOUND);
}
}
}
然后用踩，前端代碼使用方式如下：
<link href="${request.contextPath}/webjarslocator/datatables/jquery.dataTables.min.css" rel="stylesheet" type="text/css">
<link href="${request.contextPath}/webjarslocator/tether/tether.min.css" rel="stylesheet" type="text/css">
<link href="${request.contextPath}/css/index.css" rel="stylesheet" type="text/css">
<link href="${request.contextPath}/css/report.css" rel="stylesheet" type="text/css">
<script src="${request.contextPath}/webjarslocator/jquery/jquery.min.js"></script>
<script src="${request.contextPath}/js/index.js"></script>
<script src="${request.contextPath}/webjarslocator/tether/tether.min.js"></script>
<script src="${request.contextPath}/webjarslocator/bootstrap/bootstrap.min.js"></script>
<script src="${request.contextPath}/webjarslocator/datatables/jquery.dataTables.min.js"></script>
這里是freemarker的模板view代碼示例渠退。其中，request對(duì)象是內(nèi)置對(duì)象脐彩。在application.yml配置如下：
spring:
# 在freemarker獲取request對(duì)象
freemarker:
request-context-attribute: request
注意：這里不需要在寫(xiě)版本號(hào)了智什，但是注意寫(xiě)url的時(shí)候，只是在原來(lái)url基礎(chǔ)上去掉了版本號(hào)丁屎，其他的都不能少荠锭！
靜態(tài)資源動(dòng)態(tài)版本
當(dāng)我們資源內(nèi)容發(fā)生變化時(shí)，由于瀏覽器緩存晨川，用戶本地的靜態(tài)資源還是舊的資源证九，為了防止這種情況導(dǎo)致的問(wèn)題，我們?cè)谡?qǐng)求url的時(shí)候加個(gè)版本號(hào)共虑。
版本號(hào)如：
<script type="text/javascript" src="/js/index.js?v=1.0.1"></script>
這個(gè)版本號(hào)1.0.1愧怜，可以由后端代碼傳到前端頁(yè)面${version}。
小結(jié)
本章節(jié)主要探討了Spring Boot 靜態(tài)資源處理的內(nèi)容妈拌。當(dāng)我們?cè)陂_(kāi)發(fā)中拥坛，遵循SpringBoot的默認(rèn)配置，可以大大減少了我們靜態(tài)資源處理的工作尘分。
本章節(jié)完整的工程代碼：
https://github.com/EasySpringBoot/h5perf
參考資料：
1.WebJars：http://www.webjars.org/
