如何使用Spring自定义Xml标签
如何使用Spring自定义Xml标签
目录
前言
在早期基于Xml配置的Spring Mvc项目中,我们往往会使用
正文
在分析这个自定义标签的解析机制前,我先提前剧透这个自定义标签是通过哪个强大的类来解析的吧,就是隶属于spring-context包下的ComponentScanBeanDefinitionParser,这个类在Springboot扫描Bean的过程中也扮演了重要角色。
既然知道了是这个类解析的,那么我们可以通过idea强大的搜索功能来搜它的引用之处了,这边就截图如下:
可以看到这里面初始化了8个带Parser后缀的各种Parser,从方法registerBeanDefinitionParser看出Spring是通过这个ContextNamespaceHandler来完成对以 那么我们自己是否可以自定义一个NamespaceHandler来注册我们自定义的标签解析器呢?答案是肯定的。
到这里大家可能会有个疑问,这个NameSpaceHandler是怎么使用的呢?大家如果看了我之前写的文章,那就会知道有一种方式可以配置我们自定义的NamespaceHandler.
可以看到我们在初始化BeanDefinitionReader的时候我们可以设置NamespaceHandlerResolver并且配置它的NamespaceHandler文件路径。那这个NamespaceHandler配置文件应该怎么写呢?
就一行配置,但是这里有两点要注意: 从代码里看出来我们解析自定义标签的时候其实是还需要自定义schema才能完成的。
这里我们也通过ClassPathResource设置了自定义的xsd文件路径。我们来看看xsd文件长啥样:
我们先来分析下TestBeanDefinitionParser和PersonDefinitionParser这两者有啥区别: TestBeanDefinitionParser直接实现了BeanDefinitionParser接口,内部直接定义一个RootBeanDefinition并且注册。
PersonDefinitionParser继承自AbstractSingleBeanDefinitionParser抽象类,内部使用BeanDefinitionBuilder构造器来完成BeanDefinition的创建。
我们看到在NameSpaceHandler中我们除了parser外还可以定义自定义元素的decorator和自定义attribute的decorator,那这两个decorator是用来干嘛的呢?我们先来看下上述代码中的PropertyModifyingBeanDefinitionDecorator。
从decorate方法内部看出这个decorator是用来给我们的BeanDefinition来添加属性的。这样一来我们就可以在Xml配置中定义元素的属性值,比如下图示例:
我们看到testBean这个自定义标签定义了两个属性name和age。之后我们在使用这个testBean的时候就可以获取到它的name和age属性了。
那么ObjectNameBeanDefinitionDecorator这个attribute的Decorator是干嘛的呢?看如下示例
我们可以为这个Bean添加自定义Attribute,那么添加了这个Attribute我们怎么使用呢?看如下示例:
我们通过BeanDefinition的getAttribute就能获取到这个attribute值。 从Spring源码得知BeanDefinition扩展了AttributeAccessor接口,这个接口是用于附加和访问Bean元数据的通用的接口。直接实现这个接口的是AttributeAccessorSupport类。这个类里定义了名为attributes 的LinkedHashMap。 Spring通过自定义标签和自定义属性实现了很多扩展功能,很多我们常用的Spring配置内部都是通过它来完成的。 以上就是如何使用Spring自定义Xml标签的详细内容,更多关于使用Spring自定义Xml标签的资料请关注趣讯吧其它相关文章!自定义NameSpaceHandler
final class TestNamespaceHandler extends NamespaceHandlerSupport {
@Override
public void init() {
//注册parser
registerBeanDefinitionParser("testBean", new TestBeanDefinitionParser());
registerBeanDefinitionParser("person", new PersonDefinitionParser());
//注册element的 decorater
registerBeanDefinitionDecorator("set", new PropertyModifyingBeanDefinitionDecorator());
registerBeanDefinitionDecorator("debug", new DebugBeanDefinitionDecorator());
//注册 attr的 decorator
registerBeanDefinitionDecoratorForAttribute("object-name", new ObjectNameBeanDefinitionDecorator());
}
public class CustomXmlApplicationContext extends AbstractXmlApplicationContext {
private static final String CLASSNAME = CustomXmlApplicationContext.class.getSimpleName();
private static final String FQ_PATH = "org/wonder/frame/customBean";
private static final String NS_PROPS = format("%s/%s.properties", FQ_PATH, CLASSNAME);
public CustomXmlApplicationContext(String... configLocations) {
setConfigLocations(configLocations);
refresh();
}
@Override
protected void initBeanDefinitionReader(XmlBeanDefinitionReader reader) {
super.initBeanDefinitionReader(reader);
//1.指定resolver的 handlerMappingsLocation 就是 NamespaceHandler的 配置文件路径
NamespaceHandlerResolver resolver = new DefaultNamespaceHandlerResolver(this.getClassLoader(), NS_PROPS);
//2.设置resolver
reader.setNamespaceHandlerResolver(resolver);
//3.设置验证模式
reader.setValidationMode(XmlBeanDefinitionReader.VALIDATION_XSD);
//4.设置entityResolver
reader.setEntityResolver(new CustomSchemaResolver());
}
http\://www.john.com/resource=org.wonder.frame.customBean.TestNamespaceHandler
自定义schema
private static final String CLASSNAME = CustomXmlApplicationContext.class.getSimpleName();
private static final String FQ_PATH = "org/wonder/frame/customBean";
private static final String TEST_XSD = format("%s/%s.xsd", FQ_PATH, CLASSNAME);
private final class CustomSchemaResolver extends PluggableSchemaResolver {
public CustomSchemaResolver() {
super(CustomXmlApplicationContext.this.getClassLoader());
}
@Override
public InputSource resolveEntity(String publicId, String systemId) throws IOException {
InputSource source = super.resolveEntity(publicId, systemId);
if (source == null) {
try{
//todo 指定了xsd路径
Resource resource = new ClassPathResource(TEST_XSD);
source = new InputSource(resource.getInputStream());
source.setPublicId(publicId);
source.setSystemId(systemId);
return source;
}
catch (FileNotFoundException ex){
}
}
return null;
}
}
Parser
private static class TestBeanDefinitionParser implements BeanDefinitionParser {
@Override
public BeanDefinition parse(Element element, ParserContext parserContext) {
RootBeanDefinition definition = new RootBeanDefinition();
definition.setBeanClass(CustomBean.class);
MutablePropertyValues mpvs = new MutablePropertyValues();
mpvs.add("name", element.getAttribute("name"));
mpvs.add("age", element.getAttribute("age"));
//1.设置beanDefinition的 属性 propertyValues
definition.setPropertyValues(mpvs);
//2.获取到beanDefinition的 registry
parserContext.getRegistry().registerBeanDefinition(element.getAttribute("id"), definition);
return null;
}
}
private static final class PersonDefinitionParser extends AbstractSingleBeanDefinitionParser {
@Override
protected Class> getBeanClass(Element element) {
return CustomBean.class;
}
@Override
protected void doParse(Element element, BeanDefinitionBuilder builder) {
builder.addPropertyValue("name", element.getAttribute("name"));
builder.addPropertyValue("age", element.getAttribute("age"));
}
}
Decorator
private static class PropertyModifyingBeanDefinitionDecorator implements BeanDefinitionDecorator {
@Override
public BeanDefinitionHolder decorate(Node node, BeanDefinitionHolder definition, ParserContext parserContext) {
Element element = (Element) node;
//1.获取BeanDefinition
BeanDefinition def = definition.getBeanDefinition();
MutablePropertyValues mpvs = (def.getPropertyValues() == null) ? new MutablePropertyValues() : def.getPropertyValues();
mpvs.add("name", element.getAttribute("name"));
mpvs.add("age", element.getAttribute("age"));
((AbstractBeanDefinition) def).setPropertyValues(mpvs);
return definition;
}
}
CustomBean bean = (CustomBean) beanFactory.getBean("testBean");
System.out.println("name is:" +bean.getName() +" and age is:"+ bean.getAge());
BeanDefinition beanDefinition = this.beanFactory.getBeanDefinition("decorateWithAttribute");
assertEquals("foo", beanDefinition.getAttribute("objectName"));
总结
推荐阅读
-
Spring框架基于注解开发CRUD详解
-
spring DI依赖注入方式和区别有哪些
小编给大家分享一下springDI依赖注入方式和区别有哪些,相信大部分人都还不怎么了解,因此分享这篇文章给大家参考一下,希望大家...
-
spring data jpa开启批量插入、批量更新的示例分析
这篇文章给大家分享的是有关springdatajpa开启批量插入、批量更新的示例分析的内容。小编觉得挺实用的,因此分享给大家做...
-
spring中怎么利用FactoryBean配置Bean
这篇文章将为大家详细讲解有关spring中怎么利用FactoryBean配置Bean,文章内容质量较高,因此小编分享给大家做个参考...
-
如何解决解决Spring Boot正常启动后访问Controller提示404的问题
小编给大家分享一下如何解决解决SpringBoot正常启动后访问Controller提示404的问题,希望大家阅读完这篇文章之后...
-
Spring中怎么解决循环依赖问题
本篇文章给大家分享的是有关Spring中怎么解决循环依赖问题,小编觉得挺实用的,因此分享给大家学习,希望大家阅读完这篇文章后可以有...
-
Spring(aop,如何通过获取代理对象实现事务切换)
Spring,aop,如何通过获取代理对象实现事务切换,恰卡网带你了解更多相关信息。Springaop获取代理对象实现...
-
Spring(bean,四种注入方式详解)
Spring,bean,四种注入方式详解,恰卡网带你了解更多相关信息。目录一、Set方式注入pojo层:1.xml文件t...
-
Spring(Cloud,如何保证微服务内安全)
Spring,Cloud,如何保证微服务内安全,恰卡网带你了解更多相关信息。一、简介在微服务的架构下,我们需要把系统的业...
-
Spring(Cloud,Config,使用本地配置文件方式)
Spring,Cloud,Config,使用本地配置文件方式,恰卡网带你了解更多相关信息。一、简介在分布式系统中,由于服...