`
blue2048
  • 浏览: 182728 次
  • 性别: Icon_minigender_1
  • 来自: 北京
社区版块
存档分类
最新评论

扩展spring,自定义xml配置文件

阅读更多

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

设计配置属性和JavaBean 
编写XSD文件 
编写NamespaceHandler和BeanDefinitionParser完成解析工作 
编写spring.handlers和spring.schemas串联起所有部件 
在Bean文件中应用 
下面结合一个小例子来实战以上过程

1)设计配置属性和JavaBean

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

 

public class People {  
    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://blog.csdn.net/cutesource/schema/people"  
    xmlns:xsd="http://www.w3.org/2001/XMLSchema"   
    xmlns:beans="http://www.springframework.org/schema/beans"  
    targetNamespace="http://blog.csdn.net/cutesource/schema/people"  
    elementFormDefault="qualified"   
    attributeFormDefault="unqualified">  
    <xsd:import namespace="http://www.springframework.org/schema/beans" />  
    <xsd:element name="people">  
        <xsd:complexType>  
            <xsd:complexContent>  
                <xsd:extension base="beans:identifiedType">  
                    <xsd:attribute name="name" type="xsd:string" />  
                    <xsd:attribute name="age" type="xsd:int" />  
                </xsd:extension>  
            </xsd:complexContent>  
        </xsd:complexType>  
    </xsd:element>  
</xsd:schema> 
复制代码

 

关于xsd:schema的各个属性具体含义就不作过多解释,可以参见http://www.w3school.com.cn/schema/schema_schema.asp

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

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

完成后需把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("people", new PeopleBeanDefinitionParser());  
    }  
}  

 

其中registerBeanDefinitionParser("people", new PeopleBeanDefinitionParser());就是用来把节点名和解析类联系起来,在配置中引用people配置项时,就会用PeopleBeanDefinitionParser来解析配置。PeopleBeanDefinitionParser就是本例中的解析类:

 

复制代码
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 PeopleBeanDefinitionParser extends 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.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\://blog.csdn.net/cutesource/schema/people=study.schemaExt.MyNamespaceHandler

以上表示当使用到名为"http://blog.csdn.net/cutesource/schema/people"的schema引用时,会通过study.schemaExt.MyNamespaceHandler来完成解析

spring.schemas如下所示:

http\://blog.csdn.net/cutesource/schema/people.xsd=META-INF/people.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://blog.csdn.net/cutesource/schema/people"  
    xsi:schemaLocation="  
http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-2.5.xsd  
http://blog.csdn.net/cutesource/schema/people http://blog.csdn.net/cutesource/schema/people.xsd">  
    <cutesource:people id="cutesource" name="袁志俊" age="27"/>  
</beans> 
复制代码

 

其中xmlns:cutesource="http://blog.csdn.net/cutesource/schema/people"是用来指定自定义schema,xsi:schemaLocation用来指定xsd文件。<cutesource:people id="cutesource" name="zhijun.yuanzj" age="27"/>是一个具体的自定义配置使用实例。

最后就可以在具体程序中使用基本的bean载入方式来载入我们的自定义配置对象了,如:

 

 

ApplicationContext ctx = new ClassPathXmlApplicationContext("application.xml");  
People p = (People)ctx.getBean("cutesource");  
System.out.println(p.getId());  
System.out.println(p.getName());  
System.out.println(p.getAge());  

 

会输出:
cutesource
袁志俊
27

以上就是一个基于Spring可扩展Schema提供自定义配置支持实战过程,一些复杂应用和技巧还有待挖掘

 

转自 http://www.cnblogs.com/jifeng/archive/2011/09/14/2176599.html

 

分享到:
评论

相关推荐

    spring自定义xml配置扩展

    主要是讲spring自定义xml配置的扩展相关的内容,东西不算新的,都是比较基础的,想看就看一下 我也是为了搞点积分才上传的

    spring 自定义xml标签

    在Spring框架中,自定义XML标签是扩展Spring配置能力的重要方式。这允许开发者创建符合项目需求的特定标签,提高代码的可读性和可维护性。本文将深入探讨如何在Spring中自定义XML标签,以及其背后的原理和实现过程。...

    spring-boot 自定义xml配置web请求拦截器

    标题中的"spring-boot 自定义xml配置web请求拦截器"指的是在Spring Boot项目中,通过XML配置方式实现对Web请求的拦截处理。这涉及到Spring Boot的Web层架构、AOP(面向切面编程)以及自定义拦截器的概念。Spring ...

    Spring自定义配置文件便签[Maven]工程可运行

    然而,随着项目的复杂性增加,XML配置文件可能会变得庞大且难以维护。这就是自定义配置文件和标签的用武之地。 1. **自定义配置文件**:自定义配置文件允许我们创建自己的配置格式,从而简化和模块化Spring的配置。...

    spring自定义标签例子

    3. **定义标签库**:为了能在XML配置文件中使用自定义标签,你需要创建一个TLD(Tag Library Descriptor)文件,如`mytags.tld`。在这个文件中,你需要定义标签的名称、全限定类名以及各种属性。 4. **使用自定义...

    自定义 Schema 解析 Spring Bean

    本篇文章将聚焦于“自定义Schema解析Spring Bean”这一主题,这是一项高级功能,允许开发者扩展Spring的XML配置能力,以满足特定项目的需要。 自定义Schema解析是Spring框架提供的一个强大特性,它允许开发者创建...

    SpringSecurity 3配置文件

    在Spring Security 3中,主要的配置文件名为`security.xml`,这个文件定义了整个安全体系的结构。 1. **核心组件** - `http`: 这个元素定义了HTTP安全配置,包括拦截URL、登录页面设置、访问控制等。例如,你可以...

    spring mvc的配置文件详解

    ### Spring MVC 的配置文件详解 #### 一、配置分发器 (DispatcherServlet) Spring MVC 的核心组件之一就是 DispatcherServlet,它作为整个框架的入口,负责处理所有进入 Spring Web 应用程序的请求。为了使 ...

    spring-扩展点-namespacehandler(Spring自定义标签)

    总的来说,`spring-web-namespacehandler`是Spring MVC中处理自定义XML标签的核心组件,它使得开发者可以方便地通过XML配置来扩展和定制Spring MVC的行为。通过对`NamespaceHandler`及其相关组件的深入研究,我们...

    spring xml扩展

    首先,了解Spring XML配置的基本结构至关重要。在Spring应用中,通常会有一个或多个`beans.xml`文件,这些文件定义了应用中的bean及其依赖关系。例如: ```xml &lt;beans xmlns="http://www.springframework.org/...

    Spring XML 的配置实例

    Spring 框架是 Java 后端开发中的一个重要组成部分,尤其在传统的应用程序中,XML 配置文件扮演了核心角色。本实例将深入探讨 Spring 的 XML 配置机制,了解如何通过 XML 文件来管理和组织应用的组件。 XML 配置是 ...

    自定义xml标签

    在Spring框架中,自定义XML标签是扩展Spring配置能力的一种方式,这允许我们创建更加语义化的配置元素,提高代码的可读性和可维护性。本文将深入探讨如何结合Spring来实现自定义XML标签,并利用FactoryBean进行代理...

    struts核心jar包及xml配置文件

    本压缩包包含了Struts2的核心库jar文件以及相关的XML配置文件,这些都是开发Struts2应用的基础组件。 **1. Struts2核心jar包** Struts2的核心jar包是实现框架功能的关键,主要包括以下几个部分: - **struts2-core...

    spring中的BeanFactory解析xml文件

    当我们谈论“Spring中的BeanFactory解析XML文件”时,我们实际上是在讨论如何通过XML配置文件来定义、创建和管理bean。这篇文章将深入探讨BeanFactory的工作原理,以及XML配置文件在其中的作用。 首先,BeanFactory...

    spring 自定义xsd

    在Spring中,XML配置文件是其核心组成部分,用于定义bean的创建、依赖注入以及各种服务的配置。XSD(XML Schema Definition)是XML文档的结构定义语言,用于描述XML文档的元素、属性和数据类型,确保XML文件的格式...

    这一次搞懂Spring自定义标签以及注解解析原理说明.docx

    这确保了XML配置文件的正确性,因为Spring会根据`spring.schemas`来验证配置文件是否符合约定的格式。 通过这两篇文章的分析,我们可以看到Spring的自定义标签和注解解析涉及到了装饰模式、模板方法模式、委托模式...

    Spring 5.2.9 06 源码分析-spring自定义标签解析过程

    通过自定义标签,开发者可以创建更加符合业务逻辑和可读性强的XML配置文件。本文将深入剖析Spring 5.2.9版本中自定义标签的解析过程,旨在帮助读者理解Spring内部的工作机制。 首先,我们了解自定义标签的基本概念...

    利用Spring Context上下文创建自定义对象

    在Spring应用中,Context通常通过`ApplicationContext`接口来实例化,如`ClassPathXmlApplicationContext`或`FileSystemXmlApplicationContext`,这些类用于加载XML配置文件并初始化bean。 创建自定义对象的基本...

    spring自定义编辑器

    ### Spring自定义编辑器详解 #### 一、引言 在Spring框架中,自定义编辑器主要用于处理数据类型的转换问题,特别是在将用户输入的数据转换为Java对象时非常有用。例如,用户通过表单提交了一个日期格式的字符串,...

    Spring项目application.xml配置文件加解密

    在Spring项目中,`application.xml`配置文件是核心配置组件,它包含了应用的bean定义、数据源、事务管理等重要信息。为了保护敏感信息,如数据库连接字符串、API密钥等,我们需要对这些配置进行加密。本文将详细介绍...

Global site tag (gtag.js) - Google Analytics