spring源码学习之:xml配置文件标签自定义

Spring框架从2.0版本开始,提供了基于Schema风格的XML扩展机制,允许开发者扩展最基本的spring配置文件(一 般是classpath下的spring.xml)。试想一下,如果我们直接在spring.xml中加入一个自定义标签<mytag id="aty"></matag>,会发生什么呢?spring框架启动的时候会报错,因为spring根本不认识我们自定义的& lt;mytag>,这样对spring.xml的校验就会失败,最终结果就是框架不能启动。有什么方法,能够让spring认识并加载解析我们自 定义的<mytag>呢?这就是spring提供的xml扩展机制。我们可以在spring.xml中加入自己的标签,之后spring会帮 我们解析并纳入自己的管理范围内,这也就是说我们扩展了spring的功能。

现在我们来看下怎么实现这个功能,可以参考spring帮助文档中的extensible-xml.html。我们知道如果在需要在spring.xml中配置数据源,需要进行如下的配置:

<bean id="dataSource" class="org.apache.commons.dbcp.BasicDataSource">
    <property name="driverClassName" value="com.mysql.jdbc.Driver" />
    <property name="url" value="jdbc:mysql://localhost:3309/sampledb" />
    <property name="username" value="root" />
    <property name="password" value="1234" />
</bean>

这种方式配置虽然也比较简单,但是有一个缺点:使用<property>标签不够明显,不如元素属性那么直接。现在我们希望在spring.xml中做如下的配置,就能够完成数据源的配置。

<aty:datasource id="myDataSourcce" url="jdbc:mysql://localhost:3309/demodb" userName="root" password="root" />

这种方式比较直接,配置不容易出错。如果让spring能够解析这个标签,需要4步。

1、提供一个xsd文件,负责对xml的标签<datasource>进行校验

<?xml version="1.0" encoding="UTF-8"?>
<xsd:schema xmlns="http://www.aty.com/schema/aty" xmlns:xsd="http://www.w3.org/2001/XMLSchema"
  xmlns:beans="http://www.springframework.org/schema/beans"
  targetNamespace="http://www.aty.com/schema/aty" elementFormDefault="qualified"
  attributeFormDefault="unqualified">

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

  <xsd:element name="datasource">
    <xsd:complexType>
      <xsd:complexContent>
        <xsd:extension base="beans:identifiedType">
          <xsd:attribute name="url" type="xsd:string" use="required" />
          <xsd:attribute name="userName" type="xsd:string" use="required" />
          <xsd:attribute name="password" type="xsd:string" use="required" />
        </xsd:extension>
      </xsd:complexContent>
    </xsd:complexType>
  </xsd:element>

</xsd:schema>

2、定义一个BeanDefinitionParser负责解析xml,并将必要的信息放入spring中

package net.aty.custom.define;

import net.aty.custom.cfg.DataSourceInfo;

import org.springframework.beans.factory.config.BeanDefinition;
import org.springframework.beans.factory.config.BeanDefinitionHolder;
import org.springframework.beans.factory.support.BeanDefinitionReaderUtils;
import org.springframework.beans.factory.support.RootBeanDefinition;
import org.springframework.beans.factory.xml.BeanDefinitionParser;
import org.springframework.beans.factory.xml.ParserContext;
import org.w3c.dom.Element;

public class DatasourceBeanDefinitionParser implements BeanDefinitionParser
{
  public BeanDefinition parse(Element element, ParserContext context)
  {
    RootBeanDefinition def = new RootBeanDefinition();

    // 设置Bean Class
    def.setBeanClass(DataSourceInfo.class);

    // 注册ID属性
    String id = element.getAttribute("id");
    BeanDefinitionHolder idHolder = new BeanDefinitionHolder(def, id);
    BeanDefinitionReaderUtils.registerBeanDefinition(idHolder,
        context.getRegistry());

    // 注册属性
    String url = element.getAttribute("url");
    String userName = element.getAttribute("userName");
    String password = element.getAttribute("password");

    BeanDefinitionHolder urlHolder = new BeanDefinitionHolder(def, url);
    BeanDefinitionHolder userNameHolder = new BeanDefinitionHolder(def,
        userName);
    BeanDefinitionHolder passwordHolder = new BeanDefinitionHolder(def,
        password);

    BeanDefinitionReaderUtils.registerBeanDefinition(urlHolder,
        context.getRegistry());
    BeanDefinitionReaderUtils.registerBeanDefinition(userNameHolder,
        context.getRegistry());
    BeanDefinitionReaderUtils.registerBeanDefinition(passwordHolder,
        context.getRegistry());

    def.getPropertyValues().addPropertyValue("url", url);
    def.getPropertyValues().addPropertyValue("userName", userName);
    def.getPropertyValues().addPropertyValue("password", password);

    return def;
  }
}

该类的功能:设置相关的BeanClass,解析了对应的xsd文件,并将解析的内容注册到上下文中,同时返回一个BeanDefinition对象 (BeanDefinition是Spring的bean定义,提供了bean部分的操作方法,如isSingleton()、isLazyInit() 等)。注意:id属性是一个默认的属性,可以不在xsd文件中描述,但是需要注册它,否则将无法通过getBean方法获取标签定义的bean,也无法被 其他bean引用。

3、定义个NamespaceHandler,由sping框架的调用入口。这也是我们自定义xml解析的入口

package net.aty.custom.define;

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

public class DatasourceNamespaceHandlerSupport extends NamespaceHandlerSupport
{
  @Override
  public void init()
  {
    registerBeanDefinitionParser("datasource",
        new DatasourceBeanDefinitionParser());
  }
}

4、配置schema和handler

Spring没那么聪明,它无法知道我们在什么地方定义了哪些扩展标签,这些标签将被谁解析,怎么解析。这个过程要我们通过一些配置 文件来告知Spring知道,它们就是spring.handlers和spring.schemas,它们放在META-INF目录中。 Spring.jar的META-INF目录中也有同名的文件,它们的文件内容基本上是相似的,而Spring在执行过程中,如果发现其他jar文件的 META-INF文件夹中包含有这两个文件,Spring将会合并它们。

spring.handlers内容如下:

http\://www.aty.com/schema/aty=net.aty.custom.define.DatasourceNamespaceHandlerSupport

spring.schemas内容如下:

http\://www.aty.com/schema/aty.xsd=aty.xsd

我的工程目录结构如下图:

测试工程的spring.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:aty="http://www.aty.com/schema/aty"
  xsi:schemaLocation="http://www.springframework.org/schema/beans
  http://www.springframework.org/schema/beans/spring-beans-3.1.xsd
  http://www.aty.com/schema/aty
  http://www.aty.com/schema/aty.xsd">

  <aty:datasource id="myDataSourcce" url="jdbc:mysql://localhost:3309/demodb" userName="root" password="root" />

</beans>

测试类代码如下:

import net.aty.custom.cfg.DataSourceInfo;

import org.springframework.context.support.ClassPathXmlApplicationContext;

public class TestMain
{
  private static ClassPathXmlApplicationContext context = new ClassPathXmlApplicationContext(
      "spring.xml");

  public static void main(String[] args)
  {
    DataSourceInfo d = (DataSourceInfo) context.getBean("myDataSourcce");
    System.out.println(d);
  }

}

测试的工程目录结构如下:

时间: 2024-09-18 07:14:00

spring源码学习之:xml配置文件标签自定义的相关文章

Spring源码学习之:FactoryBean的使用

转载:http://book.51cto.com/art/201311/419081.htm ==========个人理解========================= FactoryBean和BeanFactory的关系[1]FactoryBean:是一个接口,是一个用户自定义实现类实现该接口的A类.当ioc容器初始化完成后.BeanFactory(ioc容器)调用getBean("beanname")的时候,返回的bean不是A类对应的实例,而是A类getObject()方法返

【spring源码学习】spring的IOC容器之自定义xml配置标签扩展namspaceHandler向IOC容器中注册bean

[spring以及第三方jar的案例]在spring中的aop相关配置的标签,线程池相关配置的标签,都是基于该种方式实现的.包括dubbo的配置标签都是基于该方式实现的.[一]原理 ===>spring在解析xml标签,一旦不是以<bean>开头的元素,就会走org.springframework.beans.factory.xml.BeanDefinitionParserDelegate的parseCustomElement(Element ele)方法解析自定义的标签 ===>

spring源码学习之:xml标签扩展配置例子

在很多情况下,我们需要为系统提供可配置化支持,简单的做法可以直接基于Spring的标准Bean来配置,但配置较为复杂或者需要更多丰富控制的 时候,会显得非常笨拙.一般的做法会用原生态的方式去解析定义好的xml文件,然后转化为配置对象,这种方式当然可以解决所有问题,但实现起来比较繁琐, 特别是是在配置非常复杂的时候,解析工作是一个不得不考虑的负担.Spring提供了可扩展Schema的支持,这是一个不错的折中方案,完成一个自定义 配置一般需要以下步骤: 设计配置属性和JavaBean 编写XSD文

spring源码学习之:spring容器的applicationContext启动过程

 Spring 容器像一台构造精妙的机器,我们通过配置文件向机器传达控制信息,机器就能够按照设定的模式进行工作.如果我们将Spring容器比喻为一辆汽车,可以将 BeanFactory看成汽车的发动机,而ApplicationContext则是 整辆汽车,它不但包括发动机,还包括离合器.变速器以及底盘.车身.电气设备等其他组件.在ApplicationContext内,各个组件按部就班. 有条不紊地完成汽车的各项功能. ApplicationContext内部封装 了一个BeanFactory对

【spring源码学习】springMVC之映射,拦截器解析,请求数据注入解析,DispatcherServlet执行过程

[一]springMVC之url和bean映射原理和源码解析 映射基本过程 (1)springMVC配置映射,需要在xml配置文件中配置<mvc:annotation-driven >  </mvc:annotation-driven> (2)配置后,该配置将会交由org.springframework.web.servlet.config.MvcNamespaceHandler处理,该类会转交给org.springframework.web.servlet.config.Anno

spring源码学习之:项目公共配置项解决方案

一:项目中有一些key,value的简单配置 org.apache.commons.configuration.DatabaseConfiguration可以轻松解决   二:配置项目的xml中bean 1 <bean name="databaseConfiguration" class="org.apache.commons.configuration.DatabaseConfiguration"> 2 <constructor-arg type

【spring源码学习】spring的事件发布监听机制源码解析

[一]相关源代码类 (1)spring的事件发布监听机制的核心管理类:org.springframework.context.event.SimpleApplicationEventMulticaster. =>该类的初始化是放在项目加载时,在ioc容器xml配置文件解析加载完毕后,注册bean创建前后置处理实现类(BeanPostProcessor 接口实现),beanFactory配置处理(BeanFactoryPostProcessor接口实现)后,初始化该事件发布监听机制的核心类. pu

【spring源码学习】spring集成orm数据框架

[一]简易的数据源配置 (1)配置文件 <!--springJdbcTemplemate数据操作配置信息 --> <bean id="driver" class="com.mysql.jdbc.Driver"></bean> <bean id="dataSource" class="org.springframework.jdbc.datasource.SimpleDriverDataSourc

【spring源码学习】spring的远程调用实现源码分析

[一]spring的远程调用提供的基础类 (1)org.springframework.remoting.support.RemotingSupport ===>spring提供实现的远程调用客户端实现的基础类 ===>例子:org.springframework.remoting.httpinvoker.HttpInvokerProxyFactoryBean org.springframework.remoting.caucho.HessianProxyFactoryBean (2)org.