1. 云图网首页
  2. 技术专区
  3. 编程笔记

SpringBoot之静态资源（F）详解编程语言

• 编程笔记

spring Boot 默认为我们提供了静态资源处理，使用 WebMvcAutoConfiguration 中的配置各种属性。

建议大家使用Spring Boot的默认配置方式，如果需要特殊处理的再通过配置进行修改。

如果想要自己完全控制WebMVC，[email protected]@EnableWebMvc（@SpringBootApplication [email protected]），[email protected]效，你需要自己来配置需要的每一项。这种情况下的配置还是要多看一下WebMvcAutoConfiguration类。

我们既然是快速使用Spring Boot，并不想过多的自己再重新配置。本文还是主要针对Spring Boot的默认处理方式，部分配置在application 配置文件中（.properties 或 .yml）

默认资源映射

我们在启动应用的时候，可以在控制台中看到如下信息：

2017-08-16 15:30:18.326  INFO 137916 --- [           main] o.s.w.s.handler.SimpleUrlHandlerMapping  : Mapped URL path [/webjars/**] onto handler of type [class org.springframework.web.servlet.resource.ResourceHttpRequestHandler] 
2017-08-16 15:30:18.326  INFO 137916 --- [           main] o.s.w.s.handler.SimpleUrlHandlerMapping  : Mapped URL path [/**] onto handler of type [class org.springframework.web.servlet.resource.ResourceHttpRequestHandler] 
2017-08-16 15:30:18.351  INFO 137916 --- [           main] o.s.w.s.handler.SimpleUrlHandlerMapping  : Mapped URL path [/**/favicon.ico] onto handler of type [class org.springframework.web.servlet.resource.ResourceHttpRequestHandler]

其中默认配置的 /** 映射到 /static （或/public、/resources、/META-INF/resources）
其中默认配置的 /webjars/** 映射到 classpath:/META-INF/resources/webjars/
PS：上面的 static、public、resources 等目录都在 classpath: 下面（如 src/main/resources/static）。

优先级顺序为：META/resources > resources > static > public

自定义资源映射

上面我们介绍了Spring Boot 的默认资源映射，一般够用了，那我们如何自定义目录？
这些资源都是打包在jar包中的，然后实际应用中，我们还有很多资源是在管理系统中动态维护的，并不可能在程序包中，对于这种随意指定目录的资源，如何访问？

自定义目录

以增加 /myres/* 映射到 classpath:/myres/* 为例的代码处理为：
实现类继承 WebMvcConfigurerAdapter 并重写方法 addResourceHandlers
MyWebAppConfigurer.java

package cn.wuyang.springboot.config; 
 
import org.springframework.context.annotation.Configuration; 
import org.springframework.web.servlet.config.annotation.InterceptorRegistry; 
import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry; 
import org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter; 
 
import cn.wuyang.springboot.interceptor.MyInterceptor1; 
import cn.wuyang.springboot.interceptor.MyInterceptor2; 
 
/** 
 * 1.拦截器:继承WebMvcConfigurerAdapter，并重写 addInterceptors 方法。 
 * 2.自定义资源映射：继承 WebMvcConfigurerAdapter 并重写方法 addResourceHandlers方法  
 * @author wuyang 
 * 
 */ 
@Configuration 
public class MyWebAppConfigurer extends WebMvcConfigurerAdapter { 
 
    @Override 
    public void addInterceptors(InterceptorRegistry registry) { 
        // 多个拦截器组成一个拦截器链 
        // addPathPatterns 用于添加拦截规则 
        // excludePathPatterns 用户排除拦截 
        registry.addInterceptor(new MyInterceptor1()).addPathPatterns("/**"); 
        registry.addInterceptor(new MyInterceptor2()).addPathPatterns("/**"); 
        super.addInterceptors(registry); 
    } 
 
    //以增加 /myres/* 映射到 classpath:/myres/* 为例的代码处理为：  
    @Override 
    public void addResourceHandlers(ResourceHandlerRegistry registry) { 
        registry.addResourceHandler("/myres/**").addResourceLocations("classpath:/myres/"); 
        super.addResourceHandlers(registry); 
    } 
 
}

启动可以看到

2017-08-16 16:05:16.469  INFO 137848 --- [           main] o.s.w.s.handler.SimpleUrlHandlerMapping  : Mapped URL path [/myres/**] onto handler of type [class org.springframework.web.servlet.resource.ResourceHttpRequestHandler] 
2017-08-16 16:05:16.469  INFO 137848 --- [           main] o.s.w.s.handler.SimpleUrlHandlerMapping  : Mapped URL path [/webjars/**] onto handler of type [class org.springframework.web.servlet.resource.ResourceHttpRequestHandler] 
2017-08-16 16:05:16.469  INFO 137848 --- [           main] o.s.w.s.handler.SimpleUrlHandlerMapping  : Mapped URL path [/**] onto handler of type [class org.springframework.web.servlet.resource.ResourceHttpRequestHandler] 
2017-08-16 16:05:16.500  INFO 137848 --- [           main] o.s.w.s.handler.SimpleUrlHandlerMapping  : Mapped URL path [/**/favicon.ico] onto handler of type [class org.springframework.web.servlet.resource.ResourceHttpRequestHandler]

访问myres 文件夹中的fengjing.jpg 图片的地址为 http://127.0.0.1:8080/myres/userinfo.JPG
这样使用代码的方式自定义目录映射，并不影响Spring Boot的默认映射，可以同时使用。
这里写图片描述
这里写图片描述

使用外部目录

如果我们要指定一个绝对路径的文件夹（如 H:/myimgs/ ），则只需要使用 addResourceLocations 指定即可。

/ 可以直接使用addResourceLocations 指定磁盘绝对路径，同样可以配置多个位置，注意路径写法需要加上file: 
registry.addResourceHandler("/myimgs/**").addResourceLocations("file:H:/myimgs/");

通过配置文件配置

上面是使用代码来定义静态资源的映射，其实Spring Boot也为我们提供了可以直接在 application.properties（或.yml）中配置的方法。
配置方法如下：

# 默认值为 /** 
spring.mvc.static-path-pattern= 
# 默认值为 classpath:/META-INF/resources/,classpath:/resources/,classpath:/static/,classpath:/public/  
spring.resources.static-locations=这里设置要指向的路径，多个使用英文逗号隔开，

页面中使用

<img alt="读取自定义配置myres中的图片" src="${pageContext.request.contextPath }/myres/userinfo.JPG">

使用webjars

先说一下什么是webjars？我们在Web开发中，前端页面中用了越来越多的js或CSS，如jQuery等等，平时我们是将这些Web资源拷贝到Java的目录下，这种通过人工方式拷贝可能会产生版本误差，拷贝版本错误，前端页面就无法正确展示。
WebJars 就是为了解决这种问题衍生的，将这些Web前端资源打包成Java的Jar包，然后借助Maven这些依赖库的管理，保证这些Web资源版本唯一性。

WebJars 就是将js, css 等资源文件放到 classpath:/META-INF/resources/webjars/ 中，然后打包成jar 发布到maven仓库中。

简单应用

以jquery为例，文件存放结构为：

META-INF/resources/webjars/jquery/2.1.4/jquery.js 
META-INF/resources/webjars/jquery/2.1.4/jquery.min.js 
META-INF/resources/webjars/jquery/2.1.4/jquery.min.map 
META-INF/resources/webjars/jquery/2.1.4/webjars-requirejs.js

Spring Boot 默认将 /webjars/** 映射到 classpath:/META-INF/resources/webjars/ ，结合我们上面讲到的访问资源的规则，便可以得知我们在JSP页面中引入jquery.js的方法为：

<script type="text/javascript" src="${pageContext.request.contextPath }/webjars/jquery/2.1.4/jquery.js"></script>

想实现这样，我们只需要在pom.xml 文件中添加jquery的webjars 依赖即可，如下：

<dependency> 
    <groupId>org.webjars</groupId> 
    <artifactId>jquery</artifactId> 
    <version>2.1.4</version> 
</dependency>

这里写图片描述
这里写图片描述
这里写图片描述

版本号统一管理

但是我们实际开发中，可能会遇到升级版本号的情况，如果我们有100多个页面，几乎每个页面上都有按上面引入jquery.js 那么我们要把版本号更换为3.0.0，一个一个替换显然不是最好的办法。
首先在pom.xml 中添加依赖：

<dependency> 
    <groupId>org.webjars</groupId> 
    <artifactId>webjars-locator</artifactId> 
</dependency>

然后增加一个WebJarsController：

package cn.wuyang.springboot.controller.base; 
 
import javax.servlet.http.HttpServletRequest; 
 
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; 
 
/** 
 * 处理WebJars，自动读取版本号 
 * 
 */ 
@Controller 
public class WebJarsController { 
 
     private final WebJarAssetLocator assetLocator = new WebJarAssetLocator(); 
 
    @ResponseBody 
    @RequestMapping("/webjarslocator/{webjar}/**") 
    public ResponseEntity<Object> 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); 
        } 
    } 
}

最后在页面中使用的方式：

<script type="text/javascript" src="${pageContext.request.contextPath }/webjarslocator/jquery/jquery.js"></script>

这里写图片描述

静态资源版本管理

Spring 默认提供了静态资源版本映射的支持。
当我们的资源内容发生改变时，由于浏览器缓存，用户本地的资源还是旧资源，为了防止这种情况发生导致的问题。我们可能会选择在资源文件后面加上参数“版本号”或其他方式。
使用这种方式，当我们文件修改后，手工修改版本号来达到URL文件不被浏览器缓存的目的。同样也存在很多文件都需要修改的问题。或者有的人会增加时间戳的方式，这样我认为是最不可取的，每次浏览器都要请求为服务器增加了不必要的压力。

资源名称md5方式

添加 application.properties 配置文件（或.yml）

spring.resources.chain.strategy.content.enabled=true 
spring.resources.chain.strategy.content.paths=/**

所有 /** 请求的静态资源都会被处理。
创建 ResourceUrlProviderController 文件

package cn.wuyang.springboot.controller.base; 
 
 
import org.springframework.beans.factory.annotation.Autowired; 
import org.springframework.web.bind.annotation.ControllerAdvice; 
import org.springframework.web.bind.annotation.ModelAttribute; 
import org.springframework.web.servlet.resource.ResourceUrlProvider; 
/** 
 * 处理静态资源URL 
 * 
 */ 
@ControllerAdvice 
public class ResourceUrlProviderController { 
 
    @Autowired 
    private ResourceUrlProvider resourceUrlProvider; 
 
    @ModelAttribute("urls") 
    public ResourceUrlProvider urls() { 
        return this.resourceUrlProvider; 
    } 
}

在页面中使用的写法

<script type="text/javascript" src="${pageContext.request.contextPath }${urls.getForLookupPath('/js/common.js') }"></script>

这里写图片描述
当我们访问页面后，HTML中实际生成的代码为：
这里写图片描述

总结

  1. 我们使用第三方的库时，建议使用webjars的方式，通过动态版本号（webjars-locator 的方式）来使用（因为第三方库在项目开发中变动频率很小，即便是变动也是版本号的修改）。
  2. 我们使用自己存放在静态资源映射目录中的资源的时候，建议使用md5 资源文件名的方式来使用（项目开发中一些css、js文件会经常修改）。
  3. 项目素材文件建议放到 classpath:/static （或其他）目录中，打包在项目中，通过CMS维护的一些图片和资源，我们使用配置引用到具体的磁盘绝对路径来使用。
  4. 注意使用md5文件名方式的时候，Spring 是有缓存机制的，也就是说，在服务不重启的情况下，你去变动修改这些资源文件，其文件名的md5值并不会改变，只有重启服务再次访问才会生效。如果需要每次都获取实际文件的md5值，需要重写相关类来实现，我们不建议这样做，因为一直去计算文件md5值是需要性能代价的。

原创文章，作者：ItWorker，如若转载，请注明出处：https://blog.ytso.com/11261.html

赞 (0)
0
上一篇 2021年7月19日
下一篇 2021年7月19日

相关推荐

发表回复

登录后才能评论