https://www.dazhuanlan.com/2019/10/22/5daebc5d16429/

最近在做传统Spring项目到SpringBoot项目迁移过程中,遇到了一些bean加载顺序的问题:
比如一个config中的bean依赖于另一个config中的bean进行初始化,于是查了一些资料,出现了一些新的概念:

  • @Order
  • @AutoConfigureAfter
  • @DependsOn

@Order注解

Before Spring 4.0, the @Order annotation was used only for the AspectJ execution order. It means the highest order advice will run first.

Since Spring 4.0, it supports the ordering of injected components to a collection. As a result, Spring will inject the auto-wired beans of the same type based on their order value.

在Spring 4.0版本之前,@Order注解只能控制AOP的执行顺序,在Spring 4.0之后,它还可以控制集合注入中bean的顺序。
控制AOP顺序很好理解,例如可以在@Aspect注解的切面上加入@Order注解,控制切面的执行顺序。
还有@EnableTransactionManagement(order = 10),这种写法,由于Spring的事务也是用AOP实现,也可以控制优先级。

下面举个例子说明控制集合注入中bean的顺序。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
public interface {
int getRating();
}
 
 
@Order(1)
public class Excellent implements {
 
@Override
public int getRating() {
return 1;
}
}
 
 
@Order(2)
public class Good implements {
 
@Override
public int getRating() {
return 2;
}
}
 
 
@Order(Ordered.LOWEST_PRECEDENCE)
public class Average implements {
 
@Override
public int getRating() {
return 3;
}
}

最后是测试类:

1
2
3
4
5
6
7
8
9
10
11
12
public class RatingRetrieverUnitTest {
 
@Autowired
private List<Rating> ratings;
 
@Test
public void givenOrder_whenInjected_thenByOrderValue() {
assertThat(ratings.get(0).getRating(), is(equalTo(1)));
assertThat(ratings.get(1).getRating(), is(equalTo(2)));
assertThat(ratings.get(2).getRating(), is(equalTo(3)));
}
}

如果不使用@Order注解,那ratings集合可能是乱序的。

有一种错误的用法:
先定义两个service:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
@Service
public class OrderService1 {
private static final Logger LOGGER = LoggerFactory.getLogger(OrderService1.class);
 
public OrderService1() {
LOGGER.info("OrderService1 constructor");
}
 
public String name() {
return "orderService1";
}
}
 
@Service
public class OrderService2 {
private static final Logger LOGGER = LoggerFactory.getLogger(OrderService2.class);
 
public OrderService2() {
LOGGER.info("OrderService2 constructor");
}
 
public String name() {
return "orderService2";
}
}

然后写两个config注入bean:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
@Configuration
@Order(1)
public class OrderService1Config {
private static final Logger LOGGER = LoggerFactory.getLogger(OrderService1Config.class);
 
@Bean
public OrderService1 orderService1() {
LOGGER.info("orderService1 init");
return new OrderService1();
}
}
@Configuration
@Order(0)
public class OrderService2Config {
private static final Logger LOGGER = LoggerFactory.getLogger(OrderService2Config.class);
 
@Bean
public OrderService2 orderService2() {
LOGGER.info("orderService2 init");
return new OrderService2();
}
}

本意是想通过@Order控制bean的注入顺序,先注入orderService2,再注入orderService1。但是并没有效果。
所以,@Order注解放到@Configuration中是无法控制bean的注入顺序的。

@AutoConfigureAfter注解

Hint for that an EnableAutoConfiguration auto-configuration should be applied after other specified auto-configuration classes.

类似的注解还有:

  • @AutoConfigureBefore
  • @AutoConfigureOrder

这三个注解是特地用于autoconfigure类的,不能用于普通的配置类。

有必要先说明一下autoconfigure类项目。

通常我们会在主类入口上标注@SpringBootApplication注解,或者直接标注@EnableAutoConfiguration注解。
这个注解是用来根据类路径中的依赖包猜测需要注入的bean,实现自动注入:

Enable auto-configuration of the Spring Application Context, attempting to guess and configure beans that you are likely to need. Auto-configuration classes are usually applied based on your classpath and what beans you have defined.

可以理解为,@EnableAutoConfiguration是服务于自动注入的bean的,即spring-boot-starter中bean的自动加载顺序。
被排序的这些类,都是通过xxx-spring-boot-autoconfigure项目中的src/resources/META-INF/spring.factories配置文件获取的,这个文件中的配置内容一般为:

1
2
3
# Auto Configure
org.springframework.boot.autoconfigure.EnableAutoConfiguration=
com.github.pagehelper.autoconfigure.PageHelperAutoConfiguration

Spring Boot 只会对从这个文件读取的配置类进行排序。

但是不要以为将自己的配置类也配置在spring.factories中就能实现排序,如果你的类被自己Spring Boot启动类扫描到了,这个类的顺序会优先于所有通过spring.factories读取的配置类。

Auto-configuration is always applied after user-defined beans have been registered.

@DependsOn注解

Beans on which the current bean depends. Any beans specified are guaranteed to be created by the container before this bean.

Used infrequently in cases where a bean does not explicitly depend on another through properties or constructor arguments, but rather depends on the side effects of another bean’s initialization.

May be used on any class directly or indirectly annotated with org.springframework.stereotype.Component or on methods annotated with Bean.

Using DependsOn at the class level has no effect unless component-scanning is being used. If a DependsOn-annotated class is declared via XML, DependsOn annotation metadata is ignored, and is respected instead.

从java doc中可以看出,@DependsOn注解可以用来控制bean的创建顺序,该注解用于声明当前bean依赖于另外一个bean。所依赖的bean会被容器确保在当前bean实例化之前被实例化。
一般用在一个bean没有通过属性或者构造函数参数显式依赖另外一个bean,但实际上会使用到那个bean或者那个bean产生的某些结果的情况。

用法

  • 直接或者间接标注在带有@Component注解的类上面;
  • 直接或者间接标注在带有@Bean注解的方法上面;
  • 使用@DependsOn注解到类层面仅仅在使用 component-scanning 方式时才有效;如果带有@DependsOn注解的类通过XML方式使用,该注解会被忽略,<bean depends-on="..."/>这种方式会生效。

例如,我们有一个FileProcessor依赖于FileReaderFileWriterFileReaderFileWriter需要在FileProcessor之前初始化:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
@Configuration
@ComponentScan("com.baeldung.dependson")
public class Config {
 
@Bean
@DependsOn({"fileReader","fileWriter"})
public FileProcessor fileProcessor(){
return new FileProcessor();
}
 
@Bean("fileReader")
public FileReader fileReader() {
return new FileReader();
}
 
@Bean("fileWriter")
public FileWriter fileWriter() {
return new FileWriter();
}
}

也可以在Component上标注:

1
2
3
 
@DependsOn({"filereader", "fileWriter"})
public class FileProcessor {}

属性注入和构造器注入

上面说到@DependsOn注解时提到,它一般用在一个bean没有通过属性或者构造函数参数显式依赖另外一个bean,但实际上会使用到那个bean或者那个bean产生的某些结果的情况。
如果bean直接依赖于另一个bean,我们可以将其通过属性或者构造函数引入进来。
而使用构造函数的方法显示依赖一个bean,能够保证被依赖的bean先初始化。但是属性注入不可以。

constructor-injection automatically enforces the order and completeness of the instantiated.

因此,我们可以在Component中使用构造函数显示注入依赖的bean:

1
2
3
4
@Autowired
public MyComponent(@Qualifier("jedisTemplateNew") JedisTemplate jedisTemplateNew) {
 
}

注意,需要使用@Qualifier限定bean名称时,不能标注在构造方法上,而是应该标注在参数上。原因跟@Resource不能标注构造方法一样,它不知道你要限定哪个参数。

假设有两个service,OrderService1依赖于OrderService2:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
public class OrderService1 {
private static final Logger LOGGER = LoggerFactory.getLogger(OrderService1.class);
 
private OrderService2 orderService2;
 
public OrderService1(OrderService2 orderService2) {
LOGGER.info("OrderService1 constructor");
this.orderService2 = orderService2;
}
 
public String name() {
String name = orderService2.name();
LOGGER.info("OrderService1 print orderService2 name={}", name);
return "orderService1";
}
}
 
public class OrderService2 {
private static final Logger LOGGER = LoggerFactory.getLogger(OrderService2.class);
 
public OrderService2() {
LOGGER.info("OrderService2 constructor");
}
 
public String name() {
return "orderService2";
}
}

对应的Configuration:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
@Configuration
public class OrderService1Config {
private static final Logger LOGGER = LoggerFactory.getLogger(OrderService1Config.class);
 
@Autowired
private OrderService2Config orderService2Config;
 
@Bean
public OrderService1 orderService1() {
LOGGER.info("orderService1 init");
return new OrderService1(orderService2Config.orderService2());
}
}
 
@Configuration
public class OrderService2Config {
private static final Logger LOGGER = LoggerFactory.getLogger(OrderService2Config.class);
 
@Bean
public OrderService2 orderService2() {
LOGGER.info("orderService2 init");
return new OrderService2();
}
}

输出:

1
2
3
4
c.m.s.config.OrderService1Config : orderService1 init
c.m.s.config.OrderService2Config : orderService2 init
c.m.s.service.OrderService2 : OrderService2 constructor
c.m.s.service.OrderService1 : OrderService1 constructor

可以看出,OrderService2先初始化。

换一种OrderService1写法,使用属性注入:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
public class OrderService1 {
private static final Logger LOGGER = LoggerFactory.getLogger(OrderService1.class);
 
private OrderService2 orderService2;
 
public void setOrderService2(OrderService2 orderService2) {
this.orderService2 = orderService2;
}
 
public OrderService1() {
LOGGER.info("OrderService1 constructor");
}
 
public String name() {
String name = orderService2.name();
LOGGER.info("OrderService1 print orderService2 name={}", name);
return "orderService1";
}
}
 
@Configuration
public class OrderService1Config {
private static final Logger LOGGER = LoggerFactory.getLogger(OrderService1Config.class);
 
@Autowired
private OrderService2Config orderService2Config;
 
@Bean
public OrderService1 orderService1() {
LOGGER.info("orderService1 init");
OrderService1 orderService1 = new OrderService1();
orderService1.setOrderService2(orderService2Config.orderService2());
return orderService1;
}
}

输出:

1
2
3
4
c.m.s.config.OrderService1Config : orderService1 init
c.m.s.service.OrderService1 : OrderService1 constructor
c.m.s.config.OrderService2Config : orderService2 init
c.m.s.service.OrderService2 : OrderService2 constructor

可以看出,OrderService2并没有先初始化。

当然,OrderService1Config也可以使用构造器注入:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
@Configuration
public class OrderService1Config {
private static final Logger LOGGER = LoggerFactory.getLogger(OrderService1Config.class);
 
private final OrderService2Config orderService2Config;
 
@Autowired
public OrderService1Config(OrderService2Config orderService2Config) {
this.orderService2Config = orderService2Config;
}
 
@Bean
public OrderService1 orderService1() {
LOGGER.info("orderService1 init");
OrderService1 orderService1 = new OrderService1();
orderService1.setOrderService2(orderService2Config.orderService2());
return orderService1;
}
}

参考:
@Order in Spring
Controlling Bean Creation Order with @DependsOn Annotation

SpringBoot中的bean加载顺序的更多相关文章

  1. SpringBoot系列教程之Bean加载顺序之错误使用姿势辟谣

    在网上查询 Bean 的加载顺序时,看到了大量的文章中使用@Order注解的方式来控制 bean 的加载顺序,不知道写这些的博文的同学自己有没有实际的验证过,本文希望通过指出这些错误的使用姿势,让观文 ...

  2. 详解web.xml中元素的加载顺序

    一.背景 最近在项目中遇到了启动时出现加载service注解注入失败的问题,后来经过不懈努力发现了是因为web.xml配置文件中的元素加载顺序导致的,那么就抽空研究了以下tomcat在启动时web.x ...

  3. springboot由于bean加载顺序导致的问题

    先记录现象: dubbo整合zipkin时,我的配置文件是这样的 @Bean("okHttpSender") public OkHttpSenderFactoryBean okHt ...

  4. SpringBoot中资源初始化加载的几种方式(看这一片就够了)

    一.问题 在平时的业务模块开发过程中,难免会需要做一些全局的任务.缓存.线程等等的初始化工作,那么如何解决这个问题呢?方法有多种,但具体又要怎么选择呢? 二.资源初始化 1.既然要做资源的初始化,那么 ...

  5. SpringBoot中资源初始化加载的几种方式

    一.问题 在平时的业务模块开发过程中,难免会需要做一些全局的任务.缓存.线程等等的初始化工作,那么如何解决这个问题呢?方法有多种,但具体又要怎么选择呢? 二.资源初始化 1.既然要做资源的初始化,那么 ...

  6. 【spring】bean加载顺序

    问题来源 有一个bean为A,一个bean为B.想要A在容器实例化的时候的一个属性name赋值为B的一个方法funB的返回值. 如果只是在A里单纯的写着: private B b; private S ...

  7. 服务器启动时Webapp的web.xml中配置的加载顺序

    一 1.启动一个WEB项目的时候,WEB容器会去读取它的配置文件web.xml,读取<listener>和<context-param>两个结点. 2.紧急着,容创建一个Ser ...

  8. 服务器启动时Webapp的web.xml中配置的加载顺序(转载)

    一 1.启动一个WEB项目的时候,WEB容器会去读取它的配置文件web.xml,读取<listener>和<context-param>两个结点. 2.紧急着,容创建一个Ser ...

  9. 「快学SpringBoot」配置文件的加载顺序和配置项默认值设置

    前言 有的时候,配置信息是我们无法在开发过程中就能确定的.比如,给客户开发的项目,客户需要根据自身的情况自定义配置,如数据库配置,加密密钥配置等等.这时候,就需要把配置文件放在外面,让用户自定义配置部 ...

随机推荐

  1. 吴裕雄--天生自然HADOOP操作实验学习笔记:使用hive操作hbase

    实验目的 熟悉hive和hbase的操作 熟悉hadoop.hbase.hive.zookeeper的关系 熟练大数据环境的搭建 学会分析日志排除问题 实验原理 1.hive整合hbase原理 前面大 ...

  2. python线程的条件变量Condition的用法实例

      Condition 对象就是条件变量,它总是与某种锁相关联,可以是外部传入的锁或是系统默认创建的锁.当几个条件变量共享一个锁时,你就应该自己传入一个锁.这个锁不需要你操心,Condition 类会 ...

  3. 获取WEB图片

    public string GetJpgFile(string strFileServerPath ,string strReportDir) { string strPath = "&qu ...

  4. srpingboot web - 启动(3) 监听器

    接上一篇 一. getRunListeners() 在run() 方法中调用了 getRunListeners(args) 方法, 先看一下这个方法干了什么 private SpringApplica ...

  5. SQL Server误设置max server memory处理小结

    昨天网上一网友说,由于他同事误将"max server memory"设置为10M后,SQL Server数据库登录不了,当时我简单测试了一下,今天有空就顺手将整个过程整理一下,记 ...

  6. gulp常用插件之http-proxy-middleware使用

    更多gulp常用插件使用请访问:gulp常用插件汇总 http-proxy-middleware这是一个用于后台将请求转发给其它服务器.其实这并不是转给gulp使用的,在其它构建工具也可以用. 更多使 ...

  7. bugku-求getshell(文件上传)

    这道题最主要是考的Content-type参数绕过WAF,然后利用绕过黑名单上传php进行解析. 先上传一个phpinfo()的php文件试试,burp抓包 正常操作,先将下面文件的类型改为:imag ...

  8. Qt Gui 第五章绘图类

    双缓冲 void Plotter::refreshPixmap() { pixmap = QPixmap(size()); pixmap.fill(, ); QPainter painter(& ...

  9. (备份)找回 Chrome 配置

    C:\Users\xiaogezi.cn\AppData\Local\Google\Chrome\User Data\Default\ 将 Preferences 文件复制到别的地方,用于备份: 将 ...

  10. Java体系结构

    java程序运行过程图 文章中内容大多来自该处Java虚拟机规范----JVM体系结构 - Java初级码农 - 博客园 JDK体系 JDK体系结构图 JDK.JRE.JVM之间的关系 JDK:Jav ...