Spring源码解读(三)
自定义标签的过程:
1.创建一个java普通对象
package test.customtag ;
public class User {
private String userName ;
private String email;
//省略set/get 方法
}
2.定义一个XSD文件,用于描述组件内容
<?xml version= " l 。” enc 。ding = ” UTF - 日” ? 〉
<schema xmlns=” http : //www . w3 . org/2001/XMLSchema ”
targetNamespace= ” http ’ // www . lexueba . com/schema/user "
xmlns : tns = ” htto : //www . le xueba . com/schema/user ”
elemen tFormDefa ul t =” q ua l 工fied ” >
<element name =” u s e r ” >
<complexType>
<attribute name=” id” typ e =” s tring ” />
<attribute name=” userName ” t ype=” string ” />
<attribute name=” email ” type =” string ” />
</complexType>
</element>
</schema>
3.创建一个文件,实现BeanDefin.itionParser接口,用来解析XSD 文件中的定义和组件定义。
package test custorntag ;
Import org.Springfrarnework.beans.factory.support.BeanDefinitionBuilder ;
import org.Springfrarnework.beans.factory.xrnl.AbstractSingleBeanDefinitionParser ;
import org.Springfrarnework.util.StringUtils ;
import org.w3c.dom.Elernent ,
public class UserBeanDefinitionParser extends AbstractSingleBeanDefinitionParser {
//Element 对应的类
protected Class getBeanClass (Element element) {
return User.class ,
//从element 中队’忻并提l仅对应的元索
protected void doParse (Element element , BeanDefinitionBuilder bean ) {
String userName = element . getAttribute ( ” userName ” ) ;
String email =element getAttribute ( ” emai l ” );
//将提lj立的数据放入到 BeanDefinitionBuilder 中,待到完成所有bean的解析后统一注册到beanFactory 中
if (StringUtils . hasText (userName)) {
bean . addPropertyValue ( ” userName ”, userName) ;
if ( StringUtils . hasText (email)) {
bean . addPropertyValue ( ” emai l ”, email) ;
}
}
}
4.扩展NamespaceHandlerSupport,目的是将组件注册到Spring容器。
在dubbo源码中也用到了这个类,实现自定义解析xml标签
dubbo源码:
public class DubboNamespaceHandler extends NamespaceHandlerSupport {
static {
Version.checkDuplicate(DubboNamespaceHandler.class);
}
@Override
public void init() {
registerBeanDefinitionParser("application", new DubboBeanDefinitionParser(ApplicationConfig.class, true));
registerBeanDefinitionParser("module", new DubboBeanDefinitionParser(ModuleConfig.class, true));
registerBeanDefinitionParser("registry", new DubboBeanDefinitionParser(RegistryConfig.class, true));
registerBeanDefinitionParser("monitor", new DubboBeanDefinitionParser(MonitorConfig.class, true));
registerBeanDefinitionParser("provider", new DubboBeanDefinitionParser(ProviderConfig.class, true));
registerBeanDefinitionParser("consumer", new DubboBeanDefinitionParser(ConsumerConfig.class, true));
registerBeanDefinitionParser("protocol", new DubboBeanDefinitionParser(ProtocolConfig.class, true));
registerBeanDefinitionParser("service", new DubboBeanDefinitionParser(ServiceBean.class, true));
registerBeanDefinitionParser("reference", new DubboBeanDefinitionParser(ReferenceBean.class, false));
registerBeanDefinitionParser("annotation", new AnnotationBeanDefinitionParser());
}
}
有兴趣的小伙伴可以看下我的博客,dubbo服务注册与发现。
回头来看Spring的源码:
package test . customtag ;
import org.Springframework.beansfactory.xml.NamespaceHandlerSupport ;
public class MyNamespaceHandler extends NamespaceHandlerSupport {
public void init () {
registerBeanDefinitionParser ( "user”, new UserBeanDefinitionParser ());
}
}
这样,只要遇到这样user开头的标签,就会交给UserBeanDefinitionParser进行解析。
5.编写Spring.handlers和Spring.schemas文件,默认位置是在工程/META-INF/文件夹下。
Spring.handlers
http\://www.lexueba.com/schema/user=test.customtag.MyNamespaceHandler
Spring.schemas
http\://www.lexueba.com/schema/user.xsd=META-INF/Spring-test.xsd
Spring加载自定义的大致流程是遇到自定义标签然后就去Spring.handlers和Spring.schemas中去找对应的handler和XSD,默认位置是/META-INF/下,进而找到对应的handler以及解析元素的Parser,从而完成整个自定义元素的解析,也就是说自定义与Spring中默认的标准配置不用,在于Spring将自定义标签解析的工作委托给了用户去实现。
6.使用,myname是命名空间的定义
<beans xmlns=” http //\;ww Springframework org/schema/beans ”
xmlns xsi=” http : //www . w3 . org/2001/XMLSchema-instance ”
xmlns · myname=”http· //www lexueba c。m/schma/user"
xsi : schemaLocation= ” http //www . Spr iηgframework . org/schema/beans http : //www .
Springframework . 。rg/schema/beans/Spring - beans - 2 . 。. xsd
http://www. lexueba c。m/schema/user http://www.lexueba c。m/schema/user xsd">
<myname : user id = ” testbean” userName=” aaa ” email = ” bbb ” /〉
</beans>
7.测试
public static vo id main (String[] args) {
Applicat i 。nContext bf = new ClassPathXmlApplicati 。nContext ( ” test/customtag/
test . xml ” ),
User user= (User) bf getBean ( ” testbean ” ) ;
System . out println(user getUserName ()+ ”,” +user . getSmail()) ;
}