美文网首页我爱编程
(翻译)Spring Container Extension

(翻译)Spring Container Extension

作者: carl_zhao | 来源:发表于2018-04-06 23:25 被阅读0次

    一般而言,开发者不需要继承ApplicationContext实现类,可以实现特定的集成接口来扩展Spring IoC容器的功能。接下来就描述这些集成接口:

    1、使用BeanPostProcessor自定义Bean

    BeanPostProcessor接口定义了回调方法,你能够实现它们(或者覆盖容器自带的)来自定义实例化、依赖解析等逻辑。如果想在Spring容器完成实例化,配置,和初始化一个Bean之后实现自定义逻辑。你可以定义一个或者多个BeanPostProcessor实现。

    可以配置多个BeanPostProcessor的实例,并且你通过设置order属性来控制这些BeanPostProcessor的执行顺序。但是只有在实现Ordered接口BeanPostProcessor才能够设置这个属性。如果你想定义自己的BeanPostProcessor你也可以考虑实现Ordered接口。如果你想了解更多可以查看Spring API中关于BeanPostProcessorOrdered接口的javadocs.

    注意:

    1. BeanPostProcessor对Bean(或者object)实例起作用。也就是说,Spring IOC容器实例化Bean实例然后BeanPostProcessor起作用。
    2. 如果你使用了容器层级结构,BeanPostProcessor的作用域是单个容器。如果你定义在一个容器中定义BeanPostProcessor,它仅会在你定义的容器中执行post-process。换句话说,定义在一个容器中的Beans不会定义在另一个容器的BeanPostProcessor的post-process方法。即使它们的容器在同一个层级中。
    3. 如果想要改变实际的Bean definition,你可以使用BeanFactoryPostProcessor。下面将会讲到。

    org.springframework.beans.factory.config.BeanPostProcessor接口包含两个回调方法。当这个类被容器注册为post-processor时,对于容器创建的每一个Bean实例,在容器初始化方法(比如InitializingBean的afterPropertiesSet方法与定义的init方法)之前将会被会执行postProcessBeforeInitialization回调,在Bean初始化回调之后会做一次postProcessAfterInitialization回调。post-processor可以对一个Bean实例做任何操作,包含完全忽略回调。Bean的post-processor典型用法是检查回调接口或者包装一个bean的代理。Spring AOP一些公共类是实现它来提供自动代理逻辑。

    注意当在一个configuration类里面使用@Bean的工厂方法来声明一个BeanPostProcessor,这个工厂方法的返回值必须是它个实现类本身或者至少是org.springframework.beans.factory.config.BeanPostProcessor接口。否则,ApplicationContext不能够根据类型自动检测到它。因为BeanPostProcessor需要早点实例化为了适用于其他bean初始化的背景下,这种早期检测是至关重要的。

    推荐通过ApplicationContext的自动检测机制来注册BeanPostProcessor,也可以通过ConfigurableBeanFactoryaddBeanPostProcessor方法来手动注册。手动注册在需要控制注册前的条件逻辑情景下会很有用,但是Ordered接口对它不再起作用。手动注册总会先于自动检测式的注册。

    容器会特殊对待实现了BeanPostProcessor接口的类,它们直接引用的类会在启动时被初始化,作为容器启动的一部分。接下来,所有的BeanPostProcessor排好序被注册,会被应用到容器的所有Bean。因为AOP自动代理本身就是一个BeanPostProcessor,那么它们直接引用的BeanPostProcessor或Bean都是自动代理不可见的(因为这样的BeanPostProcessor或Bean 都在自动代理被实例化之前都已经初始化了),因此不可能自动代理这样的BeanPostProcessor或者Bean。

    下面的例子是展示如果写,实现以及使用BeanPostProcessor在一个ApplicationContext中。

    Example: Hello World, BeanPostProcessor-style

    这个例子主要是阐明基本用法。这个例子展示了一个自定义BeanPostProcess实现容器创建bean的时候调用toString()方法,并且打印结果到控制台。

    package scripting;
    
    import org.springframework.beans.factory.config.BeanPostProcessor;
    import org.springframework.beans.BeansException;
    
    public class InstantiationTracingBeanPostProcessor implements BeanPostProcessor {
    
        // simply return the instantiated bean as-is
        public Object postProcessBeforeInitialization(Object bean,
                String beanName) throws BeansException {
            return bean; // we could potentially return any object reference here...
        }
    
        public Object postProcessAfterInitialization(Object bean,
                String beanName) throws BeansException {
            System.out.println("Bean ''" + beanName + "'' created : " + bean.toString());
            return bean;
        }
    
    }
    
    <?xml version="1.0" encoding="UTF-8"?>
    <beans xmlns="http://www.springframework.org/schema/beans"
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xmlns:lang="http://www.springframework.org/schema/lang"
        xsi:schemaLocation="http://www.springframework.org/schema/beans
            http://www.springframework.org/schema/beans/spring-beans.xsd
            http://www.springframework.org/schema/lang
            http://www.springframework.org/schema/lang/spring-lang.xsd">
    
        <lang:groovy id="messenger"
                script-source="classpath:org/springframework/scripting/groovy/Messenger.groovy">
            <lang:property name="message" value="Fiona Apple Is Just So Dreamy."/>
        </lang:groovy>
    
        <!--
        when the above bean (messenger) is instantiated, this custom
        BeanPostProcessor implementation will output the fact to the system console
        -->
        <bean class="scripting.InstantiationTracingBeanPostProcessor"/>
    
    </beans>
    

    注意:InstantiationTracingBeanPostProcessor只是一个简单的定义。它甚至没有一个名字。因为它是一个Bean,所以它可以像其它Bean一样进行依赖注入。

    下面的简单的Java应用会执行上面的代码与配置:

    import org.springframework.context.ApplicationContext;
    import org.springframework.context.support.ClassPathXmlApplicationContext;
    import org.springframework.scripting.Messenger;
    
    public final class Boot {
    
        public static void main(final String[] args) throws Exception {
            ApplicationContext ctx = new ClassPathXmlApplicationContext("scripting/beans.xml");
            Messenger messenger = (Messenger) ctx.getBean("messenger");
            System.out.println(messenger);
        }
    
    }
    

    执行上面代码会有以下的输出:

    Bean 'messenger' created : org.springframework.scripting.groovy.GroovyMessenger@272961
    org.springframework.scripting.groovy.GroovyMessenger@272961
    

    Spring Example : RequiredAnnotationBeanPostProcessor

    使用回调接口或注释与自定义实现BeanPostProcessor是一种常见的扩展Spring IoC容器。一个例子是Spring中的RequiredAnnotationBeanPostProcessor(具体例子可以参看我之的Blog -- Spring Annotaion Required - BeanPostProcessor的实现用于 Spring 确保 JavaBean 属性 bean 上标有注释@Required的值不为空.

    2、使用BeanFactoryPostProcessor来自定义配置元数据

    这个扩展点是org.springframework.beans.factory.config.BeanFactoryPostProcessor,从语义上和BeanPostProcessor很相似,但有个不同点:BeanFactorPostProcessor操作Bean的配置元数据。Spring IoC容器允许BeanFactoryPostProcessor读取配置元数据,并在容器实例化任何Bean(不包括BeanFactoryPostProcessor本身)之前修改配置元数据。

    可以配置多个BeanFactoryPostProcessor.如果BeanFacotryPostProcessor实现了Ordered接口,你可以通过order属性来控制它们执行的顺序。如果你想要写自己的BeanFacotryPostProcessor你也可以考虑实现Ordered接口。

    为了应用更改配置元数据定义的容器,把bean factory post-processor定义到一个ApplicationContext中容器会自动检测生效。Spring包含一些预定义的bean factory post-processor,比如PropertyOverrideConfigurerPropertyPlaceholderConfigurer。一个自定义的BeanFactoryPostProcessor同样可以生效,比如,注册自定义的property编辑器。

    ApplicationContext会自动检测到任何部署到它实现BeanFactoryPostProcessor接口的Bean。它会在合适的时机做为bean factory post-processors来使用这些beans。您可以部署这些后处理器bean将其他bean。

    Example:类名称替换PropertyPlaceholderConfigurer

    你可以使用PropertyPlaceholderConfigurer来具体化定义Bean的property值通过分离文件使用标准的Java Properties格式。这样就可以使得部署应用的时候可以自定义特殊属性。比如数据的URL与password,没有修改容器中主要XML定义文件或文件的复杂性或风险。

    考虑下面基于XML的配置元素片段,通过占位符来定义值DataSource。这个例子显示了通过外面的Properties文件来配置属性。在运行时,PropertyPlaceholderConfigurer使用于元数据,也就是替换掉DataSource中的这些属性。这些属性会被替换成指定的值。

    <bean class="org.springframework.beans.factory.config.PropertyPlaceholderConfigurer">
        <property name="locations" value="classpath:com/foo/jdbc.properties"/>
    </bean>
    
    <bean id="dataSource" destroy-method="close"
            class="org.apache.commons.dbcp.BasicDataSource">
        <property name="driverClassName" value="${jdbc.driverClassName}"/>
        <property name="url" value="${jdbc.url}"/>
        <property name="username" value="${jdbc.username}"/>
        <property name="password" value="${jdbc.password}"/>
    </bean>
    

    真实的值来自而一个标准的Java Properties格式的文件中。

    jdbc.driverClassName=org.hsqldb.jdbcDriver
    jdbc.url=jdbc:hsqldb:hsql://production:9002
    jdbc.username=sa
    jdbc.password=root
    

    因此,字符串${jdbc.username}会在运行时被替换成值'sa',并且同样应用于其它占位符的值也会替换成在properties文件对应的key.PropertyPlaceholderConfigurer会检测占位符在bean的properteis与attribute。而且占位符的前缀与后缀也可以自定义。

    在spring 2.5中引入了context命名空间。它同样可以通过专用的配置元素来配置properties占位符。一个或者多个位置可以逗号分隔的配置在location元素上。

    <context:property-placeholder location="classpath:com/foo/jdbc.properties"/>
    

    PropertyPlaceholderConfigurer不仅仅在你指定的Properties中查找properties。默认情况下,如果它找在指定的properties中找不到property时,它同样也会在检查Java Systemproperties.你可以通过设置以下的3中支持的integer值中的一个systemPropertiesMode属性来自定义检查行为。

    • never(0).从不检查system properties.
    • fallback(1).如果在指定properties中检测不到,检查system properties.这个是默认的。
    • override(2).在检查指定properties文件之前,先检查system properties。这就允许system properties覆盖其它property数据源。

    查阅PropertyPlaceholderConfigurer的javadocs获取更多信息。

    注意:当你不得不选择一个特定的运行时实现类,可以使用PropertyPlaceholderConfigurer用来代替class的名称。例如:

    <bean class="org.springframework.beans.factory.config.PropertyPlaceholderConfigurer">
        <property name="locations">
            <value>classpath:com/foo/strategy.properties</value>
        </property>
        <property name="properties">
            <value>custom.strategy.class=com.foo.DefaultStrategy</value>
        </property>
    </bean>
    
    <bean id="serviceStrategy" class="${custom.strategy.class}"/>
    

    3、使用FactoryBean自定义初始化逻辑

    org.springframework.beans.factory.FactoryBean接口用来实现对象本身的工厂.具体实例 -- Spring bean 之 FactoryBean

    FactoryBean接口是Spring IoC容器实例化逻辑的一个插件化的扩展点。若在系统有着复杂的初始化代码,且更适合使用Java代码(而不是XML),那么就可以创建自定义的FactoryBean,将初始化逻辑写到里面,然后将自定义的FactoryBean插入容器中。

    FactoryBean接口提供了三个方法:

    1. Object getObject():返回当前工厂创建的对象实例。
    2. Boolean isSingleton():判断是否是单例。
    3. Class getObjectType():返回对象类型。

    FactoryBean这个概念和接口被应用在Spring Framework的很多地方。Spring自身都有超过50个FactoryBean的实现。

    当你需要请求容器一个真实的FactoryBean实例而不是它提供的bean的时候。当你调用ApplicationContextgetBean()方法的时候,在这个bean的ID之前加上&的记号名称.例如获取一个ID为myBean的FactoryBean的时候,调用getBean("myBean")容器会返回FactoryBean的产品。然而调用getBean("&myBean")会返回这个FactoryBean实例本身。

    因为水平有限,翻译不足之处还望见谅。
    原文地址:spring-framework-reference-4.2.6.RELEASE

    相关文章

      网友评论

        本文标题:(翻译)Spring Container Extension

        本文链接:https://www.haomeiwen.com/subject/fvlehftx.html