Spring Boot 整合组件套路

自动配置类

Spring Boot 在整合任何一个组件的时候都会先添加一个依赖 starter，比如整合 MybatisPlus 有一个 mybatis-plus-boot-starter，如下：

<dependency>

    <groupId>com.baomidou</groupId>

    <artifactId>mybatis-plus-boot-starter</artifactId>

</dependency>

每一个 starter 基本都会有一个自动配置类，命名方式也是类似的，格式为：xxxAutoConfiguration, 比如 MybatisPlus 的自动配置类就是 MybatisPlusConfiguration，Redis 的自动配置类是 RedisAutoConfiguration， web 模块的自动配置类是 WebMvcConfiguration。

@ConditionalXxx 注解

@ConditionalXxx 标注在配置类上或者结合 @Bean 标注在方法上，表示自动配置类生效的条件。比如 @WebMvcAutoConfiguration 类上标注了一个 @ConditionalOnMissBean(WebMvcConfigurationSupport.class)，表示的意思就是当前 IOC 容器中没有 WebMvcConfigurationSupport 这个类的实例时自动配置类才会生效，这也就是在配置类上标注 @EnableWebMvc 会导致自动配置类 WebMvcAutoConfiguration 失效的原因。

需要注意方法上的 @ConditionalXxx 注解，Spring Boot 会在自动配置类中结合 @Bean 和 @ConditionalXxx 注解提供一些组件运行的默认配置，但是利用 @ConditionalXxx（在特定条件下生效）注解的条件性，方便开发者覆盖这些配置。

在 MyBatis 的自动配置类 MyBatisAutoConfiguration 中有如下一个方法：

@Bean

@ConditionalOnMissingBean

public SqlSessionFactory sqlSessionFactory(DataSoure dataSource) throws Exception {}

@Bean 这个注解的意思是注入一个 Bean 到 IOC 容器中，@ConditionalOnMissingBean 表示当 SqlSessionFactory 类型的对象在 IOC 容器中不存在才会注入。也就是说如果开发者需要定制 SqlSessionFactory，可以自己创建一个 SqlSessionFactory 类型的对象并且注入到 IOC 容器中即能覆盖自动配置类中的。比如在 MyBatis 配置多数据源的时候就需要定制一个 SqlSessionFactory 而不是使用自动配置类中的。

常用注解

@ConditionalOnBean：当容器中有指定 Bean 的条件下进行实例化
@ConditionalOnMissingBean：当容器中没有指定 Bean 的条件下进行实例化
@ConditionalOnClass：当 classpath 类路径下有指定类的条件下进行实例化
@ConditionalOnMissingClass：当类路径下没有指定类的条件下进行实例化
@ConditionalOnWebApplication：当项目是一个 Web 项目时进行实例化
@ConditionalOnNotWebApplication：当项目不是一个 Web 项目时进行实例化
@ConditionalOnProperty：当指定的属性有指定的值时进行实例化
@ConditionalOnExpression：基于 SpEL 表达式的条件判断
@ConditionalOnJava：当 JVM 版本为指定的版本范围时触发实例化
@ConditionalOnResource：当类路径下有指定的资源时触发实例化
@ConditionalOnJndi：在 JNDI 存在的条件下触发实例化
@ConditionalOnSingleCandidate：当指定的 Bean 在容器中只有一个，或者有多个但是指定了首选的 Bean 时触发实例化

@EnableConfigurationProperties 注解

@EnableConfigurationProperties 这个注解常标注在配置类上，使得 @ConfigurationProperties 标注的配置文件生效，这样就可以在全局配置文件（application.xxx）配置指定前缀的属性了。

在 Redis 的自动配置类 @RedisAutoConfiguration 上方标注如下一行代码：

@EnableConfigurationProperties(RedisProperties.class)

而 RedisProperties 的源码如下：

@ConfigurationProperties(prefix = "spring.redis")

public class RedisProperties {

	private int database = 0;

	private String url;

	private String host = "localhost";

	private String password;

	......

}

@ConfigurationProperties 这个注解指定了全局配置文件中以 spring.redis.xxx 为前缀的配置都会映射到 RedisProperties 的指定属性中，其实 RedisProperties 这个类中定义了 Redis 的一些所需属性，比如 host，ip，password 等。

@EnableConfigurationProperties 注解就是使得指定的配置生效，能够将全局配置文件中配置的属性映射到相关类的属性中。

引入一个组件后往往需要改些配置，我们都知道在全局配置文件中可以修改，但是不知道前缀是什么，可以改哪些属性，因此找到 @EnableConfigurationProperties 这个注解后就能找到对应的配置前缀以及可以修改的属性了。

@Import 注解

这个注解通常标注在自动配置类上方，并且一般都是导入一个或者多个配置类。

比如 RabbitMQ 的自动配置类 RabbitAutoConfiguration 上有如下一行代码：

@Import(RabbitAnnotationDrivenConfiguration.class)

这行代码的作用就是添加了 RabbitAnnotationDrivenConfiguration 这个配置类，使得 Spring Boot 在加载到自动配置类的时候能够一起加载。

比如 Redis 的自动配置类 RedisAutoConfiguration 上有如下一行代码：

@Import({LettuceConnectionConfiguration.class, JedisConnectionConfiguration.class})

这个 @Import 同时引入了 Lettuce 和 Jedis 两个配置类，因此如果你的 Redis 需要使用 Jedis 作为连接池的话，想要知道 Jedis 都要配置什么，此时就应该看看 JedisConnectionConfiguration 这个配置类了。

@AutoConfigurationXxx 注解

@AutoConfigurationXxx 这类注解决定了自动配置类的加载顺序，比如 AutoConfigurationAfter（在指定自动配置类之后）、AutoConfigurationBefore（在指定自动配置类之前）、AutoConfigurationOrder（指定自动配置类的优先级）。

指定配置加载顺序，是因为某些组件往往是相互依赖的，比如 MyBatis 和 DataSource，肯定要先将数据源相关的东西配置成功才能配置 MyBatis 吧，@AutoConfigurationXxx 这类注解正是解决了组件之间相互依赖的问题。