这篇文章主要为大家详细介绍Spring如何控制Bean注入的顺序,其中续注意的是在Bean上加@Order(xxx)是无法控制bean注入的顺序的,需要的可以参考一下
简介
控制bean的加载顺序的方法
- 构造方法依赖
- @DependsOn 注解
- BeanPostProcessor 扩展
- 注册
ApplicationContextInitializer
,跟3类似
Bean初始化顺序与类加载顺序基本一致:静态变量/语句块=> 实例变量或初始化语句块=> 构造方法=> @Autowirebean注入的顺序
构造方法依赖(推荐)
创建两个Bean,要求CDemo2在CDemo1之前被初始化。
@Component
public class CDemo1 {
private String name = "cdemo 1";
public CDemo1(CDemo2 cDemo2) {
System.out.println(name);
}
}
@Component
public class CDemo2 {
private String name = "cdemo 2";
public CDemo2() {
System.out.println(name);
}
}
结果(和预期一致)
限制
要有注入关系,如:CDemo2通过构造方法注入到CDemo1中,若需要指定两个没有注入关系的bean之间优先级,则不太合适(比如我希望某个bean在所有其他的Bean初始化之前执行)
循环依赖问题,如过上面的CDemo2的构造方法有一个CDemo1参数,那么循环依赖产生,应用无法启动
另外一个需要注意的点是,在构造方法中,不应有复杂耗时的逻辑,会拖慢应用的启动时间
@DependsOn(不推荐)
不推荐的原因:这种方法是通过bean的名字(字符串)来控制顺序的,如果改了bean的类名,很可能就会忘记来改所有用到它的注解,那就问题大了。
当一个bean需要在另一个bean实例化之后再实例化时,可使用这个注解。
@DependsOn("rightDemo2")
@Component
public class RightDemo1 {
private String name = "right demo 1";
public RightDemo1() {
System.out.println(name);
}
}
@Component
public class RightDemo2 {
private String name = "right demo 2";
public RightDemo2() {
System.out.println(name);
}
}
上面的注解放在 RightDemo1 上,表示RightDemo1的初始化依赖于rightDemo2这个bean
它能控制bean的实例化顺序,但是bean的初始化操作(如构造bean实例之后,调用@PostConstruct注解的初始化方法)顺序则不能保证,比如我们下面的一个实例,可以说明这个问题
@DependsOn("rightDemo2")
@Component
public class RightDemo1 {
private String name = "right demo 1";
@Autowired
private RightDemo2 rightDemo2;
public RightDemo1() {
System.out.println(name);
}
@PostConstruct
public void init() {
System.out.println(name + " _init");
}
}
@Component
public class RightDemo2 {
private String name = "right demo 2";
@Autowired
private RightDemo1 rightDemo1;
public RightDemo2() {
System.out.println(name);
}
@PostConstruct
public void init() {
System.out.println(name + " _init");
}
}
结果(先实例的Bean反而在后边执行init)
把上面测试代码中的@Autowired的依赖注入删除,即两个bean没有相互注入依赖,再执行,会发现输出顺序又不一样
BeanPostProcessor(不推荐)
一种非典型的使用方式,如非必要,请不要用这种方式来控制bean的加载顺序。
场景1:希望HDemo2在HDemo1之前被加载
@Component
public class HDemo1 {
private String name = "h demo 1";
public HDemo1() {
System.out.println(name);
}
}
@Component
public class HDemo2 {
private String name = "h demo 2";
public HDemo2() {
System.out.println(name);
}
}
将目标集中在postProcessBeforeInstantiation,这个方法在某个bean的实例化之前,会被调用,这就给了我们控制bean加载顺序的机会。
执行结果
场景2:希望某个bean在应用启动之后,首先实例化此Bean。
解决方法:重写DemoBeanPostProcessor的postProcessAfterInstantiation方法。
@Component
public class DemoBeanPostProcessor extends InstantiationAwareBeanPostProcessorAdapter
implements BeanFactoryAware {
private ConfigurableListableBeanFactory beanFactory;
@Override
public boolean postProcessAfterInstantiation(Object bean, String beanName) throws BeansException {
if ("application".equals(beanName)) {
beanFactory.getBean(FDemo.class);
}
return true;
}
}
@DependsOn("HDemo")
@Component
public class FDemo {
private String name = "F demo";
public FDemo() {
System.out.println(name);
}
}
@Component
public class HDemo {
private String name = "H demo";
public HDemo() {
System.out.println(name);
}
}
执行结果(HDemo, FDemo的实例化顺序放在了最前面)
注册ApplicationContextInitializer
第一步:通过 spring.factories 扩展来注册一个 ApplicationContextInitializer:
org.springframework.context.ApplicationContextInitializer=com.antbank.demo.bootstrap.MyApplicationContextInitializer
public class MyApplicationContextInitializer implements ApplicationContextInitializer<ConfigurableApplicationContext> {
@Override
public void initialize(ConfigurableApplicationContext applicationContext) {
// 注意,如果你同时还使用了 spring cloud,这里需要做个判断,要不要在 spring cloud applicationContext 中做这个事
// 通常 spring cloud 中的 bean 都和业务没关系,是需要跳过的
applicationContext.addBeanFactoryPostProcessor(new MyBeanDefinitionRegistryPostProcessor());
}
}
除了使用 spring 提供的 SPI 来注册 ApplicationContextInitializer
,你也可以用 SpringApplication.addInitializers
的方式直接在 main 方法中直接注册一个 ApplicationContextInitializer 结果都是可以的:
@SpringBootApplication
public class SpringBootDemoApplication {
public static void main(String[] args) {
SpringApplication application = new SpringApplication(SpringBootDemoApplication.class);
// 通过 SpringApplication 注册 ApplicationContextInitializer
application.addInitializers(new MyApplicationContextInitializer());
application.run(args);
}
}
当然了,通过 Spring 的事件机制也可以做到注册 BeanDefinitionRegistryPostProcessor
,选择实现合适的 ApplicationListener
事件,可以通过 ApplicationContextEvent
获得 ApplicationContext
,即可注册 BeanDefinitionRegistryPostProcessor
,这里就不多展开了。
这里需要注意一点,为什么需要用 ApplicationContextInitializer
来注册 BeanDefinitionRegistryPostProcessor
,能不能用 @Component
或者其他的注解的方式注册?
答案是不能的。@Component
注解的方式注册能注册上的前提是能被 ConfigurationClassPostProcessor
扫描到,也就是说用 @Component
注解的方式来注册,注册出来的 Bean 一定不可能排在 ConfigurationClassPostProcessor
前面,而我们的目的就是在所有的 Bean 扫描前注册你需要的 Bean,这样才能排在其他所有 Bean 前面,所以这里的场景下是不能用注解注册的,这点需要额外注意。
第二步:实现 BeanDefinitionRegistryPostProcessor,注册目标 bean:
用 MyBeanDefinitionRegistryPostProcessor
在 ConfigurationClassPostProcessor
扫描前注册你需要的目标 bean 的 BeanDefinition 即可。
public class MyBeanDefinitionRegistryPostProcessor implements BeanDefinitionRegistryPostProcessor {
@Override
public void postProcessBeanDefinitionRegistry(BeanDefinitionRegistry registry) throws BeansException {
// 手动注册一个 BeanDefinition,DemoB为2需要优先加载的bean
registry.registerBeanDefinition("DemoB", new RootBeanDefinition(DemoB.class));
}
@Override
public void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory) throws BeansException {}
}
当然你也可以使用一个类同时实现 ApplicationContextInitializer
和BeanDefinitionRegistryPostProcessor
通过 applicationContext#addBeanFactoryPostProcessor 注册的 BeanDefinitionRegistryPostProcessor
,比 Spring 自带的优先级要高,所以这里就不需要再实现 Ordered 接口提升优先级就可以排在 ConfigurationClassPostProcessor
前面: