@order 注解用法

古城微笑少年丶 2024-04-01 10:01 81阅读 0赞

`@order`注解是`spring-core`包下的一个注解，`@Order`的作用是定义Spring IOC容器中Bean的执行顺序的优先级（这里的顺序也可以理解为存放到容器中的先后顺序）。开发过程当中有时候经常会出现配置依赖关系，例如注入A对象使用了`@ConditionalOnBean(B.class)`，意思是要求容器当中必须存在`B.class`的实例的时候，才会进行注入`A`。这时候我们就必须保证B对象在注入`A`对象前进行注入。

#### 目录 ####

*   *  一、观察@order源码
     *  二、@order实战
     *  三、@order失效原因
     *  四、@DependsOn控制加载顺序
     *  五、springboot提供的注解
     *  六、排序源码分析
     *  七、@AutoConfigureOrder

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

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

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

**（2）属性：**

@order当中只有一个value属性，而且还是int类型，值越低优先级越高。

这里spring给了一个接口，接口有两个参数，一个代表最大一个是最小。默认值是`Ordered.LOWEST_PRECEDENCE`，表示最低优先级(输给任何其他指定的顺序值)。

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NjEwMTgzOQ_size_16_color_FFFFFF_t_70][]

@Retention(RetentionPolicy.RUNTIME)
    @Target({
        ElementType.TYPE, ElementType.METHOD, ElementType.FIELD})
    @Documented
    public @interface Order {
        
        int value() default 2147483647;
    }

官网注释：[https://github.com/spring-projects/spring-framework/blob/main/spring-core/src/main/java/org/springframework/core/annotation/Order.java][https_github.com_spring-projects_spring-framework_blob_main_spring-core_src_main_java_org_springframework_core_annotation_Order.java]

### 二、@order实战 ###

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

> 我们要求Config2先进行加载，然后通过@order来排序测试一下

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

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

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NjEwMTgzOQ_size_16_color_FFFFFF_t_70 1][]

**（3）既然order可以控制加载顺序，那我们来试验一下，然后让Config2 先加载**

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

但是好像没什么卵用

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NjEwMTgzOQ_size_16_color_FFFFFF_t_70 2][]

**（4）分析原因**

目前这两个是在同包情况下不起作用。

![在这里插入图片描述][3af740d528904e018677300b356de720.png]  
于是进行分开了

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

分开之后竟然生效了

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NjEwMTgzOQ_size_16_color_FFFFFF_t_70 3][]

**（5）于是我又改成了Config1放到最上面，这样进行测试，结果又失效了**

> 假如对这块不理解的，看一下上个图片`config1`所在的位置！这里说的放到上面是文件所在的位置！

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

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NjEwMTgzOQ_size_16_color_FFFFFF_t_70 4][]

**（6）于是我又放在了同包下，将Config2命名为A开头的，这样他就放到了最上面，于是这样同样也生效了。**

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

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NjEwMTgzOQ_size_16_color_FFFFFF_t_70 5][]

期间我还尝试着将@Configuration都改为使用@Component，结果仍然不变。

> 得出结论：设置`Config2`的`@order值`就算是小于`Config1`的`@order值`同样也是`Config1`先加载。也可以理解为Order压根没作用，  
> 加载顺序跟类的命名和存放位置有关！

假如`Config1`和`Config2`两个类在一个包下，假如要求是`Config2`先加载：

*  在同一个包：如果同包情况下可以重新命名Config2，只要在Config1上面就行。
 *  不在同一个包：或者拆开不同包也可以，但是Config2所在的包也必须比Config1所呆的包上面。

### 三、@order失效原因 ###

[https://docs.spring.io/spring-framework/docs/5.3.28/reference/html/core.html\#spring-core][https_docs.spring.io_spring-framework_docs_5.3.28_reference_html_core.html_spring-core]

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NjEwMTgzOQ_size_16_color_FFFFFF_t_70 6][]

最关键的一句话：`您可以在目标类级别和@Bean方法上声明@Order注释`，可能针对的是单个bean定义(如果多个定义使用同一个bean类)。`@Order值可能会影响注入点的优先级（注意他说的可能，说明还有不可控因素），但请注意，它们不会影响单例启动顺序`，这是由依赖关系和@DependsOn声明确定的正交关注。

**下面我继续在带有@Bean注解的类当中添加@Order看看什么效果：**

首先我把config1和config2的@Configuration注解都给去掉了，然后又新增了两个配置类，默认是A先执行的，B后执行的。

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

接下来再来看一个案例，在Spring当中加载和注入是分两步来完成的，@Order控制不了加载的顺序。所谓的加载就是通过构造器创建对象。而注入就是指的注入属性，包含@Bean修饰的方法也是。

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

然后我又把order注解加在了@Bean方法上，是没有效果的

> 注意@order用在类上代表的是当前类实例注入的顺序级别，假如要用在@Bean修饰的方法上，代表的是@Bean创建的实例的注入顺序级别，而并不是代表的当前类的。

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

### 四、@DependsOn控制加载顺序 ###

@DependsOn可以控制加载的顺序

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

### 五、springboot提供的注解 ###

springboot提供了如下三个注解可以控制顺序：

*  @AutoConfigureAfter：当前配置类在指定配置类之后执行
 *  @AutoConfigureBefore：当前配置类在指定配置类之前执行
 *  @AutoConfigureOrder：指定优先级，数值越小，优先级越高。

**（1）首先将代码改回原来的样子**

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

**（2）在Config2使用@AutoConfigureBefore(Config1.class)，代表的是在config1加载前进行加载**

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

**（3）输出结果，显然还是没生效**

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NjEwMTgzOQ_size_16_color_FFFFFF_t_70 7][]

> 可能有时候走了狗屎运给你一种错觉还真的配置成功了。实际上这种方式是不可行的，以上三个注解只有针对`自动配置类`才会生效。

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

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

**（4）自定义spring.factories**

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NjEwMTgzOQ_size_16_color_FFFFFF_t_70 8][]

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

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

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

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NjEwMTgzOQ_size_16_color_FFFFFF_t_70 9][]

### 六、排序源码分析 ###

针对于@AutoConfigure那三个注解原理：其实关键的代码还是在AutoConfigurationImportSelector中，将自动配置类从spring.factories加载出来之后会根据条件排序（只有自动配置类！），在selectImports()方法中最后一行代码如下：

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

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

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

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

从上面配置的顺序可以知道，最终决定权还是在@AutoConfigureAfter、@AutoConfigureBefore这两个注解。

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

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

### 七、@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构建了");
        }
    }

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NjEwMTgzOQ_size_16_color_FFFFFF_t_70]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/0fb853ee3dad4d789a4be1c3f572dc9d.png
[https_github.com_spring-projects_spring-framework_blob_main_spring-core_src_main_java_org_springframework_core_annotation_Order.java]: https://github.com/spring-projects/spring-framework/blob/main/spring-core/src/main/java/org/springframework/core/annotation/Order.java
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NjEwMTgzOQ_size_16_color_FFFFFF_t_70 1]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/502c1b0a4d604fef94df5fc3711643b4.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NjEwMTgzOQ_size_16_color_FFFFFF_t_70 2]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/f0b2571d877e4b9985bc665827406636.png
[3af740d528904e018677300b356de720.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/7786029ed4c34c0ca67515f85e28ad21.png
[5c4cde1e13fb420c8875126f8232fff1.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/05425bf4f0664eea9ca44f82cdd59698.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NjEwMTgzOQ_size_16_color_FFFFFF_t_70 3]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/f9777ed1925748a1b41d5f4593e9c189.png
[f94d732c263b4a6b9dda38e0d749e142.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/fb4cfa116bf440adbd5213f66838261c.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NjEwMTgzOQ_size_16_color_FFFFFF_t_70 4]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/6b9e4488898c441087d66954c25b3aa2.png
[e4410b5df8c14e6aaa65475693b4b838.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/078161c20e92442fbcdec4dca07eb92f.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NjEwMTgzOQ_size_16_color_FFFFFF_t_70 5]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/c80b3fe5252844529b00e51607109e03.png
[https_docs.spring.io_spring-framework_docs_5.3.28_reference_html_core.html_spring-core]: https://docs.spring.io/spring-framework/docs/5.3.28/reference/html/core.html#spring-core
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NjEwMTgzOQ_size_16_color_FFFFFF_t_70 6]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/f095a7537a0f41f6961c7e9d4fdb99b6.png
[1628964215094f53a0204ea6bcd8a426.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/616cfe4f2e4d435f8cd3d79990191d6e.png
[6a471ec653cc49cbad6f616a791104cd.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/4987e059b21e43279a16518bf46fbc1f.png
[1cc85e943ab6416bafab963cbfced926.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/e80effefb5764ceca9f546bcbcaa39e8.png
[80477b4388e44293812b3279ffca69e4.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/ef768ed2ac1a4442b72efdb4c332c9b9.png
[ea873b0e50714e7195cb4b04ea6638c5.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/6df2fcbd24564dbcbd57036a0388a124.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NjEwMTgzOQ_size_16_color_FFFFFF_t_70 7]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/26d87ce288aa425a9460d0a9c325c60c.png
[bb71ab7d5baf4660add5e91e197f53f6.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/bb130c0e55e24458883016b19673917f.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NjEwMTgzOQ_size_16_color_FFFFFF_t_70 8]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/7b33bdcf16c14f5795f22f5fba5d7f60.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NjEwMTgzOQ_size_16_color_FFFFFF_t_70 9]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/68ab64a68f644fa888948f959d135fa0.png
[a981ed2328b04e74a67bbf73e46c06b5.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/30db13e4c15b407682aad800b872bd97.png
[21394a73239942faab63427cdf3d2bc1.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/6b45dd92735c44b0a2b7e0cf83fa7ab2.png
[8cf280766aa145688b6fce3ae99a75f6.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/d56e6ec5a4d7422d9257f97d851ef894.png