Spring Boot-3.Web相关配置

悠扬前奏

发布于 2019-05-28 20:36:54

5860

发布于 2019-05-28 20:36:54

文章被收录于专栏：悠扬前奏的博客

1. Spring Boot提供的自动配置

通过查看WebMvcAutoConfiguration和WebMvcProperties的源码可以发现自动配置。

1.1 自动配置的ViewResolver

1.1.1 ContentNegotiatingViewResolver

由Spring MVC提供的特殊ViewResolver，它并不是自己处理View，而是代理给不同的ViewResolver来处理不同的View。它具有最高的优先级

1.1.2 BeanNameViewResolver

在控制器（@Controller）中的一个方法的返回值的字符串（视图名）会根据BeanNameViewResolver去查找Bean的名称为返回字符串的View来渲染视图。例如：定义BeanNameViewResolver的Bean：

@bean
public BeanNameViewResolver beanNameViewResolver() {
    BeanNameViewResolver resolver = new BeanNameResolver();
    return resolver;
}

定义View的Bean，名为jsonView：

@Bean
public MappingJackon2JsonViewView jsonView(){
    MappingJachson2JsonView jsonView =  new MappingJackson2JsonView();
    return jsonView;
}

这样，在控制器中，返回值为字符串jsonView，会找到bean名称为jsonView的视图来渲染：

@RequestMapping(value = "/json", produces={MediaType.APPLICATION_JSON_VALUE})
public String json(Model model){
    Person single = new Person("aa", 11);
    model.addAttribute("single", single);
    return "jsonView";
}

1.1.3 InternalResourcesViewResolver

常用ViewResolver，通过设置前缀，后缀，一级控制器中方法来返回视图名的字符串，已得到实际页面，Spring Boot的源码为：

@Bean
@ConditionalOnMissingBean(InteralResourceViewResolver.class)
public InternalResourceViewResolver defaultResolver(){
    InternalResourceViewResolver resolver = new InternalResource ViewResolver();
    resolver.setPrefix(this.prefix);
    resolver.setSuffix(this.prefix);
    return resolver;
}

1.2 自动配置的静态资源

自动配置类为addResourceHandlers方法中定义了以下资源的静态配置。

1.2.1类路径文件

把类路径下的/static、/public、/resources和/META-INF/resources文件夹下的静态文件直接映射为/，可以通过http://localhost:8080/来访问。

1.2.2 webjar

webjar就是将我们常用的脚本框架封装在jar包中的jar包。把webjar的/META-INF/resources/webjars/下的静态文件映射为/webjar/，可以通过http://localhost:8080/webjar/来访问。

1.2.3 自动配置的Formatter和Converter

只要我们定义了Converter，GenericConverter和Formatter接口的实现类的Bean，这些Bean就会自动注册到SpringMVC中。参考一下源码（位于WebMvcAutoConfiguration类中）

        @Override
        public void addFormatters(FormatterRegistry registry) {
            for (Converter<?, ?> converter : getBeansOfType(Converter.class)) {
                registry.addConverter(converter);
            }
            for (GenericConverter converter : getBeansOfType(GenericConverter.class)) {
                registry.addConverter(converter);
            }
            for (Formatter<?> formatter : getBeansOfType(Formatter.class)) {
                registry.addFormatter(formatter);
            }
        }

        private <T> Collection<T> getBeansOfType(Class<T> type) {
            return this.beanFactory.getBeansOfType(type).values();
        }

1.2.4 自动配置的HttpMessageConverters

在WebMvcAutoConfiguration中，注册了messageConverters：

private final HttpMessageConverters messageConverters;
@Override
        public void configureMessageConverters(List<HttpMessageConverter<?>> converters) {
            converters.addAll(this.messageConverters.getConverters());
        }

在Spring Boot中，如果要新增自定义的HttpMessageVoncerter，需要定义一个自己的HttpMessageConverters的Bean，然后在这个Bean中注册自定义的HttpMessageConverter即可。例如：

@Bean
public HttpMessageConverters customConverters() {
    HttpMessageConverter<?> customConverter1 = new CustomConverter1();
    HttpMessageConverter<?> customConverter2 = new CustomConverter2();
    return new HttpMessageConverters(customConverter1, customConverter2);
}

1.2.5 静态首页的支持

将静态首页index.html文件放置在如下目录：

classpath:/META-INF/resources/index.html
classpath:/resources/index.html
classpath:/static/index.html
classpath:/public/index.html 当访问应用根目录http://localhost:8080/时，会直接映射。

2. 接管Spring Boot的Web配置

可以通过一个配置类（注解有@Configuration的类）加上@EnableWebMvc注解来实现自己控制的MVC配置。
可以定义一个配置类并继承WebMvcConfigurationAdapter，无需使用@EnableWebMvc注解，然后按照Spring MVC的配制方法来添加Spring Boot

@Configuration
public class WebMvcConfig extends WebMvcConfigurationAdapter{
    @Override
    public void addViewControllers(ViewCOntrolllerRegistery residtry) {
        registery.addViewController("/xx").setViewName("/xx");
    }
}

*注意，这里重写的addViewControllers方法，并不会覆盖WebMvcAutoConfiguration中的addViewControllers方法，即自己配置和Spring Boot的自动配置同时有效。

3. 注册Servlet，Filter，Listener

当使用嵌入式Servlet容器（Tomcat，Jetty等）时，通过将Servlet，Filter，Listener生命为Spring Bean来达到注册的效果，或者注册ServletRegistrationBean、FilterRegistrationBean、ServletListenerRigistrationBean的Bean。

（1）直接注册Bean：

@Bean
pubilc XxServlet xxServlet (){
    return new XxServlet();
}

@Bean
public YyFilter yyFilter() {
    return new YyServlet();
}

@Bean
public ZzListener zzListener() {
    return new ZzListener();
}

（2）通过RegistrationBean

@Bean
public ServletRegistrationBean serletRegistrationBean() {
    return new ServletRegistrationBean(new XxServlet(), "/xx/*");
}

@Bean 
public FilterRegistrationBean filterRegistrationBean() {
    FilterRegistrationBean  registrationBean = new FilterRegistrationBean();
    registrationBean.setFilter( new YyFilter());
    registrationBean.setOrder(2);
    return registrationBean;
}

@Bean
public ServletListenerRegistrationBean<ZzListener> zzListenerRegistrationBean() {
    return new ServletListenerRegistrationBean<ZzListener> (new ZzListener())
}

本文参与腾讯云自媒体同步曝光计划，分享自作者个人站点/博客。

原始发表：2018.01.23 ，如有侵权请联系 cloudcommunity@tencent.com 删除

spring boot