springBoot快速访问工程目录下的静态资源

 更新时间:2021年06月23日 08:55:20   作者:Dkwestworld  
springboot工程,是没有webapp文件夹的,静态文件放在src/main/resources/static文件夹下即可,模板文件放在src/main/resources/templates下,本文给大家介绍springBoot快速访问工程目录下的静态资源的相关知识,一起看看吧

1、牛刀小试

1.1 图片静态资源的访问

先看官方怎么说,点击链接,打开SpringBoot官方文档

文档中明确指出:/static(or/publicor/resourcesor/META-INF/resources) ,这几个目录是SpringBoot放置静态资源的目录,只要把静态资源放到这几个目录下,就能直接访问到。

新建 Spingboot web项目试下,新项目只有 /static 目录 ,手动创建其他几个静态资源文件夹,每个目录添加1张图片

启动项目,分别访问这四张图片:

发现图片均可访问,

文档说的对,果然没骗人,

由此我们认定 SpringBoot 访问静态资源:当前项目根路径 + / + 静态资源名

1.2 为静态资源添加访问前缀

By default, resources are mapped on /**, but you can tune that with the spring.mvc.static-path-pattern property. For instance, relocating all resources to /resources/** can be achieved as follows:

PropertiesYaml
spring.mvc.static-path-pattern=/resources/**

文档又解释了一下,说,默认情况下SpringBoot是帮你映射的路径是/** ,

但是,如果你想加一个前缀也可以,比如 /res/

技术圈有句话:先有业务才有技术,SpringBoot官方考虑到某些网站添加了登录验证,一般需要登录后才能访问项目中的资源,为了登录页样式也能正常显示,方便放行静态资源,直接给所有静态资源添加一个前缀,既可统一拦截,又可统一放开

操作:在配置文件application.properties中添加

spring.mvc.static-path-pattern=/res/**

添加完再去访问原来的dog图片链接:http://localhost:8080/dog.jpeg

但是访问:http://localhost:8080/res/dog.jpeg发现这才可以

嘿嘿😋

1.3 WelCome Page 的奇妙跳转

7.1.6. Welcome Page
Spring Boot supports both static and templated welcome pages. It first looks for an index.html file in the configured static content locations. If one is not found, it then looks for an index template. If either is found, it is automatically used as the welcome page of the application.

文档说把一个名称叫 index.html 的文件放到任意的静态目录下,访问http://localhost:8080即可到达,意思就是给你一个首页跳转的快捷方式(注意:需把1.2 的配置路径去掉,否则会导致welcome page功能失效,后面源码分析会说到)

新建html,放到 /static 下,访问:

2、那么,SpringBoot是如何做到的呢?

接下来看源码探究 SpringBoot 静态资源配置原理 》》》》 gogogo

源码位置在:spring-boot-autoconfigure-2.5.1.jar 这个jar里面,具体的目录如下:

/spring-boot-autoconfigure-2.5.1.jar!/org/springframework/boot/autoconfigure/web/servlet/WebMvcAutoConfiguration.class

WebMvcAutoConfiguration 类里面找到addResourceHandlers 方法,顾名思义 添加资源处理器

@Override
        public void addResourceHandlers(ResourceHandlerRegistry registry) {
            // 相当于一个开关去控制静态资源处理器的加载,默认为true,设置为false就会禁止所有规则
            if (!this.resourceProperties.isAddMappings()) {
                logger.debug("Default resource handling disabled");
                return;
            }
            //第一个就配置webjars的访问规则,规定在类路径的/META-INF/resources/webjars/路径下,感兴趣的同学可以点进方法去,里面还配置了webjars的浏览器端缓存时间,是在application。propertities中的一个配置项 spring.web.resources.cache.period  
            addResourceHandler(registry, "/webjars/**", "classpath:/META-INF/resources/webjars/");
            //这里配置了静态资源的四个访问路径
            addResourceHandler(registry, this.mvcProperties.getStaticPathPattern(), (registration) -> {
                registration.addResourceLocations(this.resourceProperties.getStaticLocations());
                if (this.servletContext != null) {
                    ServletContextResource resource = new ServletContextResource(this.servletContext, SERVLET_LOCATION);
                    registration.addResourceLocations(resource);
                }
            });
        }

第一个if判断this.resourceProperties.isAddMappings() 去配置文件获取

spring.resources 这个属性,默认是 true , 如果设置为false 那么就等于禁用掉所有的静态资源映射功能,不行就试一下

#springapplication.propertities中配置
spring.web.resources.add-mappings=false

重启项目,发现首页无法访问了...

改回 true ,首页就又可以访问了

不要停留,继续看第二个addResourceHandler 方法,打断点看看这个方法添加了什么规则

没错,第二个addResourceHandler 方法就表明 / **下的所有请求,都在这四个默认的位置去找静态资源映射 ,这四个目录在官方文档中提到过。

另外,访问路径前缀是在 this.mvcProperties.getStaticPathPattern() 获取的,配置上:

spring.mvc.static-path-pattern=/res/**

打断点如下:

注意📢: 所有的请求先去controller控制器找映射,找不到,再来静态资源映射器。

到这里解决了静态资源目录的问题。

马不停蹄,探究 Welcome Page 的事情 》》》》》

还是在 WebMvcAutoConfiguration 这个类:搜索 “WelcomePage” :

@Bean
        public WelcomePageHandlerMapping welcomePageHandlerMapping(ApplicationContext applicationContext,
                FormattingConversionService mvcConversionService, ResourceUrlProvider mvcResourceUrlProvider) {
            WelcomePageHandlerMapping welcomePageHandlerMapping = new WelcomePageHandlerMapping(
                    new TemplateAvailabilityProviders(applicationContext), applicationContext, getWelcomePage(),
                    this.mvcProperties.getStaticPathPattern());
            welcomePageHandlerMapping.setInterceptors(getInterceptors(mvcConversionService, mvcResourceUrlProvider));
            welcomePageHandlerMapping.setCorsConfigurations(getCorsConfigurations());
            return welcomePageHandlerMapping;
        }

把WelcomePageHandlerMapping 的有参构造也拿来

WelcomePageHandlerMapping(TemplateAvailabilityProviders templateAvailabilityProviders,
            ApplicationContext applicationContext, Resource welcomePage, String staticPathPattern) {
        if (welcomePage != null && "/**".equals(staticPathPattern)) {
            logger.info("Adding welcome page: " + welcomePage);
            setRootViewName("forward:index.html");
        }
        else if (welcomeTemplateExists(templateAvailabilityProviders, applicationContext)) {
            logger.info("Adding welcome page template: index");
            setRootViewName("index");
        }
    }

根据有参构造可以看出来,只有 欢迎页这个资源存在,并且 静态资源访问路径是 /** ,才能重定向到indes.html ,否则就会去找 Controller 处理。

这就解释了,上面为什么配置了静态资源访问路径 为/res/** 后导致首页无法访问到 的问题

好了,前面牛刀小试的坑已经填完了,关于SpringBoot 静态资源配置原理 这篇总结就到这了

以上就是SprignBoot访问工程目录下的静态资源的详细内容,更多关于SprignBoot访问静态资源的资料请关注脚本之家其它相关文章!

相关文章

  • springboot 返回json格式数据时间格式配置方式

    springboot 返回json格式数据时间格式配置方式

    这篇文章主要介绍了springboot 返回json格式数据时间格式配置方式,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-11-11
  • Filter在springboot中的使用方法详解

    Filter在springboot中的使用方法详解

    这篇文章主要介绍了Filter在springboot中的使用方法详解,filter(过滤器)作用于在intreceptor(拦截器)之前,不像intreceptor一样依赖于springmvc框架,只需要依赖于serverlet,需要的朋友可以参考下
    2023-08-08
  • 大数据Kafka:消息队列和Kafka基本介绍

    大数据Kafka:消息队列和Kafka基本介绍

    本文对消息队列的应用场景,优缺点,消息队列的两种方式,常见的消息队列产品以及Kafka的特点和应用场景做了详细的讲解,需要的朋友可以参考下,希望可以对大家有所帮助
    2021-08-08
  • Java实现EasyCaptcha图形验证码的具体使用

    Java实现EasyCaptcha图形验证码的具体使用

    Java图形验证码,支持gif、中文、算术等类型,可用于Java Web、JavaSE等项目,下面就跟随小编一起来了解一下
    2021-08-08
  • java爬取豆瓣电影示例解析

    java爬取豆瓣电影示例解析

    这篇文章主要介绍了java爬取豆瓣电影示例解析,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2020-07-07
  • 继承jpa Repository 写自定义方法查询实例

    继承jpa Repository 写自定义方法查询实例

    这篇文章主要介绍了继承jpa Repository 写自定义方法查询实例,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-12-12
  • 详解如何在SpringBoot项目中使用全局异常处理

    详解如何在SpringBoot项目中使用全局异常处理

    在完整的项目开发中,异常的出现几乎是无法避免的;如果凡是有可能出现异常的地方,我们都手动的使用try-catch将其捕获的话,会使得代码显得十分臃肿并且后期不好维护。本文介绍了pringBoot项目中使用全局异常处理的方法,需要的可以参考一下
    2022-10-10
  • Java获取mac地址的方法

    Java获取mac地址的方法

    这篇文章主要介绍了Java获取mac地址的方法,涉及java针对系统硬件及IO操作的相关技巧,具有一定参考借鉴价值,需要的朋友可以参考下
    2015-07-07
  • Java的List集合框架之Vector详细解析

    Java的List集合框架之Vector详细解析

    这篇文章主要介绍了Java的List集合框架之Vector详细解析,List接口继承Collection,Collection继承于Iterable,List接口实现类分为Vector、ArrayList、LinkedList,Vector底层是一个Object数组,需要的朋友可以参考下
    2023-11-11
  • Java之如何关闭流

    Java之如何关闭流

    这篇文章主要介绍了Java之如何关闭流问题,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2022-11-11

最新评论