SpringBoot 自动配置学习笔记

喜欢ヅ旅行 2021-10-12 23:49 305阅读 0赞

## 摘要 ##

本篇SpringBoot自动配置学习笔记纲要：  
1，我们用SpringBoot的理由是因为它可让开发者更加快速高效搭建Spring应用，背后是“约定优先于配置”的理念和自动配置技术；  
2，自动配置技术实现原理  
3，自定义自动配置示例

## 1 自动配置解决了什么问题 ##

#### 我们用Spring Boot的理由 ####

我们用Spring Boot的理由是什么？我的感觉是它大大降低了使用Spring 的门槛，回想之前用spring框架一个项目里各种XML配置，想启动个工程咋这么难，真不想回到那样的日子了。  
SpringBoot能够让我们更加快速高效的搭建Spring 应用，是因为它的理念是“**约定优先于配置**”:

*  约定一些推荐的默认配置
 *  开发人员只需要指定非默认的配置

SpringBoot 能够按照约定进行默认配置，自动推测用户需要的依赖并注册相应的bean到容器中，主要归功于它的**自动配置**特性。如此神奇的自动配置特性是如何实现的？

## 2 自动配置实现原理 ##

在启动类(一般均位于`src/main/java`根路径下)中加上`@SpringBootApplication`注解就开启了SpringBoot框架，打开这个注解的实现发现它包含了三个最主要的注解

*  @SpringBootConfiguration(打开看到就是@Configuration，表示这是一个JavaConfig配置类)
 *  @ComponentScan (启动扫描组件，关于该注解详细介绍看[这篇帖][Link 1])
 *  @EnalbleAutoConfiguration(开启自动配置功能)

负责开启自动配置的是`@EnableAutoConfiguration`，打开看它的实现

@Target(ElementType.TYPE)
    @Retention(RetentionPolicy.RUNTIME)
    @Documented
    @Inherited
    @AutoConfigurationPackage
    @Import(EnableAutoConfigurationImportSelector.class)
    public @interface EnableAutoConfiguration { 
        // ......
    }

这里面最重要的是`@Import`注解，它负责引入`EnableAutoConfigurationImportSelector`类把它作为bean注册到Spring容器中。从类名可以猜出`EnableAutoConfigurationImportSelector`应该是负责选择引入哪些配置，看它的源码中有个`selectImports`方法：

//spring-boot-autoconfigure版本是2.0.3-RELEASE
        public String[] selectImports(AnnotationMetadata annotationMetadata) { 
    			//其他忽略，只保留这句最关键的
                List<String> configurations = this.getCandidateConfigurations(annotationMetadata, attributes);
    			//忽略
        }

`getCandidateConfiguratinos`方法实现：

protected List<String> getCandidateConfigurations(AnnotationMetadata metadata, AnnotationAttributes attributes) { 
        	//下面的getSpringFactoriesLoaderFactoryClass()方法返回的就是EnableAutoConfiguration.class
            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;
        }

到此可以看出`EnableAutoConfigurationImportSelector`类要做的事情就是通过`SpringFactoriesLoader`的静态方法`loadFactoryNames`来扫描所有jar包，将jar包中`/META-INF/spring.factories`文件中key为EnableAutoConfiguration的配置类引入并作为bean注册到Spring容器中。（如果你还不知道`SpringFactoriesLoader`类，相关知识[参考这篇.][.]）比如`spring-boot-autoconfigure`jar包中的`spring.factories`文件关于`EnableAutoConfiguration`的配置如下

//spring-boot-autoconfigure版本是2.0.3-RELEASE
    # 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,\
    org.springframework.boot.autoconfigure.cloud.CloudAutoConfiguration,\
    org.springframework.boot.autoconfigure.context.ConfigurationPropertiesAutoConfiguration,\
    org.springframework.boot.autoconfigure.context.MessageSourceAutoConfiguration,\
    org.springframework.boot.autoconfigure.context.PropertyPlaceholderAutoConfiguration,\
    org.springframework.boot.autoconfigure.couchbase.CouchbaseAutoConfiguration,\
    org.springframework.boot.autoconfigure.dao.PersistenceExceptionTranslationAutoConfiguration,\
    ...

全部配置太长了，这里只展示了开头的一部分。到这里我终于明白了，为什么在SpringBoot项目我自己明明没配置什么，常用的功能却都能直接用，原来开启自动配置后SpringBoot默认引入了这么多功能的配置。

注意到上面的`AopAutoConfiguration`应该是关于切面的配置，我们就以它为例，看看SpringBoot具体是如何自动配置：

@Configuration
    @ConditionalOnClass({ EnableAspectJAutoProxy.class, Aspect.class, Advice.class, AnnotatedElement.class})
    @ConditionalOnProperty(
        prefix = "spring.aop",
        name = { "auto"},
        havingValue = "true",
        matchIfMissing = true
    )
    public class AopAutoConfiguration { 
        public AopAutoConfiguration() { 
        }
    ...

这里用到了条件注解`@ConditonalOnClass`和@`ConditionalOnProperty`,分别表示：

*  只有classpath中`EnableAspectJAutoProxy.class`, `Aspect.class`, `Advice.class`, `AnnotatedElement.class`4个类都存在时配置类`AopAutoConfiguration`才生效，否则忽略它
 *  如果`application.properties`配置文件中spring.aop.auto值为true，则配置生效，值不为true则略忽配置；如果spring.aop.auto值缺失，默认配置生效

到这里应该明白了，自动配置能够推断项目需要的依赖，魔法的背后就是条件注解.

关于自动配置，总结一下就是：

> @EnableAutoConfiguration注解中导入了EnableAutoConfigurationImportSelector，而这个类的selectImports()通过SpringFactoryLoader引入了大量的默认配置类，而每个配置类依靠条件注解，实现在特定场景下自动判断配置是否生效

这个自动配置过程中有一个点没有说明，就是`EnableAutoConfigurationImportSelector`类的`selectImports()`方法是什么时候调用的。简单讲就是，它会在容器启动过程中`AbstractApplicationContext.refresh()`方法中执行，具体细节不是本文讨论的重点，有兴趣可以看[Spring Boot应用启动的秘密][.]

## 3 怎么用自动配置 ##

除了知道SpringBoot实现自动配置的原理，我们自己在开发时，也可以利用它。  
实现自己的自动配置类很简单，只需要定义一个自动配置类，然后创建`/META-INF/spring.factories`文件，加入EnableAutoConfiguration配置，并将自定义的类的全类名放在=后面。这样Spring容器启动时，就会加载你自定义的配置类。

[示例代码链接][Link 2]

[Link 1]: https://mp.csdn.net/postedit/80918704
[.]: https://www.jianshu.com/p/83693d3d0a65
[Link 2]: https://mp.weixin.qq.com/s/gs2zLSH6m9ijO0-pP2sr9Q