【Spring源码】4. 自己搞个标签?~自定义标签保姆级全过程(图解向，堆图预警)

AQin1012

已于 2023-04-16 11:51:43 修改

阅读量10w+

点赞数 2

分类专栏： Java 文章标签： spring java 自定义标签 xmlns schema

于 2022-05-25 15:57:33 首次发布

本文链接：https://blog.csdn.net/aqin1012/article/details/124967341

版权

Java 专栏收录该内容

115 篇文章 13 订阅

订阅专栏

【Spring源码系列- IOC】

1	【Spring源码】0.安装Gradle环境
2	【Spring源码】1.下载与编译_pom relocation to an other version number is not f
3	【Spring源码】2.试个水先～Debug找到传说中的三级缓存(图解向，堆图预警)
4	【Spring源码】3. xml文件如何转换成BeanDefinition(主要涉及prepareRefresh()+ obtainFreshBeanFactory()两个函数，图解向，堆图预警)_spring xml转bean
5	【Spring源码】4. 自己搞个标签?~自定义标签保姆级全过程(图解向，堆图预警)
6	【Spring源码】5.spring的bean工厂准备工作（prepareBeanFactory(beanFactory)
7	【Spring源码】6. Spring扩展自定义属性编辑器保姆级教程
8	【Spring源码】7. 如何添加自定义的BeanFactoryPostProcessor
9	【Spring源码】8. 捋下invokeBeanFactoryPostProcessors()主要处理流程
10	【Spring源码】9. 超级重要的ConfigurationClassPostProcessor
11	【Spring源码】10. 递归调用的processConfigurationClass()方法
12	【Spring源码】11. 我是注解类不？checkConfigurationClassCandidate()注解类判断方法详解
13	【Spring源码】12. 注册bean处理器registerBeanPostProcessors()
14	【Spring源码】13. 国际化处理initMessageSource()源码解析	【补充内容】【保姆级】SpringBoot项目中的i18n国际化
15	【Spring源码】14. 消息多播器（观察者模式）	【补充内容】【保姆级示例向】观察者模式
16	【Spring源码】15. Bean的创建过程（1.概述篇）
17	【Spring源码】16. Bean的创建过程（2）
18	【Spring源码】17.创建Bean这篇认真的@(・●・)@	【补充内容】【保姆级·创建对象】如何通过Supplier创建对象【保姆级·创建对象】如何通过factory-method创建对象【保姆级·创建对象】如何利用resolveBeforeInstantiation()在预处理阶段返回一个Bean的实例对象
19	【Spring源码】18. factory-method创建对象关键函数详解：instantiateUsingFactoryMethod()
20	【Spring源码】19. 没合适的构造器？找determineCandidateConstructors()！
21	【Spring源码】20. MergedBeanDefinitionPostProcessor修改/合并bean定义	【补充内容】【保姆级】@PostConstruct & @PreDestroy使用示例【Spring源码】AutowiredAnnotationBeanPostProcessor.postProcessMergedBeanDefinition()详解【Spring源码】CommonAnnotationBeanPostProcessor.postProcessMergedBeanDefinition()详解
22	【Spring源码】21. 初探循环依赖	【补充内容】【保姆级】手把手Debug循环依赖的整体流程【实践向】当移除了三级缓存…… 【分析向】没有三级缓存会导致什么？【Spring源码】插播一个创建代理对象的wrapIfNecessary()方法
23	【Spring源码】22. 属性填充populateBean()详解	【补充内容】【Spring源码】自动注入·名称：autowireByName()详解【Spring源码】自动注入·类型：autowireByType()详解【Spring源码】属性值的解析与赋值：populateBean().applyPropertyValues() 【保姆级】超超超简单的自定义注解实现@Autowired同款功能
24	【Spring源码】23. 执行初始化逻辑：initializeBean()

本文目录

前言（放在开头的废话）

如何实现自定义标签

1. 新建一个实体类AqinEntity

2. 创建实体解析类AqinBeanDefinitionParser

3. 新建自定义命名空间处理类AqinNamespaceHandler

4. 新建配置文件spring.handlers、spring.schemas和.xsd

1. 修改文件spring.handlers的内容

2. 仿照spring-bean.xsd来构造aqin.xsd

3. 修改文件spring.schemas的内容：

5. 修改配置文件applicationContext.xml

FAILURE: Build failed with an exception.Where:Script '.../gradle/docs.gradle' line: 228

7. 执行

前言（放在开头的废话）

不知道你有没有注意过命名空间这个东西，或者你有没有注意过xmlns、xmlns:context、xmlns:xsi（更多瞅下图）...

问题来了，这些是啥么？

这些是Spring中的命名空间，其主要作用是避免命名冲突，打个比方就是你和张三都有一个叫做heheda的bean，但是由于你们用的是各自的命名空间，就会给你俩的heheda前分别加上表示你俩命名空间的前缀，以免混淆。

Spring中主要分两位两种命名空间：默认命名空间和自定义命名空间（函数parseBeanDefinitions()中）

Spring中的默认命名空间有以下四个（其余都算自定义）

public static final String NESTED_BEANS_ELEMENT = "beans";
public static final String ALIAS_ELEMENT = "alias";
public static final String NAME_ATTRIBUTE = "name";
public static final String ALIAS_ATTRIBUTE = "alias";

如何实现自定义标签

那么如何实现一个自定义标签，并实现解析～～开始搞起(奋斗脸.gif)！

1. 新建一个实体类AqinEntity

AqinEntity.java

package com.aqin;

/**
 * @author aqin1012 AQin.
 * @date 2022/4/24 5:45 PM
 * @Version 1.0
 */
public class AqinEntity {
   String id;
   String name;
   String address;

   public String getId() {
      return id;
   }

   public void setId(String id) {
      this.id = id;
   }

   public String getName() {
      return name;
   }

   public void setName(String name) {
      this.name = name;
   }

   public String getAddress() {
      return address;
   }

   public void setAddress(String address) {
      this.address = address;
   }
}

2. 创建实体解析类AqinBeanDefinitionParser

AqinBeanDefinitionParser.java

package com.aqin;

import org.springframework.beans.factory.support.BeanDefinitionBuilder;
import org.springframework.beans.factory.xml.AbstractSingleBeanDefinitionParser;
import org.springframework.util.StringUtils;
import org.w3c.dom.Element;

/**
 * @Description
 * @Author aqin1012 AQin.
 * @Date 2022/5/12 3:27 PM
 * @Version 1.0
 */
public class AqinBeanDefinitionParser extends AbstractSingleBeanDefinitionParser {

   @Override
   protected Class<?> getBeanClass(Element element) {
      return AqinEntity.class;
   }

   /**
    * 此处缺少某个属性并不会导致程序报错，但是该属性会为null
    * 
    * @param element the XML element being parsed
    * @param builder used to define the {@code BeanDefinition}
    */
   @Override
   protected void doParse(Element element, BeanDefinitionBuilder builder) {
      String id = element.getAttribute("id");
      String name = element.getAttribute("name");
      String address = element.getAttribute("address");

      if (StringUtils.hasText(id)) {
         builder.addPropertyValue("id", id);
      }

      if (StringUtils.hasText(name)) {
         builder.addPropertyValue("name", name);
      }

      if (StringUtils.hasText(address)) {
         builder.addPropertyValue("address", address);
      }
   }
}

3. 新建自定义命名空间处理类AqinNamespaceHandler

AqinNamespaceHandler.java

package com.aqin;

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

/**
 * @author aqin1012
 */
public class AqinNamespaceHandler extends NamespaceHandlerSupport {

   @Override
   public void init() {
      registerBeanDefinitionParser("aqin", new AqinBeanDefinitionParser());
   }

}

4. 新建配置文件spring.handlers、spring.schemas和.xsd

我们可以参考源码中别的模块来创建：

推荐个偷懒的方法可以直接吧，直接把整个META_INF文件夹复制到我们自己新建的模块中的resources中

像这样

删掉用不到的文件，就留下面两个就成👇

1. 修改文件spring.handlers的内容

http\://www.aqin.com/schema/aqin=com.aqin.AqinNamespaceHandler

2. 仿照spring-bean.xsd来构造aqin.xsd

aqin.xsd

<?xml version="1.0" encoding="UTF-8" standalone="no"?>

<schema xmlns="http://www.w3.org/2001/XMLSchema"
      targetNamespace="http://www.aqin.com/schema/aqin"
      xmlns:tns="http://www.aqin.com/schema/aqin"
      elementFormDefault="qualified">
   <element name="aqin">
      <complexType>
         <attribute name="id" type="string"/>
         <attribute name="name" type="string"/>
         <attribute name="address" type="string"/>
      </complexType>
   </element>

</schema>

3. 修改文件spring.schemas的内容：

http\://www.aqin.com/schema/aqin.xsd=META-INF/aqin.xsd

5. 修改配置文件applicationContext.xml

applicationContext.xml

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
      xmlns:context="http://www.springframework.org/schema/context"
      xmlns:aqin1012="http://www.aqin.com/schema/aqin"
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
      xsi:schemaLocation="http://www.springframework.org/schema/beans https://www.springframework.org/schema/beans/spring-beans.xsd
      http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context.xsd
      http://www.aqin.com/schema/aqin http://www.aqin.com/schema/aqin.xsd">


   <aqin1012:aqin id="aqin1012" name="heheda~" address="浙江省杭州市"/>


</beans>

6. 相关报错处理

Process 'command '/Library/Java/JavaVirtualMachines/jdk1.8.0_202.jdk/Contents/Home/bin/java'' finished with non-zero exit value 1

报错详情

解决方法

这类错误一般是由于标签名不一致导致的

请检查以下几个地方

一般情况下，红色圈住文件内的红色部分要保持一致，黄色圈住的文件内的黄色部分要保持一致，嗯嗯啰嗦的俺...

FAILURE: Build failed with an exception.Where:Script '.../gradle/docs.gradle' line: 228

报错详情

解决方法（这里提供两种）

法1⃣️：注释判断大小写的代码

法2⃣️：首字母改成大写

7. 执行

如上图就是自定义标签添加成功喽～～～

也可在中途的打断点查看映射关系是否加载成功（如下图）

又完成一篇～赞～嘻嘻、给自己撒个花🎉～～

AQin1012

关注

2
点赞
踩
3

收藏

觉得还不错? 一键收藏
打赏
0
评论
【Spring源码】4. 自己搞个标签?~自定义标签保姆级全过程(图解向，堆图预警)

前言（放在开头的废话）不知道你有没有注意过命名空间这个东西，或者你有没有注意过xmlns、xmlns:context、xmlns:xsi（更多瞅下图）...问题来了，这些是啥么？这些是Spring中的命名空间，其主要作用是避免命名冲突，打个比方就是你和张三都有一个叫做heheda的bean，但是由于你们用的是各自的命名空间，就会给你俩的heheda前分别加上表示你俩命名空间的前缀，以免混淆。Spring中主要分两位两种命名空间：默认命名空间和自定义命名空间（函数parseBeanDef
复制链接

扫一扫