@AutoConfiguration注解详解

小咪咪 2024-04-01 09:46 11阅读 0赞

`@AutoConfiguration`属于`springboot`当中`autoconfigure`包下的注解。`springboot`给我们提供了好多`AutoConfiguration`，例如关于缓存`cache`的有`CacheAutoConfiguration`，关于定时任务`quartz`的有`QuartzAutoConfiguration`，这些`AutoConfiguration`你会发现基本上都会拿`@AutoConfiguration`来修饰。本篇来彻底了解`@AutoConfiguration`到底有什么作用，以及到底如何应用他。

#### 目录 ####

*   *  一、观察@AutoConfiguration源码
     *  二、@Configuration
     *  三、@AutoConfigureBefore
     *  四、@AutoConfigureAfter
     *  五、@AutoConfigureOrder
     *  六、源码分析

### 一、观察@AutoConfiguration源码 ###

**源码当中有三个元注解：**

*  **@Target(\{ElementType.TYPE\})：** 使用范围接口、类、枚举、注解
 *  **@Retention(RetentionPolicy.RUNTIME)：** @Retention是用来修饰注解的生命周期的，RetentionPolicy.RUNTIME代表的是不仅被保存到class文件中，jvm加载class文件之后，仍然存在；一直有效！
 *  **@Documented：** @Documented和@Deprecated注解长得有点像，@Deprecated是用来标注某个类或者方法不建议再继续使用，@Documented只能用在注解上，如果一个注解@B，被@Documented标注，那么被@B修饰的类，生成Javadoc文档时，会显示@B。

**除了元注解外还有三个注解：**

*  **@Configuration：** 这个是开发当中最常用的注解，他属于是`@Component`注解的扩展注解，同`@Controller、@Service`等几个注解的功能是一样的，只要在类上添加了该注解，然后在`springboot`的扫描范围内，启动项目的时候会将该注解修饰的类通过无参构造器创建出来，然后存入spring容器当中。
 *  **@AutoConfigureBefore：** 一般都是配合着`@Configuration`使用，主要用于修饰在类上，然后可以指定该类 在 某类之前进行加载到容器。
 *  **@AutoConfigureAfter：** 同`@AutoConfigureBefore`功能一样，他是指定该类 在 某类 之后进行加载到容器当中。

> 具体的用法请看下面的示例！

@Target({
        ElementType.TYPE})
    @Retention(RetentionPolicy.RUNTIME)
    @Documented
    @Configuration(
        proxyBeanMethods = false
    )
    @AutoConfigureBefore
    @AutoConfigureAfter
    public @interface AutoConfiguration {
        
        @AliasFor(
            annotation = Configuration.class
        )
        String value() default "";
    
        @AliasFor(
            annotation = AutoConfigureBefore.class,
            attribute = "value"
        )
        Class<?>[] before() default {
        };
    
        @AliasFor(
            annotation = AutoConfigureBefore.class,
            attribute = "name"
        )
        String[] beforeName() default {
        };
    
        @AliasFor(
            annotation = AutoConfigureAfter.class,
            attribute = "value"
        )
        Class<?>[] after() default {
        };
    
        @AliasFor(
            annotation = AutoConfigureAfter.class,
            attribute = "name"
        )
        String[] afterName() default {
        };
    }

@AutoConfiguration其实就是一个组合注解。因为一个自动配置类往往需要加很多注解，于是乎springboot就将一些经常用到的注解，给组合到一块，这样就可以做到一个注解拥有三个注解的功能。具体他是如何做到注解聚合到一块的呢，原因是依赖于`@AliasFor`注解，@AliasFor注解就是起到一个注解传值的作用。想深入了解@AliasFor可以看我的这一篇文章：

[https://blog.csdn.net/weixin\_43888891/article/details/126962698?spm=1001.2014.3001.5501][https_blog.csdn.net_weixin_43888891_article_details_126962698_spm_1001.2014.3001.5501]

![在这里插入图片描述][54d3e9c39aec45df8aa498b91bcc443f.png]

### 二、@Configuration ###

`@Configuration`注解我们经常用，但是我们很少这样用`@Configuration(proxyBeanMethods = false)`，这里的`proxyBeanMethods`默认是`true`，但是这里却设置为了`false`，那么这个属性到底有什么作用？

> `@Configuration`属于`spring`当中的注解，感兴趣的可以看一下spring源码当中的解释：[https://github.com/spring-projects/spring-framework/blob/main/spring-context/src/main/java/org/springframework/context/annotation/Configuration.java][https_github.com_spring-projects_spring-framework_blob_main_spring-context_src_main_java_org_springframework_context_annotation_Configuration.java]

源码当中解释不是中文，再者一般的也看不懂，我们直接通过代码试验来得出结论：

> 当他为true的时候，我们在容器中获取到的对象总是同一个，即便是我们调用了创建对象的方法，那获取到的还是同一个。但是当是多例的时候，如果我们调用了创建对象的方法，那就不是同一个了。

**（1）自定义一个类，用于测试**

public class TestBean1 {
        
        @Override
        public String toString() {
        
            return super.toString() + "--我是TestBean1";
        }
    
        public TestBean1() {
        
            System.out.println("TestBean1构造器执行了");
        }
    }

**（2）添加配置类**

@Configuration(proxyBeanMethods = true)
    public class Myconfig {
        
    
        @Bean
        public TestBean1 testBean1() {
        
            return new TestBean1();
        }
    }

**（3）添加测试类**

@RestController
    public class CommonController {
        
    
        @Autowired
        private Myconfig myconfig;
    
        @Autowired
        private TestBean1 testBean1;
    
        @RequestMapping("/import")
        public void printImportBeanInfo() {
        
            System.out.println(testBean1);
            System.out.println(myconfig.testBean1());
        }
    }

**（4）访问接口，得出从容器里面取和直接访问testBean1方法得出来的对象是一个对象，这就是所谓的被代理了**

![在这里插入图片描述][f995e55197224ff58feabc7cea15e869.png]  
**（5）设置为false@Configuration(proxyBeanMethods = false)**

很显然已经不是一个对象了

![在这里插入图片描述][7b4f063a2dc54546af4e4cce032a1e70.png]

### 三、@AutoConfigureBefore ###

**（1）自定义两个配置类**

@Configuration
    public class Config1 {
        
    
        public Config1() {
        
            System.out.println("Config1构建了");
        }
    }
    
    @Configuration
    public class Config2 {
        
    
        public Config2() {
        
            System.out.println("Config2构建了");
        }
    }

**（2）启动项目测试：默认是先创建的Config1后创建的Config2**

![在这里插入图片描述][eda509bcf16e4950991bec2ac785b421.png]

> 现在是有个需求要求让@Config2先加载，可能这时候有人该说了@Order注解不就可以了吗，其实不是的，@Order值可能会影响注入点的优先级，但请注意，它不会影响单例启动顺序。关于@order我专门整理了一篇文章，供参考学习！  
> [https://blog.csdn.net/weixin\_43888891/article/details/127481825][https_blog.csdn.net_weixin_43888891_article_details_127481825]

**（3）使用@AutoConfigure相关注解的前提是必须是自动配置类，可能有时候走了狗屎运给你一种错觉还真的配置成功了。**

在Config2上添加@AutoConfigureBefore(Config1.class)注解，就是告诉他我要在Config1之前注入容器，只加入注解后再次启动项目会发现没有任何作用！

![在这里插入图片描述][0aea0a4ac2424b70875a2824e0571224.png]

在autoconfigure包下就有spring.factories，这个文件配置了自动配置类，springboot会读取这个文件的，我们也可以在自己项目上定义spring.factories，这样我们的配置类对于@AutoConfigureAfter注解就可以生效了。

![在这里插入图片描述][bb71ab7d5baf4660add5e91e197f53f6.png]  
**（4）自定义spring.factories**

![在这里插入图片描述][0c132919d36c490091b39f984b154b04.png]

第一行是固定的，后面的就是全类名，虽然只有Config2使用了注解，但是需求是和Config1进行排序，所以这两个都得加。

> 可能有的人对这里会有疑问，我不使用@AutoConfigureBefore注解，只通过spring.factories下面的配置可以修改这两个配置类的启动顺序吗，答案是不可以的！！！ 关于这一点我也通过试验印证过了！

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
    com.gzl.cn.springbootcache.config.Config2,\
    com.gzl.cn.springbootcache.config.Config1

**（5）测试，成功解决**

![在这里插入图片描述][c7452adbb7ce41969a96854b8dbb6b17.png]

### 四、@AutoConfigureAfter ###

@AutoConfigureAfter和@AutoConfigureBefore其实是一样的，我这里就不演示了哈，感兴趣的可以自己参照上面进行练习一下。

### 五、@AutoConfigureOrder ###

这种也是可以的！当然前提也是需要配置spring.factories

@Configuration
    @AutoConfigureOrder(2)
    public class Config1 {
        
    
        public Config1() {
        
            System.out.println("Config1构建了");
        }
    }
    
    @Configuration
    @AutoConfigureOrder(1)
    public class Config2 {
        
    
        public Config2() {
        
            System.out.println("Config2构建了");
        }
    }

### 六、源码分析 ###

其实关键的代码还是在AutoConfigurationImportSelector中，将自动配置类从spring.factories加载出来之后会根据条件排序，在selectImports()方法中最后一行代码如下：

![在这里插入图片描述][a981ed2328b04e74a67bbf73e46c06b5.png]

紧接着会走到这个地方，实际上是分了三步排序：

1.  先按照字母排序
2.  按照@AutoConfigureOrder进行排序
3.  按照 @AutoConfigureBefore和@AutoConfigureAfter排序

![在这里插入图片描述][21394a73239942faab63427cdf3d2bc1.png]  
从上面配置的顺序可以知道，最终决定权还是在@AutoConfigureAfter、@AutoConfigureBefore这两个注解。

当我们不设置spring.factories的时候，这里面压根都没有这两个类！

![在这里插入图片描述][8cf280766aa145688b6fce3ae99a75f6.png]

[https_blog.csdn.net_weixin_43888891_article_details_126962698_spm_1001.2014.3001.5501]: https://blog.csdn.net/weixin_43888891/article/details/126962698?spm=1001.2014.3001.5501
[54d3e9c39aec45df8aa498b91bcc443f.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/ccbe55f30cbf40f48e6c93ee5bddddf9.png
[https_github.com_spring-projects_spring-framework_blob_main_spring-context_src_main_java_org_springframework_context_annotation_Configuration.java]: https://github.com/spring-projects/spring-framework/blob/main/spring-context/src/main/java/org/springframework/context/annotation/Configuration.java
[f995e55197224ff58feabc7cea15e869.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/d1d21c67583d42599bc83d27c3e36627.png
[7b4f063a2dc54546af4e4cce032a1e70.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/ec77687500c44e1f80a35acb847dab61.png
[eda509bcf16e4950991bec2ac785b421.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/ebed307df1f64d10bd78c794f22a1fcc.png
[https_blog.csdn.net_weixin_43888891_article_details_127481825]: https://blog.csdn.net/weixin_43888891/article/details/127481825
[0aea0a4ac2424b70875a2824e0571224.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/7be3f156426449cd898ca53a24a9a5c6.png
[bb71ab7d5baf4660add5e91e197f53f6.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/4f8fe32ece9e4882abe700ad0d6fc28d.png
[0c132919d36c490091b39f984b154b04.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/872eb68b14a94bcdb916891613988b07.png
[c7452adbb7ce41969a96854b8dbb6b17.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/8c711a7e09cb4fe9b6fbe8140d6473ec.png
[a981ed2328b04e74a67bbf73e46c06b5.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/bab7dad4601548c1bc3966e8f8cb361b.png
[21394a73239942faab63427cdf3d2bc1.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/ae4a0d68008b4ac7b2ffd6defd3d3030.png
[8cf280766aa145688b6fce3ae99a75f6.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/8622450f001a4fdaaeb393d97e96104c.png