SpringBoot開發(fā)實(shí)戰(zhàn)之自動(dòng)配置

更新時(shí)間：2021年08月12日 11:21:19 作者：懵懂小虎

SpringBoot的核心就是自動(dòng)配置，自動(dòng)配置又是基于條件判斷來(lái)配置Bean,下面這篇文章主要給大家介紹了關(guān)于SpringBoot開發(fā)實(shí)戰(zhàn)之自動(dòng)配置的相關(guān)資料,需要的朋友可以參考下

在介紹SpringBoot的自動(dòng)配置之前，先了解下注解@Import的使用，SpringBoot的@Enable*開頭的注解底層依賴于@Import注解導(dǎo)入一些類，使用@Import導(dǎo)入的類會(huì)被Spring加載到IOC容器中，而@Import提供了以下4中用法：

直接導(dǎo)入Bean
通過配置類導(dǎo)入Bean
導(dǎo)入ImportSelector實(shí)現(xiàn)類,一般用于加載配置文件的類
導(dǎo)入ImportBeanDefinitionRegistrar實(shí)現(xiàn)類

下面來(lái)分別介紹這幾種用法。

直接導(dǎo)入Bean就比較簡(jiǎn)單了，新建一個(gè)User類

public class User{
    private String name;
    private String address;
}

然后在啟動(dòng)類上使用@Import注解導(dǎo)入即可

@SpringBootApplication
@Import(User.class)
public class Application {
    public static void main(String[] args) {
        ConfigurableApplicationContext context = SpringApplication.run(Application.class,args);
        System.out.println(context.getBean(User.class));
    }
}

這里需要注意的是，通過上下文獲取Bean時(shí)，需要使用Bean的class，因?yàn)橥ㄟ^Bean的方式導(dǎo)入，Spring存入IOC容器，是用類的全類名存儲(chǔ)的?？梢允褂蒙舷挛牡膅etBeansOfType方法查看，返回的是Map對(duì)象。

{com.tenghu.sbc.entity.User=User(name=null, age=0)}

從返回的結(jié)果可以看出，key就是存的User的全類名。

通過配置類導(dǎo)入Bean，創(chuàng)建一個(gè)配置類;

public class UserConfig {
    @Bean(name = "user")
    public User user(){
        return new User();
    }
}

然后通過@Import導(dǎo)入這個(gè)配置類

@SpringBootApplication
@Import(UserConfig.class)
public class Application {
    public static void main(String[] args) {
        ConfigurableApplicationContext context = SpringApplication.run(Application.class,args);
        System.out.println(context.getBean(User.class));
    }
}

通過配置類的方式可以在配置類里面定義多個(gè)Bean，當(dāng)導(dǎo)入配置類時(shí)，配置類下定義的Bean都會(huì)被導(dǎo)入。

導(dǎo)入ImportSelector實(shí)現(xiàn)類

public class MyImportSelector implements ImportSelector {
    @Override
    public String[] selectImports(AnnotationMetadata annotationMetadata) {
        return new String[]{User.class.getName()};
    }
}

實(shí)現(xiàn)ImportSelector類，必須實(shí)現(xiàn)selectImports，然后返回需要導(dǎo)入的Bean。與上面一樣使用@Import導(dǎo)入這個(gè)實(shí)現(xiàn)類。

@Import(MyImportSelector.class)

導(dǎo)入ImportBeanDefinitionRegistrar實(shí)現(xiàn)類

public class MyImportBeanDefinitionRegistrar implements ImportBeanDefinitionRegistrar {
    @Override
    public void registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry) {
        BeanDefinition beanDefinition = BeanDefinitionBuilder.genericBeanDefinition(User.class).getBeanDefinition();
        registry.registerBeanDefinition("user",beanDefinition);
    }
}

使用方式一樣，通過@Import導(dǎo)入

@Import(MyImportBeanDefinitionRegistrar.class)

了解完@Import的使用，接下來(lái)可以來(lái)看下SpringBoot的自動(dòng)配置是怎么處理的。從上面的啟動(dòng)類，使用SpringBoot就用了一個(gè)注解@SpringBootApplication，可以打開這個(gè)注解的源碼看下：

@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@SpringBootConfiguration
@EnableAutoConfiguration
@ComponentScan(
    excludeFilters = {@Filter(
    type = FilterType.CUSTOM,
    classes = {TypeExcludeFilter.class}
), @Filter(
    type = FilterType.CUSTOM,
    classes = {AutoConfigurationExcludeFilter.class}
)}
)
public @interface SpringBootApplication

用到這樣一個(gè)注解@EnableAutoConfiguration注解。底層使用@Import導(dǎo)入上面第三種方式AutoConfigurationImportSelector。

@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@AutoConfigurationPackage
@Import({AutoConfigurationImportSelector.class})
public @interface EnableAutoConfiguration {
    String ENABLED_OVERRIDE_PROPERTY = "spring.boot.enableautoconfiguration";

    Class<?>[] exclude() default {};

    String[] excludeName() default {};
}

進(jìn)入源碼找到實(shí)現(xiàn)了selectImports方法

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

通過調(diào)用方法getAutoConfigurationEntry

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);
    }
}

這里主要的看調(diào)用這個(gè)方法getCandidateConfigurations，返回的就是要自動(dòng)加載的Bean

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;
}

通過META-INF/spring.factories配置文件里的EnableAutoConfiguration獲取配置的Bean

# Auto Configure
org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
org.springframework.boot.autoconfigure.admin.SpringApplicationAdminJmxAutoConfiguration,\
org.springframework.boot.autoconfigure.aop.AopAutoConfiguration,\
org.springframework.boot.autoconfigure.amqp.RabbitAutoConfiguration,\
org.springframework.boot.autoconfigure.batch.BatchAutoConfiguration,\
org.springframework.boot.autoconfigure.cache.CacheAutoConfiguration,\
org.springframework.boot.autoconfigure.cassandra.CassandraAutoConfiguration,\
.....

太多了，有興趣的可以查看Spring的xxx-autoconfigure包。將讀取到的配置最終返回給selectImports，然后通過工具類StringUtils.toStringArray轉(zhuǎn)換為字符串?dāng)?shù)組返回給@Import，從而實(shí)現(xiàn)自動(dòng)配置。第三方包只要是xxx-autoconfigure結(jié)尾的包，META-INF都有spring.factories，這個(gè)名字是固定寫法。都可以被SpringBoot識(shí)別并且進(jìn)行自動(dòng)配置，前提是需要配置到org.springframework.boot.autoconfigure.EnableAutoConfiguration下。

從以上總結(jié)來(lái)看，SpringBoot的自動(dòng)配置原理如下：

@EnableAutoConfiguration注解內(nèi)部使用Import(AutoConfigurationImportSelector.class)來(lái)加載配置類
通過配置文件：META-INF/spring.factories，配置大量的配置類，SpringBoot啟動(dòng)時(shí)就會(huì)自動(dòng)加載這些類并初始化的Bean。

這里需要說(shuō)明一點(diǎn)，并不是所有配置到配置文件的Bean都會(huì)被初始化，需要符合配置類中使用Condition來(lái)加載滿足條件的Bean。比如我們打開RedisAutoConfiguration的源碼查看：

@Configuration(
    proxyBeanMethods = false
)
@ConditionalOnClass({RedisOperations.class})
@EnableConfigurationProperties({RedisProperties.class})
@Import({LettuceConnectionConfiguration.class, JedisConnectionConfiguration.class})
public class RedisAutoConfiguration {
    public RedisAutoConfiguration() {
    }

    @Bean
    @ConditionalOnMissingBean(
        name = {"redisTemplate"}
    )
    @ConditionalOnSingleCandidate(RedisConnectionFactory.class)
    public RedisTemplate<Object, Object> redisTemplate(RedisConnectionFactory redisConnectionFactory) {
        RedisTemplate<Object, Object> template = new RedisTemplate();
        template.setConnectionFactory(redisConnectionFactory);
        return template;
    }

    @Bean
    @ConditionalOnMissingBean
    @ConditionalOnSingleCandidate(RedisConnectionFactory.class)
    public StringRedisTemplate stringRedisTemplate(RedisConnectionFactory redisConnectionFactory) {
        StringRedisTemplate template = new StringRedisTemplate();
        template.setConnectionFactory(redisConnectionFactory);
        return template;
    }
}

類上面有這么個(gè)注解@ConditionalOnClass({RedisOperations.class})，意思就是需要RedisOperations類存在的情況下，才自動(dòng)加載；這還不算完，繼續(xù)查看下面的方法上有個(gè)@ConditionalOnMissingBean(name = {"redisTemplate"})，這里的意思是，當(dāng)其他地方?jīng)]有redisTemplate實(shí)例化這個(gè)Bean時(shí)，才自動(dòng)加載。符合這兩個(gè)條件，SpringBoot才會(huì)進(jìn)行自動(dòng)加載并初始化。

總結(jié)

到此這篇關(guān)于SpringBoot開發(fā)實(shí)戰(zhàn)之自動(dòng)配置的文章就介紹到這了,更多相關(guān)SpringBoot自動(dòng)配置內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: