内容简介:很久没有写关于 Spring 的文章了,最近在系统梳理 Dubbo 代码的过程中发现了 XML schema 这个被遗漏的知识点。由于工作中使用 SpringBoot 比较多的原因,几乎很少接触 XML,此文可以算做是亡羊补牢,另一方面,也为后续的 Dubbo 源码解析做个铺垫。XML schema 扩展机制是啥?这并不是一块很大的知识点,翻阅一下 Spring 的文档,我甚至没找到一个贯穿上下文的词来描述这个功能,Spring 为基于 XML 构建的应用提供了一种扩展机制,用于定义和配置 Bean。 它
很久没有写关于 Spring 的文章了,最近在系统梳理 Dubbo 代码的过程中发现了 XML schema 这个被遗漏的知识点。由于工作中使用 SpringBoot 比较多的原因,几乎很少接触 XML,此文可以算做是亡羊补牢,另一方面,也为后续的 Dubbo 源码解析做个铺垫。
XML schema 扩展机制是啥?这并不是一块很大的知识点,翻阅一下 Spring 的文档,我甚至没找到一个贯穿上下文的词来描述这个功能, XML Schema Authoring
是文档中对应的标题,简单来说:
Spring 为基于 XML 构建的应用提供了一种扩展机制,用于定义和配置 Bean。 它允许使用者编写自定义的 XML bean 解析器,并将解析器本身以及最终定义的 Bean 集成到 Spring IOC 容器中。
Dubbo 依赖了 Spring,并提供了一套自定义的 XML 标签, <dubbo:application>
, <dubbo:registry>
, <dubbo:protocol>
, <dubbo:service>
。作为使用者,大多数人只需要关心这些参数如何配置,但不知道有没有人好奇过,它们是如何加载进入 Spring 的 IOC 容器中被其他组件使用的呢?这便牵扯出了今天的主题:Spring 对 XML schema 的扩展支持。
自定义 XML 扩展
为了搞懂 Spring 的 XML 扩展机制,最直接的方式便是实现一个自定义的扩展。实现的步骤也非常简单,分为四步:
NamespaceHandler BeanDefinitionParser
我们的目的便是想要实现一个 kirito XML schema
,我们的项目中可以自定义 kirito.xml,在其中会以 kirito 为标签来定义不同的类,并在最终的测试代码中验证这些声明在 kirito.xml 的类是否被 Spring 成功加载。大概像这样,是不是和 dubbo.xml 的格式很像呢?
动手实现
有了明确的目标,我们逐步开展自己的工作。
1 编写kirito.xsd
resources/META-INF/kirito.xsd
<?xml version="1.0" encoding="UTF-8"?> <xsd:schema xmlns="http://www.cnkirito.moe/schema/kirito" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:beans="http://www.springframework.org/schema/beans" targetNamespace="http://www.cnkirito.moe/schema/kirito"> ① <xsd:import namespace="http://www.springframework.org/schema/beans"/> <xsd:element name="application"> ② <xsd:complexType> <xsd:complexContent> <xsd:extension base="beans:identifiedType"> <xsd:attribute name="name" type="xsd:string" use="required"/> </xsd:extension> </xsd:complexContent> </xsd:complexType> </xsd:element> <xsd:element name="service"> ② <xsd:complexType> <xsd:complexContent> <xsd:extension base="beans:identifiedType"> <xsd:attribute name="name" type="xsd:string" use="required"/> </xsd:extension> </xsd:complexContent> </xsd:complexType> </xsd:element> </xsd:schema>
① 注意这里的 targetNamespace="http://www.cnkirito.moe/schema/kirito"
这便是之后 kirito 标签的关键点。
② kirito.xsd 定义了两个元素: application 和 service,出于简单考虑,都只有一个 name 字段。
schema 的意义在于它可以和 eclipse/IDEA 这样智能化的集成开发环境形成很好的搭配,在编辑 XML 的过程中,用户可以获得告警和提示。 如果配置得当,可以使用自动完成功能让用户在事先定义好的枚举类型中进行选择。
2 编写KiritoNamespaceHandler
public class KiritoNamespaceHandler extends NamespaceHandlerSupport { @Override public void init() { super.registerBeanDefinitionParser("application", new KiritoBeanDefinitionParser(ApplicationConfig.class)); super.registerBeanDefinitionParser("service", new KiritoBeanDefinitionParser(ServiceBean.class)); } }
完成 schema 之后,还需要一个 NamespaceHandler 来帮助 Spring 解析 XML 中不同命名空间的各类元素。
<kirito:application name="kirito"/> <dubbo:application name="dubbo"/> <motan:application name="motan"/>
不同的命名空间需要不同的 NamespaceHandler 来处理,在今天的示例中,我们使用 KiritoNamespaceHandler 来解析 kirito 命名空间。KiritoNamespaceHandler 继承自 NamespaceHandlerSupport 类,并在其 init() 方法中注册了两个 BeanDefinitionParser ,用于解析 kirito 命名空间/kirito.xsd 约束中定义的两个元素:application,service。BeanDefinitionParser 是下一步的主角,我们暂且跳过,将重心放在父类 NamespaceHandlerSupport 之上。
public interface NamespaceHandler { void init(); BeanDefinition parse(Element element, ParserContext parserContext); BeanDefinitionHolder decorate(Node source, BeanDefinitionHolder definition, ParserContext parserContext); }
NamespaceHandlerSupport 是 NamespaceHandler 命名空间处理器的抽象实现,我粗略看了NamespaceHandler 的几个实现类,parse 和 decorate 方法可以完成元素节点的组装并通过 ParserContext 注册到 Ioc 容器中,但实际我们并没有调用这两个方法,而是通过 init() 方法注册 BeanDefinitionParser 来完成解析节点以及注册 Bean 的工作,所以对于 NamespaceHandler,我们主要关心 init 中注册的两个 BeanDefinitionParser 即可。
3 编写KiritoBeanDefinitionParser
在文章开始我们便标记到 BeanDefinitionParser 是最为关键的一环,每一个 BeanDefinitionParser 实现类都负责一个映射,将一个 XML 节点解析成 IOC 容器中的一个实体类。
public class KiritoBeanDefinitionParser implements BeanDefinitionParser { private final Class<?> beanClass; public KiritoBeanDefinitionParser(Class<?> beanClass) { this.beanClass = beanClass; } private static BeanDefinition parse(Element element, ParserContext parserContext, Class<?> beanClass) { RootBeanDefinition beanDefinition = new RootBeanDefinition(); beanDefinition.setBeanClass(beanClass); beanDefinition.setLazyInit(false); String name = element.getAttribute("name"); beanDefinition.getPropertyValues().addPropertyValue("name", name); parserContext.getRegistry().registerBeanDefinition(name, beanDefinition); return beanDefinition; } @Override public BeanDefinition parse(Element element, ParserContext parserContext) { return parse(element, parserContext, beanClass); } }
由于我们的实体类是非常简单的,所以不存在很复杂的解析代码,而实际项目中,往往需要大量的解析步骤。parse 方法会解析一个个 XML 中的元素,使用 RootBeanDefinition 组装成对象,并最终通过 parserContext 注册到 IOC 容器中。
至此,我们便完成了 XML 文件中定义的对象到 IOC 容器的映射。
4 注册schema和handler
最后一步还需要通知 Spring,告知其自定义 schema 的所在之处以及对应的处理器。
resources/META-INF/spring.handlers
http\://www.cnkirito.moe/schema/kirito=moe.cnkirito.sample.xsd.KiritoNamespaceHandler
resources/META-INF/spring.schemas
http\://www.cnkirito.moe/schema/kirito/kirito.xsd=META-INF/kirito.xsd
没有太多可以说的,需要遵守 Spring 的约定。
至此一个自定义的 XML schema 便扩展完成了,随后来验证一下。
验证扩展
我们首先定义好 kirito.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:kirito="http://www.cnkirito.moe/schema/kirito" xsi:schemaLocation=" http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd http://www.cnkirito.moe/schema/kirito http://www.cnkirito.moe/schema/kirito/kirito.xsd"> <kirito:application name="kirito-demo-application"/> <kirito:service name="kirito-demo-service"/> </beans>
使用 Spring 去加载它,并验证 IOC 容器中是否存在注册成功的 Bean。
@SpringBootApplication @ImportResource(locations = {"classpath:kirito.xml"}) public class XmlSchemaAuthoringSampleApplication { public static void main(String[] args) { ConfigurableApplicationContext applicationContext = SpringApplication.run(XmlSchemaAuthoringSampleApplication.class, args); ServiceBean serviceBean = applicationContext.getBean(ServiceBean.class); System.out.println(serviceBean.getName()); ApplicationConfig applicationConfig = applicationContext.getBean(ApplicationConfig.class); System.out.println(applicationConfig.getName()); } }
观察控制台的输出:
kirito-demo-service kirito-demo-application
一个基础的基于 XML schema 的扩展便完成了。
Dubbo中的XML schema扩展
最后我们以 Dubbo 为例,看看一个成熟的 XML schema 扩展是如何被应用的。
刚好对应了四个标准的扩展步骤,是不是对 XML 配置下的 Dubbo 应用有了更好的理解了呢?
顺带一提,仅仅完成 Bean 的注册还是不够的,在“注册”的同时,Dubbo 还进行了一系列其他操作如:暴露端口,开启服务器,完成注册中心的注册,生成代理对象等等行为,由于不在本文的范围内,后续的 Dubbo 专题会专门介绍这些细节,本文便是了解 Dubbo 加载流程的前置文章了。
欢迎关注我的微信公众号:「Kirito的技术分享」,关于文章的任何疑问都会得到回复,带来更多 Java 相关的技术分享。
以上就是本文的全部内容,希望本文的内容对大家的学习或者工作能带来一定的帮助,也希望大家多多支持 码农网
猜你喜欢:- Kubernetes资源扩展机制(二)
- 喧喧发布 1.6.0 版本,扩展机制增强,支持服务器扩展
- 优秀开源框架的扩展机制实现
- 聊聊 Spring 中的那些扩展机制
- 浅析Dubbo的SPI扩展机制
- 图解kubernetes资源扩展机制实现(上)
本站部分资源来源于网络,本站转载出于传递更多信息之目的,版权归原作者或者来源机构所有,如转载稿涉及版权问题,请联系我们。
你不知道的JavaScript(中卷)
[美] Kyle Simpson / 单业、姜南 / 人民邮电出版社 / 2016-8 / 79.00元
JavaScript这门语言简单易用,很容易上手,但其语言机制复杂微妙,即使是经验丰富的JavaScript开发人员,如果没有认真学习的话也无法真正理解。本套书直面当前JavaScript开发人员不求甚解的大趋势,深入理解语言内部的机制,全面介绍了JavaScript中常被人误解和忽视的重要知识点。本书是其中卷,主要介绍了类型、语法、异步和性能。一起来看看 《你不知道的JavaScript(中卷)》 这本书的介绍吧!