Spring Boot自动配置类

时间：2016-09-17 19:06:57 阅读：1457 评论：0 收藏：0 [点我收藏+]

标签：

http://docs.spring.io/spring-boot/docs/current/api/overview-summary.html

http://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#auto-configuration-classes

前提

1、一般来说，xxxAware接口，都提供了一个setXxx的方法，以便于其实现类将Xxx注入自身的xxx字段中，从而进行操作。

例如 ApplicationContextAware ，就提供了 void setApplicationContext(ApplicationContext applicationContext) throws BeansException; ，从而让其实现可以直接操作 applicationContext 。

2、Spring中的 BeanFactory，这是访问bean container 的root interface。其实现类的对象通常拥有一系列 bean 定义，并以不同的String 名字来区分。

但是，官方文档不建议直接使用这种方式获取bean，而是建议使用注入的方式获取bean（@Autowire）。--这个，前期不能使用初始化注入吧？

正文

Spring Boot提供的自动配置都是位于包 org.springframework.boot.autoconfigure 之下。

注意，

① 这里是Spring Boot提供的，而非第三方（如MyBatis-Spring-Boot-Starter）提供的。

② 不包含Spring Boot Actuator部分的。

Spring Boot的自动配置类可以通过autoconfig report查看，需要开启 --debug 或 -Debug。或者在 Actuator 项目的autoconfig 端点查看。

这里先从Web开始学习

由于Spring Boot的web Starter集成了Spring MVC，而非其他，所以实际上提供的Web自动配置为Spring MVC的自动配置。

Spring MVC的自动配置在包 org.springframework.boot.autoconfigure.web 之下，该包中的内容如下：

从上图中可以清楚的看到Spring Boot为Spring MVC提供了哪些自动配置：

DispatcherServletAutoConfiguration.class
EmbeddedServletContainerAutoConfiguration.class
ErrorMvcAutoConfiguration.class
GsonHttpMessageConvertersConfiguration.class
HttpEncodingAutoConfiguration.class
HttpMessageConvertersAutoConfiguration.class
JacksonHttpMessageConvertersConfiguration.class
MultipartAutoConfiguration.class
ServerPropertiesAutoConfiguration.class
WebClientAutoConfiguration.class
WebMvcAutoConfiguration.class

接下来，我们有针对性的来捋一遍。

一、先看一下 EmbeddedServletContainerAutoConfiguration，这是内置Servlet容器的自动配置 -- 默认就是那个 pivotal-tc-server （定制版tomcat，商业的）。

该类的声明如下：

 1 @AutoConfigureOrder(Ordered.HIGHEST_PRECEDENCE) // 自动配置里面的最高优先级
 2 @Configuration
 3 @ConditionalOnWebApplication // 仅限于web应用
 4 @Import(BeanPostProcessorsRegistrar.class) // 导入内置容器的设置
 5 public class EmbeddedServletContainerAutoConfiguration {
 6     @Configuration
 7     @ConditionalOnClass({ Servlet.class, Tomcat.class })
 8     @ConditionalOnMissingBean(value = EmbeddedServletContainerFactory.class, search = SearchStrategy.CURRENT)
 9     public static class EmbeddedTomcat {
10         // ...
11     }
12 
13     @Configuration
14     @ConditionalOnClass({ Servlet.class, Server.class, Loader.class, WebAppContext.class })
15     @ConditionalOnMissingBean(value = EmbeddedServletContainerFactory.class, search = SearchStrategy.CURRENT)
16     public static class EmbeddedJetty {
17         // ...
18     }
19 
20     @Configuration
21     @ConditionalOnClass({ Servlet.class, Undertow.class, SslClientAuthMode.class })
22     @ConditionalOnMissingBean(value = EmbeddedServletContainerFactory.class, search = SearchStrategy.CURRENT)
23     public static class EmbeddedUndertow {
24         // ...
25     }
26 
27     public static class BeanPostProcessorsRegistrar implements ImportBeanDefinitionRegistrar, BeanFactoryAware {
28         // ...
29     }
30 }

@ConditionalOnWebApplication 是基于application context 是否 web application context 进行判断。

@AutoConfigureOrder(Ordered.HIGHEST_PRECEDENCE) ，这里的 Ordered.HIGHEST_PRECEDENCE 其实是int类型的最小值，代表最高的优先级。

@Import(BeanPostProcessorsRegistrar.class) ，这里 BeanPostProcessorsRegistrar 中进行的操作是注册了一个bean, EmbeddedServletContainerCustomizerBeanPostProcessor 。是通过 ImportBeanDefinitionRegistrar 进行早期注册。

这个配置类，内部共有4个静态内部类：3个容器类（tomcat、jetty、undertow）、1个bean注册类。

3个容器类是基于classpath中的class文件来判断使用哪个容器，默认使用内置容器。
1个bean注册类则是注册了一个 BeanPostProcessor bean，用于对容器进行定制。

下面重点看一下这个bean注册类的相关。

1、EmbeddedServletContainerCustomizerBeanPostProcessor

public class EmbeddedServletContainerCustomizerBeanPostProcessor implements BeanPostProcessor, ApplicationContextAware {
    // ...
}

2、BeanPostProcessor接口，该接口内容如下：

1 public interface BeanPostProcessor {
2     Object postProcessBeforeInitialization(Object bean, String beanName) throws BeansException;
3     Object postProcessAfterInitialization(Object bean, String beanName) throws BeansException;
4 }

View Code

根据方法的名字可以知道这是对在bean初始化之前、之后进行操作的方法。

该接口的Javadoc如下：

BeanPostProcessor则是一个工厂钩子（factory hook），用于对新beans实例进行定制修改，例如检查它们的标记接口或者使用代理包装它们。
ApplicationContexts能够自动探测BeanPostProcessor beans，并将他们应用到后续创建的任意beans中。
简单bean工厂允许代码化的注册post-processors，并将注册的post-processors应用到该工厂创建的所有bean中。
典型的做法是，通过标记接口装配beans时，post-processors会实现postProcessBeforeInitialization；而使用代理包装beans时则会实现postProcessAfterInitialization。

EmbeddedServletContainerCustomizerBeanPostProcessor 中提供了 postProcessBeforeInitialization 的实现（对bean有更多的操作，而非直接返回bean），对内置容器进行了定制操作。（插一句，这里的定制操作是通过applicationContext 中 EmbeddedServletContainerCustomizer beans进行的，所以需要先获取applicationContext（ApplicationContextAware的功劳），再从applicationContext中获取EmbeddedServletContainerCustomizer beans）

3、回过头来再看一下BeanPostProcessorsRegistrar

1 public static class BeanPostProcessorsRegistrar implements ImportBeanDefinitionRegistrar, BeanFactoryAware {
2     // ...
3 }

View Code

这是个静态内部类，实现了两个接口。

4、接口ImportBeanDefinitionRegistrar

public interface ImportBeanDefinitionRegistrar {
    public void registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry);
}

该接口用于在系统处理@Configuration class时注册更多的bean。是bean定义级别的操作，而非@Bean method/instance级别的。

这个方法，应该是在Spring加载bean时被Spring调用。

org.springframework.context.annotation.ConfigurationClassBeanDefinitionReader

未完待续。

Spring Boot自动配置类

标签：

原文地址：http://www.cnblogs.com/larryzeal/p/5879395.html

踩

(0)

评论一句话评论（0）

分享档案

更多>

2021年07月29日 (22)
2021年07月28日 (40)
2021年07月27日 (32)
2021年07月26日 (79)
2021年07月23日 (29)
2021年07月22日 (30)
2021年07月21日 (42)
2021年07月20日 (16)
2021年07月19日 (90)
2021年07月16日 (35)

周排行