Spring 执行顺序：Aware 接口

回目录

代码：https://gitee.com/free/boot-order/tree/master/src/main/java/com/github/abel533/aware

通过本例了解一个 Bean 中所有 Aware 方法的执行顺序。

AwareImpl 实现了全部可用的 Aware 子接口，UML 图如下：

在 AwareImpl 所有接口方法中，执行顺序如下：

0. BeanNameAware#setBeanName
1. BeanClassLoaderAware#setBeanClassLoader
2. BeanFactoryAware#setBeanFactory
3. EnvironmentAware#setEnvironment
4. EmbeddedValueResolverAware#setEmbeddedValueResolver
5. ResourceLoaderAware#setResourceLoader
6. ApplicationEventPublisherAware#setApplicationEventPublisher
7. MessageSourceAware#setMessageSource
8. ApplicationContextAware#setApplicationContext
9. ServletContextAware#setServletContext
10. LoadTimeWeaverAware#loadTimeWeaverAware
11. ImportAware#setImportMetadata
12. ImportAware > BeanNameAware#setBeanName

其中 0~2 的执行顺序在 AbstractAutowireCapableBeanFactory 类中，该类继承的 AbstractBeanFactory#createBean 方法中，按照 doCreateBean > initializeBean > invokeAwareMethods 顺序调用，在 invokeAwareMethods 方法中，按照以下顺序处理 Aware 接口：

private void invokeAwareMethods(final String beanName, final Object bean) {
    if (bean instanceof Aware) {
        if (bean instanceof BeanNameAware) {
            ((BeanNameAware) bean).setBeanName(beanName);
        }
        if (bean instanceof BeanClassLoaderAware) {
            ClassLoader bcl = getBeanClassLoader();
            if (bcl != null) {
                ((BeanClassLoaderAware) bean).setBeanClassLoader(bcl);
            }
        }
        if (bean instanceof BeanFactoryAware) {
            ((BeanFactoryAware) bean).setBeanFactory(AbstractAutowireCapableBeanFactory.this);
        }
    }
}

其中 3~8 的执行顺序在 ApplicationContextAwareProcessor 类中，该类实现的 BeanPostProcessor#postProcessBeforeInitialization 方法中，按照以下顺序处理的 Aware 接口：

private void invokeAwareInterfaces(Object bean) {
    if (bean instanceof Aware) {
        if (bean instanceof EnvironmentAware) {
            ((EnvironmentAware) bean).setEnvironment(this.applicationContext.getEnvironment());
        }
        if (bean instanceof EmbeddedValueResolverAware) {
            ((EmbeddedValueResolverAware) bean).setEmbeddedValueResolver(this.embeddedValueResolver);
        }
        if (bean instanceof ResourceLoaderAware) {
            ((ResourceLoaderAware) bean).setResourceLoader(this.applicationContext);
        }
        if (bean instanceof ApplicationEventPublisherAware) {
            ((ApplicationEventPublisherAware) bean).setApplicationEventPublisher(this.applicationContext);
        }
        if (bean instanceof MessageSourceAware) {
            ((MessageSourceAware) bean).setMessageSource(this.applicationContext);
        }
        if (bean instanceof ApplicationContextAware) {
            ((ApplicationContextAware) bean).setApplicationContext(this.applicationContext);
        }
    }
}

9 在 ServletContextAwareProcessor 中处理，该类实现的 BeanPostProcessor#postProcessBeforeInitialization 方法中，按照以下顺序处理的 Aware 接口：

@Override
public Object postProcessBeforeInitialization(Object bean, String beanName) throws BeansException {
    if (getServletContext() != null && bean instanceof ServletContextAware) {
        ((ServletContextAware) bean).setServletContext(getServletContext());
    }
    if (getServletConfig() != null && bean instanceof ServletConfigAware) {
        ((ServletConfigAware) bean).setServletConfig(getServletConfig());
    }
    return bean;
}

在例子中，ServletContextAware 成功调用了，但是由于 getServletConfig() == null，因此 ServletConfigAware ，没有起作用。

10 只有在使用 @EnableLoadTimeWeaving 或者存在 LoadTimeWeaver 实现的 Bean 时才会调用，顺序也很靠后。

11 只有被其他配置类 @Import(XX.class) 时才会调用，这个调用对 XX.class 中的所有 @Bean 来说顺序是第 1 的。

12 为了证明 11，注意 11 和 12 和前面所有输出不是同一个 Bean。