【框架源码篇 05】Spring源码篇-ApplicationContext

墨蓝 2024-02-21 11:16 65阅读 0赞

## Spring源码篇-ApplicationContext ##

前面通过手写IoC，DI、AOP和Bean的配置。到最后ApplicationContext的门面处理，对于Spring相关的核心概念应该会比较清楚了。接下来我们就看看在Spring源码中，对于的核心组件是如何实现的。

## 一、ApplicationContext ##

ApplicationContext到底是什么？字面含义是应用的上下文。这块我们需要看看ApplicationContext的具体的结构。

![image.png][]

通过ApplicationContext实现的相关接口来分析，ApplicationContext接口在具备BeanFactory的功能的基础上还扩展了 `应用事件发布`,`资源加载`,`环境参数`和 `国际化`的能力。然后我们来看看ApplicationContext接口的实现类的情况。

![image.png][image.png 1]

在ApplicationContext的实现类中有两个比较重要的分支 `AbstractRefreshableApplicationContext`和 `GenericApplicationContext`.

![image.png][image.png 2]

## 二、BeanFactory ##

上面分析了 `ApplicationContext`接口的结构。然后我们来看看 `BeanFactory`在ApplicationContext中具体的实现是怎么样的

![image.png][image.png 3]

![image.png][image.png 4]

可以看到具体的实现是 DefaultListableBeanFactory .然后我们来看看他的体系结构

![image.png][image.png 5]

BeanFactory的继承体系

![image.png][image.png 6]

## 三、BeanDefinition ##

然后我们来了解下ApplicationContext是如何来加载Bean定义的。具体代码我们需要分为XML配置文件和基于注解的两种方式来看。

### 1.基于XML方式 ###

我们先定义对应的application.xml文件

<?xml version="1.0" encoding="UTF-8"?>
    <beans xmlns="http://www.springframework.org/schema/beans"
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xmlns:context="http://www.springframework.org/schema/context"
        xmlns:aop="http://www.springframework.org/schema/aop"
        xsi:schemaLocation="http://www.springframework.org/schema/beans
            http://www.springframework.org/schema/beans/spring-beans.xsd
            http://www.springframework.org/schema/context
            http://www.springframework.org/schema/context/spring-context.xsd
            http://www.springframework.org/schema/aop
            http://www.springframework.org/schema/aop/spring-aop.xsd">
    
    	<bean id="beanE" class="com.study.spring.sample.config.BeanE" />
    
    	<bean id="beanF" class="com.study.spring.sample.config.BeanF" ></bean>
    
    	<context:annotation-config/>
    
    	<context:component-scan base-package="com.study.spring.sample.config" ></context:component-scan>
    
    </beans>

然后我们的测试类代码

public class XMLConfigMain {
        
    
    	public static void main(String[] args) {
        
    		ApplicationContext context = new GenericXmlApplicationContext(
    				"classpath:com/study/spring/sample/config/application.xml");
    		BeanF bf = context.getBean(BeanF.class);
    		bf.do1();
    	}
    }

处理的过程 解析XML --> BeanDefinition --> BeanDefinitionRegistry --> BeanFactory

![image.png][image.png 7]

### 2.基于注解方式 ###

然后来看看基于注解方式的使用的情况。首先是我们的配置类

@Configuration
    @ComponentScan("com.study.spring.sample.config")
    public class JavaBasedMain {
        
    
    	@Bean
    	public BeanH getBeanH() {
        
    		return new BeanH();
    	}
    
    	public static void main(String[] args) {
        
    		ApplicationContext context = new AnnotationConfigApplicationContext(JavaBasedMain.class);
    
    		BeanH bh = context.getBean(BeanH.class);
    		bh.doH();
    	}
    }

然后是我们的测试类

public class AnnotationMain {
        
    
    	public static void main(String[] args) {
        
    		ApplicationContext context = new AnnotationConfigApplicationContext("com.study.spring.sample.config");
    
    		BeanG bg = context.getBean(BeanG.class);
    		bg.dog();
    	}
    }

注解使用有两种方法：

1.  配置扫描路径
2.  配置@Configuration的注解类

#### 2.1 this构造方法 ####

在this的构造方法中会完成相关的配置处理。

public AnnotationConfigApplicationContext() {
        
    		this.reader = new AnnotatedBeanDefinitionReader(this);
    		this.scanner = new ClassPathBeanDefinitionScanner(this);
    	}

首先是AnnotatedBeanDefinitionReader(this)方法。会完成核心的ConfigurationClassPostProcessor的注入。ConfigurationClassPostProcessor 会完成@Configuration相关的注解的解析

![image.png][image.png 8]

this.scanner其实就是创建了一个对应的扫描器

![image.png][image.png 9]

#### 2.2 扫描实现 ####

扫描就需要进入到scan方法中。

![image.png][image.png 10]

![image.png][image.png 11]

![image.png][image.png 12]

完成相关的注册

![image.png][image.png 13]

#### 2.3 @Configuration ####

@Configuration的解析其实是在refresh方法中来实现的。

![image.png][image.png 14]

### 3.小结 ###

通过上面的分析其实我们已经对Bean定义的扫描，解析和注册过程有了一定的了解。归纳为：

1.  reader解析XML，完成xml方法配置的bean定义
2.  scanner扫描指定包下的类，找出带有@Component注解的类，注册成Bean定义
3.  通过ConfigurationClassPostProcessor对带有@Configuration注解的类进行处理，解析它上面的注解，以及类中带有@Bean 注解，加入这些的Bean的定义。

### 4.BeanDefinition ###

;然后我们来看看BeanDefinition的继承结构

![image.png][image.png 15]

继承属性访问器和元数据接口，增加了Bean定义操作，实现了数据和操作解耦。属性访问器和元数据接口接着往下看。

#### 4.1 BeanMetadataElement ####

BeanMetadataElement提供了获取数据源的方式，也就是可以指导Bean是来自哪个类。

public interface BeanMetadataElement {
        
    
    	/**
    	 * Return the configuration source {@code Object} for this metadata element
    	 * (may be {@code null}).
    	 */
    	@Nullable
    	default Object getSource() {
        
    		return null;
    	}
    
    }

#### 4.2 BeanMetadataAttribute元数据属性 ####

实现了元数据接口，增加了属性的名字和值。。

public class BeanMetadataAttribute implements BeanMetadataElement {
        
    
    	private final String name;
    
    	@Nullable
    	private final Object value;
    
    	@Nullable
    	private Object source;
    
    }

#### 4.3 AttributeAccessor属性访问器 ####

AttributeAccessor用来给Bean定义了增删改查属性的功能

public interface AttributeAccessor {
        
    
    	/**
    	 * Set the attribute defined by {@code name} to the supplied {@code value}.
    	 * If {@code value} is {@code null}, the attribute is {@link #removeAttribute removed}.
    	 * <p>In general, users should take care to prevent overlaps with other
    	 * metadata attributes by using fully-qualified names, perhaps using
    	 * class or package names as prefix.
    	 * @param name the unique attribute key
    	 * @param value the attribute value to be attached
    	 */
    	void setAttribute(String name, @Nullable Object value);
    
    	/**
    	 * Get the value of the attribute identified by {@code name}.
    	 * Return {@code null} if the attribute doesn't exist.
    	 * @param name the unique attribute key
    	 * @return the current value of the attribute, if any
    	 */
    	@Nullable
    	Object getAttribute(String name);
    
    	/**
    	 * Remove the attribute identified by {@code name} and return its value.
    	 * Return {@code null} if no attribute under {@code name} is found.
    	 * @param name the unique attribute key
    	 * @return the last value of the attribute, if any
    	 */
    	@Nullable
    	Object removeAttribute(String name);
    
    	/**
    	 * Return {@code true} if the attribute identified by {@code name} exists.
    	 * Otherwise return {@code false}.
    	 * @param name the unique attribute key
    	 */
    	boolean hasAttribute(String name);
    
    	/**
    	 * Return the names of all attributes.
    	 */
    	String[] attributeNames();
    
    }

#### 4.4 AttributeAccessorSupport属性访问抽象实现类 ####

内部定义了1个map来存放属性。

public abstract class AttributeAccessorSupport implements AttributeAccessor, Serializable {
        
    
    	/** Map with String keys and Object values. */
    	private final Map<String, Object> attributes = new LinkedHashMap<>();
    
    
    	@Override
    	public void setAttribute(String name, @Nullable Object value) {
        
    		Assert.notNull(name, "Name must not be null");
    		if (value != null) {
        
    			this.attributes.put(name, value);
    		}
    		else {
        
    			removeAttribute(name);
    		}
    	}
        //  ......
    }

#### 4.5 BeanMetadataAttributeAccessor元数据属性访问器 ####

继承AttributeAccessorSupport具备属性访问功能，实现BeanMetadataElement具备获取元数据功能。 \*\*AbstractBeanDefinition就继承于它，使得同时具有属性访问和元数据访问的功能 \*\*。

![image.png][image.png 16]

结合AbstractBeanDefinition.来看看他们的类图结构

![image.png][image.png 17]

### 5. BeanDefinition继承体系 ###

#### 5.1 AnnotatedBeanDefinition ####

增加了2个方法，获取bean所在类的注解元数据和工厂方法元数据，这些数据在进行解析处理的时候需要用到。

public interface AnnotatedBeanDefinition extends BeanDefinition {
        
    
    	/**
    	 * Obtain the annotation metadata (as well as basic class metadata)
    	 * for this bean definition's bean class.
    	 * @return the annotation metadata object (never {@code null})
    	 */
    	AnnotationMetadata getMetadata();
    
    	/**
    	 * Obtain metadata for this bean definition's factory method, if any.
    	 * @return the factory method metadata, or {@code null} if none
    	 * @since 4.1.1
    	 */
    	@Nullable
    	MethodMetadata getFactoryMethodMetadata();
    
    }

该注解有三个具体的实现。ScannedGenericBeanDefinition、AnnotatedGenericBeanDefinition、ConfigurationClassBeanDefinition。

![image.png][image.png 18]

#### 5.2 AbstractBeanDefinition模板类 ####

AbstractBeanDefinition我们可以称之为BeanDefinition的模板类。结构我们上面其实有梳理

![image.png][image.png 19]

通过上面我们可以看到AbstractBeanDefinition 具备了 Bean元数据的获取和属性相关的操作。同时AbstractBeanDefinition的继承结构

![image.png][image.png 20]

#### 5.3 RootBeanDefinition根bean定义 ####

它主要用在spring内部的bean定义、把不同类型的bean定义合并成RootBeanDefinition（getMergedLocalBeanDefinition方法）。没有实现BeanDefinition接口的设置获取父bean定义方法，不支持设置父子beanDefinition。

#### 5.4 ConfigurationClassBeanDefinition ####

用作ConfigurationClassPostProcessor解析过程中封装配置类的bean定义。

#### 5.5 GenericBeanDefinition ####

GenericBeanDefinition通用Bean的定义。

#### 5.6 ScannedGenericBeanDefinition ####

@ComponentScan扫描的bean定义使用。

#### 5.7 AnnotatedGenericBeanDefinition ####

[image.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/21/f5584f1bfd444dd98a9ed3857ad4c0aa.png
[image.png 1]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/21/75b145c7036b4ba38395c2940c63565f.png
[image.png 2]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/21/2011845d128944159b81ee831d2ae36f.png
[image.png 3]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/21/099c42f852a44860b74d86c0ac4c285c.png
[image.png 4]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/21/e60f01e4aa2c46d4a9991130428e4f16.png
[image.png 5]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/21/25c982a3ed4b4a27aea185b9d89ad387.png
[image.png 6]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/21/4f0a4560e3e14cc88747940a091b510c.png
[image.png 7]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/21/d4d4e58034754c1082815c8aba3a9b6a.png
[image.png 8]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/21/ed1e22ac49e24273941e90f1127bfbc3.png
[image.png 9]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/21/53c65f75da504246b45d2d56b4f40ab0.png
[image.png 10]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/21/e72c1b76724a4a7cbd11dc4961a74f80.png
[image.png 11]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/21/634fad6be297491089711a3d41109b4e.png
[image.png 12]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/21/fed81f58be984423aa2fab49fb160d55.png
[image.png 13]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/21/ee5da3d8d5d4410497df4819549bdcbd.png
[image.png 14]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/21/4dda9f05321847b1ac01ed809d083480.png
[image.png 15]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/21/aa2a92d70648453db1b89805b56990b4.png
[image.png 16]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/21/10a18c3ffb2a4787bef6c7883312cff4.png
[image.png 17]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/21/ef14f8c5b8fe4351b2c6d5f904ae34c0.png
[image.png 18]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/21/38a15b3873d847a3bffae3745e212343.png
[image.png 19]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/21/d5fdd33b7d634a11865c84ff8b05205c.png
[image.png 20]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/21/930896fb0a8e4c5abe237975350659e2.png