SpringBoot 自定義Schema擴展
最近在寫RPC框架時，用到了自定義的xsd配置。我們平時習慣于使用bean配置實例化對象，因此把xsd這種方式單獨拎出來。
1. 配置ServiceConfig屬性
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
|
@Datapublic class ServiceConfig { /** 接口 */ private String interfaceClass; /** 引用 */ private String ref; /** 版本 */ private String version; @Override public String toString() { return "ServiceConfig{" + "interfaceClass='" + interfaceClass + '\'' + ", ref='" + ref + '\'' + ", version='" + version + '\'' + '}'; }} |
2. 編寫XSD文件
配置element的name為service，配置的attribute對應ServiceConfig定義的屬性
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
|
<?xml version="1.0" encoding="UTF-8"?><xsd:schema xmlns="http://gitee.com/schema/link" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:beans="http://www.springframework.org/schema/beans" targetNamespace="http://gitee.com/schema/link" elementFormDefault="qualified"> <xsd:import namespace="http://www.springframework.org/schema/beans" /> <xsd:import namespace="http://www.springframework.org/schema/tool" /> <xsd:element name="service"> <xsd:complexType> <xsd:complexContent> <xsd:extension base="beans:identifiedType"> <xsd:attribute name="ref" type="xsd:string" use="required"> <xsd:annotation> <xsd:documentation><![CDATA[ 服務接口實現類]]></xsd:documentation> </xsd:annotation> </xsd:attribute> <xsd:attribute name="interfaceClass" type="xsd:string" use="required"> <xsd:annotation> <xsd:documentation><![CDATA[服務接口]]></xsd:documentation> </xsd:annotation> </xsd:attribute> <xsd:attribute name="version" type="xsd:string" /> </xsd:extension> </xsd:complexContent> </xsd:complexType> </xsd:element></xsd:schema> |
3. 編寫NamespaceHandler
registerBeanDefinitionParser方法的key是xsd配置的element的name，表示service元素由LinkServiceBeanDefinitionParser對象解析
|
1
2
3
4
5
6
|
public class LinkNamespaceHandler extends NamespaceHandlerSupport { @Override public void init() { this.registerBeanDefinitionParser("service", new LinkServiceBeanDefinitionParser()); }} |
4. 編寫BeanDefinitionParser
從element中解析出屬性，注冊到BeanDefinitionBuilder
|
1
2
3
4
5
6
7
8
9
10
11
12
|
public class LinkServiceBeanDefinitionParser extends AbstractSingleBeanDefinitionParser { @Override protected Class getBeanClass(Element element) { return ServiceConfig.class; } @Override protected void doParse(Element element, BeanDefinitionBuilder bean) { bean.addPropertyValue("ref", element.getAttribute("ref")); bean.addPropertyValue("interfaceClass", element.getAttribute("interfaceClass")); bean.addPropertyValue("version", element.getAttribute("version")); }} |
5. 配置spring.handlers和spring.schemas
|
1
2
|
http\://gitee.com/schema/link=com.test.xsd.handler.LinkNamespaceHandlerhttp\://gitee.com/schema/link/link.xsd=META-INF/link.xsd |
6. 配置spring的加載文件
在文件頭部需要引入link的schema
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
|
<?xml version="1.0" encoding="UTF-8"?><beans xmlns="http://www.springframework.org/schema/beans" xmlns:link="http://gitee.com/schema/link" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd http://gitee.com/schema/link http://gitee.com/schema/link/link.xsd"> <!-- rpc服務 --> <link:service id="serviceConfig" ref="helloService" interfaceClass="com.test.service.HelloService" version="1.0.0"/></beans> |
7. 測試
|
1
2
3
4
5
6
7
|
public class App { public static void main(String[] args) { ApplicationContext context = new ClassPathXmlApplicationContext("link-server.xml"); ServiceConfig config = (ServiceConfig) context.getBean("serviceConfig"); System.out.println(config.toString()); }} |
Spring Schema擴展機制
1. 概述
Spring2.0開始,Spring提供XML Schema可擴展機制,用戶可以自定義XML Schema文件,并自定義
XML Bean解析器，集成到Spring IOC容器中。
2. 步驟
創建一個XML Schema文件,描述自定義的合法構建模塊,也就是xsd文件。
自定義處理器類,并實現NamespaceHandler接口。
自定義一個或者多個解析器,實現BeanDefinitionParser接口(關鍵部分)。
注冊上面的組建到Spring IOC容器。
3. 示例如下
(1) 自定義XML Schema文件
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
|
<?xml version="1.0" encoding="UTF-8"?>?<xsd:schema xmlns="http://www.liuenyuan.com/schema/myns" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:beans="http://www.springframework.org/schema/beans" targetNamespace="http://www.liuenyuan.com/schema/myns" elementFormDefault="qualified"> <xsd:import namespace="http://www.springframework.org/schema/beans"/>? <xsd:element name="dateFormat"> <xsd:complexType> <xsd:complexContent> <xsd:extension base="beans:identifiedType"> <xsd:attribute name="pattern" type="xsd:string" use="required"/> </xsd:extension> </xsd:complexContent> </xsd:complexType> </xsd:element></xsd:schema> |
自定義targetNamespace是http://www.liuenyuan.com/schema/myns,xmlns與命名空間必須一致。
(2) 自定義NamespaceHandler
NamespaceHandler接口只有三個方法
-
init():在NamespaceHandler被使用之前調用,完成初始化 -
parse():解析元素 -
decorate():嵌套元素時候調用
Spring提供一個默認實現類NamespaceHandlerSupport,注入每個元素的解析器即可。
用到了代理委托概念。NamespaceHandlerSupport可以注冊任意個BeanDefinitionParser,負責所有自定義元素編排,實際XML解析工作委托給各個BeanDefinitioParser負責。
(3) 自定義BeanDefinitionParser
BeanDefinitionParser 將被調用,如果NamespapceHandler遇到元素類型已經有對應注冊的parser(例如上面的handler如果遇到dateformat，DateformatDefinitionParser會被調用，
解析相應的屬性設置到Bean中)將會被調用。BeanDefinitionParser負責解析一個頂級元素。
Spring提供AbstractSingleBeanDefinitionParser處理繁重的解析工作。
-
getBeanClass():返回元素Class類型 -
doParse():添加元素屬性或者構造參數
(4) 注冊handler和schema
把實現的NamespaceHandler和xsd文件配置到指定的配置文件中。位于META-INF目錄中。
spring.handlers文件包含xml schema uri和Handler類映射關系。
|
1
2
|
http\://www.liuenyuan.com/schema/myns=\ com.ley.springboot.schema.xml.MynsNamespaceHandler |
遇到http\://www.liuenyuan.com/schema/myns命名空間的時候會交給MynsNamespaceHandler來處理,key部分必須和xsd文件中的targetNamespace值保持一致
spring.schemas文件包含xml schema xsd文件命名空間和文件路徑映射關系。
|
1
|
http\://www.liuenyuan.com/schema/myns.xsd=META-INF/myns.xsd |
(5) 測試
NamespaceHandler實現類
|
1
2
3
4
5
6
|
public class MynsNamespaceHandler extends NamespaceHandlerSupport {? @Override public void init() { registerBeanDefinitionParser("dateFormat", new MynsBeanDefinitionParser()); }} |
BeaDefinitionParser實現類
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
|
import org.springframework.beans.factory.support.BeanDefinitionBuilder;import org.springframework.beans.factory.xml.AbstractSingleBeanDefinitionParser;import org.w3c.dom.Element;?import java.text.SimpleDateFormat;?public class MynsBeanDefinitionParser extends AbstractSingleBeanDefinitionParser {? @Override protected Class<?> getBeanClass(Element element) { return SimpleDateFormat.class; }? @Override protected void doParse(Element element, BeanDefinitionBuilder builder) { String pattern = element.getAttribute("pattern"); builder.addConstructorArgValue(pattern); }} |
以上為個人經驗，希望能給大家一個參考，也希望大家多多支持服務器之家。
原文鏈接：https://blog.csdn.net/ghaohao/article/details/81116761
