基于 Spring
源码在处理定制的标签时是通过定制的命名空间处理器和 xsd
文件进行解析的,在 spring
的 classpath
下的 META-INF/spring.schemas
和 META-INF/spring.handlers
,并且需要将标签的解析器注册到 BeanDefinition
的解析器中,这样说起来比较抽象,接下来我们自己定义一个标签就明了了。
创建一个需要解析的标签的属性,比如在 Spring
配置文件中经常看到的 <context:component-scan base-package="com.redwinter.test"></context:component-scan>
,这里的 component-scan
就是标签属性。
/**
* @author redwinter
* @since 1.0
**/
public class Redwinter {
private String username;
private String email;
private String password;
public String getUsername() {
return username;
}
public void setUsername(String username) {
this.username = username;
}
public String getEmail() {
return email;
}
public void setEmail(String email) {
this.email = email;
}
public String getPassword() {
return password;
}
public void setPassword(String password) {
this.password = password;
}
}
定义一个 Redwinter
类,里面三个属性,当然你可以自己定义你需要的属性,我这里就随便写啦。
定义好标签的属性之后就需要定义一个解析器对这些属性进行解析,定义解析器需要继承 AbstractSingleBeanDefinitionParser
,这个类是实现了 BeanDefinitionParser
的类,他下面有很多实现类,一般来说我们的Bean都是单例的,那就继承 AbstractSingleBeanDefinitionParser
即可。
/**
* @author redwinter
* @since 1.0
**/
public class RedwinterBeanDefinitionParser extends AbstractSingleBeanDefinitionParser {
@Override
protected Class getBeanClass(Element element) {
return Redwinter.class;
}
@Override
protected void doParse(Element element, BeanDefinitionBuilder builder) {
/**
* 自定义解析xml的自定义字段,并做相应的其他处理
*/
String username = element.getAttribute("username");
String email = element.getAttribute("email");
String password = element.getAttribute("password");
if (StringUtils.hasText(username)){
builder.addPropertyValue("username",username);
}
if (StringUtils.hasText(email)){
builder.addPropertyValue("email",email);
}
if (StringUtils.hasText(password)){
builder.addPropertyValue("password",password);
}
}
}
这个解析器主要是重写了父类的两个方法,一个是 getBeanClass
用于返回对应的标签属性类,一个是解析属性 doParser
,这里我只是从 element
中获取出来然后进行了下判断在加入到属性值中,当然这里你可以自定义自己的逻辑处理。
定义命名空间处理器需要继承NamespaceHandlerSupport,然后重写他的init方法,将解析器注册进去,这个解析器就是上面定义的用来解析标签属性的解析器。
/**
* @author redwinter
* @since 1.0
**/
public class RedwinterNameSpaceHandler extends NamespaceHandlerSupport {
@Override
public void init() {
// 这里的属性必须和xsd中指定的属性一致,否则报错
//org.springframework.beans.factory.parsing.BeanDefinitionParsingException: Configuration problem: Cannot locate BeanDefinitionParser for element [dl]
registerBeanDefinitionParser("dl",new RedwinterBeanDefinitionParser());
}
}
这里需要注意的是,进行注册时需要指定一个 elementName
,这个值必须和xml中定义的名称一致,否者的话就会报如下错:
org.springframework.beans.factory.parsing.BeanDefinitionParsingException: Configuration problem: Cannot locate BeanDefinitionParser for element [dl]
我这里定义的元素名称叫 dl。
xsd文件就是spring进行xml解析时解析的标签,当然你可以定义dtd文件,不过现在一般都用xsd文件,我这里命名为redwinter.xsd,完整文件如下:
这里有几个点需要注意: schema
标签下有个 targetNamespace
,这里指定了命名空间叫http://www.redwinter.com/schema/redwinter ,那么在进行 spring
配置文件的时候引入的 namespace
就是这个,然后有个 name="dl"
,这里的这个 dl
就是处理器中定义的元素名称,而且必须一致,不然解析不到,下面定义的属性就是标签属性类中定义的刷新,这个 id
是表示唯一的 Bean
名称。
这里直接列出完整文件内容:
spring.schemas
文件
http\://www.redwinter.com/schema/redwinter.xsd=META-INF/redwinter.xsd
这里需要注意的是,这里配置的 key
也是需要在 spring
配置文件中引入的, value
就是上一步定义的 xsd
文件所在路径
spring.handlers
文件
http\://www.redwinter.com/schema/redwinter=com.redwinter.test.RedwinterNameSpaceHandler
这里配置的 key
就是上一步定义的 xsd
文件中定义的 targetNamespace
, value
就是定义的命名空间处理器。
到这里自定义标签和解析就完成了,最后就需要在spring配置文件中引入并配置。
我这里定义个角 spring-test.xml
的文件进行配置
验证是否配置正确:
public class BeanCreate {
@Test
public void classPathXml() {
// ClassPathXmlApplicationContext context = new ClassPathXmlApplicationContext("classpath:spring-test.xml");
ClassPathXmlApplicationContext context = new MyClassPathXmlApplicationContext("classpath:spring-test.xml");
Redwinter redwinter = (Redwinter) context.getBean("redwinter");
System.out.println(redwinter.getEmail());
Redwinter redwinter123456 = (Redwinter) context.getBean("redwinter123456");
System.out.println(redwinter123456.getEmail());
}
}
输出:
abc@qq.com
123456-abc@qq.com
那说明自定义标签生效了,并且成功解析出来。
接下来就是继续介绍 Spring
容器的实现 AbstractApplicationContex#refresh
的第三个方法,这个方法其实就是 BeanFactory
使用的前戏准备,而第一个方法是 BeanFactory
刷新的前戏准备。
Original: https://www.cnblogs.com/redwinter/p/16165878.html
Author: 玲丶蹊
Title: Spring 源码(4)在Spring配置文件中自定义标签如何实现?
原创文章受到原创版权保护。转载请注明出处:https://www.johngo689.com/610058/
转载文章受原作者版权保护。转载请注明原作者出处!