在Spring Boot中构建自定义Auto-Configuration配置类

在Spring Boot中构建自定义Auto-Configuration配置类

1. 概述

Spring Boot为自动装配Bean提供了很好的机制，基于类路径上是否存在依赖项自动配置Spring应用程序的方法，使开发变得更快更容易。
接下来，我们将介绍如何创建自定义Auto-Configuration配置

2. Maven 依赖

我们首先要在项目中增加依赖类

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-data-jpa</artifactId>
    <version>2.3.5.RELEASE</version>
</dependency>
<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
    <version>8.0.19</version>
</dependency>

最新版本的 spring-boot-starter-data-jpa 和 mysql-connector-java 可以从Maven Central下载

3. 创建自定义Auto-Configuration

为了创建auto-configuration我们首先需要使用@Configuration 申明一个配置类 , 下面我们创建一个MySQL data source 配置类

@Configuration
public class MySQLAutoconfiguration {
    //...
}

下一个必需的步骤是设置org.springframework.boot.autoconfigure.EnableAutoConfiguration属性把MySQLAutoconfiguration类注册为自动配置候选类。配置文件路径为：项目/resources/META-INF/spring.factories

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
com.baeldung.autoconfiguration.MySQLAutoconfiguration

如果希望我们的自动配置类优先于其他自动配置候选类，可以在MySQLAutoconfiguration上添加@AutoConfigureOrder(order . highest_priority)注解

自动配置使用@Conditional注解来标记方法判断创建适合的Bean对象

注意，只有在应用程序中没有定义自动配置的bean时，自动配置才有效。如果定义了bean，那么默认的bean将被覆盖，显式配置覆盖默认配置

3.1 Class Conditions 类判断条件

类条件允许我们指定，使用**@ConditionalOnClass**注解如果存在指定的类，或者使用@ConditionalOnMissingClass注释不存在类，则包含配置bean

让我们指定我们的MySQLConfiguration只有在类DataSource存在时才会被加载:

@Configuration
@ConditionalOnClass(DataSource.class)
public class MySQLAutoconfigurat