网络知识 娱乐 SpringBoot对Spring MVC都做了哪些事?(一)

SpringBoot对Spring MVC都做了哪些事?(一)

环境:Springboot2.4.12


Spring MVC自动配置

Spring Boot为Spring MVC提供了自动配置,可以很好地与大多数应用程序配合使用。

自动配置在Spring默认设置的基础上添加了以下功能:

  • 包含ContentNegotiatingViewResolverBeanNameViewResolver bean
  • 支持提供静态资源,包括对WebJars的支持(本文档后面会讲到)。
  • ConverterGenericConverterFormatter bean的自动注册。
  • HttpMessageConverters的支持(本文档后面会讲到)。
  • 自动注册MessageCodesResolver(本文档后面将介绍)。
  • 静态index.html的支持。
  • 自动使用ConfigurableWebBindingInitializer bean(本文档后面将介绍)。

如果你想保留那些Spring Boot MVC自定义,并做更多的MVC自定义(拦截器、格式化器、视图控制器和其他特性),你可以添加你自己的WebMvcConfigurer类型的@Configuration类,但不需要@EnableWebMvc

如果你想提供RequestMappingHandlerMappingRequestMappingHandlerAdapterExceptionHandlerExceptionResolver的自定义实例,并且仍然保持Spring Boot MVC自定义,你可以声明一个WebMvcRegistrations类型的bean,并使用它来提供这些组件的自定义实例。

上面这段什么意思?就是我们可以自定义一个Class实现WebMvcRegistrations接口实现自定义的上面的RequestMappingHandlerMapping等相关的类。

WebMvcRegistrations接口

public interface WebMvcRegistrations {n default RequestMappingHandlerMapping getRequestMappingHandlerMapping() {n return null;n }n default RequestMappingHandlerAdapter getRequestMappingHandlerAdapter() {n return null;n }n default ExceptionHandlerExceptionResolver getExceptionHandlerExceptionResolver() {n return null;n }n}

自动配置中又是如何使用(知道)我们自定义的这个WebMvcRegistrations 类呢?

@Configuration(proxyBeanMethods = false)n@EnableConfigurationProperties(WebProperties.class)npublic static class EnableWebMvcConfiguration extends DelegatingWebMvcConfiguration implements ResourceLoaderAware {n // 注入自定义的WebMvcRegistrationsn private final WebMvcRegistrations mvcRegistrations;n public EnableWebMvcConfiguration(ObjectProvider<WebMvcRegistrations> mvcRegistrations) {n // ...n this.mvcRegistrations = mvcRegistrationsProvider.getIfUnique();n }n}

这里RequestMappingHandlerMapping 为例说明自动配置是如何使用自定义的。接着上面的类中,有如下方法定义

@Configuration(proxyBeanMethods = false)n@EnableConfigurationProperties(WebProperties.class)npublic static class EnableWebMvcConfiguration extends DelegatingWebMvcConfiguration implements ResourceLoaderAware {n @Beann @Overriden public RequestMappingHandlerAdapter requestMappingHandlerAdapter(...) {n // 调用父类的方法,这里就不进入父类方法了,父类方法中会调用createRequestMappingHandlerAdaptern // 方法,而此方法正好被当前类重写了n RequestMappingHandlerAdapter adapter = super.requestMappingHandlerAdapter(contentNegotiationManager, conversionService, validator);n // ...n return adapter;n }n @Overriden protected RequestMappingHandlerAdapter createRequestMappingHandlerAdapter() {n // 判断是否存在自定义的WebMvcRegistrations接口n if (this.mvcRegistrations != null) {n RequestMappingHandlerAdapter adapter = this.mvcRegistrations.getRequestMappingHandlerAdapter();n if (adapter != null) {n return adapter;n }n }n return super.createRequestMappingHandlerAdapter();n }n}

以上就是自动配置实现自定义RequestMappingHandlerMapping 等相关WebMVC核心组件的方式。

如何完全的自己控制WebMVC的配置呢?

你可以添加自己的@Configuration注释@EnableWebMvc,或者自定义配置类 @Configuration注释且此类是DelegatingWebMvcConfiguration的子类

如果你想定制Spring MVC使用的ConversionService,你可以提供一个带有addFormatters方法的WebMvcConfigurer bean。通过这个方法,你可以注册任何你喜欢的转换器,或者你可以委托给ApplicationConversionService上可用的静态方法。

HttpMessageConverters

Spring MVC使用HttpMessageConverter接口来转换HTTP请求和响应。合理的默认值是开箱即用的。例如,可以将对象自动转换为JSON(通过使用Jackson库)或XML(通过使用Jackson XML扩展(如果可用),或通过使用JAXB(如果Jackson XML扩展不可用)。缺省情况下,字符串是用UTF-8编码的。

如果你需要添加或自定义转换器,你可以使用Spring Boot的HttpMessageConverters类,如下所示:

@Configuration(proxyBeanMethods = false)npublic class MyConfiguration {n @Beann public HttpMessageConverters customConverters() {n HttpMessageConverter<?> additional = ...n HttpMessageConverter<?> another = ...n return new HttpMessageConverters(additional, another);n }n}

自动配置又是如何使用咱们自定义的配置?

  • HandlerAdapter设置HttpMessageConverter

public class WebMvcConfigurationSupport {n @Nullablentprivate List<HttpMessageConverter<?>> messageConverters;n public RequestMappingHandlerAdapter requestMappingHandlerAdapter() {n RequestMappingHandlerAdapter adapter = createRequestMappingHandlerAdapter();n // HandlerAdapter设置消息转换器n adapter.setMessageConverters(getMessageConverters());n }n protected final List<HttpMessageConverter<?>> getMessageConverters() {n // 默认为nulln if (this.messageConverters == null) {n this.messageConverters = new ArrayList<>();n // 该方法在子类中重写了,调用子类DelegatingWebMvcConfiguration#configureMessageConverters方法n configureMessageConverters(this.messageConverters);n if (this.messageConverters.isEmpty()) {n // 添加系统默认的消息转换器n addDefaultHttpMessageConverters(this.messageConverters);n }n extendMessageConverters(this.messageConverters);n }n return this.messageConverters;n }n}n@Configuration(proxyBeanMethods = false)npublic class DelegatingWebMvcConfiguration extends WebMvcConfigurationSupport {n private final WebMvcConfigurerComposite configurers = new WebMvcConfigurerComposite();n // 获取容器中所有的自定义的WebMvcConfigurern // 这里会有一个系统提供的配置类WebMvcAutoConfigurationAdaptern @Autowired(required = false)n public void setConfigurers(List<WebMvcConfigurer> configurers) {n if (!CollectionUtils.isEmpty(configurers)) {n this.configurers.addWebMvcConfigurers(configurers);n }n }n protected void configureMessageConverters(List<HttpMessageConverter<?>> converters) {n // 分别调用(内部for)WebMvcConfigurer#configureMessageConverters方法n this.configurers.configureMessageConverters(converters);n }n}

系统提供的WebMvcConfigurer 实现类WebMvcAutoConfigurationAdapter

public static class WebMvcAutoConfigurationAdapter implements WebMvcConfigurer {n private final ObjectProvider<HttpMessageConverters> messageConvertersProvider;n public WebMvcAutoConfigurationAdapter(ObjectProvider<HttpMessageConverters> messageConvertersProvider) {n // ...n this.messageConvertersProvider = messageConvertersProvider;n // ... n }n public void configureMessageConverters(List<HttpMessageConverter<?>> converters) {n // 在上面的WebMvcConfigurerComposite#configureMessageConverters方法中会执行该方法。n // 该方法先获取有效的HttpMessageConvertersn // ifAvailable方法接受一个Consumer函数式接口,将HttpMessageConverters#getConverters中的获取到的n // HttpMessageConverter添加到当前的List集合中n this.messageConvertersProvider.ifAvailable((customConverters) -> converters.addAll(customConverters.getConverters()));n }n}

以上就将自定义的HttpMessageConverter 添加到了容器中。

自定义JSON序列号和反序列化

如果你使用Jackson来序列化和反序列化JSON数据,你可能需要编写自己的JsonSerializerJsonDeserializer类。自定义序列化器通常通过模块注册到Jackson,但Spring Boot提供了一个替代的@JsonComponent注释,可以更容易地直接注册Spring bean。

你可以在JsonSerializerJsonDeserializerKeyDeserializer实现中直接使用@JsonComponent注释。你也可以在包含序列化器/反序列化器作为内部类的类上使用它,如下所示:

@JsonComponentnpublic class Example {nn public static class Serializer extends JsonSerializer<SomeObject> {n // ...n }nn public static class Deserializer extends JsonDeserializer<SomeObject> {n // ...n }nn}

ApplicationContext中的所有@JsonComponent bean都会自动向Jackson注册。因为@JsonComponent是用@Component进行元注释的,所以通常的组件扫描规则也适用。

Spring Boot还提供了JsonObjectSerializerJsonObjectDeserializer基类,它们在序列化对象时提供了标准Jackson版本的有用替代方案。

本小节完毕!!!

Springboot整合openfeign使用详解
Spring 引介增强IntroductionAdvisor使用
Spring中自定义数据类型转换详解
Spring MVC高级知识点自定义请求匹配路径
一文带你彻底理解Spring WebFlux的工作原理
SpringBoot邮件发送示例
Spring AOP动态代理失效的解决方法@Transactional为何会失效

SpringBoot对Spring MVC都做了哪些事?(一)

SpringBoot对Spring MVC都做了哪些事?(一)

SpringBoot对Spring MVC都做了哪些事?(一)

SpringBoot对Spring MVC都做了哪些事?(一)

SpringBoot对Spring MVC都做了哪些事?(一)