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>