Spring Boot 静态资源处理

时间:2022-12-01 08:12:06

静态资源处理

spring boot 默认的处理方式就已经足够了,默认情况下spring boot 使用webmvcautoconfiguration中配置的各种属性。

建议使用spring boot 默认处理方式,需要自己配置的地方可以通过配置文件修改。

但是如果你想完全控制spring mvc,你可以在@configuration注解的配置类上增加@enablewebmvc,增加该注解以后webmvcautoconfiguration中配置就不会生效,你需要自己来配置需要的每一项。这种情况下的配置方法建议参考webmvcautoconfiguration类。

本文以下内容针对spring boot 默认的处理方式,部分配置通过在application.yml配置文件中设置。

配置资源映射

spring boot 默认配置的/**映射到/static(或/public ,/resources,/meta-inf/resources),/webjars/**会映射到classpath:/meta-inf/resources/webjars/。

注意:上面的/static等目录都是在classpath:下面。

如果你想增加如/mystatic/**映射到classpath:/mystatic/,你可以让你的配置类继承webmvcconfigureradapter,然后重写如下方法:

?
1
2
3
4
5
@override
public void addresourcehandlers(resourcehandlerregistry registry) {
 registry.addresourcehandler("/mystatic/**")
   .addresourcelocations("classpath:/mystatic/");
}

这种方式会在默认的基础上增加/mystatic/**映射到classpath:/mystatic/,不会影响默认的方式,可以同时使用。

静态资源映射还有一个配置选项,为了简单这里用.properties方式书写:

?
1
spring.mvc.static-path-pattern=/** # path pattern used for static resources.

这个配置会影响默认的/**,例如修改为/static/**后,只能映射如/static/js/sample.js这样的请求(修改前是/js/sample.js)。这个配置只能写一个值,不像大多数可以配置多个用逗号隔开的。

使用注意

例如有如下目录结构:

└─resources
    │  application.yml
    │
    ├─static
    │  ├─css
    │  │      index.css
    │  │
    │  └─js
    │          index.js
    │
    └─templates
            index.ftl

index.ftl中该如何引用上面的静态资源呢?

如下写法:

?
1
2
<link rel="stylesheet" type="text/css" href="/css/index.css" rel="external nofollow" >
<script type="text/javascript" src="/js/index.js"></script>

注意:默认配置的/**映射到/static(或/public ,/resources,/meta-inf/resources)

当请求/css/index.css的时候,spring mvc 会在/static/目录下面找到。

如果配置为/static/css/index.css,那么上面配置的几个目录下面都没有/static目录,因此会找不到资源文件!

所以写静态资源位置的时候,不要带上映射的目录名(如/static/,/public/ ,/resources/,/meta-inf/resources/)!

使用webjars

webjars:http://www.webjars.org/

例如使用jquery,添加依赖:

?
1
2
3
4
5
<dependency>
 <groupid>org.webjars</groupid>
 <artifactid>jquery</artifactid>
 <version>1.11.3</version>
</dependency>

然后可以如下使用:

?
1
<script type="text/javascript" src="/webjars/jquery/1.11.3/jquery.js"></script>

你可能注意到href中的1.11.3版本号了,如果仅仅这么使用,那么当我们切换版本号的时候还要手动修改href,怪麻烦的,我们可以用如下方式解决。

先在pom.xml中添加依赖:

?
1
2
3
4
<dependency>
 <groupid>org.webjars</groupid>
 <artifactid>webjars-locator</artifactid>
</dependency>

增加一个webjarcontroller

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
@controller
public class webjarcontroller {
 private final webjarassetlocator assetlocator = new webjarassetlocator();
 @responsebody
 @requestmapping("/webjarslocator/{webjar}/**")
 public responseentity locatewebjarasset(@pathvariable string webjar, httpservletrequest request) {
  try {
   string mvcprefix = "/webjarslocator/" + webjar + "/";
   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);
  }
 }
}

然后使用的时候按照如下方式:

?
1
<script type="text/javascript" src="/webjarslocator/jquery/jquery.js"></script>

注意:这里不需要在写版本号了,但是注意写url的时候,只是在原来url基础上去掉了版本号,其他的都不能少!

静态资源版本管理

spring mvc 提供了静态资源版本映射的功能。

用途:当我们资源内容发生变化时,由于浏览器缓存,用户本地的静态资源还是旧的资源,为了防止这种情况导致的问题,我们可能会手动在请求url的时候加个版本号或者其他方式。

版本号如:

?
1
<script type="text/javascript" src="/js/sample.js?v=1.0.1"></script>

spring mvc 提供的功能可以很容易的帮助我们解决类似问题。

spring mvc 有两种解决方式。

注意:下面的配置方式针对freemarker模板方式,其他的配置方式可以参考。

资源名-md5 方式

例如:

?
1
<link rel="stylesheet" type="text/css" href="/css/index-2b371326aa93ce4b611853a309b69b29.css" rel="external nofollow" >

spring 会自动读取资源md5,然后添加到index.css的名字后面,因此当资源内容发生变化的时候,文件名发生变化,就会更新本地资源。

配置方式:

在application.properties中做如下配置:

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

这样配置后,所有/**请求的静态资源都会被处理为上面例子的样子。

到这儿还没完,我们在写资源url的时候还要特殊处理。

首先增加如下配置:

?
1
2
3
4
5
6
7
8
9
@controlleradvice
public class controllerconfig {
 @autowired
 resourceurlprovider resourceurlprovider;
 @modelattribute("urls")
 public resourceurlprovider urls() {
  return this.resourceurlprovider;
 }
}

然后在页面写的时候用下面的写法:

?
1
<link rel="stylesheet" type="text/css" href="${urls.getforlookuppath('/css/index.css')}" rel="external nofollow" >

使用urls.getforlookuppath('/css/index.css')来得到处理后的资源名。

版本号 方式

在application.properties中做如下配置:

?
1
2
3
spring.resources.chain.strategy.fixed.enabled=true
spring.resources.chain.strategy.fixed.paths=/js/**,/v1.0.0/**
spring.resources.chain.strategy.fixed.version=v1.0.0

这里配置需要特别注意,将version的值配置在paths中。原因我们在讲spring mvc 处理逻辑的时候说。

在页面写的时候,写法如下:

?
1
<script type="text/javascript" src="${urls.getforlookuppath('/js/index.js')}"></script>

注意,这里仍然使用了urls.getforlookuppath,urls配置方式见上一种方式。

在请求的实际页面中,会显示为:

?
1
<script type="text/javascript" src="/v1.0.0/js/index.js"></script>

可以看到这里的地址是/v1.0.0/js/index.js

静态资源版本管理 处理过程

在freemarker模板首先会调用urls.getforlookuppath方法,返回一个/v1.0.0/js/index.js/css/index-2b371326aa93ce4b611853a309b69b29.css。

这时页面上的内容就是处理后的资源地址。

这之后浏览器发起请求。

这里分开说。

第一种md5方式

请求/css/index-2b371326aa93ce4b611853a309b69b29.css,我们md5配置的paths=/**,所以spring mvc 会尝试url中是否包含-,如果包含会去掉后面这部分,然后去映射的目录(如/static/)查找/css/index.css文件,如果能找到就返回。

第二种版本方式

请求/v1.0.0/js/index.js

如果我们paths中没有配置/v1.0.0,那么上面这个请求地址就不会按版本方式来处理,因此会找不到上面的资源。

如果配置了/v1.0.0,spring 就会将/v1.0.0去掉再去找/js/index.js,最终会在/static/下面找到。

最后

以上是spring boot 静态资源处理的内容,有些不全面的地方或者读者有更多疑问,可以查看spring boot完整文档或本文参考的内容。

总结

以上就是这篇文章的全部内容了,希望本文的内容对大家的学习或者工作具有一定的参考学习价值,谢谢大家对服务器之家的支持。如果你想了解更多相关内容请查看下面相关链接

原文链接:https://blog.csdn.net/isea533/article/details/50412212