基于Spring可扩展Schema提供自定义配置支持(spring配置文件中配置标签支持)-白红宇

基于Spring可扩展Schema提供自定义配置支持(spring配置文件中配置标签支持)

阅读量：6570 次

发布时间：2019-06-24

本文共 4746 字，大约阅读时间需要 15 分钟。

spring使用了这么长时间，你真的了解spring bean加载的机制吗？

这个是我们项目中最常见的配置文件中的内容配置，但是spring 到底是怎么通过配置文件去实例化bean对象的呢，下面让我们一探究竟：

如何自定义配置扩展Schema的支持

设计配置属性和JavaBean

编写XSD文件

编写NamespaceHandler和BeanDefinitionParser完成解析工作

编写spring.handlers和spring.schemas串联起所有部件

1）设计配置属性和JavaBean

首先当然得设计好配置项，并通过JavaBean来建模，本例中需要配置Student实体，配置属性name和age（id是默认需要的）

代码:

public class Student{

private String id;

private String name;

private Integer age;

}

2）编写XSD文件

为上一步设计好的配置项编写XSD文件，XSD是schema的定义文件，配置的输入和解析输出都是以XSD为契约，本例中XSD如下：

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

<xsd:schema

xmlns="http://my.oschina.net/cutesource/schema/student"

xmlns:xsd="http://www.w3.org/2001/XMLSchema"

xmlns:beans="http://www.springframework.org/schema/beans"

targetNamespace="http://my.oschina.net/cutesource/schema/student"

elementFormDefault="qualified"

attributeFormDefault="unqualified">

<xsd:import namespace="http://www.springframework.org/schema/beans" />

<xsd:element name="student"> 注释：对应着配置项节点的名称，因此在应用中会用student作为节点名来引用这个配置

<xsd:complexType>

<xsd:complexContent>

<xsd:extension base="beans:identifiedType">

<xsd:attribute name="name" type="xsd:string" />

<xsd:attribute name="age" type="xsd:int" /> 注释：对应着配置项student的两个属性名，因此在应用中可以配置name和age两个属性，分别是string和int类型

</xsd:extension>

</xsd:complexContent>

</xsd:complexType>

</xsd:element>

</xsd:schema>

完成后需把xsd存放在classpath下，一般都放在META-INF目录下

3）编写NamespaceHandler和BeanDefinitionParser完成解析工作

下面需要完成解析工作，会用到NamespaceHandler和BeanDefinitionParser这两个概念。具体说来NamespaceHandler会根据schema和节点名找到某个BeanDefinitionParser，然后由BeanDefinitionParser完成具体的解析工作。因此需要分别完成NamespaceHandler和BeanDefinitionParser的实现类，Spring提供了默认实现类NamespaceHandlerSupport和AbstractSingleBeanDefinitionParser，简单的方式就是去继承这两个类。

代码：

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

public class MyNamespaceHandler extends NamespaceHandlerSupport {

public void init() {

registerBeanDefinitionParser("student", new StudentBeanDefinitionParser());

}

其中registerBeanDefinitionParser("student", new StudentBeanDefinitionParser());就是用来把节点名和解析类联系起来，在配置中引用student配置项时，就会用StudentBeanDefinitionParser来解析配置。

StudentBeanDefinitionParser代码：

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 StudentBeanDefinitionParserextends AbstractSingleBeanDefinitionParser {

protected Class getBeanClass(Element element) {

return People.class;

}

protected void doParse(Element element, BeanDefinitionBuilder bean) {

String name = element.getAttribute("name");

String age = element.getAttribute("age");

String id = element.getAttribute("id");

if (StringUtils.hasText(id)) { 注释：赋值到bean

bean.addPropertyValue("id", id);

}

if (StringUtils.hasText(name)) {

bean.addPropertyValue("name", name);

}

if (StringUtils.hasText(age)) {

bean.addPropertyValue("age", Integer.valueOf(age));

}

其中element.getAttribute就是用配置中取得属性值，bean.addPropertyValue就是把属性值放到bean中。

4）编写spring.handlers和spring.schemas串联起所有部件

上面几个步骤走下来会发现开发好的handler与xsd还没法让应用感知到，就这样放上去是没法把前面做的工作纳入体系中的，spring提供了spring.handlers和spring.schemas这两个配置文件来完成这项工作，这两个文件需要我们自己编写并放入META-INF文件夹中，这两个文件的地址必须是META-INF/spring.handlers和META-INF/spring.schemas，spring会默认去载入它们，本例中spring.handlers如下所示：

http\://my.oschina.net/cutesource/schema/student=study.schemaExt.MyNamespaceHandler 注释：MyNamespaceHandler的包路径

以上表示当使用到名为"student"的schema引用时，会通过study.schemaExt.MyNamespaceHandler来完成解析

spring.schemas如下所示：

http\://my.oschina.net/cutesource/schema/student.xsd=META-INF/student.xsd

以上就是载入xsd文件

5）在Bean文件中应用

到此为止一个简单的自定义配置以完成，可以在具体应用中使用了。使用方法很简单，和配置一个普通的spring bean类似，只不过需要基于我们自定义schema，本例中引用方式如下所示：

<beans xmlns="http://www.springframework.org/schema/beans"

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

xmlns:cutesource="http://my.oschina.net/cutesource/schema/student"

xsi:schemaLocation="

http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-2.5.xsd