一文深入了解SpringBoot自動配置原理，自定義Starter

1.SpringBoot自動配置原理

• 從@SpringBootApplication注解開始說，這個注解是一個複合注解，他是由以下幾個注解構成的。

// 用于講其他配置類，注入到spring ioc中的
@SpringBootConfiguration
// 自動配置最重要的注解
@EnableAutoConfiguration
// 用于掃描其他注解（@service、@controller）等等
@ComponentScan(
    excludeFilters = {@Filter(
    type = FilterType.CUSTOM,
    classes = {TypeExcludeFilter.class}
), @Filter(
    type = FilterType.CUSTOM,
    classes = {AutoConfigurationExcludeFilter.class}
)}
)複制代碼      

• 接下來從@EnableAutoConfiguration開始講起

其中關鍵的地方就是這個AutoConfigurationImportSelector類
@Import({AutoConfigurationImportSelector.class})複制代碼      

他裡面的selectImports方法中getAutoConfigurationEntry就是擷取自動配置的重要組成

public String[] selectImports(AnnotationMetadata annotationMetadata) {
if (!this.isEnabled(annotationMetadata)) {
    return NO_IMPORTS;
} else {
    AutoConfigurationImportSelector.AutoConfigurationEntry autoConfigurationEntry = this.getAutoConfigurationEntry(annotationMetadata);
    return StringUtils.toStringArray(autoConfigurationEntry.getConfigurations());
}
}

protected AutoConfigurationImportSelector.AutoConfigurationEntry getAutoConfigurationEntry(AnnotationMetadata annotationMetadata) {
if (!this.isEnabled(annotationMetadata)) {
    return EMPTY_ENTRY;
} else {
    AnnotationAttributes attributes = this.getAttributes(annotationMetadata);
    List<String> configurations = this.getCandidateConfigurations(annotationMetadata, attributes);
    configurations = this.removeDuplicates(configurations);
    Set<String> exclusions = this.getExclusions(annotationMetadata, attributes);
    this.checkExcludedClasses(configurations, exclusions);
    configurations.removeAll(exclusions);
    configurations = this.getConfigurationClassFilter().filter(configurations);
    this.fireAutoConfigurationImportEvents(configurations, exclusions);
    return new AutoConfigurationImportSelector.AutoConfigurationEntry(configurations, exclusions);
}
}複制代碼      

• 通過上述擷取在META-INF/spring.factories，

protected List<String> getCandidateConfigurations(AnnotationMetadata metadata, AnnotationAttributes attributes) {
    List<String> configurations = SpringFactoriesLoader.loadFactoryNames(this.getSpringFactoriesLoaderFactoryClass(), this.getBeanClassLoader());
    Assert.notEmpty(configurations, "No auto configuration classes found in META-INF/spring.factories. If you are using a custom packaging, make sure that file is correct.");
    return configurations;
}複制代碼      

• 在spring.factories中會存在很多這樣的鍵值對

# Auto Configure
org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
org.springframework.boot.autoconfigure.admin.SpringApplicationAdminJmxAutoConfiguration,\
org.springframework.boot.autoconfigure.aop.AopAutoConfiguration,\複制代碼      

當springboot啟動的時候就會加載這些xxxAutoConfigureation，這裡以RedisAutoConfiguration為例，介紹是如何進行配置的。

// 隻有符合這種要求的，才會将xxxAutoConfigureation加載到spring中
@ConditionalOnClass({RedisOperations.class})
// 開啟配置類
@EnableConfigurationProperties({RedisProperties.class})
@Import({LettuceConnectionConfiguration.class, JedisConnectionConfiguration.class})
public class RedisAutoConfiguration {複制代碼      

• RedisProperties配置類，看到這個類，是不是很熟悉，他就是我們在yml裡面配置的東西

@ConfigurationProperties(
    prefix = "spring.redis"
)
public class RedisProperties {
    private int database = 0;
    private String url;
    private String host = "localhost";
    private String username;
    private String password;
    private int port = 6379;
    private boolean ssl;
    private Duration timeout;
    private Duration connectTimeout;
    private String clientName;
}複制代碼      

總結：通過上述流程實作将快速配置，減少了繁瑣的xml配置，如果要配置，隻需簡單的在yml配置即可。

2.自定義starter，簡單實作一個線程池的建立

• 建立一個thread-pool-execute-starter的工程

// 添加依賴
<groupId>com.angel.item</groupId>
<artifactId>thread-pool-execute-starter</artifactId>
<version>1.0</version>

<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter</artifactId>
    </dependency>
</dependencies>複制代碼      

• 自動配置類

@Configuration
// 配置配置屬性
@EnableConfigurationProperties(ThreadPoolExecutorProperties.class)
// 隻有這個類才會生校
@ConditionalOnClass(ThreadPoolExecutor.class)
public class ThreadPoolAutoConfiguration {

    /**
     * 阻塞隊列
     */
    private final BlockingQueue<Runnable> workQueue = new ArrayBlockingQueue<>(4);
    /**
     * 拒絕政策
     */
    private final RejectedExecutionHandler reject = new ThreadPoolExecutor.AbortPolicy();
    /**
     * 線程池類型：CPU密集型：1；IO密集型：2
     */
    @Value("${scenes}")
    private Integer scenes;
    /**
     * 核心線程數大小
     */
    private Integer corePoolSize;
    /**
     * 最大線程數大小
     */
    private Integer maximumPoolSize;
    /**
     * 空閑線程存活時長
     */
    private Long keepAliveTime;
    /**
     * 存活時長機關
     */
    private TimeUnit unit;

    @PostConstruct
    public void init() {
        // 擷取系統CPU核心數
        int cpuCoreNumber = Runtime.getRuntime().availableProcessors();
        this.corePoolSize = cpuCoreNumber;
        this.maximumPoolSize = 25 * cpuCoreNumber;
        this.keepAliveTime = 60 * 3L;
        this.unit = TimeUnit.SECONDS;
    }

    /**
     * N: CPU核心數
     * CPU密集型：corePoolSize = N + 1
     * IO密集型：corePoolSize = 2 * N
     */
    @Bean
    public ThreadPoolExecutor threadPoolExecutor() {
        // cpu密集型
        if (scenes == 1) {
            corePoolSize = corePoolSize + 1;
        } else {
            // io密集型
            corePoolSize = 2 * corePoolSize;
        }
        return new ThreadPoolExecutor(corePoolSize, maximumPoolSize, keepAliveTime, unit, workQueue, reject);
    }
}複制代碼      

• 配置類屬性

@ConfigurationProperties(
        prefix = "thread.pool"
)
public class ThreadPoolExecutorProperties {

    private Integer scenes = 1;

    public Integer getScenes() {
        return scenes;
    }

    public void setScenes(Integer scenes) {
        this.scenes = scenes;
    }
}複制代碼      

• 在resources中建立META-INF/spring.factories

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
com.angel.item.ThreadPoolAutoConfiguration複制代碼      

• 在另外的工程中引入上面的坐标

<dependency>
    <groupId>com.angel.item</groupId>
    <artifactId>thread-pool-execute-starter</artifactId>
    <version>1.0</version>
</dependency>複制代碼      

• 在yml配置即可

thread:
  pool:
    scenes: 1複制代碼