Spring Boot 自动配置一篇概览

来源：cnblogs　　作者：WindWant　　时间：2023/5/29 8:49:05　　对本文有异议

一、什么是自动配置 bean

自动配置类通过添加 @AutoConfiguration 注解实现。

因为 @AutoConfiguration 注解本身是以 @Configuration 注解的，所以自动配置类可以算是一个标准的基于 @Configuration 注解的类。

@Conditional 注解可以用于声明自动配置启用条件，通常，我们可以使用 @ConditionalOnClass、@ConditionalOnMissingBean 注解。

二、自动配置发现

Spring Boot 通过检查【META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports】配置文件获取自动配置类。

文件内包含自定义的自动配置类全限定名，每行一个。

示例如下：

com.mycorp.libx.autoconfigure.LibXAutoConfiguration
com.mycorp.libx.autoconfigure.LibXWebAutoConfiguration

1、关于约定：

自动配置类必须通过如上配置文件引入。

合理规划其放置包位置，避免被自动包扫描。

内部不要配置自动包扫描，如需要可以使用 @Import 引入。

2、关于顺序

明确的对象先后顺序可以通过配置 @AutoConfiguration 的 before、beforeName、after、afterName 属性，或者使用 @AutoConfigurationBefore、@AutoConfigurationAfter 注解实现。例如 web 服务类配置需要置于 @WebMvcAutoConfiguration 注解之后。

如果没有明确的先后顺序，也可以使用 @AutoConfigureOrder 注解声明顺序。类似 @ Order 注解，不同之处在于其只作用于自动配置类。

三、条件注解

1、类条件

@ConditionalOnClass、@ConditionalOnMissingClass

@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Conditional({OnClassCondition.class})
public @interface ConditionalOnClass {
    Class<?>[] value() default {};
 
    String[] name() default {};
}

注解元数据是通过 ASM 处理的，所以可以通过 value 属性传递 Class 类型参数，或者也可以通过 name 传递类全限定名作为参数。

无效情景：

@Bean 注解的方法，其返回值类型为类目标条件类本身。在方法上的条件判正之前，JVM 已经加载了相关的类，并且很可能会执行相关的方法引用，如果类不存在的话，就会导致失败。

为了处理此类情景，需要添加额外的 @Configuration 注解，使用如下：

import org.springframework.boot.autoconfigure.AutoConfiguration;
import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
 
@AutoConfiguration
// Some conditions ...
public class MyAutoConfiguration {
 
    // Auto-configured beans ...
 
    @Configuration(proxyBeanMethods = false) // 
    @ConditionalOnClass(SomeService.class)
    public static class SomeServiceConfiguration {
 
        @Bean
        @ConditionalOnMissingBean
        public SomeService someService() {
            return new SomeService();
        }
 
    }
 
}

2、Bean 条件

@ConditionalOnBean、ConditionalOnMissingBean

@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Conditional({OnBeanCondition.class})
public @interface ConditionalOnBean {
    Class<?>[] value() default {};
 
    String[] type() default {};
 
    Class<? extends Annotation>[] annotation() default {};
 
    String[] name() default {};
 
    SearchStrategy search() default SearchStrategy.ALL;
 
    Class<?>[] parameterizedContainer() default {};
}

search 属性用于限定搜寻范围。

作用于 @Bean 注解的方法时，默认的目标 Bean 类型为方法的返回值类型。如下：

import org.springframework.boot.autoconfigure.AutoConfiguration;
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
import org.springframework.context.annotation.Bean;
 
@AutoConfiguration
public class MyAutoConfiguration {
 
    @Bean
    @ConditionalOnMissingBean
    public SomeService someService() {
        return new SomeService();
    }
 
}

条件注解的判正会受 Bean 定义的注册、处理顺序影响，这点需要特别关注。通常建议只在自动配置类上使用条件注解。

@ConditionalOnBean、ConditionalOnMissingBean 条件注解的 @Configuration 类依然会被创建，只不是不会被注册。

当使用 @Bean 注解方法时，返回值最好使用具体的类，而不要使用接口。这一点，对于使用基于 Bean 类型判定的条件注解时尤为重要。

3、属性条件

@ConditionalOnProperty 基于 Spring 的环境变量判正。

@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE, ElementType.METHOD})
@Documented
@Conditional({OnPropertyCondition.class})
public @interface ConditionalOnProperty {
    String[] value() default {};
 
    String prefix() default "";
 
    String[] name() default {};
 
    String havingValue() default "";
 
    boolean matchIfMissing() default false;
}

可以基于前缀或者特定名称来判断。

4、资源条件

@ConditionalOnResource 基于是否存在特定的资源来判正，如：判定资源“file:/home/user/test.dat”。

5、Web 应用条件

@ConditionalOnWebApplication、@ConditionalOnNotWebApplication

基于当前是否为 Web 应用。

@ConditionalOnWarDeployment、@ConditionalOnNotWarDeployment 判定当前应用是否为传统的部署到 servlet 容器的 WAR 包应用，区别于内嵌的 web 服务器应用。

四、构建 starter

一个典型的 Spring Boot starter 包括如下两点：

autoconfigure 模块：包含自动配置相关代码。
starter 模块：提供 autoconfigure 模块所需的依赖及其它附属依赖。

1、命名

不要以 spring-boot 做前缀，这是官方保留使用。

以自有工程名做前缀，并附加信息体现其用途。

2、配置键

配置键需要提供专门的命名空间，不要使用 Spring Boot 官方命名空间，

3、autoconfigure 模块

包含使用依赖的所有配置，也可以包括配置键定义及自定义组件初始化的回调接口。

所有引入应该做成可配置的，并且默认为不使用。

Spring Boot 使用注解处理器来收集位于配置文件（META-INF/spring-autoconfigure-metadata.properties）中的自动配置条件，快速过滤掉不需要自动配置的，以加快启动速度。

如果使用 Maven 管理项目，则需要加入如下依赖来处理启用自动配置功能：

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-autoconfigure-processor</artifactId>
    <optional>true</optional>
</dependency>