- Spring Boot实战:从0开始动手搭建企业级项目
- 十三
- 776字
- 2021-08-13 19:43:43
7.6 Spring Boot对静态资源的映射规则
与普通Spring Web项目相比,Spring Boot项目的目录结构中仅有java和resources两个目录。用于存放资源文件的webapp目录在Spring Boot项目的目录结构中根本不存在。那么Spring Boot是如何处理静态资源的呢? WebMVC在自动配置时针对资源文件的访问又做了哪些配置呢?
由源码可知,这部分配置依然是通过WebMvcAutoConfigurationAdapter内部类完成的,源码如下所示:
![](https://epubservercos.yuewen.com/3069E4/20862583308964806/epubprivate/OEBPS/Images/138-2.jpg?sign=1739379325-mfh9UwtyKkL6pUtC0mXF9Vc8SV6BIssG-0-0fef13daf218901c16def5bd8bcd0719)
如以上源码所示,静态资源的映射是在addResourceHandlers()方法中进行映射配置的,它类似于在Spring MVC配置文件中的如下配置代码:
![](https://epubservercos.yuewen.com/3069E4/20862583308964806/epubprivate/OEBPS/Images/139-2.jpg?sign=1739379325-aDgcZbw2JTCaQyFph2SAqLdwqkB94KQ5-0-796c24bc1438e4916b6c3dc47a7667c6)
回到addResourceHandlers()源码中来,staticPathPattern的变量值为"/**",其默认值在WebMvcProperties类中。实际的静态资源存放目录通过getResourceLocations()方法获取,该方法源码如下所示:
![](https://epubservercos.yuewen.com/3069E4/20862583308964806/epubprivate/OEBPS/Images/139-3.jpg?sign=1739379325-ROXmQtpWuA8Zb51C2HIU4xEyz9IhQwih-0-624f134f5fd359afffcb0a65bf0bfe95)
![](https://epubservercos.yuewen.com/3069E4/20862583308964806/epubprivate/OEBPS/Images/140-1.jpg?sign=1739379325-2tSQf1B0mgR4RUtakERiD1vR6PUBmYop-0-d3339c8e7e6fe042b1b71f3b87ff0ace)
由此可知,Spring Boot默认的静态资源处理目录为:"classpath:/META-INF/ resources/"、"classpath:/resources/"、"classpath:/static/"、"classpath:/public/"。
由于访问当前项目的任何资源都能在静态资源的文件夹中查找,而不存在的资源则会显示相应的错误页面,因此在开发Web项目时只需要包含这几个目录中的任意一个或者多个,并将静态资源文件放入其中即可。
为了验证该配置,可以在类路径下分别创建public目录(PNG格式文件)、resources目录(CSS格式文件)、stati目录(HTML格式文件和JS格式文件),并分别在三个文件夹中放入静态文件,如图7-4所示。
![](https://epubservercos.yuewen.com/3069E4/20862583308964806/epubprivate/OEBPS/Images/140-2.jpg?sign=1739379325-8uAhGluKIMnW0QaEXYAA8i9nsqZKZkTI-0-8cd50f60ae71904baad2227de202cfb5)
图7-4 静态资源文件
重启Spring Boot,在启动成功后打开浏览器并输入以下请求地址分别进行请求:
![](https://epubservercos.yuewen.com/3069E4/20862583308964806/epubprivate/OEBPS/Images/140-3.jpg?sign=1739379325-78Z0AeR89kVVvzUhbkGIvEwaUpJjhsAF-0-f626101ba3193b5e056e1290c057dc36)
访问结果如图7-5~7-8所示。
![](https://epubservercos.yuewen.com/3069E4/20862583308964806/epubprivate/OEBPS/Images/141-1.jpg?sign=1739379325-uw3kRT9QQvUKow0ssSmXT9o6uOrMOyuA-0-dd17f502c9c08cdac210b66996bb7b72)
图7-5 logo.png请求结果
![](https://epubservercos.yuewen.com/3069E4/20862583308964806/epubprivate/OEBPS/Images/141-2.jpg?sign=1739379325-uNXpXxrNKjewMTFxAlj2OA047xXpH884-0-9b1c2287c3df02a41c2a92e1c9d6499a)
图7-6 main.css请求结果
![](https://epubservercos.yuewen.com/3069E4/20862583308964806/epubprivate/OEBPS/Images/141-3.jpg?sign=1739379325-cQAecJ3LLB6Gna78r51FKEJXXABFeuoe-0-9c504afd5fdfde0f83dd2b16801f530e)
图7-7 test.html请求结果
![](https://epubservercos.yuewen.com/3069E4/20862583308964806/epubprivate/OEBPS/Images/141-4.jpg?sign=1739379325-Idnj7YsMsr9xcmKGBaxgkpupd8tSvWIB-0-3a4efe5a7b383d8ecbf241f0a5f694dd)
图7-8 test.js请求结果
通过以上请求结果可以发现,静态资源虽然在不同的目录中,但都能被正确返回。这就是Spring Boot对静态资源的拦截处理。
当然,开发时也可以在Spring Boot项目配置文件中修改这些属性。比如将拦截路径改为“/static/”,并将静态资源目录修改为“/file-test”,那么默认配置就会失效并使用开发人员自定义的配置。修改application.properties文件,添加如下配置:
![](https://epubservercos.yuewen.com/3069E4/20862583308964806/epubprivate/OEBPS/Images/142-1.jpg?sign=1739379325-YqZGGiO68q9CQ1bQGJcZOOK8JDB1aLHP-0-c1cf1b476380e251636e904fcc9be98b)
在修改后重启Spring Boot项目,再次使用原来的URL访问以上三个资源文件将会报404的错误,如图7-9所示。
![](https://epubservercos.yuewen.com/3069E4/20862583308964806/epubprivate/OEBPS/Images/142-2.jpg?sign=1739379325-hrO2OyIc87dqMoD8tLOkr4UH6O3iN62K-0-4abf9456e0172b349815bc6998a5aed9)
图7-9 404错误
如果想要正常访问文件,则需要新建static-test目录并将静态资源文件移至file-test目录下,且修改访问路径为:
![](https://epubservercos.yuewen.com/3069E4/20862583308964806/epubprivate/OEBPS/Images/142-3.jpg?sign=1739379325-h2JfHY7hIHCXEhDUnqMdKSi4QJTFE2HH-0-75bfe9bed2177f7c3d3b105a352af064)
此时页面就不会出现404错误。