一、搭建一个简单的spring工程
代码如下：
pojo类
public class Fruit {
private String name;
private String sugar;
private String color;
//省去getter、setter、构造函数
spring入口配置文件类applicationContext.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"
xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd">
<bean name="apple" class="com.mybatis.source.pojo.Fruit">
<property name="name" value="红富士苹果"/>
<property name="sugar" value="甜"/>
<property name="color" value="粉色"/>
</bean>
</beans>
测试类：
public class Test {
public static void main(String[] args) {
//1、加载解析配置文件到容器中
ApplicationContext context = new ClassPathXmlApplicationContext(
new String[]{"com/mybatis/source/spring/applicationContext.xml"});
//2、从容器中获取bean
Fruit apple = (Fruit)context.getBean("apple");
//3、使用bean
System.out.println(apple.getName());
System.out.println(apple.getSugar());
System.out.println(apple.getColor());
}
}
输出结果：
红富士苹果
甜
粉色
**以上是一个简单的spring工程，从上面的代码我们可以发现spring大概做了两件事情：1、加载解析配置文件，生成一个容器；2、从容器中返回一个bean实例对象。**这里我们先跟踪一下第一件事的源码，后面的一件事下一跟踪下源码。
二、spring加载解析配置文件源码跟踪
2.1 入口类 ClassPathXmlApplicationContext。
2.1.1 使用IDEA查看ClassPathXmlApplicationContext的类图如下，从类图中我们可以看到该类实现了BeanFactory接口和ResourceLoader接口，因为我们可以推测该类具有加载资源文件和生产bean实例的能力。
2.1.2 Ctrl + Alt 进入ClassPathXmlApplicationContext类。ClassPathXmlApplicationContext有很多重载的构造函数，我们可以发现无论使用了哪个重载的构造函数，最终都会进入如下的3个参数的构造函数。功能如下注释，大概意思：
①根据给定的父类创建一个容器
②从xml文件中读取属性
③加载所有的bean定义属性，创建单例bean
/**
* Create a new ClassPathXmlApplicationContext with the given parent,
* loading the definitions from the given XML files.
* @param configLocations array of resource locations
* @param refresh whether to automatically refresh the context,
* loading all bean definitions and creating all singletons.
* Alternatively, call refresh manually after further configuring the context.
* @param parent the parent context
* @throws BeansException if context creation failed
* @see #refresh()
*/
public ClassPathXmlApplicationContext(String[] configLocations, boolean refresh, @Nullable ApplicationContext parent) throws BeansException {
super(parent);
this.setConfigLocations(configLocations);
if (refresh) {
this.refresh();
}
}
2.1.3 第一行调用父类构造不看，我们跟踪看下第二行和第三行代码。
进入第二行代码，源码如下描述如下，大概就是设置xml文件的路径。
/** 为xml设置配置文件路径
* Set the config locations for this application context.
* 如果没有设置，则使用默认的
* <p>If not set, the implementation may use a default as appropriate.
*/
public void setConfigLocations(@Nullable String... locations) {
if (locations != null) {
//xml文件里面不能是空元素的
Assert.noNullElements(locations, "Config locations must not be null");
this.configLocations = new String[locations.length];
for (int i = 0; i < locations.length; i++) {
//将闯入的多个配置文件存贮到数组String[] configLocations中
this.configLocations[i] = resolvePath(locations[i]).trim();
}
}
else {
this.configLocations = null;
}
}
2.1.4 进入第3行代码查看。
我们现在这里的布尔型标志位refresh是由别的构造函数传入的，而且都是true，也即是说第一次进入时 refresh();方法一定会执行，这里推测该标志位的作用是控制容器只能被创建一次。
if (refresh) {
refresh();
}
进入refresh()方法。发现很复杂，看源码只需要看个大概，知道思路脉络就行了。我们先只看beanFactory生成这部分，即下面的obtainFreshBeanFactory()方法和prepareBeanFactory(beanFactory)。
@Override
public void refresh() throws BeansException, IllegalStateException {
synchronized (this.startupShutdownMonitor) {
// Prepare this context for refreshing.
prepareRefresh();
// Tell the subclass to refresh the internal bean factory.
ConfigurableListableBeanFactory beanFactory = obtainFreshBeanFactory();
// Prepare the bean factory for use in this context.
prepareBeanFactory(beanFactory);
try {
// Allows post-processing of the bean factory in context subclasses.
postProcessBeanFactory(beanFactory);
// Invoke factory processors registered as beans in the context.
invokeBeanFactoryPostProcessors(beanFactory);
// Register bean processors that intercept bean creation.
registerBeanPostProcessors(beanFactory);
// Initialize message source for this context.
initMessageSource();
// Initialize event multicaster for this context.
initApplicationEventMulticaster();
// Initialize other special beans in specific context subclasses.
onRefresh();
// Check for listener beans and register them.
registerListeners();
// Instantiate all remaining (non-lazy-init) singletons.
finishBeanFactoryInitialization(beanFactory);
// Last step: publish corresponding event.
finishRefresh();
} catch (BeansException ex) {
if (logger.isWarnEnabled()) {
logger.warn("Exception encountered during context initialization - " +
"cancelling refresh attempt: " + ex);
}
// Destroy already created singletons to avoid dangling resources.
destroyBeans();
// Reset 'active' flag.
cancelRefresh(ex);
// Propagate exception to caller.
throw ex;
}
finally {
// Reset common introspection caches in Spring's core, since we
// might not ever need metadata for singleton beans anymore...
resetCommonCaches();
}
}
进入obtainFreshBeanFactory()方法，做了两件事情：1、创建bean工厂； 2、获取返回bean工厂。
protected ConfigurableListableBeanFactory obtainFreshBeanFactory() {
//1、创建一个bean工厂
refreshBeanFactory();
//2、获取上一步创建的bean工厂
ConfigurableListableBeanFactory beanFactory = getBeanFactory();
if (logger.isDebugEnabled()) {
logger.debug("Bean factory for " + getDisplayName() + ": " + beanFactory);
}
return beanFactory;
}
进入创建工厂的方法refreshBeanFactory()，再进入createBeanFactory()。发现该方法返回了一个
new的DefaultListableBeanFactory()，这是beanFactory工厂顶层接口的默认实现类。
protected final void refreshBeanFactory() throws BeansException {
//判断是否有工厂类了，有的话销毁
if (hasBeanFactory()) {
destroyBeans();
closeBeanFactory();
}
try {
//new 一个 DefaultListableBeanFactory
DefaultListableBeanFactory beanFactory = createBeanFactory();
beanFactory.setSerializationId(getId());
customizeBeanFactory(beanFactory);
//加载bean的属性定义
loadBeanDefinitions(beanFactory);
synchronized (this.beanFactoryMonitor) {
this.beanFactory = beanFactory;
}
}
catch (IOException ex) {
throw new ApplicationContextException("I/O error parsing bean definition source for " + getDisplayName(), ex);
}
}
进入getBeanFactory()方法，获取上一步返回的beanFactory对象。
就一句，直接return了全局DefaultListableBeanFactory beanFactory对象。这里和上面生生beanFactory的refreshBeanFactory()里面都是用了一个同步锁beanFactoryMonitor，目的是为了防止beanFactory生成过程中就去获取beanFactory。
@Override
public final ConfigurableListableBeanFactory getBeanFactory() {
synchronized (this.beanFactoryMonitor) {
if (this.beanFactory == null) {
throw new IllegalStateException("BeanFactory not initialized or already closed - " +
"call 'refresh' before accessing beans via the ApplicationContext");
}
return this.beanFactory;
}
}
上面步骤返回了一个DefaultListableBeanFactory类型的beanFactory，后续的代码是对工厂进行一系列的后置装饰及别的动作，暂不分析。
2.1.5 在上述2.1.4步骤中，生成beanFactory的方法refreshBeanFactory()中有有一个很重要的方法loadBeanDefinitions(beanFactory)，下面来跟踪下它的源码，作用为：通过XmlBeanDefinitionReader对象读取bean的属性定义。
/**
* Loads the bean definitions via an XmlBeanDefinitionReader.//Reader读取bean属性
* @see org.springframework.beans.factory.xml.XmlBeanDefinitionReader
* @see #initBeanDefinitionReader
* @see #loadBeanDefinitions
*/
@Override
protected void loadBeanDefinitions(DefaultListableBeanFactory beanFactory) throws BeansException, IOException {
// Create a new XmlBeanDefinitionReader for the given BeanFactory.
XmlBeanDefinitionReader beanDefinitionReader = new XmlBeanDefinitionReader(beanFactory);
// Configure the bean definition reader with this context's
// resource loading environment.
beanDefinitionReader.setEnvironment(this.getEnvironment());
beanDefinitionReader.setResourceLoader(this);
beanDefinitionReader.setEntityResolver(new ResourceEntityResolver(this));
// Allow a subclass to provide custom initialization of the reader,
// then proceed with actually loading the bean definitions.
initBeanDefinitionReader(beanDefinitionReader);
loadBeanDefinitions(beanDefinitionReader);
}
前面的代码都是在设置一些属性，直接看下最后一行代码。使用上一步的Reader读取资源。发现
这里读取的Resource属性正是我们在2.1.2 步骤ClassPathXmlApplicationContext构造函数中设置的属性。
protected void loadBeanDefinitions(XmlBeanDefinitionReader reader) throws BeansException, IOException {
Resource[] configResources = getConfigResources();
if (configResources != null) {
reader.loadBeanDefinitions(configResources);
}
String[] configLocations = getConfigLocations();
if (configLocations != null) {
reader.loadBeanDefinitions(configLocations);
}
}
一直跟踪源码，来到如下位置，抛开异常处理不看，代码如下：
protected int doLoadBeanDefinitions(InputSource inputSource, Resource resource)
throws BeanDefinitionStoreException {
try {
Document doc = doLoadDocument(inputSource, resource);
return registerBeanDefinitions(doc, resource);
}
继续跟踪，进入doRegisterBeanDefinitions方法().
@Override
public void registerBeanDefinitions(Document doc, XmlReaderContext readerContext) {
this.readerContext = readerContext;
logger.debug("Loading bean definitions");
Element root = doc.getDocumentElement();
doRegisterBeanDefinitions(root);
}
protected void doRegisterBeanDefinitions(Element root) {
// Any nested <beans> elements will cause recursion in this method. In
// order to propagate and preserve <beans> default-* attributes correctly,
// keep track of the current (parent) delegate, which may be null. Create
// the new (child) delegate with a reference to the parent for fallback purposes,
// then ultimately reset this.delegate back to its original (parent) reference.
// this behavior emulates a stack of delegates without actually necessitating one.
BeanDefinitionParserDelegate parent = this.delegate;
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);
if (!getReaderContext().getEnvironment().acceptsProfiles(specifiedProfiles)) {
if (logger.isInfoEnabled()) {
logger.info("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(root, this.delegate)方法。
protected void parseBeanDefinitions(Element root, BeanDefinitionParserDelegate delegate) {
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;
if (delegate.isDefaultNamespace(ele)) {
parseDefaultElement(ele, delegate);
}
else {
delegate.parseCustomElement(ele);
}
}
}
}
else {
delegate.parseCustomElement(root);
}
}
抛开用户自定义的代码不看，只看默认的元素，继续进入跟踪代码parseDefaultElement(ele, delegate)，
我们这里只看解析bean元素，beans递归解析最终也是会再次进入该解析方法。
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(ele, delegate)方法：
protected void processBeanDefinition(Element ele, BeanDefinitionParserDelegate delegate) {
BeanDefinitionHolder bdHolder = delegate.parseBeanDefinitionElement(ele);
if (bdHolder != null) {
bdHolder = delegate.decorateBeanDefinitionIfRequired(ele, bdHolder);
try {
// Register the final decorated instance.
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));
}
}
进入registerBeanDefinition()方法：
public static void registerBeanDefinition(
BeanDefinitionHolder definitionHolder, BeanDefinitionRegistry registry)
throws BeanDefinitionStoreException {
// Register bean definition under primary name.
String beanName = definitionHolder.getBeanName();
registry.registerBeanDefinition(beanName, definitionHolder.getBeanDefinition());
// Register aliases for bean name, if any.
String[] aliases = definitionHolder.getAliases();
if (aliases != null) {
for (String alias : aliases) {
registry.registerAlias(beanName, alias);
}
}
}
进入registry.registerBeanDefinition(beanName, definitionHolder.getBeanDefinition())最终来到了DefaultListableBeanFactory的registerBeanDefinition()方法中。该类有一个很重要的属性如下，是一个存放bean属性定义的ConcurrentHashMap，也就是我们常说的IOC容器。
/** Map of bean definition objects, keyed by bean name */
private final Map<String, BeanDefinition> beanDefinitionMap = new ConcurrentHashMap<>(256);
@Override
public void registerBeanDefinition(String beanName, BeanDefinition beanDefinition)
throws BeanDefinitionStoreException {
Assert.hasText(beanName, "Bean name must not be empty");
Assert.notNull(beanDefinition, "BeanDefinition must not be null");
if (beanDefinition instanceof AbstractBeanDefinition) {
try {
((AbstractBeanDefinition) beanDefinition).validate();
}
catch (BeanDefinitionValidationException ex) {
throw new BeanDefinitionStoreException(beanDefinition.getResourceDescription(), beanName,
"Validation of bean definition failed", ex);
}
}
//从IOC容器中尝试获取该bean对象
BeanDefinition existingDefinition = this.beanDefinitionMap.get(beanName);
//bean存在
if (existingDefinition != null) {
//默认允许复写，如果不允许复写，则抛异常
if (!isAllowBeanDefinitionOverriding()) {
throw new BeanDefinitionStoreException(beanDefinition.getResourceDescription(), beanName,
"Cannot register bean definition [" + beanDefinition + "] for bean '" + beanName +
"': There is already [" + existingDefinition + "] bound.");
} else if (existingDefinition.getRole() < beanDefinition.getRole()) {
// e.g. was ROLE_APPLICATION, now overriding with ROLE_SUPPORT or ROLE_INFRASTRUCTURE
if (logger.isWarnEnabled()) {
logger.warn("Overriding user-defined bean definition for bean '" + beanName +
"' with a framework-generated bean definition: replacing [" +
existingDefinition + "] with [" + beanDefinition + "]");
}
} else if (!beanDefinition.equals(existingDefinition)) {
if (logger.isInfoEnabled()) {
logger.info("Overriding bean definition for bean '" + beanName +
"' with a different definition: replacing [" + existingDefinition +
"] with [" + beanDefinition + "]");
}
} else {
if (logger.isDebugEnabled()) {
logger.debug("Overriding bean definition for bean '" + beanName +
"' with an equivalent definition: replacing [" + existingDefinition +
"] with [" + beanDefinition + "]");
}
}
//覆盖bean
this.beanDefinitionMap.put(beanName, beanDefinition);
} else {
if (hasBeanCreationStarted()) {
// Cannot modify startup-time collection elements anymore (for stable iteration)
synchronized (this.beanDefinitionMap) {
this.beanDefinitionMap.put(beanName, beanDefinition);
List<String> updatedDefinitions = new ArrayList<>(this.beanDefinitionNames.size() + 1);
updatedDefinitions.addAll(this.beanDefinitionNames);
updatedDefinitions.add(beanName);
this.beanDefinitionNames = updatedDefinitions;
if (this.manualSingletonNames.contains(beanName)) {
Set<String> updatedSingletons = new LinkedHashSet<>(this.manualSingletonNames);
updatedSingletons.remove(beanName);
this.manualSingletonNames = updatedSingletons;
}
}
} else {
// Still in startup registration phase
//bean和beanDefinition存入IOC中
this.beanDefinitionMap.put(beanName, beanDefinition);
//beanName放入List中
this.beanDefinitionNames.add(beanName);
this.manualSingletonNames.remove(beanName);
}
this.frozenBeanDefinitionNames = null;
}
if (existingDefinition != null || containsSingleton(beanName)) {
resetBeanDefinition(beanName);
}
}
上述方法中代码看起来很多，其实做的事情并不复杂，大概做的事情如下：
①首先会从IOC容器中查看该bean是否存在
②如果bean已经存在，则检查是否允许复写。
③如果不存在，则将bean的name和definitions放入ConcurrentHashMap中，即IOC容器中。
④将bean的名字放入一个beanDefinitionNames List列表中。
至此我们大概走马观花式地把spring创建beanFactory的源码过了一下，可以看到spring返回的beanFactory并不是一个简单的工厂而已，里面已经包含了bean属性定义，我们可以通过beanFactory的getBean方法获取这些属性生成一个bean实例对象。事实上，我们调用容器ApplicationContext的getBean方法，其实调用就是beanFactory的方法。下一篇我们来跟踪分析下getBean生成实例的源码。
404
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
