如何使用Spring自定义Xml标签

目录
  • 前言
  • 正文
  • 自定义NameSpaceHandler
  • 自定义schema
  • Parser
  • Decorator
  • 总结

前言

在早期基于Xml配置的Spring Mvc项目中,我们往往会使用<context:component-scan basePackage="">这种自定义标签来扫描我们在basePackae配置里的包名下的类,并且会判断这个类是否要注入到Spring容器中(比如这个类上标记了@Component注解就代表需要被Spring注入),如果需要那么它会帮助我们把这些类一一注入。

正文

在分析这个自定义标签的解析机制前,我先提前剧透这个自定义标签是通过哪个强大的类来解析的吧,就是隶属于spring-context包下的ComponentScanBeanDefinitionParser,这个类在Springboot扫描Bean的过程中也扮演了重要角色。

既然知道了是这个类解析的,那么我们可以通过idea强大的搜索功能来搜它的引用之处了,这边就截图如下:

可以看到这里面初始化了8个带Parser后缀的各种Parser,从方法registerBeanDefinitionParser看出Spring是通过这个ContextNamespaceHandler来完成对以<context:自定义命名空间开头的标签解析器的注册。我们可以看到Spring内部已经集成了几个常用的NamespaceHandler,截图如下:

那么我们自己是否可以自定义一个NamespaceHandler来注册我们自定义的标签解析器呢?答案是肯定的。

自定义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());
   }

到这里大家可能会有个疑问,这个NameSpaceHandler是怎么使用的呢?大家如果看了我之前写的文章,那就会知道有一种方式可以配置我们自定义的NamespaceHandler.

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());
   }

可以看到我们在初始化BeanDefinitionReader的时候我们可以设置NamespaceHandlerResolver并且配置它的NamespaceHandler文件路径。那这个NamespaceHandler配置文件应该怎么写呢?

http\://www.john.com/resource=org.wonder.frame.customBean.TestNamespaceHandler

就一行配置,但是这里有两点要注意:

  • http\://www.john.com/resource要和xsd的targetNamspace一致。
  • http\://www.john.com/resource要和xml配置文件中的自定义namespace一致。

从代码里看出来我们解析自定义标签的时候其实是还需要自定义schema才能完成的。

自定义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;
   }
}

这里我们也通过ClassPathResource设置了自定义的xsd文件路径。我们来看看xsd文件长啥样:

<?xml version="1.0" encoding="UTF-8" standalone="no"?>

<xsd:schema xmlns="http://www.john.com/resource"
         xmlns:xsd="http://www.w3.org/2001/XMLSchema"
         targetNamespace="http://www.john.com/resource"
         elementFormDefault="qualified">

   <xsd:element name="person">
      <xsd:complexType>
         <xsd:attribute name="id" type="xsd:string" use="optional" form="unqualified"/>
         <xsd:attribute name="name" type="xsd:string" use="required" form="unqualified"/>
         <xsd:attribute name="age" type="xsd:integer" use="required" form="unqualified"/>
      </xsd:complexType>
   </xsd:element>

   <xsd:element name="testBean">
      <xsd:complexType>
         <xsd:attribute name="id" type="xsd:string" use="required" form="unqualified"/>
         <xsd:attribute name="name" type="xsd:string" use="required" form="unqualified"/>
         <xsd:attribute name="age" type="xsd:integer" use="required" form="unqualified"/>
      </xsd:complexType>
   </xsd:element>

   <xsd:element name="set">
      <xsd:complexType>
         <xsd:attribute name="name" type="xsd:string" use="required" form="unqualified"/>
         <xsd:attribute name="age" type="xsd:integer" use="required" form="unqualified"/>
      </xsd:complexType>
   </xsd:element>

   <xsd:element name="debug"/>
   <xsd:attribute name="object-name" type="xsd:string"/>
</xsd:schema>

Parser

我们先来分析下TestBeanDefinitionParser和PersonDefinitionParser这两者有啥区别:

TestBeanDefinitionParser直接实现了BeanDefinitionParser接口,内部直接定义一个RootBeanDefinition并且注册。

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;
   }
}

PersonDefinitionParser继承自AbstractSingleBeanDefinitionParser抽象类,内部使用BeanDefinitionBuilder构造器来完成BeanDefinition的创建。

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

我们看到在NameSpaceHandler中我们除了parser外还可以定义自定义元素的decorator和自定义attribute的decorator,那这两个decorator是用来干嘛的呢?我们先来看下上述代码中的PropertyModifyingBeanDefinitionDecorator。

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;
   }
}

从decorate方法内部看出这个decorator是用来给我们的BeanDefinition来添加属性的。这样一来我们就可以在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:test="http://www.john.com/resource"
      xmlns:util="http://www.springframework.org/schema/util"
      xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-2.0.xsd
       http://www.springframework.org/schema/util http://www.springframework.org/schema/util/spring-util-2.0.xsd
       http://www.john.com/resource http://www.john.com/resource/org/wonder/frame/customBean/CustomXmlApplicationContext.xsd"
   default-lazy-init="true">
   <test:testBean id="testBean" name="Rob Harrop" age="23"/>
   <bean id="customisedTestBean" class="org.wonder.frame.customBean.CustomBean">
      <!-- 自定义标签加 自定义属性 -->
      <test:set name="John wonder" age="36"/>
   </bean>

</beans>

我们看到testBean这个自定义标签定义了两个属性name和age。之后我们在使用这个testBean的时候就可以获取到它的name和age属性了。

CustomBean bean = (CustomBean) beanFactory.getBean("testBean");
System.out.println("name is:" +bean.getName() +" and age is:"+ bean.getAge());

那么ObjectNameBeanDefinitionDecorator这个attribute的Decorator是干嘛的呢?看如下示例

<!--为bean设置自定义Attr-->
<bean id="decorateWithAttribute" class="org.springframework.tests.sample.beans.TestBean" test:object-name="foo"/>

我们可以为这个Bean添加自定义Attribute,那么添加了这个Attribute我们怎么使用呢?看如下示例:

BeanDefinition beanDefinition = this.beanFactory.getBeanDefinition("decorateWithAttribute");
assertEquals("foo", beanDefinition.getAttribute("objectName"));

我们通过BeanDefinition的getAttribute就能获取到这个attribute值。

从Spring源码得知BeanDefinition扩展了AttributeAccessor接口,这个接口是用于附加和访问Bean元数据的通用的接口。直接实现这个接口的是AttributeAccessorSupport类。这个类里定义了名为attributes 的LinkedHashMap。

总结

Spring通过自定义标签和自定义属性实现了很多扩展功能,很多我们常用的Spring配置内部都是通过它来完成的。

以上就是如何使用Spring自定义Xml标签的详细内容,更多关于使用Spring自定义Xml标签的资料请关注我们其它相关文章!

(0)

相关推荐

  • Springboot项目使用html5的video标签完成视频播放功能

    文件的上传与下载会另外再写一篇博客,本篇博客只是记录视频播放功能的实现过程 1.首先引入pom文件: pom.xml <?xml version="1.0" encoding="UTF-8"?> <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi

  • Spring Cloud体系实现标签路由的方法示例

    如果你正在使用Spring Cloud体系,在实际使用过程中正遇到以下问题,可以阅读本文章的内容作为后续你解决这些问题的参考,文章内容不保证无错,请务必仔细思考之后再进行实践. 问题: 1,本地连上开发或测试环境的集群连调,正常测试请求可能会请求到本地,被自己的debug阻塞. 2,测试环境维护时,多项目并发提测,维护多个相同的集群进行测试是否必要,是否有更好的方案. 一般,我们在使用Spring Cloud全家桶的时候,会选择zuul作为网关,Ribbon作为负载均衡器,Feign作为远程服务

  • SpringMVC表单标签知识点详解

    本篇我们来学习Spring MVC表单标签的使用,借助于Spring MVC提供的表单标签可以让我们在视图上展示WebModel中的数据更加轻松. 一.首先我们先做一个简单了例子来对Spring MVC表单表单标签的使用有一个大致的印象,然后再结合例子对各个标签介绍一下如何使用. 1.首先,在com.demo.web.models包中添加一个模型TagsModel内容如下: package com.demo.web.models; import java.util.List; import ja

  • spring boot 集成 shiro 自定义密码验证 自定义freemarker标签根据权限渲染不同页面(推荐

    项目里一直用的是 spring-security ,不得不说,spring-security 真是东西太多了,学习难度太大(可能我比较菜),这篇博客来总结一下折腾shiro的成果,分享给大家,强烈推荐shiro,真心简单 : ) 引入依赖 <dependency> <groupId>org.apache.shiro</groupId> <artifactId>shiro-spring</artifactId> <version>1.4

  • SpringMVC form标签引入及使用方法

    1.需在jsp页面引入头文件: <%@ taglib prefix="form" uri="http://www.springframework.org/tags/form" %> 2.在jsp页面的使用方法: 3.对应controller的使用: @RequestMapping(value = "/to_check",params = "id") public String toCheck(int id, Map

  • SpringBoot使用Thymeleaf自定义标签的实例代码

    此篇文章内容仅限于 描述springboot与 thy 自定义标签的说明,所以你在看之前,请先会使用springboot和thymeleaf!! 之前写过一篇是springMVC与thymeleaf 的自定义标签(属于自定义方言的属性一块,类似thy的th:if和th:text等)文章,如果你想了解,以下是地址: 点击>>Thymeleaf3.0自定义标签属性 这篇例子可以实现你的分页标签实现等功能,不会讲一堆的废话和底层的原理(自行百度),属于快速上手教程,请认真看以下内容! PS: 请允许

  • 这一次搞懂Spring自定义标签以及注解解析原理说明

    前言 在上一篇文章中分析了Spring是如何解析默认标签的,并封装为BeanDefinition注册到缓存中,这一篇就来看看对于像context这种自定义标签是如何解析的.同时我们常用的注解如:@Service.@Component.@Controller标注的类也是需要在xml中配置<context:component-scan>才能自动注入到IOC容器中,所以本篇也会重点分析注解解析原理. 正文 自定义标签解析原理 在上一篇分析默认标签解析时看到过这个类DefaultBeanDefinit

  • springboot 自定义权限标签(tld),在freemarker引用操作

    第一步:引入jar包 <dependency> <groupId>javax.servlet.jsp</groupId> <artifactId>jsp-api</artifactId> <version>2.2.1-b03</version> </dependency> 第二步:自定义标签类 import java.util.Map; import java.util.Set; import javax.se

  • Spring源码解密之默认标签的解析

    前言 紧跟上篇 Spring解密 - XML解析 与 Bean注册 ,我们接着往下分析源码,话不多说了,来一起看看详细的介绍吧. 解密 在 Spring 的 XML 配置里面有两大类声明,一个是默认的如 <bean id="person" class="com.battcn.bean.Person"/> ,另一类就是自定义的如<tx:annotation-driven /> ,两种标签的解析方式差异是非常大的.parseBeanDefinit

  • springboot 在ftl页面上使用shiro标签的实例代码

    1.首先第一步导入依赖 <dependency> <groupId>com.github.theborakompanioni</groupId> <artifactId>thymeleaf-extras-shiro</artifactId> <version>1.2.1</version> </dependency> 2.在配置shiro权限的方法内加入 @Bean public ShiroDialect sh

随机推荐