Spring高级之注解@DependsOn详解（超详细）

Posted 2021-12-13 Firm陈

定义/作用
@DependsOn注解可以定义在类和方法上，意思是我这个组件要依赖于另一个组件，也就是说被依赖的组件会比该组件先注册到IOC容器中。

使用场景：
需要用到观察者模式的情况下通常都需要用到该注解，观察者模式（详细可查看相关文章）有三要素，观察者、事件源、事件，机制是观察者会监听数据源的某些时间，当事件源触发该事件后，观察者就会知道进行相应措施。

比如老师是观察者，学生是事件源，学生迟到是事件，老师观察学生是否迟到，每当学生迟到，老师就会发现，并处罚该学生。

这类场景一般需要观察者要比事件源先创建，才能不遗漏事件源触发的每一个事件，要是事件源先创建，可能会在观察者创建前就触发了事件而观察者无法知道。

比如上述例子，八点算迟到，但是老师自己都八点半才到学校，所以就无法知道八点到八点半之间迟到的学生。

源码：

//可以作用在方法和类上。
//当作用在类上时，通常会与@Component及其衍生注解等注解配合使用。
//当作用在方法上时，通常会与@Bean注解配合使用。
@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface DependsOn {
	//要依赖的bean id，是个数组，也就是说可以依赖多个bean。
	//效果是该注解作用的bean会比value设置的依赖bean晚实例化到容器中。
    String[] value() default {};
}

demo（与@Component配合使用）

/**
 * 事件源
 */
@Component
public class EventSource {
    public EventSource(){
        System.out.println("事件源创建");
    }
}

/**
 * 监听类
 */
@Component
public class EventTListener {

    public EventTListener(){
        System.out.println("监听器创建");
    }
}

//测试类：
@Configuration
@ComponentScan(basePackages = "dependsondemo")
public class SpringConfig {
}

结果：


分析：因为spring默认扫描包时会根据文件在文件夹的位置先后顺序扫描加载，而EventSource 文件位置在EventTListener前面，所以会先加载EventSource 事件源组件。这不符合逻辑。
使用@DependsOn注解：

@Component
@DependsOn(value = {"eventTListener"})
public class EventSource {
    public EventSource(){
        System.out.println("事件源创建");
    }
}

结果：

监听器先创建了。value属性的bean id必须存在，不然会报错。

demo（与Bean注解配合使用）

//要把上面两个组件类上的注解去掉，再使用下面

@Configuration
@ComponentScan(basePackages = "dependsondemo")
public class SpringConfig {

    @Bean
    @DependsOn(value = {"eventListener"})
    public EventSource eventSource(){
        return new EventSource();
    }

    @Bean
    public EventTListener eventListener(){
        return new EventTListener();
    }
}

结果：
如果不加@DependsOn注解的话，就会先创建事件源，如果加了（如上代码），就会先创建监听器。