SpringBoot如何正确配置静态资源的访问

使用SpringBoot搭建web项目时静态资源的访问必然是一个需要考虑的问题,不过SpringBoot在对于静态资源访问的问题上已经做了很好的支持,下面就静态资源访问的正确姿势进行说明。

一、静态资源配置

SpringBoot默认从以下几个目录访问静态资源:

/META-INF/resources/
/resources/
/static
/public/

以上4个默认目录中如果存在同一个静态资源,则访问的优先级至上而下,访问的映射,默认是ServletContext的根路径"/"即:

protocol://ipaddress:port/静态资源名称

当然我们也可以定义自己的静态资源访问路径以及请求映射,如下:

spring.resources.static-locations=classpath:/custom/,classpath:/META-INF/resources/,classpath:/resources/,classpath:/static/,classpath:/public/
spring.mvc.static-path-pattern=/resources/**

在以上配置中我们自定义了静态文件的存放目录custom以及请求映射/resources/。需要注意的是,在定义静态文件存放目录时,配置的目录位置越靠前,则优先级越高。此时的访问地址如下:

protocol://ipaddress:port/resources/静态资源名称

以上是通过属性配置的方式实现静态资源的配置,当然也可以使用JavaConfig的方式来配置。
栗子,JavaConfig配置静态资源

@Configuration
@EnableWebMvc
public class WebConfiguration implements WebMvcConfigurer {
    @Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {
        registry.addResourceHandler("/resources/**")
                .addResourceLocations("classpath:/custom/","classpath:/META-INF/resources/",
                        "classpath:/resources/","classpath:/static/","classpath:/public/");
    }
}

注意:不管使用属性配置还是JavaConfig配置,静态资源所在目录和请求映射路径后必须跟“/”,否则配置不会生效。

二、webjars使用

SpringBoot也支持以webjars的形式访问静态资源。

1、什么是webjars

顾名思义,webjars就是将web资源打成一个jar包以供项目使用。因为在实际的开发中,由于一个公司对UI以及静态资源版本的控制有着更高的要求,使用webjars首先也可让我们的静态资源得到共享;其次,由于独立了静态资源,所以可以提升项目的编译速度和打包速度;最后,我们可以使用maven将静态资源jar包上传至公司私服,方便了版本的控制和资源的共享。这样看来,使用webjars确实非常方便,关于静态资源如何打成一个webjars,网上教程很多,也比较简单,这里就不赘述了。
tips:在maven中央仓库中,已经提供了一些常用的依赖:

<!-- jquery webjars -->
<dependency>
    <groupId>org.webjars</groupId>
    <artifactId>jquery</artifactId>
    <version>3.1.0</version>
</dependency>
<!-- bootstrap webjars -->
<dependency>
    <groupId>org.webjars</groupId>
    <artifactId>bootstrap</artifactId>
    <version>3.4.1</version>
</dependency>

...

以上是比较常用的两个前端框架的webjars,如需其他的webjars,可以去webjars官网或者maven中央仓库去查找。

2、访问webjars

默认情况下,当我们在项目中引入指定的webjars依赖后,就可以直接通过如下的方式访问其中的静态资源:

/webjars/jquery/x.y.z/jquery.min.js

其中w.y.z为webjars的版本号。当然也可以不带版本号直接访问静态资源,不过有一个前提条件,就是你的项目中必须引入一个依赖:

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

加入这个依赖后,我们就可以使用如下两种方式访问webjars中的资源了:

方式一:/webjars/jquery/x.y.z/jquery.min.js
方式二:/webjars/jquery/jquery.min.js

三、静态资源缓存问题

在实际的开发中,我们总是会面临这样一个问题:生产环境有一个js需要优化,优化完成后需要更新到生产,但仅是这样的操作,问题就解决了吗?其实并没有。因为对于一些老用户来说,他们的浏览器已经缓存了你旧版本的js,就算你新版本js上线,对于开发人员来说,清一下缓存就好了,但是你指望用户帮你清除缓存么?这也不太现实。对于此类问题,以前最简单粗暴的方式就是给经常需要变动的js后加一个时间戳,导致页面加载时,每次都要从服务器加载js,这种做法可以解决问题,但是会影响性能。

SpringMVC给我们提供了两种解决方案:内容MD5和版本控制,这两种方案中,版本控制其实和webjars的版本访问机制类似。而MD5的这种方式默认情况下只有在重启项目后才能生效,当然你也可以通过其他方式让每次请求的时候都重新计算内容的MD5进行比对,但是这种方式不推荐,如果静态资源比较大,则会有性能问题。

1、内容MD5清除缓存

#开启内容策略
spring.resources.chain.strategy.content.enabled=true
#内容策略作用的路径
spring.resources.chain.strategy.content.paths=/**

MD5静态内容策略配置比较简单,需要注意的是,如果你在JavaConfig中启动了MVC配置,则在属性文件中配置的策略失效,必须移动至JavaConfig中进行配置。栗子、访问路径
<link href="/css/spring-2a2d595e6ed9a0b24f027f2b63b134d6.css"/>

2、版本控制清除缓存

#内容策略,版本控制
spring.resources.chain.strategy.fixed.enabled=true
#版本文件所在位置
spring.resources.chain.strategy.fixed.paths=/js/lib/**
#版本定义
spring.resources.chain.strategy.fixed.version=v12

栗子、访问路径,以下两种方式都支持

/{配置的版本}/js/lib/mymodule.js
/js/lib/mymodule.js

版本控制的配置,有时会由于SpringBoot版本的问题而不生效,需增加如下JavaConfig配置才会生效:

@Configuration
public class ThymeleafConfig {
    @Bean
    public ResourceUrlEncodingFilter resourceUrlEncodingFilter() {
        return new ResourceUrlEncodingFilter();
    }
}

关于静态的资源的使用就聊这么多,总结一下:
1、静态资源使用默认配置基本能够满足开发需要,建议不要轻易改动;
2、webjars更适合系统基础框架静态资源的打包;
3、内容策略要么统一在JavaConfig中配置,要么统一在属性配置文件配置否则会失效;
4、内容策略版本控制,按照官方文档配置可能不会生效,解决方案就是注入ResourceUrlEncodingFilter组件。

更多最新技术文章,请关注公众号“冰点IT”

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 204,684评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 87,143评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,214评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,788评论 1 277
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,796评论 5 368
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,665评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,027评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,679评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 41,346评论 1 299
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,664评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,766评论 1 331
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,412评论 4 321
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,015评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,974评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,203评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,073评论 2 350
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,501评论 2 343

推荐阅读更多精彩内容