XML Schema 作者
自2.0版本以来,Spring就提供了一种机制,用于向基本的Spring XML格式添加基于模式的扩展,以定义和配置bean。本节介绍如何编写自定义的XML bean定义解析器,并将这些解析器集成到Spring IoC容器中。
为了便于编写使用基于模式的XML编辑器的配置文件,Spring的可扩展XML配置机制基于XML Schema。如果您不熟悉标准Spring发行版中提供的Spring当前XML配置扩展,请先阅读前一节关于XML模式的内容。
创建新的XML配置扩展:
为了统一示例,我们创建一个XML扩展(自定义XML元素),使我们能够配置SimpleDateFormat
类型的对象(来自java.text
包)。完成后,我们将能够定义如下类型为SimpleDateFormat
的bean定义:
<myns:dateformat id="dateFormat"
pattern="yyyy-MM-dd HH:mm"
lenient="true"/>
(我们稍后在本附录中提供更详细的示例。这个第一个简单示例的目的是引导您完成制作自定义扩展的基本步骤。)
编写模式
为了与Spring的IoC容器一起使用创建XML配置扩展,首先要编写一个XML模式来描述扩展。对于我们的示例,我们使用以下模式来配置SimpleDateFormat
对象:
<!-- myns.xsd(位于org/springframework/samples/xml包内) -->
<?xml version="1.0" encoding="UTF-8"?>
<xsd:schema xmlns="http://www.mycompany.example/schema/myns"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:beans="http://www.springframework.org/schema/beans"
targetNamespace="http://www.mycompany.example/schema/myns"
elementFormDefault="qualified"
attributeFormDefault="unqualified">
<xsd:import namespace="http://www.springframework.org/schema/beans"/>
<xsd:element name="dateformat">
<xsd:complexType>
<xsd:complexContent>
<xsd:extension base="beans:identifiedType"> (1)
<xsd:attribute name="lenient" type="xsd:boolean"/>
<xsd:attribute name="pattern" type="xsd:string" use="required"/>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
</xsd:element>
</xsd:schema>
1 | 指定的行包含所有可识别标签的扩展基础(意味着它们具有可以在容器中用作bean标识符的id 属性)。我们可以使用此属性,因为我们导入了Spring提供的beans 命名空间。 |
上述模式使我们能够直接在XML应用程序上下文文件中配置SimpleDateFormat
对象,如下例所示:
<myns:dateformat id="dateFormat"
pattern="yyyy-MM-dd HH:mm"
lenient="true"/>
请注意,在创建基础设施类之后,上述XML片段实质上与以下XML片段相同:
<bean id="dateFormat" class="java.text.SimpleDateFormat">
<constructor-arg value="yyyy-MM-dd HH:mm"/>
<property name="lenient" value="true"/>
</bean>
前两个片段中的第二个创建了一个bean(由名称dateFormat
标识,类型为SimpleDateFormat
),并设置了一些属性。
基于模式的创建配置格式方法允许与具有模式感知XML编辑器的IDE紧密集成。通过使用正确编写的模式,您可以使用自动完成功能让用户在枚举中选择定义在其中的多个配置选项。 |
编写NamespaceHandler
除了模式之外,我们还需要一个NamespaceHandler
来解析Spring在解析配置文件时遇到的该特定命名空间的所有元素。对于此示例,NamespaceHandler
应该负责解析myns:dateformat
元素。
NamespaceHandler
接口包含三个方法:
-
init()
:允许初始化NamespaceHandler
,并在Spring在使用处理程序之前调用。 -
BeanDefinition parse(Element, ParserContext)
:当Spring遇到顶级元素(不是嵌套在bean定义或不同命名空间内)时调用。此方法可以注册bean定义本身,返回bean定义,或两者兼而有之。 -
BeanDefinitionHolder decorate(Node, BeanDefinitionHolder, ParserContext)
:当Spring遇到不同命名空间的属性或嵌套元素时调用。用于装饰一个或多个bean定义(例如,与Spring支持的作用域一起使用)。我们首先强调一个简单示例,不使用装饰,然后展示稍微更高级示例中的装饰。
尽管您可以为整个命名空间编写自己的NamespaceHandler
(因此提供了解析命名空间中的每个元素的代码),但通常情况下,在Spring XML配置文件中的每个顶级XML元素都会导致一个bean定义(就像我们的情况一样,其中一个<myns:dateformat/>
元素导致一个SimpleDateFormat
bean定义)。Spring提供了一些方便的类来支持这种情况。在下面的示例中,我们使用NamespaceHandlerSupport
类:
-
Java
-
Kotlin
package org.springframework.samples.xml;
import org.springframework.beans.factory.xml.NamespaceHandlerSupport;
public class MyNamespaceHandler extends NamespaceHandlerSupport {
public void init() {
registerBeanDefinitionParser("dateformat", new SimpleDateFormatBeanDefinitionParser());
}
}
package org.springframework.samples.xml
import org.springframework.beans.factory.xml.NamespaceHandlerSupport
class MyNamespaceHandler : NamespaceHandlerSupport {
override fun init() {
registerBeanDefinitionParser("dateformat", SimpleDateFormatBeanDefinitionParser())
}
}
您可能会注意到这个类中实际上没有太多的解析逻辑。实际上,NamespaceHandlerSupport
类具有内置的委托概念。它支持注册任意数量的BeanDefinitionParser
实例,当需要解析其命名空间中的元素时,它会委托给这些实例。这种关注点的清晰分离让NamespaceHandler
处理其命名空间中所有自定义元素的解析协调,同时委托给BeanDefinitionParsers
来执行XML解析的繁重工作。这意味着每个BeanDefinitionParser
仅包含解析单个自定义元素的逻辑,正如我们将在下一步中看到的那样。
使用BeanDefinitionParser
如果NamespaceHandler
遇到已映射到特定bean定义解析器(在本例中为dateformat
)的类型的XML元素,则会使用BeanDefinitionParser
。换句话说,BeanDefinitionParser
负责解析模式中定义的一个独特顶级XML元素。在解析器中,我们可以访问XML元素(因此也可以访问其子元素),以便解析我们的自定义XML内容,如下例所示:
-
Java
-
Kotlin
package org.springframework.samples.xml;
import org.springframework.beans.factory.support.BeanDefinitionBuilder;
import org.springframework.beans.factory.xml.AbstractSingleBeanDefinitionParser;
import org.springframework.util.StringUtils;
import org.w3c.dom.Element;
import java.text.SimpleDateFormat;
public class SimpleDateFormatBeanDefinitionParser extends AbstractSingleBeanDefinitionParser { (1)
protected Class getBeanClass(Element element) {
return SimpleDateFormat.class; (2)
}
protected void doParse(Element element, BeanDefinitionBuilder bean) {
// this will never be null since the schema explicitly requires that a value be supplied
String pattern = element.getAttribute("pattern");
bean.addConstructorArgValue(pattern);
// this however is an optional property
String lenient = element.getAttribute("lenient");
if (StringUtils.hasText(lenient)) {
bean.addPropertyValue("lenient", Boolean.valueOf(lenient));
}
}
}
1 | 我们使用Spring提供的AbstractSingleBeanDefinitionParser 来处理创建单个BeanDefinition 的基本工作。 |
2 | 我们向AbstractSingleBeanDefinitionParser 超类提供我们单个BeanDefinition 表示的类型。 |
package org.springframework.samples.xml
import org.springframework.beans.factory.support.BeanDefinitionBuilder
import org.springframework.beans.factory.xml.AbstractSingleBeanDefinitionParser
import org.springframework.util.StringUtils
import org.w3c.dom.Element
import java.text.SimpleDateFormat
class SimpleDateFormatBeanDefinitionParser : AbstractSingleBeanDefinitionParser() { (1)
override fun getBeanClass(element: Element): Class<*>? { (2)
return SimpleDateFormat::class.java
}
override fun doParse(element: Element, bean: BeanDefinitionBuilder) {
// this will never be null since the schema explicitly requires that a value be supplied
val pattern = element.getAttribute("pattern")
bean.addConstructorArgValue(pattern)
// this however is an optional property
val lenient = element.getAttribute("lenient")
if (StringUtils.hasText(lenient)) {
bean.addPropertyValue("lenient", java.lang.Boolean.valueOf(lenient))
}
}
}
1 | 我们使用Spring提供的AbstractSingleBeanDefinitionParser 来处理创建单个BeanDefinition 的基本工作。 |
2 | 我们向AbstractSingleBeanDefinitionParser 超类提供我们单个BeanDefinition 表示的类型。 |
在这种简单情况下,这就是我们需要做的全部。我们单个BeanDefinition
的创建由AbstractSingleBeanDefinitionParser
超类处理,以及bean定义的唯一标识的提取和设置。
注册处理程序和模式
编码已完成。剩下的工作就是让Spring XML解析基础设施了解我们的自定义元素。我们通过在两个专用属性文件中注册我们的自定义namespaceHandler
和自定义XSD文件来实现这一点。这些属性文件都放置在应用程序的META-INF
目录中,例如可以与JAR文件中的二进制类一起分发。Spring XML解析基础设施会通过消费这些特殊属性文件自动获取您的新扩展,这些文件的格式将在接下来的两个部分详细介绍。
编写META-INF/spring.handlers
名为spring.handlers
的属性文件包含XML模式URI到命名空间处理程序类的映射。对于我们的示例,我们需要编写以下内容:
http\://www.mycompany.example/schema/myns=org.springframework.samples.xml.MyNamespaceHandler
(在Java属性格式中,:
字符是有效的分隔符,因此URI中的:
字符需要用反斜杠进行转义。)
键值对的第一部分(键)是与您的自定义命名空间扩展关联的URI,需要与自定义XSD模式中指定的targetNamespace
属性的值完全匹配。
编写'META-INF/spring.schemas'
名为spring.schemas
的属性文件包含XML模式位置(与XML文件中使用模式作为xsi:schemaLocation
属性的一部分引用的位置)到类路径资源的映射。此文件需要防止Spring绝对必须使用需要Internet访问以检索模式文件的默认EntityResolver
。如果在此属性文件中指定映射,Spring将在类路径上搜索模式(在本例中,在org.springframework.samples.xml
包中的myns.xsd
)。以下代码段显示了我们需要添加的自定义模式的行:
http\://www.mycompany.example/schema/myns/myns.xsd=org/springframework/samples/xml/myns.xsd
(请记住必须转义:
字符。)
建议将您的XSD文件(或文件)部署在类路径上与NamespaceHandler
和BeanDefinitionParser
类一起。
在Spring XML配置中使用自定义扩展
使用您自己实现的自定义扩展与使用Spring提供的“自定义”扩展没有区别。以下示例在Spring XML配置文件中使用在前面步骤中开发的自定义<dateformat/>
元素:
<?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:myns="http://www.mycompany.example/schema/myns"
xsi:schemaLocation="
http://www.springframework.org/schema/beans https://www.springframework.org/schema/beans/spring-beans.xsd
http://www.mycompany.example/schema/myns http://www.mycompany.com/schema/myns/myns.xsd">
<!-- 作为顶级bean -->
<myns:dateformat id="defaultDateFormat" pattern="yyyy-MM-dd HH:mm" lenient="true"/> (1)
<bean id="jobDetailTemplate" abstract="true">
<property name="dateFormat">
<!-- 作为内部bean -->
<myns:dateformat pattern="HH:mm MM-dd-yyyy"/>
</property>
</bean>
</beans>
1 | 我们的自定义bean。 |
更详细的示例
本节介绍了一些更详细的自定义XML扩展示例。
在自定义元素中嵌套自定义元素
本节中呈现的示例展示了如何编写各种工件以满足以下配置目标所需:
<?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:foo="http://www.foo.example/schema/component"
xsi:schemaLocation="
http://www.springframework.org/schema/beans https://www.springframework.org/schema/beans/spring-beans.xsd
http://www.foo.example/schema/component http://www.foo.example/schema/component/component.xsd">
<foo:component id="bionic-family" name="Bionic-1">
<foo:component name="Mother-1">
<foo:component name="Karate-1"/>
<foo:component name="Sport-1"/>
</foo:component>
<foo:component name="Rock-1"/>
</foo:component>
</beans>
前面的配置将自定义扩展嵌套在彼此之内。实际上由<foo:component/>
元素配置的类是Component
类(在下一个示例中显示)。请注意,Component
类没有为components
属性公开的setter方法。这使得通过使用setter注入为Component
类配置bean定义变得困难(或者说不可能)。以下清单显示了Component
类:
-
Java
-
Kotlin
package com.foo;
import java.util.ArrayList;
import java.util.List;
public class Component {
private String name;
private List<Component> components = new ArrayList<Component> ();
// 'components'属性没有setter方法
public void addComponent(Component component) {
this.components.add(component);
}
public List<Component> getComponents() {
return components;
}
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
}
package com.foo
import java.util.ArrayList
class Component {
var name: String? = null
private val components = ArrayList<Component>()
// 'components'属性没有setter方法
fun addComponent(component: Component) {
this.components.add(component)
}
fun getComponents(): List<Component> {
return components
}
}
FactoryBean
,为
components
属性公开一个setter属性。以下清单显示了这样一个自定义
FactoryBean
:
-
Java
-
Kotlin
package com.foo;
import org.springframework.beans.factory.FactoryBean;
import java.util.List;
public class ComponentFactoryBean implements FactoryBean<Component> {
private Component parent;
private List<Component> children;
public void setParent(Component parent) {
this.parent = parent;
}
public void setChildren(List<Component> children) {
this.children = children;
}
public Component getObject() throws Exception {
if (this.children != null && this.children.size() > 0) {
for (Component child : children) {
this.parent.addComponent(child);
}
}
return this.parent;
}
public Class<Component> getObjectType() {
return Component.class;
}
public boolean isSingleton() {
return true;
}
}
package com.foo
import org.springframework.beans.factory.FactoryBean
import org.springframework.stereotype.Component
class ComponentFactoryBean : FactoryBean<Component> {
private var parent: Component? = null
private var children: List<Component>? = null
fun setParent(parent: Component) {
this.parent = parent
}
fun setChildren(children: List<Component>) {
this.children = children
}
override fun getObject(): Component? {
if (this.children != null && this.children!!.isNotEmpty()) {
for (child in children!!) {
this.parent!!.addComponent(child)
}
}
return this.parent
}
override fun getObjectType(): Class<Component>? {
return Component::class.java
}
override fun isSingleton(): Boolean {
return true
}
}
这样做效果很好,但向最终用户公开了大量Spring管道。我们要做的是编写一个自定义扩展,隐藏所有这些Spring管道。如果我们遵循之前描述的步骤,我们首先创建XSD模式来定义自定义标记的结构,如下清单所示:
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<xsd:schema xmlns="http://www.foo.example/schema/component"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
targetNamespace="http://www.foo.example/schema/component"
elementFormDefault="qualified"
attributeFormDefault="unqualified">
<xsd:element name="component">
<xsd:complexType>
<xsd:choice minOccurs="0" maxOccurs="unbounded">
<xsd:element ref="component"/>
</xsd:choice>
<xsd:attribute name="id" type="xsd:ID"/>
<xsd:attribute name="name" use="required" type="xsd:string"/>
</xsd:complexType>
</xsd:element>
</xsd:schema>
再次遵循之前描述的过程,然后创建一个自定义NamespaceHandler
:
-
Java
-
Kotlin
package com.foo;
import org.springframework.beans.factory.xml.NamespaceHandlerSupport;
public class ComponentNamespaceHandler extends NamespaceHandlerSupport {
public void init() {
registerBeanDefinitionParser("component", new ComponentBeanDefinitionParser());
}
}
package com.foo
import org.springframework.beans.factory.xml.NamespaceHandlerSupport
class ComponentNamespaceHandler : NamespaceHandlerSupport() {
override fun init() {
registerBeanDefinitionParser("component", ComponentBeanDefinitionParser())
}
}
接下来是自定义BeanDefinitionParser
。请记住,我们正在创建一个描述ComponentFactoryBean
的BeanDefinition
。以下清单显示了我们的自定义BeanDefinitionParser
实现:
-
Java
-
Kotlin
包 com.foo;
import org.springframework.beans.factory.config.BeanDefinition;
import org.springframework.beans.factory.support.AbstractBeanDefinition;
import org.springframework.beans.factory.support.BeanDefinitionBuilder;
import org.springframework.beans.factory.support.ManagedList;
import org.springframework.beans.factory.xml.AbstractBeanDefinitionParser;
import org.springframework.beans.factory.xml.ParserContext;
import org.springframework.util.xml.DomUtils;
import org.w3c.dom.Element;
import java.util.List;
public class ComponentBeanDefinitionParser extends AbstractBeanDefinitionParser {
protected AbstractBeanDefinition parseInternal(Element element, ParserContext parserContext) {
return parseComponentElement(element);
}
private static AbstractBeanDefinition parseComponentElement(Element element) {
BeanDefinitionBuilder factory = BeanDefinitionBuilder.rootBeanDefinition(ComponentFactoryBean.class);
factory.addPropertyValue("parent", parseComponent(element));
List<Element> childElements = DomUtils.getChildElementsByTagName(element, "component");
if (childElements != null && childElements.size() > 0) {
parseChildComponents(childElements, factory);
}
return factory.getBeanDefinition();
}
private static BeanDefinition parseComponent(Element element) {
BeanDefinitionBuilder component = BeanDefinitionBuilder.rootBeanDefinition(Component.class);
component.addPropertyValue("name", element.getAttribute("name"));
return component.getBeanDefinition();
}
private static void parseChildComponents(List<Element> childElements, BeanDefinitionBuilder factory) {
ManagedList<BeanDefinition> children = new ManagedList<>(childElements.size());
for (Element element : childElements) {
children.add(parseComponentElement(element));
}
factory.addPropertyValue("children", children);
}
}
包 com.foo
import org.springframework.beans.factory.config.BeanDefinition
import org.springframework.beans.factory.support.AbstractBeanDefinition
import org.springframework.beans.factory.support.BeanDefinitionBuilder
import org.springframework.beans.factory.support.ManagedList
import org.springframework.beans.factory.xml.AbstractBeanDefinitionParser
import org.springframework.beans.factory.xml.ParserContext
import org.springframework.util.xml.DomUtils
import org.w3c.dom Element
import java.util.List
类 ComponentBeanDefinitionParser : AbstractBeanDefinitionParser() {
override fun parseInternal(element: Element, parserContext: ParserContext): AbstractBeanDefinition? {
return parseComponentElement(element)
}
private fun parseComponentElement(element: Element): AbstractBeanDefinition {
val factory = BeanDefinitionBuilder.rootBeanDefinition(ComponentFactoryBean::class.java)
factory.addPropertyValue("parent", parseComponent(element))
val childElements = DomUtils.getChildElementsByTagName(element, "component")
if (childElements != null && childElements.size > 0) {
parseChildComponents(childElements, factory)
}
return factory.getBeanDefinition()
}
private fun parseComponent(element: Element): BeanDefinition {
val component = BeanDefinitionBuilder.rootBeanDefinition(Component::class.java)
component.addPropertyValue("name", element.getAttribute("name"))
return component.beanDefinition
}
private fun parseChildComponents(childElements: List<Element>, factory: BeanDefinitionBuilder) {
val children = ManagedList<BeanDefinition>(childElements.size)
for (element in childElements) {
children.add(parseComponentElement(element))
}
factory.addPropertyValue("children", children)
}
}
最后,各种构件需要在Spring XML基础设施中注册,方法是修改META-INF/spring.handlers
和META-INF/spring.schemas
文件,如下所示:
# 在 'META-INF/spring.handlers' http\://www.foo.example/schema/component=com.foo.ComponentNamespaceHandler
# 在 'META-INF/spring.schemas' http\://www.foo.example/schema/component/component.xsd=com/foo/component.xsd
在“普通”元素上自定义属性
编写自定义解析器及相关工件并不难。但有时并不是正确的做法。考虑这样一种情况,您需要向已存在的bean定义添加元数据。在这种情况下,您肯定不希望编写自己的整个自定义扩展。相反,您只想向现有的bean定义元素添加一个额外的属性。
再举一个例子,假设您为一个服务对象定义了一个bean定义,该对象(未知)访问一个集群化的JCache,并且您希望确保在周围集群中急切启动命名的JCache实例。以下清单显示了这样的定义:
<bean id="checkingAccountService" class="com.foo.DefaultCheckingAccountService"
jcache:cache-name="checking.account">
<!-- 这里是其他依赖项... -->
</bean>
然后,当解析'jcache:cache-name'
属性时,我们可以创建另一个BeanDefinition
。这个BeanDefinition
然后为我们初始化了命名的JCache。我们还可以修改'checkingAccountService'
的现有BeanDefinition
,使其依赖于这个新的JCache初始化BeanDefinition
。以下清单显示了我们的JCacheInitializer
:
-
Java
-
Kotlin
package com.foo;
public class JCacheInitializer {
private final String name;
public JCacheInitializer(String name) {
this.name = name;
}
public void initialize() {
// 大量的JCache API调用以初始化命名的缓存...
}
}
package com.foo
class JCacheInitializer(private val name: String) {
fun initialize() {
// 大量的JCache API调用以初始化命名的缓存...
}
}
现在我们可以继续进行自定义扩展。首先,我们需要编写描述自定义属性的XSD模式,如下所示:
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<xsd:schema xmlns="http://www.foo.example/schema/jcache"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
targetNamespace="http://www.foo.example/schema/jcache"
elementFormDefault="qualified">
<xsd:attribute name="cache-name" type="xsd:string"/>
</xsd:schema>
接下来,我们需要创建相关的NamespaceHandler
,如下所示:
-
Java
-
Kotlin
package com.foo;
import org.springframework.beans.factory.xml.NamespaceHandlerSupport;
public class JCacheNamespaceHandler extends NamespaceHandlerSupport {
public void init() {
super.registerBeanDefinitionDecoratorForAttribute("cache-name",
new JCacheInitializingBeanDefinitionDecorator());
}
}
package com.foo
import org.springframework.beans.factory.xml.NamespaceHandlerSupport
class JCacheNamespaceHandler : NamespaceHandlerSupport() {
override fun init() {
super.registerBeanDefinitionDecoratorForAttribute("cache-name",
JCacheInitializingBeanDefinitionDecorator())
}
}
接下来,我们需要创建解析器。请注意,在这种情况下,因为我们将解析一个XML属性,所以我们编写一个BeanDefinitionDecorator
而不是BeanDefinitionParser
。以下清单显示了我们的BeanDefinitionDecorator
实现:
-
Java
-
Kotlin
package com.foo;
import org.springframework.beans.factory.config.BeanDefinitionHolder;
import org.springframework.beans.factory.support.AbstractBeanDefinition;
import org.springframework.beans.factory.support.BeanDefinitionBuilder;
import org.springframework.beans.factory.xml.BeanDefinitionDecorator;
import org.springframework.beans.factory.xml.ParserContext;
import org.w3c.dom.Attr;
import org.w3c.dom.Node;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
public class JCacheInitializingBeanDefinitionDecorator implements BeanDefinitionDecorator {
private static final String[] EMPTY_STRING_ARRAY = new String[0];
public BeanDefinitionHolder decorate(Node source, BeanDefinitionHolder holder,
ParserContext ctx) {
String initializerBeanName = registerJCacheInitializer(source, ctx);
createDependencyOnJCacheInitializer(holder, initializerBeanName);
return holder;
}
private void createDependencyOnJCacheInitializer(BeanDefinitionHolder holder,
String initializerBeanName) {
AbstractBeanDefinition definition = ((AbstractBeanDefinition) holder.getBeanDefinition());
String[] dependsOn = definition.getDependsOn();
if (dependsOn == null) {
dependsOn = new String[]{initializerBeanName};
} else {
List dependencies = new ArrayList(Arrays.asList(dependsOn));
dependencies.add(initializerBeanName);
dependsOn = (String[]) dependencies.toArray(EMPTY_STRING_ARRAY);
}
definition.setDependsOn(dependsOn);
}
private String registerJCacheInitializer(Node source, ParserContext ctx) {
String cacheName = ((Attr) source).getValue();
String beanName = cacheName + "-initializer";
if (!ctx.getRegistry().containsBeanDefinition(beanName)) {
BeanDefinitionBuilder initializer = BeanDefinitionBuilder.rootBeanDefinition(JCacheInitializer.class);
initializer.addConstructorArg(cacheName);
ctx.getRegistry().registerBeanDefinition(beanName, initializer.getBeanDefinition());
}
return beanName;
}
}
package com.foo
import org.springframework.beans.factory.config.BeanDefinitionHolder
import org.springframework.beans.factory.support.AbstractBeanDefinition
import org.springframework.beans.factory.support.BeanDefinitionBuilder
import org.springframework.beans.factory.xml.BeanDefinitionDecorator
import org.springframework.beans.factory.xml.ParserContext
import org.w3c.dom.Attr
import org.w3c.dom.Node
import java.util.ArrayList
class JCacheInitializingBeanDefinitionDecorator : BeanDefinitionDecorator {
override fun decorate(source: Node, holder: BeanDefinitionHolder,
ctx: ParserContext): BeanDefinitionHolder {
val initializerBeanName = registerJCacheInitializer(source, ctx)
createDependencyOnJCacheInitializer(holder, initializerBeanName)
return holder
}
private fun createDependencyOnJCacheInitializer(holder: BeanDefinitionHolder,
initializerBeanName: String) {
val definition = holder.beanDefinition as AbstractBeanDefinition
var dependsOn = definition.dependsOn
dependsOn = if (dependsOn == null) {
arrayOf(initializerBeanName)
} else {
val dependencies = ArrayList(listOf(*dependsOn))
dependencies.add(initializerBeanName)
dependencies.toTypedArray()
}
definition.setDependsOn(*dependsOn)
}
private fun registerJCacheInitializer(source: Node, ctx: ParserContext): String {
val cacheName = (source as Attr).value
val beanName = "$cacheName-initializer"
if (!ctx.registry.containsBeanDefinition(beanName)) {
val initializer = BeanDefinitionBuilder.rootBeanDefinition(JCacheInitializer::class.java)
initializer.addConstructorArg(cacheName)
ctx.registry.registerBeanDefinition(beanName, initializer.getBeanDefinition())
}
return beanName
}
}
最后,我们需要通过修改META-INF/spring.handlers
和META-INF/spring.schemas
文件将各种工件注册到Spring XML基础设施中,如下所示:
# 在 'META-INF/spring.handlers' http\://www.foo.example/schema/jcache=com.foo.JCacheNamespaceHandler
# 在 'META-INF/spring.schemas' http\://www.foo.example/schema/jcache/jcache.xsd=com/foo/jcache.xsd