title: spring解析自定義標(biāo)簽
tags: spring,源碼
grammar_cjkRuby: true
spring解析自定義標(biāo)簽
1、實(shí)踐
1.1袜刷、如何拓展自定義標(biāo)簽
1.1.1申窘、創(chuàng)建一個(gè)需要拓展的組件（POJO）
1539088667367.png
1.1.2度硝、定義一個(gè)xsd文件描述組件內(nèi)容
1539092925444.png
1.1.3费韭、定義一個(gè)NamespaceHandler
程序可以通過此類定位到BeanDefinitionParse
1539092964595.png
1.1.4别垮、定義一個(gè)BeanDefinitionParse盗舰，用來解析組件內(nèi)容
1539092992933.png
1.1.5猴凹、編寫spring.handlers和spring.schemas文件
spring.handlers
http\://www.dreamlong.com/schema/user=com.wl.custom.namespaceHandler.UserNamespaceHandler
spring.schemas
http\://www.dreamlong.com/schema/user.xsd=xml/user.xsd
1.1.6、編寫xml配置
1539093226527.png
1.1.7岭皂、程序架構(gòu)
程序的架構(gòu)如圖所示：
1539093129734.png
1539093157067.png
1.1.8郊霎、運(yùn)行結(jié)果
1539093275863.png
2、源碼
2.1爷绘、入口
DefaultBeanDefinitionDocumentReader.parseBeanDefinitions
protected void parseBeanDefinitions(Element root, BeanDefinitionParserDelegate delegate) {
//如果是缺省命名空間书劝，進(jìn)行默認(rèn)解析注冊进倍，否則進(jìn)行自定義元素解析方法
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;
//循環(huán)遍歷節(jié)點(diǎn)，如果是默認(rèn)命名空間购对，則采取默認(rèn)元素解析方法猾昆，否則采用自定義元素解析方法
if (delegate.isDefaultNamespace(ele)) {
parseDefaultElement(ele, delegate);
}
else {
delegate.parseCustomElement(ele);
}
}
}
}
else {
delegate.parseCustomElement(root);
}
}
在實(shí)踐部分可知，命名空間為自定義空間骡苞，http://www.dreamlong.com/schema/user
2.2垂蜗、解析過程
BeanDefinitionParserDelegate.parseCustomElement
public BeanDefinition parseCustomElement(Element ele, @Nullable BeanDefinition containingBd) {
//獲取當(dāng)前元素的命名空間
String namespaceUri = getNamespaceURI(ele);
if (namespaceUri == null) {
return null;
}
//根據(jù)命名空間獲取對應(yīng)Handler
NamespaceHandler handler = this.readerContext.getNamespaceHandlerResolver().resolve(namespaceUri);
if (handler == null) {
error("Unable to locate Spring NamespaceHandler for XML schema namespace [" + namespaceUri + "]", ele);
return null;
}
//通過返回的處理器解析當(dāng)前元素
return handler.parse(ele, new ParserContext(this.readerContext, this, containingBd));
}
2.2.1、獲取節(jié)點(diǎn)的命名空間
String namespaceUri = getNamespaceURI(ele);
1539099017123.png
2.2.2解幽、根據(jù)命名空間獲取對應(yīng)的NamespaceHandler
NamespaceHandler handler = this.readerContext.getNamespaceHandlerResolver().resolve(namespaceUri);
this.readerContext.getNamespaceHandlerResolver();
此方法返回結(jié)果是NamespaceHandlerResolver贴见，而NamespaceHandlerResolver的實(shí)現(xiàn)類是DefaultNamespaceHandlerResolver，進(jìn)入到DefaultNamespaceHandlerResolver.resolve:
public NamespaceHandler resolve(String namespaceUri) {
//獲取handlerMapping躲株，即spring.handlers中存儲(chǔ)的信息片部，以 namespaceUri -> NamespaceHandler名字 的形式存儲(chǔ)
//如果已經(jīng)實(shí)例化，則該namespaceUri對應(yīng)的value值是NamespaceHandler對象霜定，而不是String類型
Map<String, Object> handlerMappings = getHandlerMappings();
//獲取到對應(yīng)的NamespaceHandler名字或者實(shí)例
Object handlerOrClassName = handlerMappings.get(namespaceUri);
if (handlerOrClassName == null) {
return null;
}
//如果當(dāng)前類已經(jīng)實(shí)例化档悠，則直接返回
else if (handlerOrClassName instanceof NamespaceHandler) {
return (NamespaceHandler) handlerOrClassName;
}
//還未實(shí)例化，則上面獲取的handlerOrClassName只是名字望浩，還需實(shí)例化
else {
//獲取到className
String className = (String) handlerOrClassName;
try {
//通過className以及當(dāng)前類加載器加載class類
Class<?> handlerClass = ClassUtils.forName(className, this.classLoader);
if (!NamespaceHandler.class.isAssignableFrom(handlerClass)) {
throw new FatalBeanException("Class [" + className + "] for namespace [" + namespaceUri +
"] does not implement the [" + NamespaceHandler.class.getName() + "] interface");
}
//實(shí)例化對應(yīng)的Handler
NamespaceHandler namespaceHandler = (NamespaceHandler) BeanUtils.instantiateClass(handlerClass);
namespaceHandler.init();
//將實(shí)例化好的Handler以namespaceUri->Handler的形式存儲(chǔ)在handlerMappings中
handlerMappings.put(namespaceUri, namespaceHandler);
return namespaceHandler;
}
catch (ClassNotFoundException ex) {
throw new FatalBeanException("Could not find NamespaceHandler class [" + className +
"] for namespace [" + namespaceUri + "]", ex);
}
catch (LinkageError err) {
throw new FatalBeanException("Unresolvable class definition for NamespaceHandler class [" +
className + "] for namespace [" + namespaceUri + "]", err);
}
}
}
以上代碼一共做了這么幾件事：
1辖所、讀取所有META-INF/spring.handlers的文件，并且以namespaceUri -> NamespaceHandler名字 的形式存儲(chǔ)
2磨德、根據(jù)傳入的namespaceUri獲取對應(yīng)的值缘回，如果該值類型是NamespaceHandler，則直接返回剖张；如果是字符串類型，則還未實(shí)例化揩环，進(jìn)行實(shí)例化搔弄，然后將實(shí)例化NamespaceHandler替代原來的NamespaceHandler名字
3、返回對應(yīng)的NamespaceHandler
1539131755529.png
1539135467615.png
2.2.3丰滑、解析
return handler.parse(ele, new ParserContext(this.readerContext, this, containingBd));
這句代碼的做了這么2件事：
1顾犹、查找到對應(yīng)的BeandefinitionParser
2、解析
2.2.3.1褒墨、定位BeanDefinitionParser
首先我們可以得知當(dāng)前NamespaceHandler為UserNamespaceHandler,那么要如何獲取到對應(yīng)的UserBeanDefinitionParser炫刷，首先我們知道UserNamespaceHandler有如下方法：
public class UserNamespaceHandler extends NamespaceHandlerSupport {
@Override
public void init() {
//以節(jié)點(diǎn)本地名稱->BeanDefinitioinParser的形式存儲(chǔ)在Map<String, BeanDefinitionParser>中
registerBeanDefinitionParser("user",new UserBeanDefinitionParse());
}
}
由于UserNamespaceHandler繼承了NamespaceHandlerSupport，進(jìn)入到NamespaceHandlerSupport：
public abstract class NamespaceHandlerSupport implements NamespaceHandler {
/**
* Stores the {@link BeanDefinitionParser} implementations keyed by the
* local name of the {@link Element Elements} they handle.
* 以節(jié)點(diǎn)本地名稱->BeanDefinitionParser的形式存儲(chǔ)于Map
*/
private final Map<String, BeanDefinitionParser> parsers =
new HashMap<String, BeanDefinitionParser>();
/**
* 將對應(yīng)的BeanDefinitionParser存放到map中
*/
protected final void registerBeanDefinitionParser(String elementName, BeanDefinitionParser parser) {
this.parsers.put(elementName, parser);
}
//根據(jù)Element的localName定位到對應(yīng)的BeanDefinitionParser
private BeanDefinitionParser findParserForElement(Element element, ParserContext parserContext) {
//獲取節(jié)點(diǎn)的本地名稱
String localName = parserContext.getDelegate().getLocalName(element);
//根據(jù)節(jié)點(diǎn)本地名稱獲取到對應(yīng)BeanDefinitionParser
BeanDefinitionParser parser = this.parsers.get(localName);
if (parser == null) {
parserContext.getReaderContext().fatal(
"Cannot locate BeanDefinitionParser for element [" + localName + "]", element);
}
return parser;
}
}
因此郁妈，我們可以知道：
1浑玛、NamespaceHandler在初始化（init）時(shí)將對應(yīng)的BeanDefinitionParser以elementName->BeanDefinitionParser的形式存儲(chǔ)在map中
2、NamespaceHandler可以根據(jù)Element的localName噩咪，從而定位到對應(yīng)的BeanDefinitionParser
2.2.3.2顾彰、解析
由于當(dāng)前定位到的解析器為UserBeanDefinitionParse极阅，它的繼承體系圖如圖所示：
1539137582091.png
1539137716761.png
2.2.3.2.1、AbstractBeanDefinitionParser.parse
public final BeanDefinition parse(Element element, ParserContext parserContext) {
//模板方法涨享，由子類完成筋搏，解析相應(yīng)的標(biāo)簽，除了id以及name以外
AbstractBeanDefinition definition = parseInternal(element, parserContext);
if (definition != null && !parserContext.isNested()) {
try {
//解析該標(biāo)簽的id屬性
String id = resolveId(element, definition, parserContext);
if (!StringUtils.hasText(id)) {
parserContext.getReaderContext().error(
"Id is required for element '" + parserContext.getDelegate().getLocalName(element)
+ "' when used as a top-level tag", element);
}
String[] aliases = null;
if (shouldParseNameAsAliases()) {
String name = element.getAttribute(NAME_ATTRIBUTE);
if (StringUtils.hasLength(name)) {
aliases = StringUtils.trimArrayElements(StringUtils.commaDelimitedListToStringArray(name));
}
}
//將id作為beanName厕隧，結(jié)合definition構(gòu)建BeanDefinitionHolder
BeanDefinitionHolder holder = new BeanDefinitionHolder(definition, id, aliases);
//以beanName->BeanDefinition的形式注冊BeanDefinition
registerBeanDefinition(holder, parserContext.getRegistry());
if (shouldFireEvents()) {
BeanComponentDefinition componentDefinition = new BeanComponentDefinition(holder);
postProcessComponentDefinition(componentDefinition);
parserContext.registerComponent(componentDefinition);
}
}
catch (BeanDefinitionStoreException ex) {
String msg = ex.getMessage();
parserContext.getReaderContext().error((msg != null ? msg : ex.toString()), element);
return null;
}
}
return definition;
}
這個(gè)方法主要做了這么幾件事：
1奔脐、解析自定義標(biāo)簽相關(guān)屬性parseInternal(element, parserContext);，此方法交由子類完成
2吁讨、獲取節(jié)點(diǎn)的id屬性髓迎，并將其作為beanName
3、注冊BeanDefinition
由上面的類體系圖可以得知挡爵，AbstractSingleBeanDefinitionParser實(shí)現(xiàn)了parserInternal
2.2.3.2.2竖般、AbstractSingleBeanDefinitionParser.parserInternal
protected final AbstractBeanDefinition parseInternal(Element element, ParserContext parserContext) {
//構(gòu)建BeanDefinition
BeanDefinitionBuilder builder = BeanDefinitionBuilder.genericBeanDefinition();
//設(shè)置parnetName屬性
String parentName = getParentName(element);
if (parentName != null) {
builder.getRawBeanDefinition().setParentName(parentName);
}
//設(shè)置beanClass
Class<?> beanClass = getBeanClass(element);
if (beanClass != null) {
builder.getRawBeanDefinition().setBeanClass(beanClass);
}
else {
String beanClassName = getBeanClassName(element);
if (beanClassName != null) {
builder.getRawBeanDefinition().setBeanClassName(beanClassName);
}
}
builder.getRawBeanDefinition().setSource(parserContext.extractSource(element));
BeanDefinition containingBd = parserContext.getContainingBeanDefinition();
if (containingBd != null) {
// Inner bean definition must receive same scope as containing bean.
builder.setScope(containingBd.getScope());
}
if (parserContext.isDefaultLazyInit()) {
// Default-lazy-init applies to custom bean definitions as well.
builder.setLazyInit(true);
}
//模板方法，交由子類實(shí)現(xiàn)
doParse(element, parserContext, builder);
return builder.getBeanDefinition();
}
這個(gè)方法一共做了這么幾件事：
1茶鹃、構(gòu)建BeanDefinition
2涣雕、設(shè)置相關(guān)基本屬性
3、解析節(jié)點(diǎn)闭翩，由子類實(shí)現(xiàn)doParse
因此調(diào)用UserBeanDefinitionParse.doParse
2.2.3.2.3挣郭、最后調(diào)用具體實(shí)現(xiàn)類的doParse方法
protected void doParse(Element element, BeanDefinitionBuilder builder) {
String userName = element.getAttribute("userName");
String password = element.getAttribute("password");
if(StringUtils.hasText(userName)){
builder.addPropertyValue("userName",userName);
}
if(StringUtils.hasText(password)){
builder.addPropertyValue("password",password);
}
}
3、總結(jié)
自定義標(biāo)簽的解析過程到此結(jié)束
