从01开始 从01开始
首页
  • 计算机科学导论
  • 数字电路
  • 计算机组成原理

    • 计算机组成原理-北大网课
  • 操作系统
  • Linux
  • Docker
  • 计算机网络
  • 计算机常识
  • Git
  • JavaSE
  • Java高级
  • JavaEE

    • Ant
    • Maven
    • Log4j
    • Junit
    • JDBC
    • XML-JSON
  • JavaWeb

    • 服务器软件
    • Servlet
  • Spring
  • 主流框架

    • Redis
    • Mybatis
    • Lucene
    • Elasticsearch
    • RabbitMQ
    • MyCat
    • Lombok
  • SpringMVC
  • SpringBoot
  • 学习网课的心得
  • 输入法
  • 节假日TodoList
  • 其他
  • 关于本站
  • 网站日记
  • 友人帐
  • 如何搭建一个博客
GitHub (opens new window)

peterjxl

人生如逆旅,我亦是行人
首页
  • 计算机科学导论
  • 数字电路
  • 计算机组成原理

    • 计算机组成原理-北大网课
  • 操作系统
  • Linux
  • Docker
  • 计算机网络
  • 计算机常识
  • Git
  • JavaSE
  • Java高级
  • JavaEE

    • Ant
    • Maven
    • Log4j
    • Junit
    • JDBC
    • XML-JSON
  • JavaWeb

    • 服务器软件
    • Servlet
  • Spring
  • 主流框架

    • Redis
    • Mybatis
    • Lucene
    • Elasticsearch
    • RabbitMQ
    • MyCat
    • Lombok
  • SpringMVC
  • SpringBoot
  • 学习网课的心得
  • 输入法
  • 节假日TodoList
  • 其他
  • 关于本站
  • 网站日记
  • 友人帐
  • 如何搭建一个博客
GitHub (opens new window)
  • JavaSE

  • JavaSenior

  • JavaEE

  • JavaWeb

  • Spring

  • 主流框架

  • SpringMVC

  • SpringBoot

    • SpringBoot教程-尚硅谷

      • SpringBoot课程介绍
      • Spring和SpringBoot
      • HelloWorld
      • 了解自动配置原理
      • 底层注解-@Configuration详解
      • 底层注解-@Import导入组件
      • 底层注解-@Conditional条件装配
      • 原生配置文件引入-@ImportResource
      • 底层注解-配置绑定@ConfigurationProperties
      • 自动配置原理
      • 自动配置流程
      • Lombok简化开发
      • DevTools
      • Spring-Initailizr
      • 配置文件-Yaml用法
      • Web开发简介
      • web开发-静态资源规则于定制化
      • 静态资源配置原理
        • 加载配置
        • 内部类
        • 资源处理的默认规则
      • Rest映射及源码解析
      • 请求映射原理
      • 常用参数注解使用
      • MatrixVariable:矩阵变量
      • 各种类型参数解析原理
      • Servlet-API参数解析原理
      • Model、Map参数解析原理
      • 自定义对象参数绑定原理
      • 自定义Converter原理
      • 数据响应原理
      • 内容协商原理
      • 基于请求参数的内容原理
      • 自定义MessageConverter原理
      • Thymeleaf初体验
      • web实验-后台管理系统
      • web实验-抽取公共页面
      • web实验-遍历数据
      • 源码分析-视图解析器与视图
      • 拦截器-登录检查与静态资源放行
      • 拦截器的执行时机和原理
      • 单文件和多文件上传的使用
      • 文件上传原理
      • 错误处理机制
      • 错误处理-底层组件源码分析
      • 异常处理流程
      • 几种异常处理原理
      • Web原生对象注入
      • 嵌入式Servlet容器
      • 定制化原理
      • 数据库场景的自动配置分析和整合测试
      • 自定义方式整合Druid
      • 通过starter整合Druid
      • 整合Mybatis
      • 使用注解整合Mybatis
      • 整合MybatisPlus操作数据库
      • MybatisPlus-列表分页展示
      • 整合Redis
      • 单元测试-Junit5
      • 单元测试-断言机制
      • 单元测试-前置条件
      • 单元测试-嵌套测试
      • 单元测试-参数化测试
      • 指标监控-基本概念
      • 指标监控-配置EndPoint
      • 指标监控-可视化
      • 原理解析-Profile功能
      • 配置文件深入
      • 自定义Starter
      • SpringApplication初始化过程
      • SpringBoot完整启动过程
      • SpringBoot
  • Java并发

  • Java源码

  • JVM

  • 韩顺平

  • Java
  • Java
  • SpringBoot
  • SpringBoot教程-尚硅谷
2023-08-22
目录

静态资源配置原理

# 180.静态资源配置原理

几乎每个系统都有静态资源,SpringBoot也做了相应的支持   ‍

# 加载配置

  1. 首先,我们之前讲过,SpringBoot启动时默认会加载所有的自动配置类(xxxAutoConfiguration开头的类),jar包名字为spring-boot-autoconfigure-2.3.4.RELEASE.jar
  2. 其中就有web相关的自动配置类,例如DispatchServletAutoConfiguration,HttpEncodingAutoConfiguration.........
  3. 主要还有一个类:WebMbcAutoConfiguration,这个就是配置SpringMVC的,类定义如下:
@Configuration(proxyBeanMethods = false)
@ConditionalOnWebApplication(type = Type.SERVLET)
@ConditionalOnClass({ Servlet.class, DispatcherServlet.class, WebMvcConfigurer.class })
@ConditionalOnMissingBean(WebMvcConfigurationSupport.class)
@AutoConfigureOrder(Ordered.HIGHEST_PRECEDENCE + 10)
@AutoConfigureAfter({ DispatcherServletAutoConfiguration.class, TaskExecutionAutoConfiguration.class, ValidationAutoConfiguration.class })
public class WebMvcAutoConfiguration {}
1
2
3
4
5
6
7

‍

# 内部类

接下来我们看,其给容器中配置了什么内容。我们主要看其有一个内部类:

@Configuration(proxyBeanMethods = false)
@Import(EnableWebMvcConfiguration.class)
@EnableConfigurationProperties({ WebMvcProperties.class, ResourceProperties.class })
@Order(0)
public static class WebMvcAutoConfigurationAdapter implements WebMvcConfigurer {}
1
2
3
4
5

‍

  • 第1行的注解,说明这是一个配置类;

  • 第3行的注解,这是进行属性绑定的。

    • 首先WebMvcProperties类,和配置文件中spring.mvc开头的配置进行了绑定
    • ResourceProperties类,和配置文件中spring.resources开头的配置进行了绑定

‍

‍

该内部类只有一个有参构造器,所有参数的值都会从容器中配置(在SpringBoot中大部分都是这样,算是一个特性)

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;
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

‍

该方法的参数说明:

  • ResourceProperties resourceProperties:获取和spring.resources绑定的所有的值的对象
  • WebMvcProperties mvcProperties: 获取和spring.mvc绑定的所有的值的对象
  • ListableBeanFactory beanFactory: Spring的beanFactory,相当于是容器
  • HttpMessageConverters: 找到所有的HttpMessageConverters,后面会说
  • ResourceHandlerRegistrationCustomizer: 找到资源处理器的自定义器。
  • DispatcherServletPath:路径,后续再说
  • ServletRegistrationBean:给应用注册Servlet、Filter....

‍

然后剩余的部分,就是一些配置的方法了,例如configureXXX开头的方法。比较重要的是addResourceHandlers​方法,这是配置资源处理的默认规则。

‍

‍

# 资源处理的默认规则

该方法源码:

@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();
    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
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

‍

# 静态资源文件

首先,该方法前3行先判断有无禁用路径配置,是的话则直接返回,后续的代码都不生效;例如这样配置

spring:
  resources:
    add-mappings: false   # 默认为true,为false则禁用所有静态资源规则
1
2
3

‍

‍

后续的代码,可以看到配置了webjars的路径,是/META-INF/resources/webjars​,这也就是为什么我们之前能访问webjars里的内容。

还配置了静态资源的路径,方法getStaticPathPattern返回的是/**​,getStaticLocations()​方法则返回的是之前定义的如下路径:

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

‍

# 缓存配置

‍

除此之外,我们还可以配置静态资源的缓存(秒为单位)

spring:
  resources:
    cache:
      period: 1100
1
2
3
4

‍

然后我们访问JQuery的文件,并且刷新,能看到控制台的请求头有时间限制:

​​

‍

在配置类中,也有获取缓存的代码,例如第7行有个getCache方法:

    Duration cachePeriod = this.resourceProperties.getCache().getPeriod();
1

‍

‍

# 欢迎页配置

还有一个欢迎页的配置:

@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;
}
1
2
3
4
5
6
7
8
9
10
11
12

‍

我们先说说HandlerMapping,这是SpringMVC的核心组件(在SpringMVC中的组件介绍 (opens new window)里讲过),相当于处理器映射,保存了每一个handler能处理那些请求。

而WelcomePageHandlerMapping,相当于配置了欢迎页是谁来处理。

然后方法传入了一堆参数,这些都是从容器中获取的;

然后方法里有new一个WelcomePageHandlerMapping对象:

WelcomePageHandlerMapping(TemplateAvailabilityProviders templateAvailabilityProviders,
		ApplicationContext applicationContext, Optional<Resource> welcomePage, String staticPathPattern) {
	if (welcomePage.isPresent() && "/**".equals(staticPathPattern)) {
		logger.info("Adding welcome page: " + welcomePage.get());
		setRootViewName("forward:index.html");
	}
	else if (welcomeTemplateExists(templateAvailabilityProviders, applicationContext)) {
		logger.info("Adding welcome page template: index");
		setRootViewName("index");
	}
}
1
2
3
4
5
6
7
8
9
10
11

‍

因此,也就是这里配置了index首页的默认配置,并且第3行,有判断静态资源路径是否/**​;这也就是为什么,我们之前自定义了静态资源访问路径后,首页就不生效了。

在GitHub上编辑此页 (opens new window)
上次更新: 2023/8/23 10:10:57
web开发-静态资源规则于定制化
Rest映射及源码解析

← web开发-静态资源规则于定制化 Rest映射及源码解析→

Theme by Vdoing | Copyright © 2022-2023 粤ICP备2022067627号-1 粤公网安备 44011302003646号
  • 跟随系统
  • 浅色模式
  • 深色模式
  • 阅读模式