Spring复杂的BeanFactory继承体系该如何理解? ----中

Posted 大忽悠爱忽悠

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了Spring复杂的BeanFactory继承体系该如何理解? ----中相关的知识,希望对你有一定的参考价值。

Spring复杂的BeanFactory继承体系该如何理解? ----中


上篇连接:

Spring复杂的BeanFactory继承体系该如何理解? ----上

本系列重点不在于对源码的讲解,而在于让大家认识到spring为什么这样设计,重在思想的传递


了解Bean的一生

在已经可以借助于BeanFactoryPostProcessor来干预Magic实现的第一个阶段(容器启动阶段)活动之后,我们就可以开始探索下一个阶段,即bean实例化阶段的实现逻辑了。

容器启动之后,并不会马上就实例化相应的bean定义。

我们知道,容器现在仅仅拥有所有对象的BeanDefinition来保存实例化阶段将要用的必要信息。只有当请求方通过BeanFactory的getBean()
方法来请求某个对象实例的时候,才有可能触发Bean实例化阶段的活动。

BeanFactory的getBean()方法可以被客户端对象显式调用,也可以在容器内部隐式地被调用。隐式调用有如下两种情况。

  • 对于BeanFactory来说,对象实例化默认采用延迟初始化。通常情况下,当对象A被请求而需要第一次实例化的时候,如果它所依赖的对象B之前同样没有被实例化,那么容器会先实例化对象A所依赖的对象。这时容器内部就会首先实例化对象B,以及对象 A依赖的其他还没有被实例化的对象。这种情况是容器内部调用getBean(),对于本次请求的请求方是隐式的。
  • ApplicationContext启动之后会实例化所有的bean定义,这个特性在本书中已经多次提到。但ApplicationContext在实现的过程中依然遵循Spring容器实现流程的两个阶段,只不过它会在启动阶段的活动完成之后,紧接着调用注册到该容器的所有bean定义的实例化方法
    getBean()。这就是为什么当你得到ApplicationContext类型的容器引用时,容器内所有对象已经被全部实例化完成。不信你查一下类org.springframework.context.support. AbstractApplicationContext的refresh()方法。

之所以说getBean()方法是有可能触发Bean实例化阶段的活动,是因为只有当对应某个bean定义的getBean()方法第一次被调用时,不管是显式的还是隐式的,Bean实例化阶段的活动才会被触发,第二次被调用则会直接返回容器缓存的第一次实例化完的对象实例(prototype类型bean除外)。

当getBean()方法内部发现该bean定义之前还没有被实例化之后,会通过createBean()方法来进行具体的对象实例化,实例化过程如图所示。


Spring容器将对其所管理的对象全部给予统一的生命周期管理,这些被管理的对象完全摆脱了原来那种“new完后被使用,脱离作用域后即被回收”的命运。下面我们将详细看一看现在的每个bean在容器中是如何走过其一生的。

提示 可以在org.springframework.beans.factory.support.AbstractBeanFactory类的代码中查看到getBean()方法的完整实现逻辑,可以在其子类org.springframework.beans. factory.support.AbstractAutowireCapableBeanFactory的代码中一窥createBean()方法的全貌。


1. Bean的实例化与BeanWrapper

容器在内部实现的时候,采用“策略模式(Strategy Pattern)”来决定采用何种方式初始化bean实例。通常,可以通过反射或者CGLIB动态字节码生成来初始化相应的bean实例或者动态生成其子类。

org.springframework.beans.factory.support.InstantiationStrategy定义是实例化策略的抽象接口,其直接子类SimpleInstantiationStrategy实现了简单的对象实例化功能,可以通过反射来实例化对象实例,但不支持方法注入方式的对象实例化。

CglibSubclassingInstantiationStrategy继承了SimpleInstantiationStrategy的以反射方式实例化对象的功能,并且通过CGLIB的动态字节码生成功能,该策略实现类可以动态生成某个类的子类,进而满足了方法注入所需的对象实例化需求。

默认情况下,容器内部采用的是CglibSubclassingInstantiationStrategy。

容器只要根据相应bean定义的BeanDefintion取得实例化信息,结合CglibSubclassingInstantiationStrategy以及不同的bean定义类型,就可以返回实例化完成的对象实例。

但是,返回方式上有些“点缀”。不是直接返回构造完成的对象实例,而是以BeanWrapper对构造完成的对象实例进行包裹,返回相应的BeanWrapper实例

至此,第一步结束。


BeanWrapper接口通常在Spring框架内部使用,它有一个实现类org.springframework.beans. BeanWrapperImpl其作用是对某个bean进行“包裹”,然后对这个“包裹”的bean进行操作,比如设置或者获取bean的相应属性值。而在第一步结束后返回BeanWrapper实例而不是原先的对象实例,就是为了第二步“设置对象属性”

BeanWrapper定义继承了org.springframework.beans.PropertyAccessor接口,可以以统一的方式对对象属性进行访问;BeanWrapper定义同时又直接或者间接继承了PropertyEditorRegistry和TypeConverter接口。

不知你是否还记得CustomEditorConfigurer?

当把各种PropertyEditor注册给容器时,知道后面谁用到这些PropertyEditor吗?

对,就是BeanWrapper!在第一步构造完成对象之后,Spring会根据对象实例构造一个BeanWrapperImpl实例,然后将之前CustomEditorConfigurer注册的PropertyEditor复制一份给BeanWrapperImpl实例(这就是BeanWrapper同时又是PropertyEditorRegistry的原因)。

这样,当BeanWrapper转换类型、设置对象属性值时,就不会无从下手了。

使用BeanWrapper对bean实例操作很方便,可以免去直接使用Java反射API(Java Reflection API) 操作对象实例的烦琐。来看一段代码,之后我们就会更加清楚Spring容器内部是如何设置对象属性的了!

使用BeanWrapper操作对象

Object provider = Class.forName("package.name.FXNewsProvider").newInstance(); 
Object listener = Class.forName("package.name.DowJonesNewsListener").newInstance(); 
Object persister = Class.forName("package.name.DowJonesNewsPersister").newInstance(); 

BeanWrapper newsProvider = new BeanWrapperImpl(provider);  
newsProvider.setPropertyValue("newsListener", listener); 
newsProvider.setPropertyValue("newPersistener", persister); 

assertTrue(newsProvider.getWrappedInstance() instanceof FXNewsProvider); 
assertSame(provider, newsProvider.getWrappedInstance()); 
assertSame(listener, newsProvider.getPropertyValue("newsListener")); 
assertSame(persister, newsProvider.getPropertyValue("newPersistener")); 

我想有了BeanWrapper的帮助,你不会想直接使用Java反射API来做同样事情的。下面演示了同样的功能,即直接使用Java反射API是如何实现的(忽略了异常处理相关代码)。

直接使用Java反射API操作对象

Object provider = Class.forName("package.name.FXNewsProvider").newInstance(); 
Object listener = Class.forName("package.name.DowJonesNewsListener").newInstance(); 
Object persister = Class.forName("package.name.DowJonesNewsPersister").newInstance(); 

Class providerClazz = provider.getClass(); 
Field listenerField = providerClazz.getField("newsListener"); 
listenerField.set(provider, listener); 
Field persisterField = providerClazz.getField("newsListener"); 
persisterField.set(provider, persister); 

assertSame(listener, listenerField.get(provider)); 
assertSame(persister, persisterField.get(provider)); 

如果你觉得没有太大差别,那是因为没有看到紧随其后的那些异常(exception)还有待处理!


2. 各色的Aware接口

当对象实例化完成并且相关属性以及依赖设置完成之后,Spring容器会检查当前对象实例是否实现了一系列的以Aware命名结尾的接口定义。

如果是,则将这些Aware接口定义中规定的依赖注入给当前对象实例。

这些Aware接口为如下几个。

  • org.springframework.beans.factory.BeanNameAware。如果Spring容器检测到当前对象实例实现了该接口,会将该对象实例的bean定义对应的beanName设置到当前对象实例。
  • org.springframework.beans.factory.BeanClassLoaderAware。如果容器检测到当前对象实例实现了该接口,会将对应加载当前bean的Classloader注入当前对象实例。默认会使用加载org.springframework.util.ClassUtils类的Classloader。
  • org.springframework.beans.factory.BeanFactoryAware。在介绍方法注入的时候,我们提到过使用该接口以便每次获取prototype类型bean的不同实例。如果对象声明实现了BeanFactoryAware接口,BeanFactory容器会将自身设置到当前对象实例。这样,当前对象
    实例就拥有了一个BeanFactory容器的引用,并且可以对这个容器内允许访问的对象按照需要进行访问。

以上几个Aware接口只是针对BeanFactory类型的容器而言,对于ApplicationContext类型的容器,也存在几个Aware相关接口。

不过在检测这些接口并设置相关依赖的实现机理上,与以上几个接口处理方式有所不同,使用的是下面将要说到的BeanPostProcessor方式。不过,设置Aware接口这一步与BeanPostProcessor是相邻的,把这几个接口放到这里一起提及,也没什么不可以的。

对于ApplicationContext类型容器,容器在这一步还会检查以下几个Aware接口并根据接口定义设置相关依赖。

  • org.springframework.context.ResourceLoaderAware 。 ApplicationContext 实现了Spring的ResourceLoader接口(后面会提及详细信息)。当容器检测到当前对象实例实现了ResourceLoaderAware接口之后,会将当前ApplicationContext自身设置到对象实例,这样
    当前对象实例就拥有了其所在ApplicationContext容器的一个引用。
  • org.springframework.context.ApplicationEventPublisherAware。ApplicationContext作为一个容器,同时还实现了ApplicationEventPublisher接口,这样,它就可以作为ApplicationEventPublisher来使用。所以,当前ApplicationContext容器如果检测到当前实例化的对象实例声明了ApplicationEventPublisherAware接口,则会将自身注入当前对象。
  • org.springframework.context.MessageSourceAware。ApplicationContext通过MessageSource接口提供国际化的信息支持,即I18n(Internationalization)。它自身就实现了MessageSource接口,所以当检测到当前对象实例实现了MessageSourceAware接口,则会将自身注入当前对象实例。
  • org.springframework.context.ApplicationContextAware。 如果ApplicationContext容器检测到当前对象实现ApplicationContextAware接口,则会将自身注入当前对象实例。

3.BeanPostProcessor

BeanPostProcessor的概念容易与BeanFactoryPostProcessor的概念混淆。但只要记住BeanPostProcessor是存在于对象实例化阶段,而BeanFactoryPostProcessor则是存在于容器启动阶段,这两个概念就比较容易区分了。

与BeanFactoryPostProcessor通常会处理容器内所有符合条件的BeanDefinition类似,BeanPostProcessor会处理容器内所有符合条件的实例化后的对象实例。该接口声明了两个方法,分别在两个不同的时机执行,见如下代码定义:

public interface BeanPostProcessor
 
 Object postProcessBeforeInitialization(Object bean, String beanName) throws BeansException; 
 Object postProcessAfterInitialization(Object bean, String beanName) throws BeansException; 

postProcessBeforeInitialization()方法是BeanPostProcessor前置处理这一步将会执行的方法,postProcessAfterInitialization()则是对应BeanPostProcessor后置处理那一步将会执行的方法。

BeanPostProcessor的两个方法中都传入了原来的对象实例的引用,这为我们扩展容器的对象实例化过程中的行为提供了极大的便利,我
们几乎可以对传入的对象实例执行任何的操作。


通常比较常见的使用BeanPostProcessor的场景,是处理标记接口实现类,或者为当前对象提供代理实现。

ApplicationContext对应的那些Aware接口实际上就是通过BeanPostProcessor的方式进行处理的。

当ApplicationContext中每个对象的实例化过程走到BeanPostProcessor前置处理这一步时,ApplicationContext容器会检测到之前注册到容器的ApplicationContextAwareProcessor这个BeanPostProcessor的实现类,然后就会调用其postProcessBeforeInitialization()方法,检查并设置Aware相关依赖。

ApplicationContextAwareProcessor的postProcessBeforeInitialization()代码很简单明了。

postProcessBeforeInitialization方法定义

class ApplicationContextAwareProcessor implements BeanPostProcessor 
    private final ConfigurableApplicationContext applicationContext;
    private final StringValueResolver embeddedValueResolver;

    public ApplicationContextAwareProcessor(ConfigurableApplicationContext applicationContext) 
        this.applicationContext = applicationContext;
        this.embeddedValueResolver = new EmbeddedValueResolver(applicationContext.getBeanFactory());
    

    @Nullable
    public Object postProcessBeforeInitialization(Object bean, String beanName) throws BeansException 
        if (!(bean instanceof EnvironmentAware) && !(bean instanceof EmbeddedValueResolverAware) && !(bean instanceof ResourceLoaderAware) && !(bean instanceof ApplicationEventPublisherAware) && !(bean instanceof MessageSourceAware) && !(bean instanceof ApplicationContextAware) && !(bean instanceof ApplicationStartupAware)) 
            return bean;
         else 
            AccessControlContext acc = null;
            if (System.getSecurityManager() != null) 
                acc = this.applicationContext.getBeanFactory().getAccessControlContext();
            

            if (acc != null) 
                AccessController.doPrivileged(() -> 
                    this.invokeAwareInterfaces(bean);
                    return null;
                , acc);
             else 
                this.invokeAwareInterfaces(bean);
            

            return bean;
        
    

    private void invokeAwareInterfaces(Object bean) 
        if (bean instanceof EnvironmentAware) 
            ((EnvironmentAware)bean).setEnvironment(this.applicationContext.getEnvironment());
        

        if (bean instanceof EmbeddedValueResolverAware) 
            ((EmbeddedValueResolverAware)bean).setEmbeddedValueResolver(this.embeddedValueResolver);
        

        if (bean instanceof ResourceLoaderAware) 
            ((ResourceLoaderAware)bean).setResourceLoader(this.applicationContext);
        

        if (bean instanceof ApplicationEventPublisherAware) 
            ((ApplicationEventPublisherAware)bean).setApplicationEventPublisher(this.applicationContext);
        

        if (bean instanceof MessageSourceAware) 
            ((MessageSourceAware)bean).setMessageSource(this.applicationContext);
        

        if (bean instanceof ApplicationStartupAware) 
            ((ApplicationStartupAware)bean).setApplicationStartup(this.applicationContext.getApplicationStartup());
        

        if (bean instanceof ApplicationContextAware) 
            ((ApplicationContextAware)bean).setApplicationContext(this.applicationContext);
        

    


除了检查标记接口以便应用自定义逻辑,还可以通过BeanPostProcessor对当前对象实例做更多的处理。比如替换当前对象实例或者字节码增强当前对象实例等。Spring的AOP则更多地使用BeanPostProcessor来为对象生成相应的代理对象,如org.springframework.aop.framework. autoproxy.BeanNameAutoProxyCreator。我们将在Spring AOP部分详细介绍该类和AOP相关概念。


BeanPostProcessor是容器提供的对象实例化阶段的强有力的扩展点。为了进一步演示它的强大威力,我们有必要实现一个自定义的BeanPostProcessor。

自定义BeanPostProcessor

假设系统中所有的DowJonesNewsListener类需要从某个位置取得相应的服务器连接密码,而且系统中保存的密码是加密的,那么在DowJonesNewsListener发送这个密码给新闻服务器进行连接验证的时候,首先需要对系统中取得的密码进行解密,然后才能发送。我们将采用BeanPostProcessor技术,对所有的DowJonesNewsListener 的实现类进行统一的解密操作。

(1) 标注需要进行解密的实现类

为了能够识别那些需要对服务器连接密码进行解密的IFXNewsListener实现,我们声明了接口PasswordDecodable,并要求相关IFXNewsListener实现类实现该接口。

PasswordDecodable接口声明以及相关的IFXNewsListener实现类定义见代码。

PasswordDecodable接口声明以及相关的IFXNewsListener实现类

public interface PasswordDecodable  
 String getEncodedPassword(); 
 void setDecodedPassword(String password); 
 

public class DowJonesNewsListener implements PasswordDecodable  
 private String password; 

 public String getEncodedPassword()  
 return this.password; 
  
 public void setDecodedPassword(String password)  
 this.password = password; 
  
 

(2) 实现相应的BeanPostProcessor对符合条件的Bean实例进行处理

public class PasswordDecodePostProcessor implements BeanPostProcessor 
    @Override
    public Object postProcessBeforeInitialization(Object bean, String beanName) throws BeansException 
        return bean;
    

    @Override
    public Object postProcessAfterInitialization(Object bean, String beanName) throws BeansException 
        if (bean instanceof PasswordDecodable) 
            //获取加密后的密码
            String encodedPassword = ((PasswordDecodable) bean).getEncodedPassword();
            //进行解密
            String decodedPassword = decodePassword(encodedPassword);
            //设置解密后的密码
            ((PasswordDecodable) bean).setDecodedPassword(decodedPassword);
        
        return bean;
    

    private String decodePassword(String encodedPassword) 
        // 实现解码逻辑  
        return "解密后的密码: " + encodedPassword;
    

(3) 将自定义的BeanPostProcessor注册到容器

只有将自定义的BeanPostProcessor实现类告知容器,容器才会在合适的时机应用它。所以,我们需要将PasswordDecodePostProcessor注册到容器。

ConfigurableBeanFactory beanFactory = new XmlBeanFactory(new ClassPathResource(...)); 
beanFactory.addBeanPostProcessor(new PasswordDecodePostProcessor()); 
... 
// getBean(); 

对于ApplicationContext容器来说,事情则方便得多,直接将相应的BeanPostProcessor实现类通过通常的XML配置文件配置一下即可。

ApplicationContext容器会自动识别并加载注册到容器的BeanPostProcessor,如下配置内容将我们的PasswordDecodePostProcessor注册到容器:

<beans> 
 <bean id="passwordDecodePostProcessor" class="package.name.PasswordDecodePostProcessor"> 
 <!--如果需要,注入必要的依赖--> 
 </bean>  
 ... 
 </beans> 

合理利用BeanPostProcessor这种Spring的容器扩展机制,将可以构造强大而灵活的应用系统。


提示

实际上,有一种特殊类型的BeanPostProcessor我们没有提到,它的执行时机与通常的BeanPostProcessor不同。

org.springframework.beans.factory.config.InstantiationAwareBeanPostProcessor接口可以在对象的实例化过程中导致某种类似于电路“短路”的效果。

实际上,并非所有注册到Spring容器内的bean定义都是按照上图的流程实例化的。

在所有的步骤之前,也就是实例化bean对象步骤之前,容器会首先检查容器中是否注册有InstantiationAwareBeanPostProcessor类型的BeanPostProcessor

如果有,首先使用相应的InstantiationAwareBeanPostProcessor来构造对象实例。构造成功后直接返回构造完成的对象实例,而不会按照“正规的流程”继续执行。这就是它可能造成“短路”的原因。

不过,通常情况下都是Spring容器内部使用这种特殊类型的BeanPostProcessor做一些动态对象代理等工作,我们使用普通的BeanPostProcessor实现就可以。

这里简单提及一下,目的是让大家有所了解。


4. InitializingBean和init-method

org.springframework.beans.factory.InitializingBean是容器内部广泛使用的一个对象生命周期标识接口,其定义如下:

public interface InitializingBean 
    void afterPropertiesSet() throws Exception;

该接口定义很简单,其作用在于,在对象实例化过程调用过“BeanPostProcessor的前置处理” 之后,会接着检测当前对象是否实现了InitializingBean接口,如果是,则会调用其afterPropertiesSet()方法进一步调整对象实例的状态。

比如,在有些情况下,某个业务对象实例化完成后,还不能处于可以使用状态。这个时候就可以让该业务对象实现该接口,并在方法afterPropertiesSet()中完成对该业务对象的后续处理。

虽然该接口在Spring容器内部广泛使用,但如果真的让我们的业务对象实现这个接口,则显得Spring容器比较具有侵入性。所以,Spring还提供了另一种方式来指定自定义的对象初始化操作,那就是在XML配置的时候,使用的init-method属性。

通过init-method,系统中业务对象的自定义初始化操作可以以任何方式命名,而不再受制于InitializingBean的afterPropertiesSet()。如果系统开发过程中规定:所有业务对象的自定义初始化操作都必须以init()命名,为了省去挨个< bean >的设置init-method这样的烦琐,我们还可以通过最顶层的< beans >的default-init-method统一指定这一init()方法名。

可以认为在InitializingBean和init-method中任选其一就可以帮你完成类似的初始化工作。除非……,除非你真的那么“幸运”,居然需要在同一个业务对象上按照先后顺序执行两个初始化方法。这个时候,就只好在同一对象上既实现InitializingBean的afterPropertiesSet(),又提供自定义初始化方法啦!


5. DisposableBean与destroy-method

当所有的一切,该设置的设置,该注入的注入,该调用的调用完成之后,容器将检查singleton类型的bean实例,看其是否实现了org.springframework.beans.factory.DisposableBean接口。

或者其对应的bean定义是否通过< bean>的destroy-method属性指定了自定义的对象销毁方法。

如果是,就会为该实例注册一个用于对象销毁的回调(Callback),以便在这些singleton类型的对象实例销毁之前,执行销毁逻辑。

与InitializingBean和init-method用于对象的自定义初始化相对应,DisposableBean和destroy-method为对象提供了执行自定义销毁逻辑的机会。

最常见到的该功能的使用场景就是在Spring容器中注册数据库连接池,在系统退出后,连接池应该关闭,以释放相应资源。

我们需要思考一个问题: bean的销毁方法会在什么时候被调用呢?

对于ApplicationContext容器来说。AbstractApplicationContext为我们提供了registerShutdownHook()方法,该方法底层使用标准的Runtime类的addShutdownHook()方式来调用相应bean对象的销毁逻辑,从而保证在Java虚拟机退出之前,这些singtleton类型的bean对象
实例的自定义销毁逻辑会被执行。

当然AbstractApplicationContext注册的shutdownHook不只是调用对象实例的自定义销毁逻辑,也包括ApplicationContext相关的事件发布等。

使用registerShutdownHook()方法注册并触发对象销毁逻辑回调行为

public class ApplicationLauncher 
 
 public static void main(String[] args)  
 BasicConfigurator.configure(); 

 BeanFactory container = new ClassPathXmlApplicationContext("..."); 

 ((AbstractApplicationContext)container).registerShutdownHook(); 

 BusinessObject bean = (BusinessObject)container.getBean("..."); 

 bean.doSth(); 
 // 应用程序退出,容器关闭

  
 

同样的道理,在Spring 2.0引入了自定义scope之后,使用自定义scope的相关对象实例的销毁逻辑,也应该在合适的时机被调用执行。不过,所有这些规则不包含prototype类型的bean实例,因为prototype对象实例在容器实例化并返回给请求方之后,容器就不再管理这种类型对象实例的生命周期了。

至此,bean走完了它在容器中“光荣”的一生。


小结

Spring的IoC容器主要有两种,即BeanFactory和ApplicationContext。本章伊始,首先对这两种容器做了总体上的介绍,然后转入本章的重点,也就是Spring的BeanFactory基础容器。

我们从对比使用BeanFactory开发前后的差别开始,阐述了BeanFactory作为一个具体的IoC Service Provider,它是如何支持各种对象注册以及依赖关系绑定的。

XML自始至终都是Spring的IoC容器支持最完善的Configuration Metadata提供方式。

所以,我们接着从XML入手,深入挖掘了BeanFactory(以及ApplicationContext)的各种潜力。

对于充满好奇心的我们,不会只停留在会使用BeanFactory进行开发这一层面。

所以,最后我们又一起探索了BeanFactory(当然,也是ApplicationContext)实现背后的各种奥秘。

BeanFactory是Spring提供的基础IoC容器,但并不是Spring提供的唯一IoC容器。

ApplicationContext构建于BeanFactory之上,提供了许多BeanFactory之外的特性。下一章,我们将一起走入ApplicationContext的世界。


以上是关于Spring复杂的BeanFactory继承体系该如何理解? ----中的主要内容,如果未能解决你的问题,请参考以下文章

Spring复杂的BeanFactory继承体系该如何理解? ----中

Spring复杂的BeanFactory继承体系该如何理解?---下

spring的beanFactory继承体系

Spring源码学习之BeanFactory体系结构

Spring源码解析 - BeanFactory接口体系解读

Spring BeanFactory源码学习