Spring源码阅读-解析BeanDefinition
一：解析并注册BeanDefinition总体过程
- 将类路径从String逐步转换为Resource、EncodeResource、document、Element；
- 将Element解析为BeanDefinition并返回一个BeanDefinitionHolder；
- 使用BeanDefinitionReaderUtils将BeanDefinitionHolder中的BeanDefinition注册到BeanFactory，
也就是将BeanDefinition存放到BeanFactory中的beanDefinitionMap中。
二、几个关键类
ClassPathXmlApplicationContext
虽然实现了BeanFactory接口，但是只是自己持有一个BeanFactory的实现类。
DefaultListableBeanFactory
BeanFactory是Bean工厂，可以从中获取交给Spring管理的Bean对象；
Registry是用来注册和存储管理BeanDefinition（由BeanDefinitionRegistry定义）和bean对象（由BeanRegistry定义）的。
XmlBeanDefinitionReader
BeanDefinition是用来描述Bean对象的定义；
BeanDefinitionReader负责将xml资源转换为Document对象、加载BeanDefinition、注册BeanDefinition等。
三：从ClassPathXmlApplicationContext到XmlBeanDefinitionReader的过程
四：解析BeanDefinition源码核心部分逻辑
到XmlBeanDefinitionReader的loadBeanDefinitions(EncodedResource encodedResource)开始解析xml文件
EncodedResource是带编码格式的Resource，Resource里面是一个类路径和一个类加载器
public int loadBeanDefinitions(EncodedResource encodedResource) throws BeanDefinitionStoreException {
Assert.notNull(encodedResource, "EncodedResource must not be null");
if (logger.isTraceEnabled()) {
logger.trace("Loading XML bean definitions from " + encodedResource);
}
//拿当前线程已经加载过的所有encodedResource
Set<EncodedResource> currentResources = this.resourcesCurrentlyBeingLoaded.get();
//encodedResource加入threadLocal-set，如失败则说明当前encodedResource已经加载过了，不能重复加载
if (!currentResources.add(encodedResource)) {
throw new BeanDefinitionStoreException(
"Detected cyclic loading of " + encodedResource + " - check your import definitions!");
}
//处理encodedResource
try (InputStream inputStream = encodedResource.getResource().getInputStream()) {
InputSource inputSource = new InputSource(inputStream);
if (encodedResource.getEncoding() != null) {
inputSource.setEncoding(encodedResource.getEncoding());
}
//加载BeanDefinition
return doLoadBeanDefinitions(inputSource, encodedResource.getResource());
}
catch (IOException ex) {
throw new BeanDefinitionStoreException(
"IOException parsing XML document from " + encodedResource.getResource(), ex);
}
finally {
//当前这个resource处理完，需要从set中移除
currentResources.remove(encodedResource);
//防止threadLocal内存泄露
if (currentResources.isEmpty()) {
this.resourcesCurrentlyBeingLoaded.remove();
}
}
}
其中doLoadBeanDefinitions(inputSource, encodedResource.getResource())主要是将resource转换为document对象，
然后解析成BeanDefinitions，再将BeanDefinitions注册到BeanFactory中，最后返回新注册BeanDefinition数量
protected int doLoadBeanDefinitions(InputSource inputSource, Resource resource)
throws BeanDefinitionStoreException {
try {
//将resource转换成程序层面可以识别的有层次结构的document对象。
Document doc = doLoadDocument(inputSource, resource);
//将document解析成BeanDefinition并且注册到BeanFactory中，返回新注册的BeanDefinition数量。
int count = registerBeanDefinitions(doc, resource);
if (logger.isDebugEnabled()) {
logger.debug("Loaded " + count + " bean definitions from " + resource);
}
//返回新注册BeanDefinition的数量。
return count;
}
catch (BeanDefinitionStoreException ex) {
throw ex;
}
catch (SAXParseException ex) {
throw new XmlBeanDefinitionStoreException(resource.getDescription(),
"Line " + ex.getLineNumber() + " in XML document from " + resource + " is invalid", ex);
}
catch (SAXException ex) {
throw new XmlBeanDefinitionStoreException(resource.getDescription(),
"XML document from " + resource + " is invalid", ex);
}
catch (ParserConfigurationException ex) {
throw new BeanDefinitionStoreException(resource.getDescription(),
"Parser configuration exception parsing XML from " + resource, ex);
}
catch (IOException ex) {
throw new BeanDefinitionStoreException(resource.getDescription(),
"IOException parsing XML document from " + resource, ex);
}
catch (Throwable ex) {
throw new BeanDefinitionStoreException(resource.getDescription(),
"Unexpected exception parsing XML document from " + resource, ex);
}
}
registerBeanDefinitions应用了面向对象中单一职责的原则，将逻辑处理委托给单一的类进行处理，而这个逻辑处理类就是BeanDefinitionDocumentReader；
BeanDefinitionDocumentReader是一个接口，通过createBeanDefinitionDocumentReader()拿到的是是DefaultBeanDefinitionDocumentReader了；
其中documentReader.registerBeanDefinitions(doc, createReaderContext(resource))这个方法的重要目的之一就是提取root，以便于再次将root作为参数继续BeanDefinition的注册。
public int registerBeanDefinitions(Document doc, Resource resource) throws BeanDefinitionStoreException {
BeanDefinitionDocumentReader documentReader = createBeanDefinitionDocumentReader();
//getRegistry()返回创建的BeanFactory实例，就是DefaultListableBeanFactory
int countBefore = getRegistry().getBeanDefinitionCount();
//解析doc并且注册到BeanFactory中。
documentReader.registerBeanDefinitions(doc, createReaderContext(resource));
//返回的新注册的bd数量。
return getRegistry().getBeanDefinitionCount() - countBefore;
}
通过doc.getDocumentElement()拿到Element root，表示的是document代表的xml的顶层标签 =>
@Override
public void registerBeanDefinitions(Document doc, XmlReaderContext readerContext) {
this.readerContext = readerContext;
doRegisterBeanDefinitions(doc.getDocumentElement());
}
doRegisterBeanDefinitions(Element root)方法是核心部分；
createDelegate(getReaderContext(), root, parent)给出bean标签解析器对象BeanDefinitionParserDelegate，用于解析beanName、别名以及各种默认的属性；
parseBeanDefinitions(root, this.delegate)解析"import", "alias", "bean"这些子标签；
preProcessXml(root)和postProcessXml(root)都是用于子类扩展。
protected void doRegisterBeanDefinitions(Element root) {
BeanDefinitionParserDelegate parent = this.delegate;
//返回一个beans标签解析器对象。
this.delegate = createDelegate(getReaderContext(), root, parent);
if (this.delegate.isDefaultNamespace(root)) {
//获取beans标签 属性 profile
String profileSpec = root.getAttribute(PROFILE_ATTRIBUTE);
if (StringUtils.hasText(profileSpec)) {
String[] specifiedProfiles = StringUtils.tokenizeToStringArray(
profileSpec, BeanDefinitionParserDelegate.MULTI_VALUE_ATTRIBUTE_DELIMITERS);
// We cannot use Profiles.of(...) since profile expressions are not supported
// in XML config. See SPR-12458 for details.
if (!getReaderContext().getEnvironment().acceptsProfiles(specifiedProfiles)) {
if (logger.isDebugEnabled()) {
logger.debug("Skipped XML bean definition file due to specified profiles [" + profileSpec +
"] not matching: " + getReaderContext().getResource());
}
return;
}
}
}
//子类扩展
preProcessXml(root);
parseBeanDefinitions(root, this.delegate);
//子类扩展
postProcessXml(root);
this.delegate = parent;
}
parseBeanDefinitions(Element root, BeanDefinitionParserDelegate delegate)
迭代处理每个子标签，分为默认和自定义两种，分别处理。
protected void parseBeanDefinitions(Element root, BeanDefinitionParserDelegate delegate) {
//默认命名空间，为bean标签，alias标签和import标签
//非默认命名空间主要为aop标签 和管理事务的标签
if (delegate.isDefaultNamespace(root)) {
NodeList nl = root.getChildNodes();
//迭代处理每个子标签
for (int i = 0; i < nl.getLength(); i++) {
//这一步node拿到了xml中的信息，但是细节不清楚
Node node = nl.item(i);
if (node instanceof Element) {
Element ele = (Element) node;
//子标签是spring默认标签。
if (delegate.isDefaultNamespace(ele)) {
//解析默认标签
parseDefaultElement(ele, delegate);
}
else {
//解析自定义标签
delegate.parseCustomElement(ele);
}
}
}
}
else {
delegate.parseCustomElement(root);
}
}
parseDefaultElement(Element ele, BeanDefinitionParserDelegate delegate)
根据Element标签名匹配不同处理方法；
其中嵌套就是递归调用doRegisterBeanDefinitions(Element ele)。
private void parseDefaultElement(Element ele, BeanDefinitionParserDelegate delegate) {
//import标签
if (delegate.nodeNameEquals(ele, IMPORT_ELEMENT)) {
importBeanDefinitionResource(ele);
}
//alias标签
else if (delegate.nodeNameEquals(ele, ALIAS_ELEMENT)) {
processAliasRegistration(ele);
}
//bean标签
else if (delegate.nodeNameEquals(ele, BEAN_ELEMENT)) {
processBeanDefinition(ele, delegate);
}
//嵌套beans标签
else if (delegate.nodeNameEquals(ele, NESTED_BEANS_ELEMENT)) {
// recurse
doRegisterBeanDefinitions(ele);
}
}
processBeanDefinition(Element ele, BeanDefinitionParserDelegate delegate)
处理BeanDefinition包括解析以及注册到BeanFactory；
BeanDefinitionHolder 是将BeanDefinition、BeanName以及aliases包装起来的对象。
protected void processBeanDefinition(Element ele, BeanDefinitionParserDelegate delegate) {
//bdHolder保存bean标签上的别名信息
BeanDefinitionHolder bdHolder = delegate.parseBeanDefinitionElement(ele);
if (bdHolder != null) {
//装饰BeanDefinition，主要是处理自定义属性。
bdHolder = delegate.decorateBeanDefinitionIfRequired(ele, bdHolder);
try {
// Register the final decorated instance.
//将BeanDefinition注册到容器中。
BeanDefinitionReaderUtils.registerBeanDefinition(bdHolder, getReaderContext().getRegistry());
}
catch (BeanDefinitionStoreException ex) {
getReaderContext().error("Failed to register bean definition with name '" +
bdHolder.getBeanName() + "'", ele, ex);
}
// Send registration event.
getReaderContext().fireComponentRegistered(new BeanComponentDefinition(bdHolder));
}
}
parseBeanDefinitionElement(Element ele, @Nullable BeanDefinition containingBean)
主要是处理BeanName和aliases，
核心的逻辑在AbstractBeanDefinition beanDefinition = parseBeanDefinitionElement(ele, beanName, containingBean)中,
将Element解析成BeanDefinition。
public BeanDefinitionHolder parseBeanDefinitionElement(Element ele, @Nullable BeanDefinition containingBean) {
//获取id属性值
String id = ele.getAttribute(ID_ATTRIBUTE);
//获取name属性值
String nameAttr = ele.getAttribute(NAME_ATTRIBUTE);
//别名列表
List<String> aliases = new ArrayList<>();
if (StringUtils.hasLength(nameAttr)) {
//将name属性值按照,;拆分成数组
String[] nameArr = StringUtils.tokenizeToStringArray(nameAttr, MULTI_VALUE_ATTRIBUTE_DELIMITERS);
aliases.addAll(Arrays.asList(nameArr));
}
String beanName = id;
if (!StringUtils.hasText(beanName) && !aliases.isEmpty()) {
beanName = aliases.remove(0);
if (logger.isTraceEnabled()) {
logger.trace("No XML 'id' specified - using '" + beanName +
"' as bean name and " + aliases + " as aliases");
}
}
if (containingBean == null) {
checkNameUniqueness(beanName, aliases, ele);
}
//将Element解析成BeanDefinition
AbstractBeanDefinition beanDefinition = parseBeanDefinitionElement(ele, beanName, containingBean);
//Element被解析成为了BeanDefinition对象
if (beanDefinition != null) {
//自动生成beanName
if (!StringUtils.hasText(beanName)) {
try {
if (containingBean != null) {
beanName = BeanDefinitionReaderUtils.generateBeanName(
beanDefinition, this.readerContext.getRegistry(), true);
}
else {
beanName = this.readerContext.generateBeanName(beanDefinition);
// Register an alias for the plain bean class name, if still possible,
// if the generator returned the class name plus a suffix.
// This is expected for Spring 1.2/2.0 backwards compatibility.
String beanClassName = beanDefinition.getBeanClassName();
if (beanClassName != null &&
beanName.startsWith(beanClassName) && beanName.length() > beanClassName.length() &&
!this.readerContext.getRegistry().isBeanNameInUse(beanClassName)) {
aliases.add(beanClassName);
}
}
if (logger.isTraceEnabled()) {
logger.trace("Neither XML 'id' nor 'name' specified - " +
"using generated bean name [" + beanName + "]");
}
}
catch (Exception ex) {
error(ex.getMessage(), ele);
return null;
}
}
String[] aliasesArray = StringUtils.toStringArray(aliases);
return new BeanDefinitionHolder(beanDefinition, beanName, aliasesArray);
}
return null;
}
parseBeanDefinitionElement(Element ele, String beanName, @Nullable BeanDefinition containingBean)
负责解析BeanDefinition，包括parent标签、标签上各种attribute信息、子标签信息；
其中parseBeanDefinitionAttributes(ele, beanName, containingBean, bd)解析标签的各种attribute。
public AbstractBeanDefinition parseBeanDefinitionElement(
Element ele, String beanName, @Nullable BeanDefinition containingBean) {
//表示当前解析器状态
this.parseState.push(new BeanEntry(beanName));
String className = null;
if (ele.hasAttribute(CLASS_ATTRIBUTE)) {
//读取bean标签的className
className = ele.getAttribute(CLASS_ATTRIBUTE).trim();
}
String parent = null;
if (ele.hasAttribute(PARENT_ATTRIBUTE)) {
parent = ele.getAttribute(PARENT_ATTRIBUTE);
}
try {
//创建一个BeanDefinition对象，设置class信息
AbstractBeanDefinition bd = createBeanDefinition(className, parent);
//解析bean标签定义的attribute信息：lazy-init、init-method、depends-on...
parseBeanDefinitionAttributes(ele, beanName, containingBean, bd);
//解析各种子标签
bd.setDescription(DomUtils.getChildElementValueByTagName(ele, DESCRIPTION_ELEMENT));
parseMetaElements(ele, bd);
parseLookupOverrideSubElements(ele, bd.getMethodOverrides());
parseReplacedMethodSubElements(ele, bd.getMethodOverrides());
parseConstructorArgElements(ele, bd);
parsePropertyElements(ele, bd);
parseQualifierElements(ele, bd);
bd.setResource(this.readerContext.getResource());
bd.setSource(extractSource(ele));
return bd;
}
catch (ClassNotFoundException ex) {
error("Bean class [" + className + "] not found", ele, ex);
}
catch (NoClassDefFoundError err) {
error("Class that bean class [" + className + "] depends on not found", ele, err);
}
catch (Throwable ex) {
error("Unexpected failure during bean definition parsing", ele, ex);
}
finally {
this.parseState.pop();
}
return null;
}
parseBeanDefinitionAttributes(Element ele, String beanName,@Nullable BeanDefinition containingBean, AbstractBeanDefinition bd)
主要解析bean标签上面定义的attribute信息：scope、abstract、lazy-init、init-method、depends-on等
public AbstractBeanDefinition parseBeanDefinitionAttributes(Element ele, String beanName,
@Nullable BeanDefinition containingBean, AbstractBeanDefinition bd) {
//这个属性已经废弃
if (ele.hasAttribute(SINGLETON_ATTRIBUTE)) {
error("Old 1.x 'singleton' attribute in use - upgrade to 'scope' declaration", ele);
}
//默认值是 singleton
else if (ele.hasAttribute(SCOPE_ATTRIBUTE)) {
bd.setScope(ele.getAttribute(SCOPE_ATTRIBUTE));
}
else if (containingBean != null) {
// Take default from containing bean in case of an inner bean definition.
bd.setScope(containingBean.getScope());
}
//标签是一个抽象标签，只能让子标签去继承
if (ele.hasAttribute(ABSTRACT_ATTRIBUTE)) {
bd.setAbstract(TRUE_VALUE.equals(ele.getAttribute(ABSTRACT_ATTRIBUTE)));
}
//读取bean标签上的lazy-init属性
String lazyInit = ele.getAttribute(LAZY_INIT_ATTRIBUTE);
//默认为false
if (isDefaultValue(lazyInit)) {
lazyInit = this.defaults.getLazyInit();
}
bd.setLazyInit(TRUE_VALUE.equals(lazyInit));
//读取bean标签上的autowire属性
String autowire = ele.getAttribute(AUTOWIRE_ATTRIBUTE);
bd.setAutowireMode(getAutowireMode(autowire));
//<bean depends-on="a,b">...</bean> 说明当前bean实例化时，需要先处理a,b
if (ele.hasAttribute(DEPENDS_ON_ATTRIBUTE)) {
String dependsOn = ele.getAttribute(DEPENDS_ON_ATTRIBUTE);
bd.setDependsOn(StringUtils.tokenizeToStringArray(dependsOn, MULTI_VALUE_ATTRIBUTE_DELIMITERS));
}
//默认值true，表示bean可以参与到外部bean的依赖自动注入中。
String autowireCandidate = ele.getAttribute(AUTOWIRE_CANDIDATE_ATTRIBUTE);
if (isDefaultValue(autowireCandidate)) {
String candidatePattern = this.defaults.getAutowireCandidates();
if (candidatePattern != null) {
String[] patterns = StringUtils.commaDelimitedListToStringArray(candidatePattern);
bd.setAutowireCandidate(PatternMatchUtils.simpleMatch(patterns, beanName));
}
}
else {
bd.setAutowireCandidate(TRUE_VALUE.equals(autowireCandidate));
}
//当某个接口有多个实现对象时，可指定一个primary对象，这个对象参与外部对象的自动依赖注入。
if (ele.hasAttribute(PRIMARY_ATTRIBUTE)) {
bd.setPrimary(TRUE_VALUE.equals(ele.getAttribute(PRIMARY_ATTRIBUTE)));
}
//当spring创建该bean对应的实例时，最终会执行 init-method 配置的方法。
if (ele.hasAttribute(INIT_METHOD_ATTRIBUTE)) {
String initMethodName = ele.getAttribute(INIT_METHOD_ATTRIBUTE);
bd.setInitMethodName(initMethodName);
}
else if (this.defaults.getInitMethod() != null) {
bd.setInitMethodName(this.defaults.getInitMethod());
bd.setEnforceInitMethod(false);
}
//spring容器销毁时执行spring容器内管理的bean实例的销毁方法。
if (ele.hasAttribute(DESTROY_METHOD_ATTRIBUTE)) {
String destroyMethodName = ele.getAttribute(DESTROY_METHOD_ATTRIBUTE);
bd.setDestroyMethodName(destroyMethodName);
}
else if (this.defaults.getDestroyMethod() != null) {
bd.setDestroyMethodName(this.defaults.getDestroyMethod());
bd.setEnforceDestroyMethod(false);
}
//读取 factory-method 属性。
if (ele.hasAttribute(FACTORY_METHOD_ATTRIBUTE)) {
bd.setFactoryMethodName(ele.getAttribute(FACTORY_METHOD_ATTRIBUTE));
}
//读取 factory-bean 属性。
if (ele.hasAttribute(FACTORY_BEAN_ATTRIBUTE)) {
bd.setFactoryBeanName(ele.getAttribute(FACTORY_BEAN_ATTRIBUTE));
}
return bd;
}
参考文档
https://book.douban.com/subject/25866350/
https://blog.csdn.net/YangLiehui/article/details/98847317?spm=1001.2014.3001.5501
https://blog.csdn.net/wang704987562/article/details/81273899
浙公网安备 33010602011771号