Java怎么自定义Spring配置标签-java教程-PHP中文网

引言：

在Sping中，一般使用这样的元素来配置一个bean，Spring在创建容器的时候会扫描这些配置，根据配置创建对象存放于容器中，然后我们再从容器中取出，或者在配置其他bean的时候作为属性注入。使用bean配置的一个限制是我们必须遵循配置文件的XML Schema定义，这在大多数情况下不会出现问题。但是在一些情况下，我们希望实现更为灵活的bean配置。Spring为此提供了 Custom tag Support，也称为Extensible XML Authoring。通过这个拓展点，我们可以灵活定制自己需要的配置格式。

例如，如果我们使用了责任链设计应用程序，那么我们可能希望用下面的方式来配置责任链：


     handler1
     handler2

档Spring创建容器时，扫描到这样的元素的时候，会根据我们事先的定义实例化一个责任链对象，并填充属性。因此，这种特殊的标签可以作为标签以外的另一种形式。借助Spring的Custome Tag，我们完全可以实现这样的bean配置。在产品级的应用框架中，可以实现更为复杂的定制标签元素。作为一个入门级别的介绍，我们定义一个用于配置日期格式化的一个类SimpleDateFormat。当然，使用传统的完全够用，我们这里只是作为例子。

一个HelloWorld例子：

立即学习“Java免费学习笔记（深入）”；

定制标签的第一步是要定义标签元素的XML结构，也就是采用XSD来元素我们要定制的元素的结构时怎样的。

我们定义如下一个简单的XSD：

在这个XSD定义中，有一个标签叫dateformat，这就是我们用来替换bean标签的自定义标签。注意到我们导入了Spring本身的beans命名空间，并且在beans:identifiedType基础之上定义dateformat标签。也就是我们这个标签可以像标签一样拥有id属性。同时我们增加了两个属性lenient和pattern。这有点继承的味道。

定义完XSD之后，我们要告诉Spring遇到这样的标记（命名空间+元素名称）时，如何创建对象。Spring中，完成这个任务的是NamespaceHandler。因此我们需要提供一个NamespaceHandler实现来处理自定义的标签元素。

一个简单的实现如下：

package extensiblexml.customtag;
import org.springframework.beans.factory.xml.NamespaceHandlerSupport;
public class MyNamespaceHandler extends NamespaceHandlerSupport {
	public void init() {
		registerBeanDefinitionParser("dateformat",
				new SimpleDateFormatBeanDefinitionParser());
	}
 
}

我们在初始化方法中注册了一个Bean定义的解析器，这个解析器就是用来解析定制的配置标签的。

其实现如下：

package extensiblexml.customtag;
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 { 
    protected Class getBeanClass(Element element) {
        return SimpleDateFormat.class; 
    }
    @SuppressWarnings("deprecation")
	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.addConstructorArg(pattern);
 
        // this however is an optional property
        String lenient = element.getAttribute("lenient");
        if (StringUtils.hasText(lenient)) {
            bean.addPropertyValue("lenient", Boolean.valueOf(lenient));
        }
    }
 
}

这个解析器的doParse中，实现了解析的具体逻辑，借助Spring提供的支持类，我们可以很轻松地完成解析。以上三个文件放在同一个目录下，即把XSD文件跟Java代码放在同一目录。编码完毕之后，还需要做一些配置工作。我们必须告诉Spring我们准备使用自定义的标签元素，告诉Spring如何解析元素，否则Spring没那么聪明。这里需要2个配置文件，在与代码根路径同一级别下，床垫一个叫META-INF的文件。并在里面创建名为spring.handlers和spring.schemas,用于告诉Spring自定义标签的文档结构以及解析它的类。两个文件内容分别如下：

spring.handlers:

http\://www.mycompany.com/schema/myns=extensiblexml.customtag.MyNamespaceHandler

等号的左边是XSD定义中的targetNamespace属性，右边是NamespaceHandler的全称限定名。

spring.schemas:

http\://www.mycompany.com/schema/myns/myns.xsd=extensiblexml/customtag/myns.xsd

然后像往常一样配置bean，作为简单的测试，我们定义一个bean：

在Eclipse中，整个项目结构如下图：

Java怎么自定义Spring配置标签

最后我们写个测试类测试一下能否工作：

package extensiblexml.customtag;
import java.text.SimpleDateFormat;
import java.util.Date;
import org.springframework.context.ApplicationContext;
import org.springframework.context.support.ClassPathXmlApplicationContext;
public class Test {
	public static void main(String[] args) {
		ApplicationContext context = new ClassPathXmlApplicationContext(
				"beans.xml");
		SimpleDateFormat format = (SimpleDateFormat) context
				.getBean("defaultDateFormat");
		System.out.println(format.format(new Date()));
 
	}
 
}

一切正常，输出如下：

Java怎么自定义Spring配置标签

更实用的例子

YXPHP企业网站管理系统4.0

支持静态模板,支持动态模板标签,支持图片.SWF.FLV系列广告标签.支持百万级海量数据,绑定内置URL伪装策略(URL后缀名随你怎么写)，绑定内置系统升级策略(暂不开放升级),绑定内置模板付费升级策略(暂不开放更新)。支持标签容错处理,绑定内置攻击防御策略,绑定内置服务器优化策略(系统内存释放的干干净净)。支持离线运行,支持次目录,兼容U主机。支持会员功能,支持文章版块权限阅读,支持会员自主注册

下载

第一个例子主要是为了举例，在实际中用处不大，我们接着来看一个更复杂的自定义标签。我们自定义一个标签，当Spring扫描到这个标签的时候，创建一个指定目录下的File类的集合。另外，可以使用对该目录的文件进行过滤。

如下：

上面的bean定义中，我们从“src/extensible/example”目录中筛选出java源码文件。

使用下面的测试迭代输出文件名：

@SuppressWarnings("unchecked")
List fileList = (List) context.getBean("xmlList");
for (File file : fileList) {
	System.out.println(file.getName());
}

输出结果如下：

Java怎么自定义Spring配置标签

根据第一个例子中的步骤，各部分配置及代码如下：

core-commons-1.0.xsd:

CoreNamespaceHandler.java:

package extensiblexml.example;
import org.springframework.beans.factory.xml.NamespaceHandlerSupport;
public class CoreNamespaceHandler
    extends NamespaceHandlerSupport
{
    @Override
    public void init() {
        this.registerBeanDefinitionParser("fileList", new FileListDefinitionParser());
        this.registerBeanDefinitionParser("fileFilter", new FileFilterDefinitionParser());
    }
}

FileListDefinitionParser.java:

public class FileListDefinitionParser
	extends AbstractSingleBeanDefinitionParser
{
	/**
	 * The bean that is created for this tag element
	 *
	 * @param element The tag element
	 * @return A FileListFactoryBean
	 */
	@Override
	protected Class getBeanClass(Element element) {
		return FileListFactoryBean.class;
	}
 
	/**
	 * Called when the fileList tag is to be parsed
	 *
	 * @param element The tag element
	 * @param ctx The context in which the parsing is occuring
	 * @param builder The bean definitions build to use
	 */
	@Override
	protected void doParse(Element element, ParserContext ctx, BeanDefinitionBuilder builder) {
		// Set the directory property
		builder.addPropertyValue("directory", element.getAttribute("directory"));
 
		// Set the scope
		builder.setScope(element.getAttribute("scope"));
 
		// We want any parsing to occur as a child of this tag so we need to make
		// a new one that has this as it's owner/parent
		ParserContext nestedCtx = new ParserContext(ctx.getReaderContext(), ctx.getDelegate(), builder.getBeanDefinition());
 
		// Support for filters
		Element exclusionElem = DomUtils.getChildElementByTagName(element, "fileFilter");
		if (exclusionElem != null) {
			// Just make a new Parser for each one and let the parser do the work
			FileFilterDefinitionParser ff = new FileFilterDefinitionParser();
			builder.addPropertyValue("filters", ff.parse(exclusionElem, nestedCtx));
		}
 
		// Support for nested fileList
		List fileLists = DomUtils.getChildElementsByTagName(element, "fileList");
		// Any objects that created will be placed in a ManagedList
		// so Spring does the bulk of the resolution work for us
		ManagedList