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访问静态资源的资料请关注脚本之家其它相关文章!

相关文章

  • springmvc Controller方法没有加@ResponseBody导致api访问404问题

    springmvc Controller方法没有加@ResponseBody导致api访问404问题

    这篇文章主要介绍了springmvc Controller方法没有加@ResponseBody导致api访问404问题,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2024-01-01
  • 利用java批量给pdf加水印的方法示例

    利用java批量给pdf加水印的方法示例

    这篇文章主要介绍了利用java批量给pdf加水印的方法,文中给出了简单的示例代码,需要的朋友可以参考借鉴,下面来一起看吧。
    2017-03-03
  • Spring-AOP @AspectJ切点函数之@annotation()用法

    Spring-AOP @AspectJ切点函数之@annotation()用法

    这篇文章主要介绍了Spring-AOP @AspectJ切点函数之@annotation()用法,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-07-07
  • Java Swing组件下拉菜单控件JComboBox用法示例

    Java Swing组件下拉菜单控件JComboBox用法示例

    这篇文章主要介绍了Java Swing组件下拉菜单控件JComboBox用法,结合具体实例形式分析了Swing组件下拉菜单控件JComboBox的具体定义、使用方法及相关使用注意事项,需要的朋友可以参考下
    2017-11-11
  • Java 数组高频考点分析讲解

    Java 数组高频考点分析讲解

    数组对于每一门编程语言来说都是重要的数据结构之一,当然不同语言对数组的实现及处理也不尽相同。Java 语言中提供的数组是用来存储固定大小的同类型元素
    2022-04-04
  • SpringBoot中使用redis做分布式锁的方法

    SpringBoot中使用redis做分布式锁的方法

    这篇文章主要介绍了SpringBoot中使用redis做分布式锁的方法,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2020-09-09
  • Java的sort的排序及使用详解

    Java的sort的排序及使用详解

    这篇文章主要为大家详细介绍了Java的sort的排序及使用,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下 ,希望您能够多多关注
    2022-02-02
  • 解决MyBatis中模糊搜索使用like匹配带%字符时失效问题

    解决MyBatis中模糊搜索使用like匹配带%字符时失效问题

    Mybatis是我们日常项目中经常使用的框架,在项目中我们一般会使用like查询作为模糊匹配字符进行搜索匹配,下面的Mapper.xml是我们使用like在项目中进行模糊匹配的常用方式,感兴趣的朋友跟随小编一起看看吧
    2021-09-09
  • 浅析java中asList的使用详解

    浅析java中asList的使用详解

    Java中的asList方法是数组工具类 Arrays中的一个静态方法,asList()方法把数组转换成集合时,不能使用其修改集合相关的方法,本文通过示例代码给大家介绍java asList使用,感兴趣的朋友一起看看吧
    2021-10-10
  • 一文带你掌握SpringBoot中常见定时任务的实现

    一文带你掌握SpringBoot中常见定时任务的实现

    这篇文章主要为大家详细介绍了Spring Boot中定时任务的基本用法、高级特性以及最佳实践,帮助开发人员更好地理解和应用定时任务,提高系统的稳定性和可靠性,需要的可以参考下
    2024-03-03

最新评论