Spring自定义配置实战
本文介绍如何使用Spring的可扩展Schema特性来自定义配置支持。通过一个实战案例，详细讲解了设计配置属性、编写XSD文件、实现NamespaceHandler及BeanDefinitionParser等步骤。
转载：http://blog.youkuaiyun.com/cutesource/article/details/5864562
在很多情况下，我们需要为系统提供可配置化支持，简单的做法可以直接基于spring的标准Bean来配置，但配置较为复杂或者需要更多丰富控制的时候，会显得非常笨拙。一般的做法会用原生态的方式去解析定义好的xml文件，然后转化为配置对象，这种方式当然可以解决所有问题，但实现起来比较繁琐，特别是是在配置非常复杂的时候，解析工作是一个不得不考虑的负担。Spring提供了可扩展Schema的支持，这是一个不错的折中方案，完成一个自定义配置一般需要以下步骤：
- 设计配置属性和JavaBean
- 编写XSD文件
- 编写NamespaceHandler和BeanDefinitionParser完成解析工作
- 编写spring.handlers和spring.schemas串联起所有部件
- 在Bean文件中应用
下面结合一个小例子来实战以上过程
1）设计配置属性和JavaBean
首先当然得设计好配置项，并通过JavaBean来建模，本例中需要配置People实体，配置属性name和age（id是默认需要的）
2）编写XSD文件
为上一步设计好的配置项编写XSD文件，XSD是schema的定义文件，配置的输入和解析输出都是以XSD为契约，本例中XSD如下：
关于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，简单的方式就是去继承这两个类。本例就是采取这种方式：
其中registerBeanDefinitionParser("people", new PeopleBeanDefinitionParser());就是用来把节点名和解析类联系起来，在配置中引用people配置项时，就会用PeopleBeanDefinitionParser来解析配置。PeopleBeanDefinitionParser就是本例中的解析类：
其中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.youkuaiyun.com/cutesource/schema/people=study.schemaExt.MyNamespaceHandler
以上表示当使用到名为"http://blog.youkuaiyun.com/cutesource/schema/people"的schema引用时，会通过study.schemaExt.MyNamespaceHandler来完成解析
spring.schemas如下所示：
http/://blog.youkuaiyun.com/cutesource/schema/people.xsd=META-INF/people.xsd
以上就是载入xsd文件
5）在Bean文件中应用
到此为止一个简单的自定义配置以完成，可以在具体应用中使用了。使用方法很简单，和配置一个普通的spring bean类似，只不过需要基于我们自定义schema，本例中引用方式如下所示：
其中xmlns:cutesource="http://blog.youkuaiyun.com/cutesource/schema/people"是用来指定自定义schema，xsi:schemaLocation用来指定xsd文件。<cutesource:people id="cutesource" name="zhijun.yuanzj" age="27"/>是一个具体的自定义配置使用实例。
最后就可以在具体程序中使用基本的bean载入方式来载入我们的自定义配置对象了，如：
会输出：
cutesource
袁志俊
27
以上就是一个基于Spring可扩展Schema提供自定义配置支持实战过程，一些复杂应用和技巧还有待挖掘
=================================================================================
转载：http://www.blogjava.net/heavensay/archive/2013/10/28/405699.html
说明：
这篇文档是对Spring加载和解析xml文件过程的分析，下面看一个spring解析xml文件的测试例子。
public void test3BeanDefinitionReader(){
DefaultResourceLoader loader = new DefaultResourceLoader();
Resource resource = loader.getResource("/ioc/application.xml");
BeanDefinitionRegistry registry = new SimpleBeanDefinitionRegistry();
BeanDefinitionReader reader = new XmlBeanDefinitionReader(registry);
int count = reader.loadBeanDefinitions(resource);
String[] beanDefinitionNames = reader.getRegistry().getBeanDefinitionNames();
System.out.println("----------------------");
for (String name : beanDefinitionNames) {
System.out.println(name);
}
}
- Resource：各种资源的抽象接口，包括xml文件，网络上的资源等。
- BeanDefinitionRegistry：用于注册BeanDefinitionRegistry。
- BeanDefinitionReader：用于读取解析Resource的抽象接口。
- DefaultBeanDefinitionDocumentReader：实现了BeanDefinitionDocumentReader接口，DefaultBeanDefinitionDocumentReader并不负责任何具体的bean解析，它面向的是xml Document对象，根据其元素的命名空间和名称，起一个类似路由的作用（（不过，命名空间的判断，也是委托给delegate来做的），它跟BeanDefinitionParserDelegate协同合作，把解析任务交接BeanDefinitionParserDelegate来做。
- BeanDefinitionParserDelegate：完成具体Bean的解析(比如<bean>、<import>、<alias>标签)，对于扩展的标签会交给不同的NamespaceHandler跟BeanDefinitionParser来解析。
- BeanDefinitionParser：解析配置文件成相应的BeanDefinition(<context:component-scan>,<aop:config>等标签都是又不同的BeanDefinitionParser来解析)，一般在NamespaceHandler中使用。Spring也为自定义BeanDefinitionParser提供了很多支持，在一些抽象类的基础上添加少量功能即可满足大部分需求。
- NamespaceHandler：要解析自定义的bean就要通过自己所实现的NamespaceHandler来进行解析。比如定义了http\://www.springframework.org/schema/osgi=org.springframework.osgi.config.OsgiNamespaceHandler,那么在碰到osgi的scheme的时候就会去调用OsgiNamespaceHandler来进行解析； 在对于普通的扩展需求来说，只要让自己的Handler继承NamespaceHandlerSupport并实现 init()方法 就好了，对于特殊的扩展需求 则可以自己 来实现NamespaceHandler。
源码1：加载xml文件
public int loadBeanDefinitions(Resource resource) throws BeanDefinitionStoreException {
// 加载xml资源
return loadBeanDefinitions( new EncodedResource(resource));
}
public int loadBeanDefinitions(EncodedResource encodedResource) throws BeanDefinitionStoreException {
InputStream inputStream = encodedResource.getResource().getInputStream();
try {
InputSource inputSource = new InputSource(inputStream);
if (encodedResource.getEncoding() != null) {
// 设置字符集
inputSource.setEncoding(encodedResource.getEncoding());
}
return doLoadBeanDefinitions(inputSource, encodedResource.getResource());
}
}
protected int doLoadBeanDefinitions(InputSource inputSource, Resource resource)
throws BeanDefinitionStoreException {
try {
int validationMode = getValidationModeForResource(resource);
// 根据xml文件，得到标准的Document对象
Document doc = this.documentLoader.loadDocument(
inputSource, getEntityResolver(), this.errorHandler, validationMode, isNamespaceAware());
return registerBeanDefinitions(doc, resource);
}
public int registerBeanDefinitions(Document doc, Resource resource) throws BeanDefinitionStoreException {
// BeanDefinitionDocumentReader实际解析doc文档
BeanDefinitionDocumentReader documentReader = createBeanDefinitionDocumentReader();
int countBefore = getRegistry().getBeanDefinitionCount();
documentReader.registerBeanDefinitions(doc, createReaderContext(resource));
return getRegistry().getBeanDefinitionCount() - countBefore;
}
DefaultBeanDefinitionDocumentReader:
public void registerBeanDefinitions(Document doc, XmlReaderContext readerContext) {
Element root = doc.getDocumentElement();
// 元素解析的代理类，主要的bean解析，以及一些自定义元素的解析
BeanDefinitionParserDelegate delegate = createHelper(readerContext, root);
// 默认为空操作
preProcessXml(root);
// 解析元素
parseBeanDefinitions(root, delegate);
postProcessXml(root);
}
protected void parseBeanDefinitions(Element root, BeanDefinitionParserDelegate delegate) {
// 默认命名空间为http://www.springframework.org/schema/beans，也就是xml文件中<bean>的标签
if (delegate.isDefaultNamespace(root)) {
NodeList nl = root.getChildNodes();
for ( int i = 0; i < nl.getLength(); i++) {
Node node = nl.item(i);
if (node instanceof Element) {
Element ele = (Element) node;
if (delegate.isDefaultNamespace(ele)) {
// 处理默认<bean>标签
parseDefaultElement(ele, delegate);
}
else {
// 处理自定义标签 (i.e. AOP,CONTENT,JDBC)
delegate.parseCustomElement(ele);
}
}
}
}
else { // 处理自定义标签
delegate.parseCustomElement(root);
}
}
源码2：基本元素解析(i.e. <bean>、<import>......)
private void parseDefaultElement(Element ele, BeanDefinitionParserDelegate delegate) {
if (delegate.nodeNameEquals(ele, IMPORT_ELEMENT)) {
// 解析<import>标签
importBeanDefinitionResource(ele);
}
else if (delegate.nodeNameEquals(ele, ALIAS_ELEMENT)) {
// 解析<alias>标签
processAliasRegistration(ele);
}
else if (delegate.nodeNameEquals(ele, BEAN_ELEMENT)) {
// 解析<bean>标签
processBeanDefinition(ele, delegate);
}
}
protected void processBeanDefinition(Element ele, BeanDefinitionParserDelegate delegate) {
// 解析element，得到BeanDefinition，BeanDefinitionHolder中包含了BeanDefinition
BeanDefinitionHolder bdHolder = delegate.parseBeanDefinitionElement(ele);
// 注册BeanDefinition
BeanDefinitionReaderUtils.registerBeanDefinition(bdHolder, getReaderContext().getRegistry());
}
BeanDefinitionParserDelegate:
public BeanDefinitionHolder parseBeanDefinitionElement(Element ele) {
return parseBeanDefinitionElement(ele, null);
}
public BeanDefinitionHolder parseBeanDefinitionElement(Element ele, BeanDefinition containingBean) {
String id = ele.getAttribute(ID_ATTRIBUTE);
String nameAttr = ele.getAttribute(NAME_ATTRIBUTE);
List<String> aliases = new ArrayList<String>();
if (StringUtils.hasLength(nameAttr)) {
String[] nameArr = StringUtils.tokenizeToStringArray(nameAttr, BEAN_NAME_DELIMITERS);
aliases.addAll(Arrays.asList(nameArr));
}
String beanName = id;
if (containingBean == null) {
// 检查bean name的唯一性
checkNameUniqueness(beanName, aliases, ele);
}
// 解析Element
AbstractBeanDefinition beanDefinition = parseBeanDefinitionElement(ele, beanName, containingBean);
if (beanDefinition != null) {
String[] aliasesArray = StringUtils.toStringArray(aliases);
return new BeanDefinitionHolder(beanDefinition, beanName, aliasesArray);
}
return null;
}
// 真正解析<bean>的地方
public AbstractBeanDefinition parseBeanDefinitionElement(
Element ele, String beanName, BeanDefinition containingBean) {
this.parseState.push( new BeanEntry(beanName));
String className = null;
if (ele.hasAttribute(CLASS_ATTRIBUTE)) {
className = ele.getAttribute(CLASS_ATTRIBUTE).trim();
}
String parent = null;
if (ele.hasAttribute(PARENT_ATTRIBUTE)) {
parent = ele.getAttribute(PARENT_ATTRIBUTE);
}
AbstractBeanDefinition bd = createBeanDefinition(className, parent);
parseBeanDefinitionAttributes(ele, beanName, containingBean, bd);
bd.setDescription(DomUtils.getChildElementValueByTagName(ele, DESCRIPTION_ELEMENT));
parseMetaElements(ele, bd);
parseLookupOverrideSubElements(ele, bd.getMethodOverrides());
parseReplacedMethodSubElements(ele, bd.getMethodOverrides());
parseConstructorArgElements(ele, bd);
parsePropertyElements(ele, bd);
parseQualifierElements(ele, bd);
bd.setResource( this.readerContext.getResource());
bd.setSource(extractSource(ele));
return bd;
return null;
}
源码3：处理扩展或自定义标签：
public BeanDefinition parseCustomElement(Element ele) {
return parseCustomElement(ele, null);
}
public BeanDefinition parseCustomElement(Element ele, BeanDefinition containingBd) {
String namespaceUri = getNamespaceURI(ele);
// 根据元素的命名空间得到NamespaceHandler
NamespaceHandler handler = this.readerContext.getNamespaceHandlerResolver().resolve(namespaceUri);
// 使用合适的NamespaceHandler解析元素
return handler.parse(ele, new ParserContext( this.readerContext, this, containingBd));
}
NamespaceHandlerSupport：
public BeanDefinition parse(Element element, ParserContext parserContext) {
// 得到真正具体处理自定义的BeanDefinitionParser，解析element得到BeanDefinition
return findParserForElement(element, parserContext).parse(element, parserContext);
}
private BeanDefinitionParser findParserForElement(Element element, ParserContext parserContext) {
String localName = parserContext.getDelegate().getLocalName(element);
// parsers中包含了具体处理自定义标签的类
BeanDefinitionParser parser = this.parsers.get(localName);
return parser;
}
代码3.2：在源码3.1中代码：{NamespaceHandler handler = this.readerContext.getNamespaceHandlerResolver().resolve(namespaceUri)}这步中，展示了对于扩展或自定义的标签的处理类是从哪里加载的
// 得到Map<Element名称，NamespaceHandler处理类>
Map<String, Object> handlerMappings = getHandlerMappings();
// 根据namespaceUri得到匹配的NamespaceHandler
Object handlerOrClassName = handlerMappings.get(namespaceUri);
if (handlerOrClassName == null) {
return null;
}
else if (handlerOrClassName instanceof NamespaceHandler) {
return (NamespaceHandler) handlerOrClassName;
} else{
}
}
private Map<String, Object> getHandlerMappings() {
// handlerMappingsLocation默认值：META-INF/spring.handlers
// spring就会从jar包中的Meta-INF/spring.handlers文件中得到处理各种不同命名空间元素的类
Properties mappings =
PropertiesLoaderUtils.loadAllProperties( this.handlerMappingsLocation, this.classLoader);
Map<String, Object> handlerMappings = new ConcurrentHashMap<String, Object>();
CollectionUtils.mergePropertiesIntoMap(mappings, handlerMappings);
this.handlerMappings = handlerMappings;
return this.handlerMappings;
}
当初一直在想Spring是如何解析自定义元素(i.e. <context:component-scan>,<aop:config> )。通过源码分析看出spring在解析的过程中，会去收集spring.*.jar/META-INF下的spring.handers,spring.schemas文件，这2个文件就是指明了解析spring中自定义标签的Namespace类。如果自己开发Spring组件，需要增加新的标签，也可以按照这个机制。
参考：
http://kyfxbl.iteye.com/blog/1610255 (小读spring ioc源码)
http://blog.youkuaiyun.com/cutesource/article/details/5864562 (基于Spring可扩展Schema提供自定义配置支持)
扫一扫
641
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
