如何使用Spring自定義Xml標(biāo)簽

更新時(shí)間：2021年06月21日 11:47:16 作者：沉迷Spring

要實(shí)現(xiàn)自定義的xml配置，需要有兩個(gè)默認(rèn)spring配置文件來(lái)支持。一個(gè)是spring.schemas,一個(gè)是spring.handlers，前者是為了驗(yàn)證你自定義的xml配置文件是否符合你的格式要求，后者是告訴spring該如何來(lái)解析你自定義的配置文件。本文將介紹如何使用Spring自定義Xml標(biāo)簽

前言

在早期基于Xml配置的Spring Mvc項(xiàng)目中，我們往往會(huì)使用<context:component-scan basePackage="">這種自定義標(biāo)簽來(lái)掃描我們?cè)赽asePackae配置里的包名下的類(lèi)，并且會(huì)判斷這個(gè)類(lèi)是否要注入到Spring容器中(比如這個(gè)類(lèi)上標(biāo)記了@Component注解就代表需要被Spring注入),如果需要那么它會(huì)幫助我們把這些類(lèi)一一注入。

正文

在分析這個(gè)自定義標(biāo)簽的解析機(jī)制前，我先提前劇透這個(gè)自定義標(biāo)簽是通過(guò)哪個(gè)強(qiáng)大的類(lèi)來(lái)解析的吧，就是隸屬于spring-context包下的ComponentScanBeanDefinitionParser，這個(gè)類(lèi)在Springboot掃描Bean的過(guò)程中也扮演了重要角色。

既然知道了是這個(gè)類(lèi)解析的，那么我們可以通過(guò)idea強(qiáng)大的搜索功能來(lái)搜它的引用之處了，這邊就截圖如下：

可以看到這里面初始化了8個(gè)帶Parser后綴的各種Parser,從方法registerBeanDefinitionParser看出Spring是通過(guò)這個(gè)ContextNamespaceHandler來(lái)完成對(duì)以<context:自定義命名空間開(kāi)頭的標(biāo)簽解析器的注冊(cè)。我們可以看到Spring內(nèi)部已經(jīng)集成了幾個(gè)常用的NamespaceHandler,截圖如下：

那么我們自己是否可以自定義一個(gè)NamespaceHandler來(lái)注冊(cè)我們自定義的標(biāo)簽解析器呢？答案是肯定的。

自定義NameSpaceHandler

final class TestNamespaceHandler extends NamespaceHandlerSupport {

   @Override
   public void init() {

      //注冊(cè)parser
      registerBeanDefinitionParser("testBean", new TestBeanDefinitionParser());
      registerBeanDefinitionParser("person", new PersonDefinitionParser());

      //注冊(cè)element的 decorater
      registerBeanDefinitionDecorator("set", new PropertyModifyingBeanDefinitionDecorator());
      registerBeanDefinitionDecorator("debug", new DebugBeanDefinitionDecorator());

      //注冊(cè) attr的 decorator
      registerBeanDefinitionDecoratorForAttribute("object-name", new ObjectNameBeanDefinitionDecorator());
   }

到這里大家可能會(huì)有個(gè)疑問(wèn)，這個(gè)NameSpaceHandler是怎么使用的呢？大家如果看了我之前寫(xiě)的文章，那就會(huì)知道有一種方式可以配置我們自定義的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.設(shè)置resolver
      reader.setNamespaceHandlerResolver(resolver);
      //3.設(shè)置驗(yàn)證模式
      reader.setValidationMode(XmlBeanDefinitionReader.VALIDATION_XSD);
      //4.設(shè)置entityResolver
      reader.setEntityResolver(new CustomSchemaResolver());
   }

可以看到我們?cè)诔跏蓟疊eanDefinitionReader的時(shí)候我們可以設(shè)置NamespaceHandlerResolver并且配置它的NamespaceHandler文件路徑。那這個(gè)NamespaceHandler配置文件應(yīng)該怎么寫(xiě)呢？

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

就一行配置，但是這里有兩點(diǎn)要注意：

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

從代碼里看出來(lái)我們解析自定義標(biāo)簽的時(shí)候其實(shí)是還需要自定義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;
   }
}

這里我們也通過(guò)ClassPathResource設(shè)置了自定義的xsd文件路徑。我們來(lái)看看xsd文件長(zhǎng)啥樣：

<?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

我們先來(lái)分析下TestBeanDefinitionParser和PersonDefinitionParser這兩者有啥區(qū)別：

TestBeanDefinitionParser直接實(shí)現(xiàn)了BeanDefinitionParser接口，內(nèi)部直接定義一個(gè)RootBeanDefinition并且注冊(cè)。

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.設(shè)置beanDefinition的 屬性 propertyValues
      definition.setPropertyValues(mpvs);

      //2.獲取到beanDefinition的 registry
      parserContext.getRegistry().registerBeanDefinition(element.getAttribute("id"), definition);
      return null;
   }
}

PersonDefinitionParser繼承自AbstractSingleBeanDefinitionParser抽象類(lèi)，內(nèi)部使用BeanDefinitionBuilder構(gòu)造器來(lái)完成BeanDefinition的創(chuàng)建。

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,那這兩個(gè)decorator是用來(lái)干嘛的呢？我們先來(lái)看下上述代碼中的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方法內(nèi)部看出這個(gè)decorator是用來(lái)給我們的BeanDefinition來(lái)添加屬性的。這樣一來(lái)我們就可以在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">
      <!-- 自定義標(biāo)簽加 自定義屬性 -->
      <test:set name="John wonder" age="36"/>
   </bean>

</beans>

我們看到testBean這個(gè)自定義標(biāo)簽定義了兩個(gè)屬性name和age。之后我們?cè)谑褂眠@個(gè)testBean的時(shí)候就可以獲取到它的name和age屬性了。

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

那么ObjectNameBeanDefinitionDecorator這個(gè)attribute的Decorator是干嘛的呢？看如下示例

<!--為bean設(shè)置自定義Attr-->
<bean id="decorateWithAttribute" class="org.springframework.tests.sample.beans.TestBean" test:object-name="foo"/>

我們可以為這個(gè)Bean添加自定義Attribute，那么添加了這個(gè)Attribute我們?cè)趺词褂媚?？看如下示例?/p>

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

我們通過(guò)BeanDefinition的getAttribute就能獲取到這個(gè)attribute值。

從Spring源碼得知BeanDefinition擴(kuò)展了AttributeAccessor接口，這個(gè)接口是用于附加和訪問(wèn)Bean元數(shù)據(jù)的通用的接口。直接實(shí)現(xiàn)這個(gè)接口的是AttributeAccessorSupport類(lèi)。這個(gè)類(lèi)里定義了名為attributes 的LinkedHashMap。