【微服务】spring 控制bean加载顺序使用详解

一、前言

二、使用@order注解控制顺序

2.1 @order 注解使用示例

2.2 order注解顺序失效问题

2.2.1 @order失效问题解决办法

2.3 实现Ordered接口

三、使用@dependon注解控制顺序

四、AutoConfiguration注解控制bean加载顺序

4.1 @AutoConfigureBefore 操作演示

4.2 @AutoConfigureOrder 操作演示

4.3 源码解读与分析

五、自定义ApplicationContextInitializer

5.1 ApplicationContextInitializer介绍

5.2 ApplicationContextInitializer使用

5.3 ApplicationContextInitializer控制加载顺序

六、使用场景

6.1 解决bean的依赖关系

6.2 设置某些配置类的优先级最高

6.3 依赖传递

七、写在文末

一、前言

在使用spring框架开发过程中，可能会遇到下面的情况：

某个bean被另一个bean依赖，也就是bean-b的创建必须依赖bean-a；
某个bean被很多其他bean依赖，比如bean-a初始化完成后，其他bean需要依靠bean-a初始化自己的业务；
...

类似这样的场景还有很多，总结来说，这就涉及到bean的加载顺序问题，如何解决呢？下面列举出几种常用的解决方案。

二、使用@order注解控制顺序

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

2.1 @order 注解使用示例

有如下两个类，Demo1和Demo2，分别在类上添加@Order注解

@Component
@Order(1)
public class Demo1 {@Beanpublic UserService serviceA(){System.out.println("serviceA 执行");return new UserService();}
}

两个类各自创建一个UserService的bean

@Component
@Order(2)
public class Demo2 {@Beanpublic UserService serviceB(){System.out.println("serviceB 执行");return new UserService();}
}

运行下面的代码，观察测试效果

public class OrderTest {public static void main(String[] args) {AnnotationConfigApplicationContext applicationContext = new AnnotationConfigApplicationContext(BeanScanConfig.class);String[] beanDefinitionNames = applicationContext.getBeanDefinitionNames();for(String beanName : beanDefinitionNames){System.out.println(beanName);}}
}

可以看到，order数字更小的demo1这个类的bean比demo2的bean要先创建出来；

2.2 order注解顺序失效问题

上面通过在类上添加@order，可以控制类创建的bean的顺序，事实真的如此吗？如果此时，我们将demo1的order调大，demo2的order数字调小，你将看到的效果仍然是serviceA先输出，这就是order注解顺序失效问题。关于这个问题，spring官方文档也有说明，翻译出来意思如下：

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

2.2.1 @order失效问题解决办法

解决方式1

将需要控制bean的创建顺序的两个类放到不同的包路径下

再次运行测试代码，当demo2的order数字更小的情况下，就能看到预期的demo2创建的bean优先输出的效果了

解决方式2

重新修改类的命名，比如将demo2的类修改为ADemo，让ADemo这个类在同一个包路径下置于Demo2之前

这样修改后，再次运行测试代码观察效果，此时ADemo就优先Demo1了

2.3 实现Ordered接口

使用spring提供的ordered接口，只需要自定义的类实现这个接口，并重写里面的getOrder方法，在getOrder方法的返回值中，数值越小，优先级越高，如下自定义两个被sppring管理的类，实现Ordered接口

@Component
public class Listener1 implements Ordered {@Beanpublic UserService userService1(){System.out.println("userService1 bean");return new UserService();}@Overridepublic int getOrder() {return 100;}
}

@Component
public class Listener2 implements Ordered {@Beanpublic UserService userService2(){System.out.println("userService2 bean");return new UserService();}@Overridepublic int getOrder() {return 10;}
}

与ordered接口类似的还有PriorityOrdered，用法大同小异，有兴趣的同学可以进一步挖掘。

三、使用@dependon注解控制顺序

当某个bean-a的创建或加载需要明确依赖另一个bean-b的时候可以考虑使用dependon注解，换言之，bean-b要优先于bean-a创建；

如下有两个类，OrderDemo1和OrderDemo2

@Component
@DependsOn("orderDemo2")
public class OrderDemo1 {public OrderDemo1(){System.out.println("OrderDemo1 ...");}}

其中OrderDemo1的创建依赖OrderDemo2

@Component
public class OrderDemo2 {public OrderDemo2(){System.out.println("OrderDemo2 ...");}}

运行程序，可以看到OrderDemo2优先于OrderDemo1创建

由于这种方法是通过bean的名字（字符串）来控制顺序的，如果改了bean的类名，很可能就会忘记来改所有用到它的注解，那就问题大了，所以这种方式一般不推荐使用，但是也不失为控制bean创建顺序的方式。

四、AutoConfiguration注解控制bean加载顺序

Spring Boot会根据当前容器内的情况来动态的判断自动配置类的配置顺序，它给我们提供了@AutoConfigureBefore、@AutoConfigureAfter、@AutoConfigureOrder 三大注解：

@AutoConfigureBefore

用在自动配置类上面，表示该自动配置类需要在另外指定的自动配置类配置完之后配置加载

@AutoConfigureAfter

用在自动配置类上面，表示该自动配置类需要在另外指定的自动配置类配置完之前配置加载

@AutoConfigureOrder

确定配置加载的优先级顺序，表示绝对顺序（数字越小，优先顺序越高）

4.1 @AutoConfigureBefore 操作演示

定义两个配置类DbConfig1与DbConfig2，代码如下

@Configuration
public class DbConfig1 {public DbConfig1(){System.out.println("DbConfig1 构建方法...");}}

其中，DbConfig2类上使用了注解AutoConfigureBefore，期望DbConfig2比DbConfig1先加载

@Configuration
@AutoConfigureBefore(DbConfig1.class)
public class DbConfig2 {public DbConfig2(){System.out.println("DbConfig2 构建方法...");}}

到这里还没有完事，还需在resources目录下，将DbConfig1与DbConfig2配置到spring.factories文件中进行自动装配

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
com.congge.config.DbConfig2,\
com.congge.config.DbConfig1

运行上面的代码，观察控制台输出，可以看到DbConfig2比DbConfig1先加载

我们还可以将注解换成AutoConfigureAfter，看看是什么效果

@Configuration
@AutoConfigureAfter(DbConfig1.class)
public class DbConfig2 {public DbConfig2(){System.out.println("DbConfig2 构建方法...");}}

再次运行代码，可以看到这次就是DbConfig1先加载

4.2 @AutoConfigureOrder 操作演示

也可以使用AutoConfigureOrder 注解来控制不同配置类的加载顺序，数字越小，优先顺序越高，添加两个配置类，分别使用该注解进行标注

@Configuration
@AutoConfigureOrder(2)
public class OrderConfig1 {public OrderConfig1(){System.out.println("OrderConfig1 加载...");}
}

OrderConfig2中的数值更大，理论上OrderConfig1优先加载

@Configuration
@AutoConfigureOrder(7)
public class OrderConfig2 {public OrderConfig2(){System.out.println("OrderConfig2 加载...");}
}

同样，使用AutoConfigureOrder控制配置类的加载顺序也需要将其配置到spring.factories

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
com.congge.config.DbConfig2,\
com.congge.config.DbConfig1,\
com.congge.config.OrderConfig1,\
com.congge.config.OrderConfig2

运行上面的代码，看到如下效果，说明OrderConfig1优于OrderConfig2加载

4.3 源码解读与分析

最关键的代码在AutoConfigurationImportSelector这个类中，spring在bean装载过程中，将自动配置类从spring.factories加载出来之后会根据条件排序，在selectImports()方法中最后一行代码进行排序，如下

跟进sortAutoConfigurations这个方法，最终的排序逻辑来到下面这个getInPriorityOrder方法中；

在这个方法中，关于排序是分成3种方式完成的

先按字母排序；
再按照@AutoConfigureOrder进行排序；
最后按照 @AutoConfigureBefore和@AutoConfigureAfter排序；

而从配置的顺序不难发现，最终决定权还是在@AutoConfigureAfter、@AutoConfigureBefore这两个注解。

五、自定义ApplicationContextInitializer

对spring的bean的生命周期和加载过程熟悉的同学，想必了解到，容器启动过程中，通过解析xml文件中的配置生成bean或者通过扫描路径并解析得到bean，这些bean最终会统一保存在一个容器中被spring管理。既然如此，开发人员就可以人工的干预这个bean的解析过程，通过spring提供的相关扩展点，改变bean在容器中的位置就可以达到控制bean的顺序了，下面看具体的操作流程。

5.1 ApplicationContextInitializer介绍

先看spring官网的介绍：

翻译过来大概的意思如下

用于在spring容器刷新之前初始化Spring ConfigurableApplicationContext的回调接口。（剪短说就是在容器刷新之前调用该类的 initialize 方法。并将 ConfigurableApplicationContext 类的实例传递给该方法）；
通常用于需要对应用程序上下文进行编程初始化的web应用程序中。例如，根据上下文环境注册属性源或激活配置文件等；
可排序的（实现Ordered接口，或者添加@Order注解）；

5.2 ApplicationContextInitializer使用

新建一个类 MyAppInitializer并实现 ApplicationContextInitializer 接口

public class MyAppInitializer implements ApplicationContextInitializer {@Overridepublic void initialize(ConfigurableApplicationContext applicationContext) {System.out.println("-----MyAppInitializer initialize-----");}
}

然后在启动类中添加进去

@SpringBootApplication
public class BootApp {public static void main(String[] args) {SpringApplication application = new SpringApplication(BootApp.class);application.addInitializers(new MyAppInitializer());application.run(args);}
}

运行上面的main程序，在启动时看到控制台输出下面的信息

从上面的介绍了解到，实现ApplicationContextInitializer该接口，将会在容器刷新之前进行加载，对应到spring源码中，即refreshContext(context)方法，了解spring的bean的加载流程的同学应该知道，refreshContext里面就是调用AbstractApplicationContext的refresh的方法，其主要功能就是注册spring容器里面的bean,以及对bean的处理还有广播等功能，简而言之，就是在这个方法中，完成系统中bean的创建和存储的一系列过程。

基于此，按照上面的效果来看，实现ApplicationContextInitializer该接口之后，其类的加载时机要更加靠前，于是就可以借助这个特性，在bean还没有真正创建出来之前，人为的干预bean的创建顺序，将指定的类注册到spring上下文中。

5.3 ApplicationContextInitializer控制加载顺序

自定义一个类实现ApplicationContextInitializer接口

public class MyAppInitializer implements ApplicationContextInitializer {@Overridepublic void initialize(ConfigurableApplicationContext applicationContext) {System.out.println("-----MyAppInitializer initialize-----");applicationContext.addBeanFactoryPostProcessor(new MyBeanFactoryPostProcessor());}
}

自定义一个类实现接口BeanDefinitionRegistryPostProcessor，重写postProcessBeanDefinitionRegistry方法，手动注册需要控制加载到容器中顺序的类，注意，按照上面的流程操作完成之后，对于你要控制的配置类，就不要使用相关的注解标注了，比如下面要控制的是OrderService这个类的顺序在最前面。

public class MyBeanFactoryPostProcessor implements BeanDefinitionRegistryPostProcessor {@Overridepublic void postProcessBeanDefinitionRegistry(BeanDefinitionRegistry beanDefinitionRegistry) throws BeansException {AbstractBeanDefinition beanDefinition = BeanDefinitionBuilder.genericBeanDefinition().getBeanDefinition();beanDefinition.setBeanClass(OrderService.class);beanDefinitionRegistry.registerBeanDefinition("orderService",beanDefinition);}@Overridepublic void postProcessBeanFactory(ConfigurableListableBeanFactory configurableListableBeanFactory) throws BeansException {}
}

将MyAppInitializer配置到spring.factories文件中

org.springframework.context.ApplicationContextInitializer=\
com.congge.config.MyAppInitializer

运行main程序，观察控制台输出效果如下，说明OrderService不仅被容器管理，而且顺序在最前面，这就达到了控制bean的顺序的目的。

六、使用场景

到这里，再来看文章开头提出的问题，为什么需要控制spring中bean的加载顺序呢？关于这个问题，这里提出下面的几种常用的场景。

6.1 解决bean的依赖关系

比如在初始化时，配置类B需要用到配置类A中的某些属性，配置类C需要用到B中的某些属性，在这种级联依赖的情形下，为了避免启动过程中依赖的问题导致启动失败，就可以通过控制配置bean的顺序来解决。

6.2 设置某些配置类的优先级最高

比如说，我们有一个商品管理的配置类，需要在项目启动的时候，完成从数据库的数据写入到redis缓存中，并且定时刷新商品数据，并且该类还提供了一个对外访问的static方法，这种场景下，由于对外提供了static方法，其他类可以直接调用它的方法，如果不是最先加载的话，当请求获取商品数据时，商品还没有加载完成，那就就会出现问题。因此就需要保证这个配置bean最先被加载。