Spring Boot靜態資源處理

<div class="article"> <h1 class="title">Spring Boot靜態資源處理</h1>javascript

<!-- 文章內容 -->
    <div data-note-content="" class="show-content">
      <div class="show-content-free">
        <h1>8.8 Spring Boot靜態資源處理</h1>

當使用Spring Boot來開發一個完整的系統時，咱們每每須要用到前端頁面，這就不可或缺地須要訪問到靜態資源，好比圖片、css、js等文件。 Spring Boot使用 WebMvcAutoConfiguration 中的配置各類屬性, 默認爲咱們提供了靜態資源處理。若是須要特殊處理的再經過配置進行修改。 咱們來看一下WebMvcAutoConfiguration類裏面的默認配置。 <h2>靜態資源默認配置WebMvcAutoConfiguration</h2> 在WebMvcAutoConfiguration類裏面有個addResourceHandlers方法： <pre class="hljs java"><code class="java"> @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)); } } </code></pre> 其中，針對webjars作了默認的處理： <pre class="hljs bash"><code class="bash">registry.addResourceHandler("/webjars/**") .addResourceLocations( "classpath:/META-INF/resources/webjars/") </code></pre> 其中，若是當前的ResourceHandlerRegistry裏面資源映射沒有「/**」，則啓用SpringBoot內置默認的靜態資源處理： <pre class="hljs javascript"><code class="javascript">String staticPathPattern = this.mvcProperties.getStaticPathPattern();//"/**"php

<span class="hljs-keyword">if</span> (!registry.hasMappingForPattern(staticPathPattern)) {</br>
            customizeResourceHandlerRegistration(</br>
                    registry.addResourceHandler(staticPathPattern)</br>
                            .addResourceLocations(</br>
                                    <span class="hljs-keyword">this</span>.resourceProperties.getStaticLocations())</br>
                    .setCachePeriod(cachePeriod));</br>
        }</br>

</code></pre>css

默認的靜態資源映射路徑在ResourceProperties類裏面，相關代碼以下： <pre class="hljs php"><code class="php">private static final String[] CLASSPATH_RESOURCE_LOCATIONS = { "classpath:/META-INF/resources/", "classpath:/resources/", "classpath:/static/", "classpath:/public/" };html

<span class="hljs-keyword">private</span> <span class="hljs-keyword">static</span> <span class="hljs-keyword">final</span> String[] RESOURCE_LOCATIONS;</br></br>

<span class="hljs-keyword">static</span> {</br>
    RESOURCE_LOCATIONS = <span class="hljs-keyword">new</span> String[CLASSPATH_RESOURCE_LOCATIONS.length</br>
            + SERVLET_RESOURCE_LOCATIONS.length];</br>
    System.arraycopy(SERVLET_RESOURCE_LOCATIONS, <span class="hljs-number">0</span>, RESOURCE_LOCATIONS, <span class="hljs-number">0</span>,</br>
            SERVLET_RESOURCE_LOCATIONS.length);</br>
    System.arraycopy(CLASSPATH_RESOURCE_LOCATIONS, <span class="hljs-number">0</span>, RESOURCE_LOCATIONS,</br>
            SERVLET_RESOURCE_LOCATIONS.length, CLASSPATH_RESOURCE_LOCATIONS.length);</br>
}</br></br>

<span class="hljs-comment">/**</br>
 * Locations of static resources. Defaults to classpath:[/META-INF/resources/,</br>
 * /resources/, /static/, /public/] plus context:/ (the root of the servlet context).</br>
 */</span></br>
<span class="hljs-keyword">private</span> String[] staticLocations = RESOURCE_LOCATIONS;</br>

</code></pre>前端

即默認配置的 /** 映射到以下目錄： <blockquote> classpath:/META-INF/resources/ classpath:/resources/ classpath:/static/ classpath:/public/ </blockquote> 綜上所述，Spring Boot 默認配置爲： <table> <thead> <tr> <th>頁面請求路徑模式</th> <th>靜態資源在工程的路徑</th> <th>優先級</th> </tr> </thead> <tbody> <tr> <td>/**</td> <td>classpath:/META-INF/resources/</td> <td>第1優先</td> </tr> <tr> <td>/**</td> <td>classpath:/resources/</td> <td>第2優先</td> </tr> <tr> <td>/**</td> <td>classpath:/META-INF/resources/</td> <td>第3優先</td> </tr> <tr> <td>/**</td> <td>classpath:/static/</td> <td>第4優先</td> </tr> <tr> <td>/webjars/**</td> <td>classpath:/META-INF/resources/webjars/</td> <td>-</td> </tr> </tbody> </table> <h2>自定義靜態資源映射</h2> 在SpringBoot集成Swagger的時候，咱們須要增長swagger-ui.html映射到classpath:/META-INF/resources/，咱們自定義配置類，繼承WebMvcConfigurerAdapter，而後重寫addResourceHandlers方法： <pre class="hljs java"><code class="java">@Configuration //@EnableWebMvc //這個註解會覆蓋掉SpringBoot的默認的靜態資源映射配置 class WebMvcConfig extends WebMvcConfigurerAdapter { @Override void addResourceHandlers(ResourceHandlerRegistry registry) {java

<span class="hljs-comment">//Swagger ui Mapping</span></br>
    registry.addResourceHandler(<span class="hljs-string">"swagger-ui.html"</span>)</br>
            .addResourceLocations(<span class="hljs-string">"classpath:/META-INF/resources/"</span>)</br></br>

}</br></br>

} </code></pre>jquery

若是想要本身徹底控制WebMVC（徹底覆蓋SpringBoot默認配置），就須要在@Configuration註解的配置類上增長@EnableWebMvc，當增長@EnableWebMvc註解之後，WebMvcAutoConfiguration中配置就不會生效，會自動覆蓋了官方給出的/static, /public, META-INF/resources, /resources等存放靜態資源的目錄。而將靜態資源定位於src/main/webapp。 在spring-boot-features.adoc中指出，若是你的應用要打成jar形式來運行的話，不要把靜態資源放到src/main/webapp目錄，雖然這是標準目錄，可是僅在打war包的時候起做用。由於大多數的構建工具在打jar包的時候，會默認忽略此目錄： <blockquote> TIP: Do not use the <code>src/main/webapp</code> directory 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. </blockquote> 當須要從新定義好資源所在目錄時，則須要主動添加上述的那個配置類，來Override addResourceHandlers方法。你須要本身來配置須要的每一項。 這種方式會在默認的基礎上增長 <blockquote> swagger-ui.html映射到classpath:/META-INF/resources/ </blockquote> 不會影響默認的方式，能夠同時使用。 <h2>前端資源的引用方法</h2> 在index.ftl中該如何引用上面的靜態資源呢？ 推薦默認的寫法以下： <pre class="hljs javascript"><code class="javascript"><link rel="stylesheet" type="text/css" href="/css/index.css"> <script type="text/javascript" src="/js/index.js"></script> </code></pre> 注意：默認配置的/**映射到/static（或/public ，/resources，/META-INF/resources） 當請求/css/index.css的時候，Spring MVC 會在/static/目錄下面找到。 若是配置爲/static/js/index.js <pre class="hljs xml"><code class="xml"><script src="${request.contextPath}/static/js/index.js"></script> </code></pre> 那麼上面配置的幾個目錄下面都沒有/static目錄，所以會找不到資源文件。 這個時候，就須要另外添加自定義的映射了： <pre class="hljs bash"><code class="bash">registry.addResourceHandler("/static/**") .addResourceLocations("classpath:/static/") </code></pre> <blockquote> 因此，當咱們使用SpringBoot默認靜態資源配置的時候，寫靜態資源位置不要帶上映射的目錄名（如/static/，/public/ ，/resources/，/META-INF/resources/）。 </blockquote> <h2>使用WebJars</h2> Spring Boot 在支持 Spring MVC的靜態資源處理的特性的同時, 容許使用jar包版本的靜態資源和使用版本無關的URL的靜態資源的引用。它就是Webjars[1]。 例如，使用jQuery，添加依賴： <pre class="hljs bash"><code class="bash">compile group: 'org.webjars.bower', name: 'jquery', version: '3.2.1' </code></pre> 而後，在前端html代碼中，就能夠直接以下使用： <pre class="hljs xml"><code class="xml"><script type="text/javascript" src="/webjars/jquery/3.2.1/jquery.js"></script> </code></pre> 你可能注意到href中的1.11.3版本號了，若是僅僅這麼使用，那麼當咱們切換版本號的時候還要手動修改href，比較麻煩。咱們徹底能夠約定一套目錄規則，把後端webjars的依賴版本，直接傳遞到後端。而負責完成維護管理這套目錄規則的人就是webjars-locator。webjars-locator經過在classpath中尋找須要加載的靜態資源，而後引入前端頁面。查找路徑的邏輯的方法是WebJarAssetLocator類裏的getFullPath方法。 咱們要想使用webjars-locator，先要添加依賴： <pre class="hljs java"><code class="java"> //Group: org.webjars.bower // https://mvnrepository.com/artifact/org.webjars/webjars-locator compile group: 'org.webjars', name: 'webjars-locator', version: '0.32' </code></pre> 而後，增長一個WebJarController： <pre class="hljs javascript"><code class="javascript">package com.easy.springboot.h5perf.controllergit

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.WebJarAssetLocatorgithub

import javax.servlet.http.HttpServletRequestweb

/**

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

</code></pre>

而後，前端代碼使用方式以下： <pre class="hljs xml"><code class="xml"><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">

</code></pre>

這裏是freemarker的模板view代碼示例。其中，request對象是內置對象。在application.yml配置以下： <pre class="hljs bash"><code class="bash">spring: # 在freemarker獲取request對象 freemarker: request-context-attribute: request </code></pre> 注意：這裏不須要在寫版本號了，可是注意寫url的時候，只是在原來url基礎上去掉了版本號，其餘的都不能少！ <h2>靜態資源動態版本</h2> 當咱們資源內容發生變化時，因爲瀏覽器緩存，用戶本地的靜態資源仍是舊的資源，爲了防止這種狀況致使的問題，咱們在請求url的時候加個版本號。 版本號如： <pre class="hljs xml"><code class="xml"><script type="text/javascript" src="/js/index.js?v=1.0.1"></script> </code></pre> 這個版本號1.0.1，能夠由後端代碼傳到前端頁面${version}。 <h1>小結</h1> 本章節主要探討了Spring Boot 靜態資源處理的內容。當咱們在開發中，遵循SpringBoot的默認配置，能夠大大減小了咱們靜態資源處理的工做。 本章節完整的工程代碼： <a href="https://link.jianshu.com?t=https://github.com/EasySpringBoot/h5perf" target="_blank" rel="nofollow">https://github.com/EasySpringBoot/h5perf</a> 參考資料： 1.WebJars：<a href="https://link.jianshu.com?t=http://www.webjars.org/" target="_blank" rel="nofollow">http://www.webjars.org/</a>

</div>
    </div>
</div>