SpringBoot-08-整合SpringMVC

字数统计: 3.1k字   |   阅读时长≈ 13分钟

SpringBoot-08-整合SpringMVC

0. 前言

官方文档：对springmvc AutoConfiguration解释如下：

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.
    • 视图解析器
  • Support for serving static resources, including support for WebJars (covered later in this document)).
    • 静态资源的映射
  • Automatic registration of Converter, GenericConverter, and Formatter beans.
    • 格式的转换，对象的自动合成
  • Support for HttpMessageConverters (covered later in this document).
    • 转换http的请求和响应
  • Automatic registration of MessageCodesResolver (covered later in this document).
  • Static index.html support.
  • Custom Favicon support (covered later in this document).
  • Automatic use of a ConfigurableWebBindingInitializer bean (covered later in this document).
    • 数据的初始化绑定

总结：如果想要使用自己定制化的东西，我们只需要给容器中添加这个组件就好了！剩下的事情SpringBoot就会帮我们做了！

文档分析

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
# Spring MVC Auto-configuration
// Spring Boot为Spring MVC提供了自动配置，它可以很好地与大多数应用程序一起工作
Spring Boot provides auto-configuration for Spring MVC that works well with most applications.
// 自动配置在Spring默认设置的基础上添加了以下功能：
The auto-configuration adds the following features on top of Spring’s defaults:
// 包含视图解析器
Inclusion of ContentNegotiatingViewResolver and BeanNameViewResolver beans.
// 支持静态资源文件夹的路径，以及webjars
Support for serving static resources, including support for WebJars (covered later in this document)).
// 自动注册了Converter：
// 转换器：这就是网页提交数据到后台自动封装成为对象的东西，比如把“1”字符串自动转换成int类型
// Formatter：【格式化器，比如页面给我们了一个2019-8-10，它会给我们自动格式化为Date对象】
Automatic registration of Converter, GenericConverter, and Formatter beans.
//SpringMVC用来转换Http请求和响应的，比如可以把一个User对象转换成JSON字符串
Support for HttpMessageConverters (covered later in this document).
// 定义错误代码生成规则的
Automatic registration of MessageCodesResolver (covered later in this document).
// 首页定制
Static index.html support.
//图标定制
Custom Favicon support (covered later in this document).
//初始化数据绑定器：帮我们把请求数据绑定到JavaBean中
Automatic use of a ConfigurableWebBindingInitializer bean (covered later in this document).

Spring MVC Auto-configuration
// Spring Boot为Spring MVC提供了自动配置，它可以很好地与大多数应用程序一起工作。
Spring Boot provides auto-configuration for Spring MVC that works well with most applications.
// 自动配置在Spring默认设置的基础上添加了以下功能：
The auto-configuration adds the following features on top of Spring’s defaults:
// 包含视图解析器
Inclusion of ContentNegotiatingViewResolver and BeanNameViewResolver beans.
// 支持静态资源文件夹的路径，以及webjars
Support for serving static resources, including support for WebJars 
// 自动注册了Converter：
// 转换器，这就是我们网页提交数据到后台自动封装成为对象的东西，比如把"1"字符串自动转换为int类型
// Formatter：【格式化器，比如页面给我们了一个2019-8-10，它会给我们自动格式化为Date对象】
Automatic registration of Converter, GenericConverter, and Formatter beans.
// HttpMessageConverters
// SpringMVC用来转换Http请求和响应的的，比如我们要把一个User对象转换为JSON字符串，可以去看官网文档解释；
Support for HttpMessageConverters (covered later in this document).
// 定义错误代码生成规则的
Automatic registration of MessageCodesResolver (covered later in this document).
// 首页定制
Static index.html support.
// 图标定制
Custom Favicon support (covered later in this document).
// 初始化数据绑定器：帮我们把请求数据绑定到JavaBean中！
Automatic use of a ConfigurableWebBindingInitializer bean (covered later in this document).

/*
如果您希望保留Spring Boot MVC功能，并且希望添加其他MVC配置（拦截器、格式化程序、视图控制器和其他功能），则可以添加自己
的@configuration类，类型为webmvcconfiguer，但不添加@EnableWebMvc。

如果希望提供
RequestMappingHandlerMapping、RequestMappingHandlerAdapter或ExceptionHandlerExceptionResolver的自定义
实例，则可以声明WebMVCregistrationAdapter实例来提供此类组件。
*/
If you want to keep those Spring Boot MVC customizations and make more MVC customizations (interceptors, formatters, view controllers, and other features), you can add your own @Configuration class of type WebMvcConfigurer but without @EnableWebMvc.

If you want to provide custom instances of RequestMappingHandlerMapping, RequestMappingHandlerAdapter, or ExceptionHandlerExceptionResolver, and still keep the Spring Boot MVC customizations, you can declare a bean of type WebMvcRegistrations and use it to provide custom instances of those components.

// 如果您想完全控制Spring MVC，可以添加自己的@Configuration，并用@EnableWebMvc进行注释。
If you want to take complete control of Spring MVC, you can add your own @Configuration annotated with @EnableWebMvc, or alternatively add your own @Configuration-annotated DelegatingWebMvcConfiguration as described in the Javadoc of @EnableWebMvc.

1.1 视图解析器 源码分析

SpringBoot 整合视图解析器使用方法：

  • 您想完全控制Spring MVC，可以添加自己的@Configuration，并用@EnableWebMvc进行注释。
  • 如果仅仅是想扩展SpringMVC.那么@Configuration并且implements ViewResolver接口即可

  • 自动配置了ViewResolver，就是我们之前学习的SpringMVC的视图解析器；

  • 即根据方法的返回值取得视图对象（View），然后由视图对象决定如何渲染（转发，重定向）。

  • 去看看这里的源码：我们找到 WebMvcAutoConfiguration， 然后搜索ContentNegotiatingViewResolver。找到如下方法！

1
2
3
4
5
6
7
8
9
10
@Bean
@ConditionalOnBean(ViewResolver.class)
@ConditionalOnMissingBean(name = "viewResolver", value = ContentNegotiatingViewResolver.class)
public ContentNegotiatingViewResolver viewResolver(BeanFactory beanFactory) {
    ContentNegotiatingViewResolver resolver = new ContentNegotiatingViewResolver();
    resolver.setContentNegotiationManager(beanFactory.getBean(ContentNegotiationManager.class));
    // ContentNegotiatingViewResolver使用所有其他视图解析器来定位视图，因此它应该有较高的优先级
    resolver.setOrder(Ordered.HIGHEST_PRECEDENCE);
    return resolver;
}
  • 继续点进这个类：
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
@Nullable // 注解说明：@Nullable 即参数可为null
public View resolveViewName(String viewName, Locale locale) throws Exception {
    RequestAttributes attrs = RequestContextHolder.getRequestAttributes();
    Assert.state(attrs instanceof ServletRequestAttributes, "No current ServletRequestAttributes");
    List<MediaType> requestedMediaTypes = this.getMediaTypes(((ServletRequestAttributes)attrs).getRequest());
    if (requestedMediaTypes != null) {
        // 1. 获取候选的视图对象
        List<View> candidateViews = this.getCandidateViews(viewName, locale, requestedMediaTypes);
        // 2. 选择一个最适合的视图对象，然后把这个视图解析器对象返回
        View bestView = this.getBestView(candidateViews, requestedMediaTypes, attrs);
        if (bestView != null) {
            return bestView;
        }
    }
    // .....
}

  • 继续点进去看，他是怎么获得候选的视图的呢？

  • getCandidateViews中看到他是把所有的视图解析器拿来，进行while循环，挨个解析！

1
Iterator var5 = this.viewResolvers.iterator();
  • 结论：ContentNegotiatingViewResolver这个视图解析器就是用来组合所有的视图解析器的
1
2
3
4
5
6
7
8
9
10
protected void initServletContext(ServletContext servletContext) {
    // 1. 这里它是从beanFactory工具中获取容器中的所有视图解析器
    // 2. ViewRescolver.class 把所有的视图解析器来组合的
    Collection<ViewResolver> matchingBeans = BeanFactoryUtils.beansOfTypeIncludingAncestors(this.obtainApplicationContext(), ViewResolver.class).values();
    ViewResolver viewResolver;
    if (this.viewResolvers == null) {
        this.viewResolvers = new ArrayList(matchingBeans.size());
    }
    // ...............
}
  • 既然它是在容器中去找视图解析器，是否可以猜想，我们就可以去实现一个视图解析器了
  • 如果自己给容器中添加一个视图解析器，这个类就会自动帮我们将它组合起来。

1.2 自定义 视图解析器

  1. 首先，在主程序中写一个视图解析器
    • 视图解析器就需要实现ViewResolver接口
    • 并且放入到ioc容器中（@Bean）
1
2
3
4
5
6
7
8
9
10
11
12
@Bean //放到bean中
public ViewResolver myViewResolver(){
    return new MyViewResolver();
}

//写一个静态内部类，视图解析器就需要实现ViewResolver接口
private static class MyViewResolver implements ViewResolver{
    @Override
    public View resolveViewName(String s, Locale locale) throws Exception {
        return null;
    }
}
  1. 给DispatcherServlet中的 doDispatch方法 加个断点进行调试一下，因为所有的请求都会走到这个方法中(源码分析)
    • 参数（请求，响应）

  1. 启动项目，然后随便访问一个页面，看一下Debug信息；找到this
  2. 找到视图解析器，看到我们自己定义的就在这里了；

总结：如果想要使用自己定制化的东西，我们只需要给容器中添加这个组件就好了！剩下的事情SpringBoot就会帮我们做了！

1.3 转换器 和 格式化器

1.3.1 格式化器 源码分析

  • 找到格式化转换器：webMVCConfiguration.java 
1
2
3
4
5
6
7
8
9
@Bean
@Override
public FormattingConversionService mvcConversionService() {
    // 1. 拿到配置文件中的格式化规则-->去webMVCAutoConfiguration中寻找
    WebConversionService conversionService = 
        new WebConversionService(this.mvcProperties.getDateFormat());
    addFormatters(conversionService);
    return conversionService;
}
  • 点击去：默认格式 dd/MM/yyyy : webMVCProperties.java
1
2
3
4
5
6
7
8
public String getDateFormat() {
    return this.dateFormat;
}

/**
* Date format to use. For instance, `dd/MM/yyyy`. 默认的
 */
private String dateFormat;
1
2
3
4
// 注入到ioc容器中	
public void setDateFormat(String dateFormat) {
		this.dateFormat = dateFormat;
	}

  • 可以看到在我们的Properties文件中，我们可以进行自动配置它！

  • 如果配置了自己的格式化方式，就会注册到Bean中生效，可以在配置文件中配置日期格式化的规则：

1.4 修改SpringBoot配置 原理

  • 通过源码探究，得出结论；这个结论一定是属于自己的，而且一通百通。
  • SpringBoot的底层，大量用到了这些设计细节思想，所以，没事需要多阅读源码！得出结论；
  • SpringBoot在自动配置很多组件的时候，先看容器中有没有用户自己配置的（如果用户自己配置@bean），如果有就用用户配置的，如果没有就用自动配置的；
  • 如果配置的组件存在多个，比如试图解析器，SpringBoot就会将会用配置和自己默认的组合起来！

1.5 视图跳转

  • 官方文档如下：
1
If you want to keep Spring Boot MVC features and you want to add additional MVC configuration (interceptors, formatters, view controllers, and other features), you can add your own @Configuration class of type WebMvcConfigurer but without @EnableWebMvc. If you wish to provide custom instances of RequestMappingHandlerMapping, RequestMappingHandlerAdapter, or ExceptionHandlerExceptionResolver, you can declare a WebMvcRegistrationsAdapter instance to provide such components.
  • 需要做的就是编写一个@Configuration注解类，并且类型要为WebMvcConfigurer，而且还不能标注@EnableWebMvc注解。
  1. 新建一个包叫config，写一个类MyMvcConfig；
1
2
3
4
5
6
7
8
9
10
11
//应为类型要求为WebMvcConfigurer，所以我们实现其接口
//可以使用自定义类扩展MVC的功能
@Configuration
public class MyMvcConfig implements WebMvcConfigurer {

    @Override
    public void addViewControllers(ViewControllerRegistry registry) {
        // 浏览器发送/zhuuu ， 就会跳转到test页面；
        registry.addViewController("/zhuuu").setViewName("test");
    }
}
  1. 去网页测试结果localhost:8080/zhuuu

1.6 分析原理 @EnableWebMvc

1、WebMvcAutoConfiguration 是 SpringMVC的自动配置类，里面有一个类WebMvcAutoConfigurationAdapter

2、这个类上有一个注解，在做其他自动配置时会导入：@Import(EnableWebMvcConfiguration.class)

3、我们点进EnableWebMvcConfiguration这个类看一下，它继承了一个父类：DelegatingWebMvcConfiguration

  • 这个父类中有这样一段代码：
1
2
3
4
5
6
7
8
9
10
11
12
// @EnableWebMvc 溯源源码分析
public class DelegatingWebMvcConfiguration extends WebMvcConfigurationSupport {
    private final WebMvcConfigurerComposite configurers = new WebMvcConfigurerComposite();
    
  // 意义：从容器中获取所有的webmvcConfigurer，并进行添加configurer
    @Autowired(required = false)
    public void setConfigurers(List<WebMvcConfigurer> configurers) {
        if (!CollectionUtils.isEmpty(configurers)) {
            this.configurers.addWebMvcConfigurers(configurers);
        }
    }
}
  • 同时在webMvcConfiguration.java类有一行代码@ConditionalOnMissBean(WebMvcConfigurationSupport.class)
    • 这就是springBoot 设计的巧妙, 你继承了这个类，那么SpringBoot的默认配置就不会生效

4、可以在这个类中去寻找一个我们刚才设置的viewController当做参考，发现它调用了一个(在不使用@EnableWebMVC注解的前提下)

1
2
3
protected void addViewControllers(ViewControllerRegistry registry) {
    this.configurers.addViewControllers(registry);
}

5、点进去看一下

1
2
3
4
5
6
7
8
9
10
public void addViewControllers(ViewControllerRegistry registry) {
    Iterator var2 = this.delegates.iterator();

    while(var2.hasNext()) {
        // 将所有的WebMvcConfigurer相关配置来一起调用！包括我们自己配置的和Spring给我们配置的
        WebMvcConfigurer delegate = (WebMvcConfigurer)var2.next();
        delegate.addViewControllers(registry);
    }

}
  • 所以得出结论：所有的WebMvcConfiguration都会被作用，不止Spring自己的配置类，我们自己的配置类当然也会被调用；

官方文档：

1
If you want to take complete control of Spring MVC you can add your own @Configuration annotated with @EnableWebMvc.

  • 全面接管即：SpringBoot对SpringMVC的自动配置不需要了，所有都是我们自己去配置！

  • 只需在我们的配置类中要加一个@EnableWebMvc。

  • 看下如果我们全面接管了SpringMVC了，我们之前SpringBoot给我们配置的静态资源映射一定会无效，我们可以去测试一下；

  • 不加注解之前，访问首页：

  • 加了@EnableWebMvc注解之后

1.6.1 原理再分析

  • 为什么加了一个注解，自动配置就失效了！看下源码：
  1. 这里发现它是导入了一个类，点进去继续查看
1
2
3
@Import(DelegatingWebMvcConfiguration.class)
public @interface EnableWebMvc {
}
  1. 它继承了一个父类WebMvcConfigurationSupport
1
2
3
public class DelegatingWebMvcConfiguration extends WebMvcConfigurationSupport {
  // ......
}

1.6.2 小结

1
2
3
4
5
6
7
8
9
10
11
@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 {
    
}
  • 总结一句话：@EnableWebMvc将WebMvcConfigurationSupport组件导入进来了；
  • 而导入的WebMvcConfigurationSupport只是SpringMVC最基本的功能！
  • 在SpringBoot中会有非常多的扩展配置，只要看见了这个，我们就应该多留心注意~
打赏
  • 版权声明： 本博客所有文章除特别声明外，均采用 Apache License 2.0 许可协议。转载请注明出处！
  • © 2019-2022 Zhuuu
  • PV: UV:

请我喝杯咖啡吧~

支付宝
微信