学习笔记--SpringBoot2Web开发

1、SpringMVC自动配置

Spring Boot provides auto-configuration for Spring MVC that works well with most applications.(大多场景我们都无需自定义配置)

The auto-configuration adds the following features on top of Spring’s defaults:

Inclusion of ContentNegotiatingViewResolver and BeanNameViewResolver beans.

内容协商视图解析器和BeanName视图解析器

Support for serving static resources, including support for WebJars

静态资源（包括webjars）

Automatic registration of Converter, GenericConverter, and Formatter beans.

自动注册 Converter，GenericConverter，Formatter

Support for HttpMessageConverters

支持 HttpMessageConverters （后来我们配合内容协商理解原理）

Automatic registration of MessageCodesResolver

自动注册 MessageCodesResolver （国际化用）

Static index.html support.

静态index.html 页支持

Custom Favicon support

自定义 Favicon

Automatic use of a ConfigurableWebBindingInitializer bean

自动使用 ConfigurableWebBindingInitializer ，（DataBinder负责将请求数据绑定到JavaBean上）

2、简单功能分析

2.1 静态资源访问

1、静态资源目录

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

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

原理：静态映射/** 。这意味着所有不能处理的请求都要经过静态资源处理器。

请求进来，先去找Controller看能不能处理。不能处理的所有请求又都交给静态资源处理器。静态资源也找不到则响应404页面

改变默认的静态资源路径

spring:
  resources:
    static-locations: [classpath:/haha/]

这个locations是一个数组，可以填写多个地址。

改变了之后，就只能在类路径下/haha/下访问静态资源。

2、静态资源访问前缀

默认无前缀

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

注意：这个是请求地址，不是资源地址。资源还是放在/static (or /public or /resources or /META-INF/resources)

当前项目 + static-path-pattern + 静态资源名 = 静态资源文件夹下找。

这个的主要功能就是配合拦截器使用，拦截器一般都会排除访问静态资源的请求。

2.2 欢迎页支持

静态资源路径下 index.html文件

可以配置静态资源路径

但是不可以配置静态资源的访问前缀。否则导致index.html不能被默认访问

spring:
#  mvc:
#    static-path-pattern: /res/**   这个会导致welcome page功能失效

  resources:
    static-locations: [classpath:/haha/]

controller能处理/index请求

2.3 自定义Favicon

Favicon：页面眉头的小图标。

只要将favicon.ico 放在静态资源目录下即可。

2.4 静态资源配置原理

SpringBoot启动默认加载 xxxAutoConfiguration 类（自动配置类）
SpringMVC功能的自动配置类 WebMvcAutoConfiguration，生效

@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 {}

即满足这些Conditional前提，配置类才生效。

给容器中配了什么？

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

配置文件的相关属性和 webMvcProperties 以及ResourceProperties 进行了绑定

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;
	}

资源处理的默认规则

有一个方法叫addResourceHandlers，这个处理器揭示了springboot如何自动获取静态资源的。

@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));
			}
		}

这个自动配置资源文件的方法是可以禁用的，如：

spring:
  resources:
    add-mappings: false   禁用所有静态资源规则

可以设置静态资源的缓存时间，在这个缓存时间内，不用再次访问地址也能获得静态资源。

spring:
    resources:
        cache:
            period: xxxxxx

下面是处理springboot映射静态资源的方法：

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

首先是获得静态映射，从配置文件中读取，如果没有配置，默认为/**。
将配置文件中的静态资源目录添加，如果没有配置，默认为resourceProperties文件下的路径。
同样有缓存机制。

下面是资源属性类，存放了默认的读取静态资源的目录：

@ConfigurationProperties(prefix = "spring.resources", ignoreUnknownFields = false)
public class ResourceProperties {

	private static final String[] CLASSPATH_RESOURCE_LOCATIONS = { "classpath:/META-INF/resources/",
			"classpath:/resources/", "classpath:/static/", "classpath:/public/" };

	/**
	 * Locations of static resources. Defaults to classpath:[/META-INF/resources/,
	 * /resources/, /static/, /public/].
	 */
	private String[] staticLocations = CLASSPATH_RESOURCE_LOCATIONS;

欢迎页的处理规则

下面是关于欢迎页的处理类：


	@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(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)) {
            // 调用Controller  /index
			logger.info("Adding welcome page template: index");
			setRootViewName("index");
		}
	}

HandlerMapping：处理器映射。保存了每一个Handler能处理哪些请求。

所以welcomePageHandlerMapping就是处理欢迎请求的处理器。
当欢迎页存在且静态映射是/**时，会将index.html文件当成欢迎页面，所以这就解释了为什么如果我们改变静态映射，会报错。这里是写死了的。
当静态映射不是/**时，就会去controller里找/index请求，将index请求返回当做欢迎页。

posted @ 2022-03-20 09:51 小超和你阅读(76) 评论(0) 收藏举报

刷新页面返回顶部