Spring Aware接口详解

Spring Aware接口详解
若 Spring 检测到 bean 实现了 Aware 接口,则会为其注入相应的依赖。所以通过让bean 实现 Aware 接口,则能在 bean 中获得相应的 Spring 容器资源。
 
Spring 中提供的 Aware 接口有:
 
BeanNameAware:注入当前 bean 对应 beanName
 
BeanClassLoaderAware:注入加载当前 bean 的 ClassLoader
 
BeanFactoryAware:注入 当前BeanFactory容器 的引用
 
BeanNameAware和BeanFactoryAware都属于org.springframework.beans.factory.Aware根标记接口。
 
其使用setter注入来在应用程序上下文启动期间获取对象。
 
Aware接口是回调,监听器和观察者设计模式的混合,它表示bean有资格通过回调方式被Spring容器通知。
 
1 BeanNameAware
 
使对象能够知道容器中定义的bean名称。
 
public class MyBeanName implements BeanNameAware {
 
    @Override
 
    public void setBeanName(String beanName) {
 
        System.out.println(beanName);
 
    }
 
}
 
beanName属性表示在Spring容器中注册的bean id,在我们的实现中,只是显示bean名称。
 
在Spring配置类中注册这种类型的bean:
 
@Configuration
 
public class Config {
 
    @Bean(name = "myCustomBeanName")
 
    public MyBeanName getMyBeanName() {
 
        return new MyBeanName();
 
    }
 
 
启动应用程序上下文并从中获取bean:
 
AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext(Config.class);
 
MyBeanName myBeanName = context.getBean(MyBeanName.class); 
 
setBeanName方法打印出了“myCustomBeanName”。
 
若从@Bean注解中删除name =“…”代码,则在这种情况下,将getMyBeanName()方法名称分配给bean,所以输出将是“getMyBeanName”。
 
2 BeanFactoryAware
 
用于注入BeanFactory对象,就能访问创建对象的BeanFactory。
 
public class MyBeanFactory implements BeanFactoryAware {
 
    private BeanFactory beanFactory;
 
    @Override
 
    public void setBeanFactory(BeanFactory beanFactory) throws BeansException {
 
        this.beanFactory = beanFactory;
 
    }
 
    public void getMyBeanName() {
 
        MyBeanName myBeanName = beanFactory.getBean(MyBeanName.class);
 
        System.out.println(beanFactory.isSingleton("myCustomBeanName"));
 
    }
 
}
 
在setBeanFactory()方法的帮助下,我们将IoC容器中的BeanFactory引用分配给beanFactory属性。
 
然后,我们可以像在getMyBeanName()函数中一样直接使用它。
 
初始化MyBeanFactory并调用getMyBeanName()方法:
 
MyBeanFactory myBeanFactory = context.getBean(MyBeanFactory.class);
 
myBeanFactory.getMyBeanName();
 
由于我们已经在前面的示例中实例化了MyBeanName类,因此Spring将在此处调用现有实例。
 
3 适用场景
 
获取bean名称以进行日志记录或埋点,对于BeanFactoryAware,它可以使用扩展代码中的spring bean。
 
大多数情况下,应避免使用任何Aware接口,因为实现这些接口会将代码耦合到Spring框架。

推荐阅读