Spring（九）- Spring自定义命名空间整合第三方框架原理解析

最新推荐文章于 2023-03-19 20:42:45 发布
最新推荐文章于 2023-03-19 20:42:45 发布
阅读量880 收藏 8
点赞数 1
分类专栏： Spring 文章标签： spring dubbo java mybatis
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_36602071/article/details/127875047
版权

文章目录

一、Spring通过命名空间整合第三方框架

1. Dubbo 命名空间

Spring 整合其他组件时就不像MyBatis这么简单了，例如Dubbo框架在与Spring进行整合时，要使用Dubbo提供的命名空间的扩展方式，自定义了一些Dubbo的标签，Dubbo框架再去解析自己的Dubbo标签

<beans xmlns="http://www.springframework.org/schema/beans"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
	<!--引入dubbo命名空间-->
	xmlns:dubbo="http://dubbo.apache.org/schema/dubbo"
	xsi:schemaLocation="http://www.springframework.org/schema/beans 
	http://www.springframework.org/schema/beans/spring-beans.xsd 
	<!--引入dubbo对应的schema映射地址-->
	http://dubbo.apache.org/schema/dubbo 
	http://dubbo.apache.org/schema/dubbo/dubbo.xsd">
	<!--配置应用名称--> 
	<dubbo:application name="dubbo1-consumer"/>
	<!--配置注册中心地址--> 
	<dubbo:registry address="zookeeper://localhost:2181"/>
	<!--扫描dubbo的注解--> 
	<dubbo:annotation package="com.itheima.controller"/>
	<!--消费者配置--> 
	<dubbo:consumer check="false" timeout="1000" retries="0"/>
</beans>

2. Context 命名空间

为了降低我们此处的学习成本，不再引入Dubbo第三方框架了，以Spring的 context 命名空间去进行讲解，该方式也是命名空间扩展方式。

需求：加载外部properties文件jdbc.properties，将键值对存储在Spring容器中

jdbc.driver=com.mysql.jdbc.Driver
jdbc.url=jdbc:mysql://localhost:3306/mybatis
jdbc.username=root
jdbc.password=root

引入context命名空间，再使用context命名空间的标签，使用SpEL表达式在xml或注解中根据key获得value

<beans xmlns="http://www.springframework.org/schema/beans"
	xmlns:context="http://www.springframework.org/schema/context"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation="http://www.springframework.org/schema/beans 
	http://www.springframework.org/schema/beans/spring-beans.xsd
	http://www.springframework.org/schema/context 
	http://www.springframework.org/schema/context/spring-context.xsd"> 
	
	<!--加载properties文件-->
	<context:property-placeholder location="classpath:jdbc.properties" />
	
	<bean id="dataSource" class="com.alibaba.druid.pool.DruidDataSource"> 
		<property name="driverClassName" value="${jdbc.driver}"></property> 
		<property name="url" value="${jdbc.url}"></property> 
		<property name="username" value="${jdbc.username}"></property> 
		<property name="password" value="${jdbc.password}"></property>
	</bean> 
<beans>

其实，加载的properties文件中的属性最终通过Spring解析后会被存储到了Spring容器的environment中去，不仅自己定义的属性会进行存储，Spring也会把环境相关的一些属性进行存储
在这里插入图片描述

二、Spring自定义命名空间原理解析

首先从ClassPathXmlApplicationContext入手，进入spring容器入口refresh()方法

public class ClassPathXmlApplicationContext extends AbstractXmlApplicationContext {
	@Override
	public void refresh() throws BeansException, IllegalStateException {
		synchronized (this.startupShutdownMonitor) {
			...
			// 将beanDefinition定义信息填充到beanDefinitionMap中
			ConfigurableListableBeanFactory beanFactory = obtainFreshBeanFactory();
			...
		}
	}
}

接着调用AbstractApplicationContext类中的obtainFreshBeanFactory方法

public abstract class AbstractApplicationContext extends DefaultResourceLoader implements ConfigurableApplicationContext {
	protected ConfigurableListableBeanFactory obtainFreshBeanFactory() {
			refreshBeanFactory();
			return getBeanFactory();
	}
}

接着执行AbstractRefreshableApplicationContext类中的refreshBeanFactory方法

public abstract class AbstractRefreshableApplicationContext extends AbstractApplicationContext {
	@Override
	protected final void refreshBeanFactory() throws BeansException {
		...
		loadBeanDefinitions(beanFactory);
		...
	}
}

最终会通过loadBeanDefinitions方法->doLoadBeanDefinitions方法->registerBeanDefinitions方法->doRegisterBeanDefinitions方法->parseBeanDefinitions方法

public class DefaultBeanDefinitionDocumentReader implements BeanDefinitionDocumentReader {
	protected void parseBeanDefinitions(Element root, BeanDefinitionParserDelegate delegate) {
		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)) {
						// 默认命名空间的标签有import、alias、bean、beans
						parseDefaultElement(ele, delegate);
					} else {
						// 解析自定义命名空间的标签
						delegate.parseCustomElement(ele);
					}
				}
			}
		} else {
			delegate.parseCustomElement(root);
		}
	}
}

在这里插入图片描述

默认命名空间的标签有import、alias、bean、beans

在这里插入图片描述

由于context是自定义命名空间的标签，所以会执行delegate.parseCustomElement(ele);方法

public class BeanDefinitionParserDelegate {
	@Nullable
	public BeanDefinition parseCustomElement(Element ele, @Nullable BeanDefinition containingBd) {
		// xmlns:context="http://www.springframework.org/schema/context"
		// 这里的namespaceUri对应的是xml中的"http://www.springframework.org/schema/context"
		String namespaceUri = getNamespaceURI(ele);
		// 根据命名空间uri获取命名空间处理器
		NamespaceHandler handler = this.readerContext.getNamespaceHandlerResolver().resolve(namespaceUri);
		// 执行命名空间处理器的parse方法，解析执行的标签
		return handler.parse(ele, new ParserContext(this.readerContext, this, containingBd));
	}
}

根据命名空间uri获取命名空间处理器

public class DefaultNamespaceHandlerResolver implements NamespaceHandlerResolver {

	// 通过构造方法创建DefaultNamespaceHandlerResolver时，会将"META-INF/spring.handlers"中配置的命名空间处理器加载到handlerMappings中
	public DefaultNamespaceHandlerResolver() {
		this(null, "META-INF/spring.handlers");
	}
	
	// 在执行resovle方法时，就是从Map<String, Object> handlerMappings中根据命名空间名称获得对应的处理器对象，此处是ContextNamespaceHandler，最终执行NamespaceHandler的parse方法
	@Override
	@Nullable
	public NamespaceHandler resolve(String namespaceUri) {
		// key是命名空间uri，value是命名空间处理器
		Map<String, Object> handlerMappings = getHandlerMappings();
		...
		String className = handlerMappings.get(namespaceUri);
		Class<?> handlerClass = ClassUtils.forName(className, this.classLoader);
		// 此时这里的命名空间处理器就是ContextNamespaceHandler
		NamespaceHandler namespaceHandler = (NamespaceHandler) BeanUtils.instantiateClass(handlerClass);
		// 执行ContextNamespaceHandler的init方法
		namespaceHandler.init();
		handlerMappings.put(namespaceUri, namespaceHandler);
		return namespaceHandler;
		...
	}
}

在这里插入图片描述
在这里插入图片描述

执行ContextNamespaceHandler的init方法
ContextNamespaceHandler源码如下，间接实现了NamespaceHandler接口，初始化方法init会被自动调用。由于context命名空间下有多个标签，所以每个标签又单独注册了对应的解析器，注册到了其父类NamespaceHandlerSupport的Map<String, BeanDefinitionParser> parsers中去了

public class ContextNamespaceHandler extends NamespaceHandlerSupport {
	@Override
	public void init() {
		// 注入解析器，不同的标签有不同的解析器
		registerBeanDefinitionParser("property-placeholder", new PropertyPlaceholderBeanDefinitionParser());
		registerBeanDefinitionParser("property-override", new PropertyOverrideBeanDefinitionParser());
		registerBeanDefinitionParser("annotation-config", new AnnotationConfigBeanDefinitionParser());
		registerBeanDefinitionParser("component-scan", new ComponentScanBeanDefinitionParser());
		registerBeanDefinitionParser("load-time-weaver", new LoadTimeWeaverBeanDefinitionParser());
		registerBeanDefinitionParser("spring-configured", new SpringConfiguredBeanDefinitionParser());
		registerBeanDefinitionParser("mbean-export", new MBeanExportBeanDefinitionParser());
		registerBeanDefinitionParser("mbean-server", new MBeanServerBeanDefinitionParser());
	}
}

注入解析器后，再去执行命名空间处理器ContextNamespaceHandler的parse方法，该parse方法具体流程是再去调每个自定义标签解析器的parse方法，例如上面"property-placeholder"标签，会执行PropertyPlaceholderBeanDefinitionParser解析器的parse方法，parse方法主要作用就是解析标签的beanDefinition定义信息注册到容器中，Spring再根据对应的beanDefinition定义信息创建对象

public abstract class NamespaceHandlerSupport implements NamespaceHandler {
	@Override
	@Nullable
	public BeanDefinition parse(Element element, ParserContext parserContext) {
		BeanDefinitionParser parser = findParserForElement(element, parserContext);
		return (parser != null ? parser.parse(element, parserContext) : null);
	}
}

在这里插入图片描述

通过上述分析，我们清楚的了解了外部命名空间标签的执行流程，如下：
⚫ 将自定义标签的约束：物理约束文件与网络约束名称的约束 以键值对形式存储到一个spring.schemas文件里，该文件存储在类加载路径的 META-INF里，Spring会自动加载到;
⚫ 将自定义命名空间的名称 与 自定义命名空间的处理器映射关系 以键值对形式存在到一个叫spring.handlers文件里，该文件存储在类加载路径的 META-INF里，Spring会自动加载到;
⚫ 准备好NamespaceHandler，如果命名空间只有一个标签，那么直接在parse方法中进行解析即可，一般解析结果就是注册该标签对应的BeanDefinition。如果命名空间里有多个标签，那么可以在init方法中为每个标签都注册一个BeanDefinitionParser，在执行NamespaceHandler的parse方法时再分流给不同的BeanDefinitionParser进行解析(重写doParse方法即可)。

在这里插入图片描述
在这里插入图片描述

http\://www.springframework.org/schema/context/spring-context.xsd=org/springframework/context/config/spring-context.xsd

约束文件http://www.springframework.org/schema/context/spring-context.xsd对应真实的路径是org/springframework/context/config/spring-context.xsd
在这里插入图片描述

三、手写自定义命名空间标签与Spring整合

设想自己是一名架构师，进行某一个框架与Spring的集成开发，效果是通过一个指示标签，向Spring容器中自动注入一个BeanPostProcessor，这样可以在创建bean的生命周期中对自定义框架中的bean进行增强处理

步骤分析：

  1. 确定命名空间名称、schema虚拟路径、标签名称；
  2. 编写schema约束文件haohao-annotation.xsd
  3. 在类加载路径下创建META目录，编写约束映射文件spring.schemas和处理器映射文件spring.handlers
  4. 编写命名空间处理器 HaohaoNamespaceHandler，在init方法中注册HaohaoBeanDefinitionParser
  5. 编写标签的解析器 HaohaoBeanDefinitionParser，在parse方法中注册HaohaoBeanPostProcessor
  6. 编写HaohaoBeanPostProcessor
    ========== 以上五步是框架开发者写的，以下是框架使用者写的===========
  7. 在applicationContext.xml配置文件中引入命名空间
  8. 在applicationContext.xml配置文件中使用自定义的标签
<beans xmlns="http://www.springframework.org/schema/beans"
		xmlns:xsi="http://www.w3.org/2001/xmlSchema-instance"
		xmlns:haohao="http://www.itheima.com/haohao"
		xsi:schemaLocation="http://www.springframework.org/schema/beans 
		http://www.springframework.org/schema/beans/spring-beans.xsd
		http://www.itheima.com/haohao
		http://www.itheima.com/haohao/haohao-annotation.xsd">
		<haohao:annotation-driven/>
</beans>

编写schema约束文件haohao-annotation.xsd

<?xml version="1.0" encoding="UTF-8"?>
	<xsd:schema xmlns="http://www.itheima.com/haohao"
	xmlns:xsd="http://www.w3.org/2001/XMLSchema"
	targetNamespace="http://www.itheima.com/haohao">
	<xsd:element name="annotation-driven"></xsd:element>
</xsd:schema>

在类加载路径下创建META目录，编写约束映射文件spring.schemas和处理器映射文件spring.handlers
在这里插入图片描述
编写命名空间处理器 HaohaoNamespaceHandler，在init方法中注册HaohaoBeanDefinitionParser

public class HaohaoNamespaceHandler extends NamespaceHandlerSupport {
	@Override
	public void init() {
		this.registerBeanDefinitionParser("annotation-driven", new HaohaoBeanDefinitionParser());
	}
}

编写标签的解析器 HaohaoBeanDefinitionParser，在parse方法中注册HaohaoBeanPostProcessor

public class HaohaoBeanDefinitionParser implements BeanDefinitionParser {
	public BeanDefinition parse(Element element, ParserContext parserContext) {
		// 创建HaohaoBeanPostProcessor的BeanDefinition
		RootBeanDefinition beanDefinition = new RootBeanDefinition();
		beanDefinition.setBeanClass(HaohaoBeanPostProcessor.class);
		// 注册HaohaoBeanPostProcessor
		parserContext.getRegistry().registerBeanDefinition("haohaoBeanPostProcessor", beanDefinition);
			return beanDefinition;
	}
}

编写HaohaoBeanPostProcessor

public class HaohaoBeanPostProcessor implements BeanPostProcessor {
	@Override
	public Object postProcessBeforeInitialization(Object bean, String beanName) throws BeansException {
		System.out.println("创建bean时，可以在此进行增强处理...");
		return bean;
	}
}
Super_Leng
关注
  • 1
    点赞
  • 踩
  • 8
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
Spring整合Dubbo框架过程及原理解析
08-25
主要介绍了Spring整合Dubbo框架过程及原理解析,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
spring-ssm 框架整合
09-13
ssm 框架整合现成文件
搞懂 Dubbo 入门理论，这一篇就够
主要分享测试的学习资源，帮助快速了解测试行业，帮助想转行、进阶、小白成长为高级测试工程师。
12-21 479
● RPC， Remote Procedure Call ，远程过程调用，是一种跨系统间服务调用的协议或框架● 在很多企业，在内部存在大量的业务子系统，这些子系统都承担独立的业务功能，并相互协作，实现企业各种业务● 这些业务子系统协作过程中，存在大量的相互接口调用，常用的接口调用技术有Socket、Web Service、RPC、REST等● 在企业内部，RPC由于其能像调用本地方法一样使用外部系统接口、效率高、性能好等特点，有着众多的应用场景● RPC优点：○ 格式清晰严谨，交互的双方遵守严格的接口规范和
C++中自定义命名空间（namespace）及其使用的三种方法
Libetaion的博客
08-23 7693
C++中自定义命名空间(namespace)及使用对应变量的三种方法
分布式框架 ---dubbo
guoguo0717的博客
03-31 519
分布式框架-Dubbox 1 什么是SOA架构 SOA是Service-Oriented Architecture的首字母简称，它是一种支持面向服务的架构样式。从服务、基于服务开发和服务的结果来看，面向服务是一种思考方式。其实SOA架构更多应用于互联网项目开发。 为什么互联网项目会采用SOA架构呢？随着互联网的发展，网站应用的规模不断扩大，常规的垂直应用架构已无法应对，分布式服务架构以及流动计算架构势在必行，迫切需一个治理系统确保架构有条不紊的演进。 战争论–《战争论》是普鲁士军事理论家卡尔·冯·克劳塞维
Spring namespace（命名空间）
weixin_53184944的博客
03-19 494
Spring namespace（命名空间）
SpringCloudAlibaba之设置dubbo注册指定nacos的命名空间
m0_67401746的博客
04-08 3767
配置parameters[namespace]: 6058d723-26ee-4619-8415-9fd23b0046b8，内容为Nacos的命名空间id dubbo: scan: base-packages: com.bean.demo.service #dubbo 的api实现类扫描包（默认扫描包会自动添加进Spring的依赖中 因为Dubbo会使用componentScan） protocol: name: dubbo #通信协议：dubbo port: -1 #dub
spring-redis-session 自定义 key 和过期时间
08-25
主要介绍了spring-redis-session 自定义 key 和过期时间,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
这一次搞懂Spring自定义标签以及注解解析原理说明
09-07
主要介绍了这一次搞懂Spring自定义标签以及注解解析原理说明，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧
最新版本的Struts2+Spring4+Hibernate4框架整合
10-15
整合使用最新版本的三大框架（即Struts2、Spring4和Hibernate4），搭建项目架构原型。 项目架构原型：Struts2.3.16 + Spring4.1.1 + Hibernate4.3.6。 此外，还有：log4j、slf4j、junit4、ehcache等知识点。 项目...
补充：Spring XML 配置文件中命名空间；（可能存在理解偏差的地方，随时补充和修正……）
小枯林的博客
08-15 607
本篇博客准转载和参考的博客有： ●【Spring XML 配置文件中命名空间的理解】，该文的作者是【慵懒的他】 ； ● 【Spring配置文件之引入命名空间】； ● 【XML 命名空间（XML Namespaces）】； StepOne：如有需要可以先快速瞅一下xml的基础知识； 有关xml的内容，如有兴趣可以参考【XML一：XML概念与用途；XML文档结构；XML标签书写规则；】及附近相关文章；但是，这个无所谓，xml的那些基础...
使用Spring开发中常用的xml配置文件的命名空间
pkx0128的博客
03-09 560
spring springaop springmvc Mybatis <?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE configuration PUBLIC "-//mybatis.org//DTD Config 3.0//EN" "http://mybatis.org/dtd/mybatis-3-c...
c++（3）自定义命名空间
tr_ainiyangyang的博客
06-07 622
下面的例子 讲述了自定义命名空间的使用方式。和几种不同的引用定义名称的方法。
从Spring头那一堆东西说起
记不住是因为重复的不够多
08-22 414
  平时用的最多的框架莫过Spring，但就算用了怎么久也一直对Spring配置文件的头部那一堆的XML Schema云里雾里的。 今天就来好好整整。俗话说，岁月是把杀猪刀，说不定哪天又忘了，好记性不如烂笔头啊，今天就记记。。   先来看看最初的版本：     &lt;?xml version="1.0" encoding="UTF-8"?&gt; &lt;!DOCTYPE bean...
spring的xml完整版命名空间
qq_42449963的博客
11-06 266
<?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:p="http://www.springframework.org/schema/p" xmlns:context="http://ww
applicationContext的命名空间
Smart-YI
11-19 979
默认的命名空间<beans xmlns="http://www.springframework.org/schema/beans" xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd > <
java 配置文件 命名空间_spring 配置文件applicationContext.xml命名空间及标签解析
weixin_39705193的博客
03-05 153
以spring-data-elasticsearch-2.0.0RELEASE.jar为例xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xmlns:context="http://www.springframework.org/schema/context"**xmlns:elasticsearch="http://www.springf...
架构师集合之spring的xml自定义名称空间（NamespaceHandler以及BeanDefinitionParser）
小明程序猿
02-20 338
spring的xml解析 自定义xml名称空间 NamespaceHandler BeanDefinitionParser
自定义 Spring Boot Starter
qq_42698338的博客
02-14 184
自定义 Spring Boot Starter 日常开发中，某些场景下我们还会引入一些自己封装、复用性高、独立强的模块，但是每次引入都要为其大量配置。 一、命名规则 官方命名空间（springboot旗下项目） 前缀：spring-boot-starter- 举例：spring-boot-starter-web, spring-boot-starter-jdbc 自定义命名空间（非springboot项目） 后缀：-spring-boot-starter 举例：mybatis-spring-boot-st
spring-authorization-server自定义认证配置
最新发布
09-20
spring-authorization-server是Spring框架的一个模块，用于构建带有自定义认证配置的授权服务器。 在使用spring-authorization-server时，我们可以通过自定义认证配置来对授权服务器进行个性化的定制。具体步骤如下...

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值