Spring官方文档阅读(五)之IOC容器(容器的扩展点)
8.容器扩展点通常,应用程序开发人员不需要为ApplicationContext实现类提供子类。 相反,可以通过插入特殊集成接口的实现来扩展Spring IOC容器。 接下来的几节描述了这些集成接口。8.1使用BeanPostProcessor自定义BeanBeanPostProcessor接口定义了回调方法,您可以实施这些回调方法以提供自己的(或覆盖容器的默认值)实例化逻辑,依赖关系解析逻辑等。
8.容器扩展点
通常,应用程序开发人员不需要为ApplicationContext实现类提供子类。 相反,可以通过插入特殊集成接口的实现来扩展Spring IOC容器。 接下来的几节描述了这些集成接口。
8.1使用BeanPostProcessor自定义Bean
BeanPostProcessor接口定义了回调方法,您可以实施这些回调方法以提供自己的(或覆盖容器的默认值)实例化逻辑,依赖关系解析逻辑等。 如果您想在Spring容器完成实例化,配置和初始化bean之后实现一些自定义逻辑,则可以插入一个或多个自定义BeanPostProcessor实现。
您可以配置多个BeanPostProcessor实例,并且可以通过设置order属性来控制这些BeanPostProcessor实例的运行顺序。 仅当BeanPostProcessor实现Ordered接口时,才可以设置此属性。 如果您编写自己的BeanPostProcessor,则也应该考虑实现Ordered接口。
注意:
BeanPostProcessor实例在bean(或对象)实例上运行。 也就是说,Spring IOC容器实例化一个bean实例,然后BeanPostProcessor实例完成其工作。BeanPostProcessor实例是按容器划分作用域的。 仅在使用容器层次结构时,这才有意义。 如果在一个容器中定义BeanPostProcessor,它将仅对该容器中的bean进行后处理。 换句话说,在一个容器中定义的bean不会由在另一个容器中定义的BeanPostProcessor进行后处理,即使这两个容器是同一层次结构的一部分。- 要更改实际的bean定义(即定义bean的蓝图),您需要使用
BeanFactoryPostProcessor
org.springframework.beans.factory.config.BeanPostProcessor接口恰好由两个回调方法组成。 将此类注册为容器的后处理器时,对于容器创建的每个bean实例,后处理器都会在容器初始化方法(例如InitializingBean.afterPropertiesSet()或 任何声明的init方法),并在任何bean初始化回调之后被调用。 后处理器可以对bean实例执行任何操作,包括完全忽略回调。 Bean后处理器通常检查回调接口,或者可以用代理包装Bean。 一些Spring AOP基础结构类被实现为bean后处理器,以提供代理包装逻辑。
ApplicationContext自动检测实现BeanPostProcessor接口的配置元数据中定义的所有bean。 ApplicationContext将这些bean注册为后处理器,以便以后在bean创建时可以调用它们。 Bean后处理器可以以与其他任何Bean相同的方式部署在容器中。
请注意,在配置类上使用@Bean工厂方法声明BeanPostProcessor时,工厂方法的返回类型应该是实现类本身,或者至少是org.springframework.beans.factory.config.BeanPostProcessor接口。 指示该bean的后处理器性质。 否则,ApplicationContext无法在完全创建之前按类型自动检测它。 由于BeanPostProcessor需要及早实例化才能应用于上下文中其他bean的初始化,因此这种早期类型检测至关重要。
注意:
- 以编程方式注册BeanPostProcessor实例
- 尽管建议的
BeanPostProcessor注册方法是通过ApplicationContext自动检测(如前所述),但是您可以使用addBeanPostProcessor方法以编程方式针对ConfigurableBeanFactory注册它们。 当您需要在注册之前评估条件逻辑,甚至需要跨层次结构的上下文复制Bean后处理器时,这将非常有用。 但是请注意,以编程方式添加的BeanPostProcessor实例不遵守Ordered接口。 在这里,注册的顺序决定了执行的顺序。 还要注意,以编程方式注册的BeanPostProcessor实例始终在通过自动检测注册的BeanPostProcessor实例之前进行处理,而不考虑任何明确的顺序。 - BeanPostProcessor实例和AOP自动代理
- 实现
BeanPostProcessor接口的类是特殊的,并且容器对它们的处理方式有所不同。 作为ApplicationContext特殊启动阶段的一部分,所有BeanPostProcessor实例和它们直接引用的Bean都会在启动时实例化。 接下来,以排序方式注册所有BeanPostProcessor实例,并将其应用于容器中的所有其他bean。 因为AOP自动代理是作为BeanPostProcessor本身实现的,所以BeanPostProcessor实例或它们直接引用的bean都没有资格进行自动代理,因此没有编织的方面。 - 对于任何此类bean,您应该会看到一条参考日志消息:
Bean someBean is not eligible for getting processed by all BeanPostProcessor interfaces (for example: not eligible for auto-proxying).- 如果您使用自动装配或
@Resource(可能会退回到自动装配)将Bean连接到BeanPostProcessor中,则Spring在搜索类型匹配的依赖项候选对象时可能会访问意外的Bean,因此使它们不符合自动代理或其他种类的条件 bean后处理。 例如,如果您有一个用@Resource注解的依赖项,其中字段或设置器名称不直接与bean的声明名称相对应,并且不使用name属性,那么Spring将访问其他bean以按类型匹配它们。
下面的示例演示如何在ApplicationContext中编写,注册和使用BeanPostProcessor实例:
8.11Example: Hello World, BeanPostProcessor-style
第一个示例说明了基本用法。 该示例显示了一个自定义BeanPostProcessor实现,该实现调用由容器创建的每个bean的toString()方法,并将结果字符串打印到系统控制台。
以下清单显示了自定义BeanPostProcessor实现类的定义:
package scripting;
import org.springframework.beans.factory.config.BeanPostProcessor;
public class InstantiationTracingBeanPostProcessor implements BeanPostProcessor {
// simply return the instantiated bean as-is
public Object postProcessBeforeInitialization(Object bean, String beanName) {
return bean; // we could potentially return any object reference here...
}
public Object postProcessAfterInitialization(Object bean, String beanName) {
System.out.println("Bean '" + beanName + "' created : " + bean.toString());
return bean;
}
}
以下bean元素使用InstantiationTracingBeanPostProcessor:
<?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
https://www.springframework.org/schema/beans/spring-beans.xsd
http://www.springframework.org/schema/lang
https://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一样对其进行依赖注入。 (前面的配置还定义了一个由Groovy脚本支持的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 = ctx.getBean("messenger", Messenger.class);
System.out.println(messenger);
}
}
前面的应用程序的输出类似于以下内容:
Bean 'messenger' created : org.springframework.scripting.groovy.GroovyMessenger@272961
org.springframework.scripting.groovy.GroovyMessenger@272961
8.12例子:RequiredAnnotationBeanPostProcessor
将回调接口或注解与自定义BeanPostProcessor实现结合使用是扩展Spring IOC容器的常用方法。 Spring的RequiredAnnotationBeanPostProcessor是一个示例,它是Spring发行版附带的BeanPostProcessor实现,可确保标有(任意)批注的bean上的JavaBean属性实际上(被配置为)依赖注入了一个值。
8.2使用BeanFactoryPostProcessor自定义配置元数据
我们要看的下一个扩展点是org.springframework.beans.factory.config.BeanFactoryPostProcessor。 该接口的语义与BeanPostProcessor的语义相似,但有一个主要区别:BeanFactoryPostProcessor对Bean配置元数据进行操作。 也就是说,Spring IOC容器允许BeanFactoryPostProcessor读取配置元数据,并有可能在容器实例化除BeanFactoryPostProcessor实例以外的任何bean之前更改它。
您可以配置多个BeanFactoryPostProcessor实例,并且可以通过设置order属性来控制这些BeanFactoryPostProcessor实例的运行顺序。 但是,仅当BeanFactoryPostProcessor实现Ordered接口时,才可以设置此属性。 如果编写自己的BeanFactoryPostProcessor,则也应该考虑实现Ordered接口。
如果要更改实际的bean实例(即从配置元数据创建的对象),则需要使用BeanPostProcessor(在前面的使用BeanPostProcessor自定义Bean中进行了介绍)。 从技术上讲,可以在BeanFactoryPostProcessor中使用Bean实例(例如,通过使用BeanFactory.getBean()),但这样做会导致Bean实例化过早,从而违反了标准容器的生命周期。 这可能会导致负面影响,例如绕过bean后处理。
同样,BeanFactoryPostProcessor实例是按容器划分作用域的。 仅在使用容器层次结构时才有意义。 如果在一个容器中定义BeanFactoryPostProcessor,则仅将其应用于该容器中的Bean定义。 一个容器中的Bean定义不会由另一个容器中的BeanFactoryPostProcessor实例进行后处理,即使两个容器都属于同一层次结构也是如此。
Bean工厂后处理器在ApplicationContext中声明时会自动运行,以便将更改应用于定义容器的配置元数据。 Spring包含许多预定义的bean工厂后处理器,例如PropertyOverrideConfigurer和PropertySourcesPlaceholderConfigurer。 您也可以使用自定义BeanFactoryPostProcessor,例如注册自定义属性编辑器。
ApplicationContext自动检测实现BeanFactoryPostProcessor接口的部署到其中的所有Bean。 它在适当的时候将这些bean用作bean工厂的后处理器。 您可以像部署其他任何bean一样部署这些后处理器bean。
注意:
- 与
BeanPostProcessors一样,您通常不想为延迟初始化配置BeanFactoryPostProcessors。 如果没有其他bean引用Bean(Factory)PostProcessor,则该后处理器将完全不会实例化。 因此,将其标记为延迟初始化将被忽略,即使您在元素的声明中将default-lazy-init属性设置为true,Bean(Factory)PostProcessor也会被实例化。
8.21示例:类名替换PropertySourcesPlaceholderConfigurer
您可以使用PropertySourcesPlaceholderConfigurer来通过使用标准Java属性格式将bean定义中的属性值外部化到单独的文件中。 这样做使部署应用程序的人员可以自定义特定于环境的属性,例如数据库URL和密码,而无需为修改容器的主要XML定义文件而复杂或冒风险。
考虑以下基于XML的配置元数据片段,其中定义了具有占位符值的DataSource:
<bean class="org.springframework.context.support.PropertySourcesPlaceholderConfigurer">
<property name="locations" value="classpath:com/something/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>
该示例显示了从外部属性文件配置的属性。 在运行时,将PropertySourcesPlaceholderConfigurer应用于替换数据源某些属性的元数据。 将要替换的值指定为$ {property-name}格式的占位符,该格式遵循Ant和log4j和JSP EL样式。
实际值来自标准Java属性格式的另一个文件:
jdbc.driverClassName=org.hsqldb.jdbcDriver
jdbc.url=jdbc:hsqldb:hsql://production:9002
jdbc.username=sa
jdbc.password=root
因此,$ {jdbc.username}字符串在运行时将被替换为值“ sa”,并且其他与属性文件中的键匹配的占位符值也将被替换。 PropertySourcesPlaceholderConfigurer检查Bean定义的大多数属性和属性中的占位符。 此外,您可以自定义占位符前缀和后缀。
借助Spring 2.5中引入的上下文名称空间,您可以使用专用配置元素配置属性占位符。 您可以在location属性中以逗号分隔的列表形式提供一个或多个位置,如以下示例所示:
<context:property-placeholder location="classpath:com/something/jdbc.properties"/>
PropertySourcesPlaceholderConfigurer不仅在您指定的属性文件中查找属性。 默认情况下,如果无法在指定的属性文件中找到属性,则会检查Spring Environment属性和常规Java System属性。
您可以使用PropertySourcesPlaceholderConfigurer替换类名称,这在您必须在运行时选择特定的实现类时有时很有用。 以下示例显示了如何执行此操作:
<bean class="org.springframework.beans.factory.config.PropertySourcesPlaceholderConfigurer">
<property name="locations">
<value>classpath:com/something/strategy.properties</value>
</property>
<property name="properties">
<value>custom.strategy.class=com.something.DefaultStrategy</value>
</property>
</bean>
<bean id="serviceStrategy" class="${custom.strategy.class}"/>
如果无法在运行时将类解析为有效的类,则将要创建的bean的解析将失败,这是在非延迟初始化bean的ApplicationContext的preInstantiateSingletons()阶段期间进行的。
8.22例子:PropertyOverrideConfigurer
另一个bean工厂后处理程序PropertyOverrideConfigurer类似于PropertySourcesPlaceholderConfigurer,但是与后者不同,原始定义对于bean属性可以具有默认值或完全没有值。 如果覆盖的属性文件没有某个bean属性的条目,则使用默认的上下文定义。
注意,bean定义不知道会被覆盖,因此从XML定义文件中不能立即看出正在使用覆盖配置器。 如果有多个PropertyOverrideConfigurer实例为同一个bean属性定义了不同的值,则由于覆盖机制,最后一个实例将获胜。
属性文件配置行采用以下格式:
beanName.property=value
下面的清单显示了该格式的示例:
dataSource.driverClassName=com.mysql.jdbc.Driver
dataSource.url=jdbc:mysql:mydb
此示例文件可与包含一个名为dataSource的bean的容器定义一起使用,该bean具有驱动程序和url属性。
只要路径的每个组成部分(最终属性被覆盖)之外的所有组成部分都已经为非空(可能是由构造函数初始化),则也支持复合属性名。 在下面的示例中,tom bean的fred属性的bob属性的sammy属性设置为标量值123:
tom.fred.bob.sammy=123
注意:
- 指定的替代值始终是文字值。 它们不会转换为bean引用。 当XML bean定义中的原始值指定bean引用时,此约定也适用。
使用Spring 2.5中引入的上下文名称空间,可以使用专用配置元素配置属性覆盖,如以下示例所示:
<context:property-override location="classpath:override.properties"/>
8.3使用FactoryBean自定义实例化逻辑
您可以实现org.springframework.beans.factory。为本身是工厂的对象提供FactoryBean接口。
FactoryBean接口是可插入Spring IOC容器的实例化逻辑的一点。 如果您有复杂的初始化代码,而不是(可能)冗长的XML,可以用Java更好地表达,则可以创建自己的FactoryBean,在该类中编写复杂的初始化,然后将自定义FactoryBean插入容器。
FactoryBean接口提供了三个方法:
- Object getObject():返回此工厂创建的对象的实例。 实例可以共享,具体取决于该工厂是否返回单例或原型。
- boolean isSingleton():如果此FactoryBean返回单例则返回true,否则返回false。
- class getObjectType():返回由getObject()方法返回的对象类型;如果类型未知,则返回null。
Spring框架中的许多地方都使用了FactoryBean概念和接口。 Spring附带了50多个FactoryBean接口实现。
当您需要向容器要求一个实际的FactoryBean实例本身而不是由它产生的bean时,请在调用ApplicationContext的getBean()方法时在该bean的ID前面加上一个&符号(&)。 因此,对于给定的myBean id为FactoryBean的FactoryBean,在容器上调用getBean(“ myBean”)将返回FactoryBean的乘积,而调用getBean(“&myBean”)将返回FactoryBean实例本身。
魔乐社区(Modelers.cn) 是一个中立、公益的人工智能社区,提供人工智能工具、模型、数据的托管、展示与应用协同服务,为人工智能开发及爱好者搭建开放的学习交流平台。社区通过理事会方式运作,由全产业链共同建设、共同运营、共同享有,推动国产AI生态繁荣发展。
更多推荐


所有评论(0)