1.重要核心接口
1.1Resource接口
Resource接口表示一个资源类，本质上就是一个InputStream，用来读取一个配置文件然后封装到Resource中。
1.2BeanDefinition接口
根据英文意思，就是Bean定义，包括一个bean的所有属性，其中核心的就是我们配置的bean的id，class， scope，isLazy，init-method factory-method等。
1.3BeanDefinitionRegistry接口
BeanFactory接口实现了此接口，一般BeanDefinitionRegistry实现类就是BeanFactory的实现类对象，即IOC容器。
在下面经过XmlBeanDefinitionReader解析Resource为BeanDefinition(s)后，就会将这些BeanDefinition信息存储到BeanFactory(IOC容器的)的Map中。最终根据BeanDefinition创建出对象放到容器中。
1.4BeanDefinitionReader接口
用来解析Resource封装的资源，对应读取不同类型配置文件。将Resource解析为BeanDefinition注册到IOC中。
2.XmlBeanFactory初始化之解析加载bean
2.1.测试代码
public class BeanFactoryTest {
public static void main(String[] args) {
//通过Spring的配置文件创建一个BeanFactory对象
BeanFactory beanFactory = new XmlBeanFactory(new ClassPathResource("spring-bf.xml"));
//获取容器中的对象
Object a = beanFactory.getBean("componentA");
Object b = beanFactory.getBean("componentB");
System.out.println(a);
System.out.println(b);
}
}
2.2流程图
详细流程图
整体流程图
扫描二维码关注公众号，回复： 13540718 查看本文章
3.源码解析
3.1XmlBeanDefinitionReader类核心方法
3.1.1loadBeanDefinitions()
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);
}
//从ThreadLocal中获取当前线程已经加载过的所有encdoeResource
Set<EncodedResource> currentResources = this.resourcesCurrentlyBeingLoaded.get();
//将当前的resource加入到threadLocal中，加入失败说明当前encoderResource已经加载过了，不能重复加载
if (!currentResources.add(encodedResource)) {
throw new BeanDefinitionStoreException(
"Detected cyclic loading of " + encodedResource + " - check your import definitions!");
}
//获取encodedResource包装的输入流对象
try (InputStream inputStream = encodedResource.getResource().getInputStream()) {
//因为接下来要使用sax解析器解析xml，所以需要将输入流包装为inputSource，inputSource是sax中表示资源的对象
InputSource inputSource = new InputSource(inputStream);
//设置编码
if (encodedResource.getEncoding() != null) {
inputSource.setEncoding(encodedResource.getEncoding());
}
//解析xml然后加载beanDefinition的入口
return doLoadBeanDefinitions(inputSource, encodedResource.getResource());
}
catch (IOException ex) {
throw new BeanDefinitionStoreException(
"IOException parsing XML document from " + encodedResource.getResource(), ex);
}
finally {
//加载完毕 将当前的资源从资源集合中(Set)移除
currentResources.remove(encodedResource);
/*
* 当前线程内部的threadlocalMap中当前以当前threadLocal为key的Entry的value(当前的currentResources)为NULL。
* 这里调用remove()方法将这个entry干掉。防止内存泄露
*/
if (currentResources.isEmpty()) {
this.resourcesCurrentlyBeingLoaded.remove();
}
}
}
3.1.2doLoadBeanDefinitions()
protected int doLoadBeanDefinitions(InputSource inputSource, Resource resource)
throws BeanDefinitionStoreException {
try {
//将resource转换成程序层面可以识别的有层次结构的 document 对象。
Document doc = doLoadDocument(inputSource, resource);
/*
* 将document解析成beanDefinition并且注册到beanFactory中，最终返回新注册 * 到beanFactory中的beanDefinition数量
*/
int count = registerBeanDefinitions(doc, resource);
if (logger.isDebugEnabled()) {
logger.debug("Loaded " + count + " bean definitions from " + resource);
}
//返回新注册bd的数量。
return count;
}
}
3.1.3registerBeanDefinitions()
public int registerBeanDefinitions(Document doc, Resource resource) throws BeanDefinitionStoreException {
//创建一个 BeanDefinitionDocumentReader ，每个document对象，都会创建一个 beanDefinitionDocumentReader对象。
BeanDefinitionDocumentReader documentReader = createBeanDefinitionDocumentReader();
/*
* getRegistry() 会返回程序创建的beanFactory实例。
* countBefore：解析该doc之前，容器中已有的bd数量。
*
* (此方法是XmlBeanDefinitionReader的父类AbstractBeanDefinitionReader中的 * 一个方法，返回的其内部的BeanDefinitionRegistry实现类，在第一节我们分析过，其 * 实现类就是BeanFactory实现类，即IOC容器).
*/
int countBefore = getRegistry().getBeanDefinitionCount();
/*解析doc 并且注册到 beanFactory中。
* xmlReaderContext：包含最主要的参数是 当前 this-> * XmlBeanDefinitionReader中含有BeanFactory。
*/
documentReader.registerBeanDefinitions(doc, createReaderContext(resource));
//返回的新注册的beanDefinition数量。
return getRegistry().getBeanDefinitionCount() - countBefore;
}
3.2DefaultBeanDefinitionDocumentReader
3.2.1registerBeanDefinitions()
@Override
public void registerBeanDefinitions(Document doc, XmlReaderContext readerContext) {
this.readerContext = readerContext;
//传入顶级标签 <beans></beans>
doRegisterBeanDefinitions(doc.getDocumentElement());
}
3.2.2doRegisterBeanDefinitions()
protected void doRegisterBeanDefinitions(Element root) {
BeanDefinitionParserDelegate parent = this.delegate;
//返回一个beans标签解析器对象
this.delegate = createDelegate(getReaderContext(), root, parent);
//一般都会成立
if (this.delegate.isDefaultNamespace(root)) {
String profileSpec = root.getAttribute(PROFILE_ATTRIBUTE);
if (StringUtils.hasText(profileSpec)) {
String[] specifiedProfiles = StringUtils.tokenizeToStringArray(
profileSpec, BeanDefinitionParserDelegate.MULTI_VALUE_ATTRIBUTE_DELIMITERS);
//条件成立 说明当前环境不支持这些标签 直接return;
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);
//解析 传入beans标签和解析器
parseBeanDefinitions(root, this.delegate);
//留给子类实现
postProcessXml(root);
this.delegate = parent;
}
3.2.3parseBeanDefinitions
protected void parseBeanDefinitions(Element root, BeanDefinitionParserDelegate delegate) {
if (delegate.isDefaultNamespace(root)) {
/*
* 获取beans标签内部的子标签
*/
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;
if (delegate.isDefaultNamespace(ele)) {
parseDefaultElement(ele, delegate);
}
else {
delegate.parseCustomElement(ele);
}
}
}
}
//解析自定义标签
else {
delegate.parseCustomElement(root);
}
}
3.2.4parseDefaultElement()
private void parseDefaultElement(Element ele, BeanDefinitionParserDelegate delegate) {
//条件成立：说明ele标签 是 import 标签。
if (delegate.nodeNameEquals(ele, IMPORT_ELEMENT)) {
importBeanDefinitionResource(ele);
}
//条件成立：说明ele标签 是 alias 标签。
else if (delegate.nodeNameEquals(ele, ALIAS_ELEMENT)) {
processAliasRegistration(ele);
}
//条件成立：说明ele标签 是 bean 标签
else if (delegate.nodeNameEquals(ele, BEAN_ELEMENT)) {
processBeanDefinition(ele, delegate);
}
//条件成立：说明ele标签 是 嵌套 beans 标签
else if (delegate.nodeNameEquals(ele, NESTED_BEANS_ELEMENT)) {
// recurse
doRegisterBeanDefinitions(ele);
}
}
3.2.5processBeanDefinition()
protected void processBeanDefinition(Element ele, BeanDefinitionParserDelegate delegate) {
//解析完成后返回bdHolder，bdHolder主要是保存了 bean 标签上的别名信息。
//内部含有BeanDefinition属性。
BeanDefinitionHolder bdHolder = delegate.parseBeanDefinitionElement(ele);
if (bdHolder != null) {
//如果beanDefinition需要装饰的话，这里面会进行处理，主要是处理 自定义 属性。
bdHolder = delegate.decorateBeanDefinitionIfRequired(ele, bdHolder);
try {
//将bd注册到容器中。
BeanDefinitionReaderUtils.registerBeanDefinition(bdHolder, getReaderContext().getRegistry());
}
catch (BeanDefinitionStoreException ex) {
getReaderContext().error("Failed to register bean definition with name '" +
bdHolder.getBeanName() + "'", ele, ex);
}
//发送一个 bd 注册完成的事件。
// Send registration event.
getReaderContext().fireComponentRegistered(new BeanComponentDefinition(bdHolder));
}
}
3.3BeanDefinitionParserDelegate
3.3.1*parseBeanDefinitionElement()
public BeanDefinitionHolder parseBeanDefinitionElement(Element ele, @Nullable BeanDefinition containingBean) {
//获取bean标签的id属性(bean标签的id和name都不是必要属性，class属性是)
String id = ele.getAttribute(ID_ATTRIBUTE);
//获取bean标签的name属性(name属性可以设置多个，中间以逗号分割)
String nameAttr = ele.getAttribute(NAME_ATTRIBUTE);
//构造一个集合，将所有的别名取出来放到集合中
List<String> aliases = new ArrayList<>();
if (StringUtils.hasLength(nameAttr)) {
String[] nameArr = StringUtils.tokenizeToStringArray(nameAttr, MULTI_VALUE_ATTRIBUTE_DELIMITERS);
//将分割后的所有别名设置到集合中
aliases.addAll(Arrays.asList(nameArr));
}
//默认情况将id属性赋值给beanName。
String beanName = id;
/*
* 这里就是判断如果id属性为NULL但是设置了别名，那么就将别名列表的第一个别名
* 设置为beanName，并将这个别名从别名集合中移除。
*/
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);
}
/*
* 核心，根据beanName和bean标签将这个bean标签解析并封装为BeanDefinition返回
*/
AbstractBeanDefinition beanDefinition = parseBeanDefinitionElement(ele, beanName, containingBean);
//封装的beanDefinition对象不为NULL。
if (beanDefinition != null) {
/*
* beanName为NULL，说明这个bean标签没有设置id和name，下面就是为其自动生成 * beanName的逻辑
* 默认生成的beanName就是 全类名 + # + 序号
*/
if (!StringUtils.hasText(beanName)) {
try {
if (containingBean != null) {
beanName = BeanDefinitionReaderUtils.generateBeanName(
beanDefinition, this.readerContext.getRegistry(), true);
}
else {
//工具类生成一个beanName
beanName = this.readerContext.generateBeanName(beanDefinition);
//获取全类名
String beanClassName = beanDefinition.getBeanClassName();
/*
* 如果当前的beanClassName没有被当做某一个beanName使用，
* 那么就将这个beanClassName作为这个bean的别名。
*/
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);
/*
* 将创建完毕的beanDefinition对象包装成beanDefinifion，传入beanName和
* 别名列表
*/
return new BeanDefinitionHolder(beanDefinition, beanName, aliasesArray);
}
return null;
}
3.3.2*parseBeanDefinitionElement()
@Nullable
public AbstractBeanDefinition parseBeanDefinitionElement(
Element ele, String beanName, @Nullable BeanDefinition containingBean) {
//设置解析器状态
this.parseState.push(new BeanEntry(beanName));
//获取bean标签上的class属性
String className = null;
if (ele.hasAttribute(CLASS_ATTRIBUTE)) {
className = ele.getAttribute(CLASS_ATTRIBUTE).trim();
}
//获取bean标签上的parent属性
String parent = null;
if (ele.hasAttribute(PARENT_ATTRIBUTE)) {
parent = ele.getAttribute(PARENT_ATTRIBUTE);
}
try {
//创建出来了 一个 bd对象，bd对象仅仅设置了 class 信息和父类名属性等。
AbstractBeanDefinition bd = createBeanDefinition(className, parent);
//解析bean标签上面定义的attribute信息：lazy-init、init-method、depends-on...
parseBeanDefinitionAttributes(ele, beanName, containingBean, bd);
//<bean>
// <description>xxxxxx</description>
// </bean>
//将description子标签的信息 读取出来 保存到 bd中。
bd.setDescription(DomUtils.getChildElementValueByTagName(ele, DESCRIPTION_ELEMENT));
//解析
// <bean>
// <meta key="meta_1" value="meta_val_1"/>
// <meta key="meta_2" value="meta_val_2"/>
// </bean>
parseMetaElements(ele, bd);
//解析lookup-method子标签,bd.methodOverrides 属性 保存需要覆盖 复写的方法。 动态代理时实现。
parseLookupOverrideSubElements(ele, bd.getMethodOverrides());
//解析replace-method子标签
parseReplacedMethodSubElements(ele, bd.getMethodOverrides());
//解析构造方法参数子标签
parseConstructorArgElements(ele, bd);
//解析 属性 子标签
parsePropertyElements(ele, bd);
//解析 qualifier 子标签
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 c lass [" + 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;
}
3.3.3*createBeanDefinition()
public static AbstractBeanDefinition createBeanDefinition(
@Nullable String parentName, @Nullable String className, @Nullable ClassLoader classLoader) throws ClassNotFoundException {
/*
* 这里真正创建了一个BeanDefinition对象，因为BeanDefinition是一个接口，这里构造 * 的是其实现类GenericBeanDefinition()对象。
*/
GenericBeanDefinition bd = new GenericBeanDefinition();
//设置父类的名字
bd.setParentName(parentName);
if (className != null) {
if (classLoader != null) {
//根据全类名拿到Class对象赋值给bd内部的beanClass属性(Object)
bd.setBeanClass(ClassUtils.forName(className, classLoader));
}
else {
bd.setBeanClassName(className);
}
}
//返回创建的beanDefinition对象
return bd;
}
3.3.4*parseBeanDefinitionAttributes()
解析bean标签上的各种属性，设置到beanDefinition对象中。
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);
}
//scope属性
else if (ele.hasAttribute(SCOPE_ATTRIBUTE)) {
bd.setScope(ele.getAttribute(SCOPE_ATTRIBUTE));
}
//lazyInit属性
String lazyInit = ele.getAttribute(LAZY_INIT_ATTRIBUTE);
if (isDefaultValue(lazyInit)) {
lazyInit = this.defaults.getLazyInit();
}
bd.setLazyInit(TRUE_VALUE.equals(lazyInit));
String autowire = ele.getAttribute(AUTOWIRE_ATTRIBUTE);
bd.setAutowireMode(getAutowireMode(autowire));
//depdnes-on属性
if (ele.hasAttribute(DEPENDS_ON_ATTRIBUTE)) {
String dependsOn = ele.getAttribute(DEPENDS_ON_ATTRIBUTE);
bd.setDependsOn(StringUtils.tokenizeToStringArray(dependsOn, MULTI_VALUE_ATTRIBUTE_DELIMITERS));
}
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));
}
if (ele.hasAttribute(PRIMARY_ATTRIBUTE)) {
bd.setPrimary(TRUE_VALUE.equals(ele.getAttribute(PRIMARY_ATTRIBUTE)));
}
//init—method属性，在类中定义一个方法，在bean的声明周期中会调用
if (ele.hasAttribute(INIT_METHOD_ATTRIBUTE)) {
String initMethodName = ele.getAttribute(INIT_METHOD_ATTRIBUTE);
bd.setInitMethodName(initMethodName);
}
//destory-method属性，类似init—method，在工厂关闭时会调用
if (ele.hasAttribute(DESTROY_METHOD_ATTRIBUTE)) {
String destroyMethodName = ele.getAttribute(DESTROY_METHOD_ATTRIBUTE);
bd.setDestroyMethodName(destroyMethodName);
}
//factory-Bean属性，用于创建复杂对象
if (ele.hasAttribute(FACTORY_METHOD_ATTRIBUTE)) {
bd.setFactoryMethodName(ele.getAttribute(FACTORY_METHOD_ATTRIBUTE));
}
if (ele.hasAttribute(FACTORY_BEAN_ATTRIBUTE)) {
bd.setFactoryBeanName(ele.getAttribute(FACTORY_BEAN_ATTRIBUTE));
}
return bd;
}
3.4最终注册到容器中
public static void registerBeanDefinition(
BeanDefinitionHolder definitionHolder, BeanDefinitionRegistry registry)
throws BeanDefinitionStoreException {
// Register bean definition under primary name.
String beanName = definitionHolder.getBeanName();
/*
* 这里最终根据beanName和BeanDefinition进行key-value映射，
* 存储到BeanFactory内部的beanDefinitionMap中(是一个ConcurrentHashMap类型)
* ||
* (beanDefinition Map.put(beanName, beanDefinition))
*/
registry.registerBeanDefinition(beanName, definitionHolder.getBeanDefinition());
/*
* 别名的注册就是注册到一个Map<String, String>中(也是ConcurrentHashMap类 * 型)，key是别名，value是beanName，在getBean("别名")时会进行一次重定向。
*/
String[] aliases = definitionHolder.getAliases();
if (aliases != null) {
for (String alias : aliases) {
registry.registerAlias(beanName, alias);
}
}
}
4.总结
解析阶段就是使用Spring提供的BeanDefinitionReader接口去解析不同的配置(如xml配置文件使用XmlBeanDefinitionReader类去解析或者是配置类(@Configuration注解标注的类))，最终将bean标签解析为BeanDefinition对象注册到容器中(最终put到beanDefinitionMap中，key是beanName(一般都是id)，value就是BeanDefinition对象)，处理别名的方式就是将(别名->beanName)放到一个Map中，然后getBean()时做一次重定向。
- bean标签没有设置id属性和name属性时，默认会生成一个id，
(全类名 + # + 序号),并且如果这个全类名在容器中没有使用过的话，会被设置为这bean的别名。 - 没有设置id但是设置了name属性时，那么name属性的第一个别名会被当做id，并且这个name属性的第一个别名不在作为别名(源码进行了remove())。