SpringBoot05——WEB01对于静态资源的处理规则

BUZHIDAO52

已于 2023-04-13 02:36:51 修改

阅读量275

点赞数

于 2023-04-07 08:28:30 首次发布

本文链接：https://blog.csdn.net/BUZHIDAO52/article/details/129980928

版权

静态资源访问

springboot访问静态资源的方式

只要静态资源放在类路径下： /static (or /public or /resources or /META-INF/resources

也就是说在这四个资源目录下的静态资源都可以访问到

我们都建立这四个目录

我们在其中放入四张照片

访问方式：当前项目根路径/ + 静态资源名

测试：

四个都可以

动态请求与静态请求冲突

如果这个时候我们的代码中如下代码（请求路径与静态资源重名），会执行谁？

返回的是动态的

为什么会这样？

给静态资源加统一前缀

作用：我们之后的项目一定是需要配置拦截器的，但是静态资源默认请求是/**（访问所有），我们可以在静态资源前面加一个统一的前缀，方便以后配置拦截器

用法：

配置yaml文件

spring:
  mvc:
    static-path-pattern: /res/**

这个的意思就是访问路径前缀只能/res才可以访问所有静态资源文件

控制访问哪个文件夹下的静态资源

用法：

配置yaml文件

spring:
  mvc:
    static-path-pattern: /res/**
  resources:
    static-locations: classpath:/static/

此时因为one.png在我们规定的文件夹下，可以访问，但是其他的就不可以了

欢迎页支持

就是可以定义一个名称为index.html的文件，来访问项目根路径，项目会所默认展示的页面，或者我们的Controller写了index请求，也会自动帮我们找到并且进行处理

第一种情况：

测试：

总结

自定义Favicon

作用与用法：就是我们平时访问网站，选项卡旁边的小图标我们现在可以自己设定，只需要把名称为favicon.ico名称的图片加到静态资源目录下就可以了

成功

SpringBoot对静态资源管理的原理

所有的springboot项目启动流程应该是

1.SpringBoot启动默认加载 xxxAutoConfiguration 类（自动配置类）

那么我们的是web项目，web场景的自动配置类一定被加载了

加载了web，那么servlet一定也被加载了

我们看到其中中央处理器自动配置类，编解码自动配置类，但是对于静态资源核心的是

这是springMVC最核心的自动配置类

那既然找到了

2.看看这个配置类能不能生效（看上面的注解）

@ConditionalOnClass({Servlet.class, DispatcherServlet.class, WebMvcConfigurer.class})
@ConditionalOnMissingBean({WebMvcConfigurationSupport.class})
@AutoConfigureOrder(-2147483638)

对他们进行逐行分析

@ConditionalOnClass({Servlet.class, DispatcherServlet.class, WebMvcConfigurer.class})

类路径里有这三个类，下面的代码才生效，这些只要我们导入了MVC的包，一定会生效的

@ConditionalOnMissingBean({WebMvcConfigurationSupport.class})
容器中没有这个类型的组件的时候，下面的代码才会生效

这个组件是什么？

这里涉及到以后我们可以自己配置组件，全面接管springMVC的配置类，springBoot检测到我们配置了，自己就不会生效了

现在证明我们的自动配置是生效的

3.现在生效了，看看它都帮我们配置了什么

这个是兼容Rest请求（post，get请求）的，现在不是我们的重点

这个是表单内容过滤器，现在不是我们的重点

在这里，完成了对于静态资源的默认配置

注意：@EnableConfigurationProperties这个注解我们之前说过，是绑定需要用到的类与配置文件，完成相互对应的配置

4.配置文件的相关属性和xxx进行了绑定。WebMvcProperties==spring.mvc、ResourceProperties==spring.resources

扩展知识：如果一个配置类只有一个有参构造器（现在这个就是），那么所有参数都会从容器中寻找

//有参构造器所有参数的值都会从容器中确定
//ResourceProperties resourceProperties；获取和spring.resources绑定的所有的值的对象
//WebMvcProperties mvcProperties 获取和spring.mvc绑定的所有的值的对象
//ListableBeanFactory beanFactory Spring的beanFactory
//HttpMessageConverters 找到所有的HttpMessageConverters
//ResourceHandlerRegistrationCustomizer 找到 资源处理器的自定义器。=========
//DispatcherServletPath  
//ServletRegistrationBean   给应用注册Servlet、Filter....
	public WebMvcAutoConfigurationAdapter(ResourceProperties resourceProperties, WebMvcProperties mvcProperties,
				ListableBeanFactory beanFactory, ObjectProvider<HttpMessageConverters> messageConvertersProvider,
				ObjectProvider<ResourceHandlerRegistrationCustomizer> resourceHandlerRegistrationCustomizerProvider,
				ObjectProvider<DispatcherServletPath> dispatcherServletPath,
				ObjectProvider<ServletRegistrationBean<?>> servletRegistrations) {
			this.resourceProperties = resourceProperties;
			this.mvcProperties = mvcProperties;
			this.beanFactory = beanFactory;
			this.messageConvertersProvider = messageConvertersProvider;
			this.resourceHandlerRegistrationCustomizer = resourceHandlerRegistrationCustomizerProvider.getIfAvailable();
			this.dispatcherServletPath = dispatcherServletPath;
			this.servletRegistrations = servletRegistrations;
		}

注意，现在这个方法已经拿到了对于资源管理相关操作的参数，我们看看它对应的方法做出了哪些操作

@Override
		public void addResourceHandlers(ResourceHandlerRegistry registry) {
			if (!this.resourceProperties.isAddMappings()) {
				logger.debug("Default resource handling disabled");
				return;
			}
			Duration cachePeriod = this.resourceProperties.getCache().getPeriod();
			CacheControl cacheControl = this.resourceProperties.getCache().getCachecontrol().toHttpCacheControl();
			//webjars的规则
            if (!registry.hasMappingForPattern("/webjars/**")) {
				customizeResourceHandlerRegistration(registry.addResourceHandler("/webjars/**")
						.addResourceLocations("classpath:/META-INF/resources/webjars/")
						.setCachePeriod(getSeconds(cachePeriod)).setCacheControl(cacheControl));
			}
            
            //
			String staticPathPattern = this.mvcProperties.getStaticPathPattern();
			if (!registry.hasMappingForPattern(staticPathPattern)) {
				customizeResourceHandlerRegistration(registry.addResourceHandler(staticPathPattern)
						.addResourceLocations(getResourceLocations(this.resourceProperties.getStaticLocations()))
						.setCachePeriod(getSeconds(cachePeriod)).setCacheControl(cacheControl));
			}
		}

(1)先从this.resourceProperties拿到了isAddMappings，这是什么？

我们可以在配置文件中尝试设置一下

这东西是可以被设置的

看看代码

如果我们拿到的这个add-mapping为空，就不会执行下面的else的代码了，下面的else为静态资源自动配置的代码

所以，用不用静态资源自动配置是我们可以在配置文件中设计的

（2）获取缓存的时间长度

（3）之前我们访问/webjars会显示很多东西，为什么会这样？

if (!registry.hasMappingForPattern("/webjars/**")) {
                    this.customizeResourceHandlerRegistration(registry.addResourceHandler(new String[]{"/webjars/**"}).addResourceLocations(new String[]{"classpath:/META-INF/resources/webjars/"}).setCachePeriod(this.getSeconds(cachePeriod)).setCacheControl(cacheControl));
                }

原来这边已经写死了，如果这样子访问，自动跳转到classpath:/META-INF/resources/webjars/

并且设置缓存（缓存时长是我们在第二点里设定或者直接用系统默认的）

（4）对静态资源的默认配置操作

String staticPathPattern = this.mvcProperties.getStaticPathPattern();
                if (!registry.hasMappingForPattern(staticPathPattern)) {
                    this.customizeResourceHandlerRegistration(registry.addResourceHandler(new String[]{staticPathPattern}).addResourceLocations(WebMvcAutoConfiguration.getResourceLocations(this.resourceProperties.getStaticLocations())).setCachePeriod(this.getSeconds(cachePeriod)).setCacheControl(cacheControl));
                }

首先获取了mvcProperties也就是WebMvcProperties==spring.mvc配置文件

之前我们就自己设置了

但是我们不设置也会有默认的，也就是/**

现在我们进来了，之前我们的webjars默认路径是写死的，现在哪找默认配置呢？

在resourceProperties里找，也就是ResourceProperties==spring.resources配置文件

这个文件里写了什么？

就是写了我们之前的四个默认的静态资源访问路径

（5）关于欢迎页的规则

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

首先了解一个知识点

HandlerMapping：处理器映射（是springMVC的一个核心组件）。保存了每一个Handler能处理哪些请求。（他们会自己寻找）

现在我们看到这个欢迎页自动配置的类是WelcomePageHandlerMapping，也是一个HandlerMapping

现在来看方法，这个方法也是只有一个有参构造，里面所有的东西也都是从容器中获取，不用我们关心

让后源码给我们WelcomePageHandlerMapping welcomePageHandlerMapping = new WelcomePageHandlerMapping，new了一个WelcomePageHandlerMapping，并且向里面传入了参数，核心的参数就是mvcProperties，这玩意也要从配置文件中寻找，而且我们也可以在自己的配置文件中进行修改

我们来看看new对象的时候都干了什么

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

    }

这里也是一个条件判断

第一种情况：如果我们的访问路径是/**，而且欢迎页存在，就跳转到index.html页面