Spring——使用自定義標簽

文章內容參考了《Spring源碼深度解析》一書。自己照着書中內容做了一遍，不懂的地方以及采坑的地方會在文中記錄。

推薦一篇post，關於Spring配置文件的命名空間：

https://www.cnblogs.com/gonjan-blog/p/6637106.html

 

我們暫時只是知道使用Spring的常規標簽，加個bean，事務，Aop等等。隨着滿足業務的需求，同時降低程序員的工作量，我們有時需要自己定制一些標簽。話補多少，下面進入主題。

 

自定義標簽的使用

擴展Spring自定義標簽大致需要如下幾步：（把大象裝冰箱，需要三步，開門，放，關門。。。）

1.創建需要擴展的組件

2.定義XSD文件描述組件內容

3.創建一個文件，實現BeanDefinitionParser接口，用來解析XSD文件中的定義和組件定義

4.創建Handler文件，擴展字NamespaceHandlerSupport,目的是將組件注冊到Spring容器

5.編寫Spring.handlers和Spring.schemas文件

上述，五點看完了，我最開始時一頭霧水，這是什么啊？別着急，跟哥往下走。下面有好東西，保證不打暈你。

 

例子：

1.創建POJO，接收配置文件

package test.customtag;

public class User {
    private String userName;
    public String getUserName() {
        return userName;
    }
    public void setUserName(String userName) {
        this.userName = userName;
    }
    private String email;
    public String getEmail() {
        return email;
    }
    public void setEmail(String email) {
        this.email = email;
    }
}

2.定義一個XSD文件描述組件內容

src/main/resources/META-INF/user.xsd

<?xml version="1.0" encoding="UTF-8"?>
<schema xmlns="http://www.w3.org/2001/XMLSchema" targetNamespace="http://www.example.org/schema/user" xmlns:tns="http://www.example.org/schema/user" elementFormDefault="qualified">
    <element name="user2">
        <complexType>
            <attribute name ="id" type = "string"/>
            <attribute name ="userName" type = "string"/>
            <attribute name ="email" type = "string"/>
        </complexType>
    </element>
</schema>

描述了一個targetNamespace，並且創建了一個element user2。里面有三個attribute。主要是為了驗證Spring配置文件中的自定義格式。再進一步解釋，就是，Spring位置文件中使用的user2自定義標簽中，屬性只能是上面的三種，有其他的屬性的話，就會報錯。

網上有人說element ，complexType等等這些標簽要用XSD開頭的標簽，但是我這里沒有用也能成功的執行，我猜測可能是spring的版本問題。（我這個猜測沒有依據）

大家對這個XSD可能會有疑問，不要擔心。推薦一篇post，里面講解的很好，地址放在文章開頭那里。

3.創建文件，實現BeanDefinitionParser接口，用來解析XSD文件中的定義和組件定義

package test.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;

public class UserBeanDefinitionParser extends AbstractSingleBeanDefinitionParser {

    @SuppressWarnings("rawtypes")
    protected Class getBeanClass(Element element) {
        return User.class;
    }
    
    protected void doParse(Element element, BeanDefinitionBuilder bean) {
        String userName = element.getAttribute("userName");
        String email = element.getAttribute("email");
        if (StringUtils.hasText(userName)) {
            bean.addPropertyValue("userName", userName);
        }
        if (StringUtils.hasText(email)){
            bean.addPropertyValue("email", email);
        } 
        
    }
}

上文，雖說是繼承了AbstractSingleBeanDefinitionParser ，但根本上來說，是實現了BeanDefinitionParser接口。

4.創建Handler文件，擴展自NamespaceHandlerSupport，目的是將組件注冊到Spring容器中。

package test.customtag;

import org.springframework.beans.factory.xml.NamespaceHandlerSupport;

public class MyNamespaceHandler extends NamespaceHandlerSupport {

    public void init() {

        registerBeanDefinitionParser("user2", new UserBeanDefinitionParser());
    }

}

5.編寫Spring.handlers和Spring.schemas文件

路徑：src/main/resources/META-INF/Spring.handlers

http\://www.example.org/schema/user=test.customtag.MyNamespaceHandler

路徑：src/main/resources/META-INF/Spring.schemas

http\://www.example.org/schema/user.xsd=META-INF/user.xsd

\ 是轉義字符的概念。

6.創建測試配置文件

路徑：src/main/resources/test.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:myname2="http://www.example.org/schema/user"
    xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
    http://www.example.org/schema/user http://www.example.org/schema/user.xsd">
    
    <myname2:user2 id = "testbean" userName = "lee" email = "bbb"/>
</beans>

在第4行這里引入了myname2對應的命名空間，它會到第六行（http://www.example.org/schema/user.xsd）找到對應XSD文件進行check。第六行的user.xsd文件的位置，到步驟5里的Spring.schemas里去參照。

在這里說明一下自己遇到的疑問：第八行，自己eclipse報了紅叉，信息如下：

Multiple annotations found at this line:
    - cvc-complex-type.2.4.c: The matching wildcard is strict, but no declaration can be found for element 'myname2:user2'.
    - schema_reference.4: Failed to read schema document 'http://www.example.org/schema/user.xsd', because 1) could not find the
     document; 2) the document could not be read; 3) the root element of the document is not <xsd:schema>.

但是，我沒有解決它，直接執行第6步的代碼，最后成功執行了，搞不懂原因。

6.測試。

package test.customtag;

import org.springframework.context.ApplicationContext;
import org.springframework.context.support.ClassPathXmlApplicationContext;

public class Tst {    
    public static void main(String[] args) {    
        ApplicationContext beans=new ClassPathXmlApplicationContext("classpath:test.xml");    
        User user=(User)beans.getBean("testbean");    
        System.out.println("username:"+user.getUserName()+"  "+"email:"+user.getEmail());    
    }    
}   

 

文章記錄的不是特別的詳細，有一些知識點沒有全面的記錄。但是，跟着一步步做，Spring自定義標簽的實現，應該是沒有問題了。稍后，有時間，會記錄Sping源碼中，關於自定義標簽解析的部分。與君共勉。