SpringBoot _@Configuration 和 @Component 區別(轉發大神的)

Spring @Configuration 和 @Component 區別

一句話概括就是 @Configuration 中所有帶 @Bean 註解的方法都會被動態代理，因此調用該方法返回的都是同一個實例。

下面看看實現的細節。

@Configuration 註解：

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Component
public @interface Configuration {
    String value() default "";
}

• 1
• 2
• 3
• 4
• 5
• 6
• 7

從定義來看， @Configuration 註解本質上還是 @Component，因此 <context:component-scan/> 或者 @ComponentScan 都能處理@Configuration 註解的類。

@Configuration 標記的類必須符合下面的要求：

• 配置類必須以類的形式提供（不能是工廠方法返回的實例），允許通過生成子類在運行時增強（cglib 動態代理）。
• 配置類不能是 final 類（沒法動態代理）。
• 配置註解通常爲了通過 @Bean 註解生成 Spring 容器管理的類，
• 配置類必須是非本地的（即不能在方法中聲明，不能是 private）。
• 任何嵌套配置類都必須聲明爲static。
• @Bean 方法可能不會反過來創建進一步的配置類（也就是返回的 bean 如果帶有 @Configuration，也不會被特殊處理，只會作爲普通的 bean）。

加載過程

Spring 容器在啓動時，會加載默認的一些 PostPRocessor，其中就有 ConfigurationClassPostProcessor，這個後置處理程序專門處理帶有 @Configuration 註解的類，這個程序會在 bean 定義加載完成後，在 bean 初始化前進行處理。主要處理的過程就是使用 cglib 動態代理增強類，而且是對其中帶有 @Bean 註解的方法進行處理。

在 ConfigurationClassPostProcessor 中的 postProcessBeanFactory 方法中調用了下面的方法：

/**
 * Post-processes a BeanFactory in search of Configuration class BeanDefinitions;
 * any candidates are then enhanced by a {@link ConfigurationClassEnhancer}.
 * Candidate status is determined by BeanDefinition attribute metadata.
 * @see ConfigurationClassEnhancer
 */
public void enhanceConfigurationClasses(ConfigurableListableBeanFactory beanFactory) {
    Map<String, AbstractBeanDefinition> configBeanDefs = new LinkedHashMap<String, AbstractBeanDefinition>();
    for (String beanName : beanFactory.getBeanDefinitionNames()) {
        BeanDefinition beanDef = beanFactory.getBeanDefinition(beanName);
        if (ConfigurationClassUtils.isFullConfigurationClass(beanDef)) {
            //省略部分代碼
            configBeanDefs.put(beanName, (AbstractBeanDefinition) beanDef);
        }
    }
    if (configBeanDefs.isEmpty()) {
        // nothing to enhance -> return immediately
        return;
    }
    ConfigurationClassEnhancer enhancer = new ConfigurationClassEnhancer();
    for (Map.Entry<String, AbstractBeanDefinition> entry : configBeanDefs.entrySet()) {
        AbstractBeanDefinition beanDef = entry.getValue();
        // If a @Configuration class gets proxied, always proxy the target class
        beanDef.setAttribute(AutoProxyUtils.PRESERVE_TARGET_CLASS_ATTRIBUTE, Boolean.TRUE);
        try {
            // Set enhanced subclass of the user-specified bean class
            Class<?> configClass = beanDef.resolveBeanClass(this.beanClassLoader);
            Class<?> enhancedClass = enhancer.enhance(configClass, this.beanClassLoader);
            if (configClass != enhancedClass) {
                //省略部分代碼
                beanDef.setBeanClass(enhancedClass);
            }
        }
        catch (Throwable ex) {
            throw new IllegalStateException(
              "Cannot load configuration class: " + beanDef.getBeanClassName(), ex);
        }
    }
}

• 1
• 2
• 3
• 4
• 5
• 6
• 7
• 8
• 9
• 10
• 11
• 12
• 13
• 14
• 15
• 16
• 17
• 18
• 19
• 20
• 21
• 22
• 23
• 24
• 25
• 26
• 27
• 28
• 29
• 30
• 31
• 32
• 33
• 34
• 35
• 36
• 37
• 38
• 39

在方法的第一次循環中，查找到所有帶有 @Configuration 註解的 bean 定義，然後在第二個 for 循環中，通過下面的方法對類進行增強：

Class<?> enhancedClass = enhancer.enhance(configClass, this.beanClassLoader);

• 1

然後使用增強後的類替換了原有的 beanClass：

beanDef.setBeanClass(enhancedClass);

• 1

所以到此時，所有帶有 @Configuration 註解的 bean 都已經變成了增強的類。

下面關注上面的 enhance 增強方法，多跟一步就能看到下面的方法：

/**
 * Creates a new CGLIB {@link Enhancer} instance.
 */
private Enhancer newEnhancer(Class<?> superclass, ClassLoader classLoader) {
    Enhancer enhancer = new Enhancer();
    enhancer.setSuperclass(superclass);
    enhancer.setInterfaces(new Class<?>[] {EnhancedConfiguration.class});
    enhancer.setUseFactory(false);
    enhancer.setNamingPolicy(SpringNamingPolicy.INSTANCE);
    enhancer.setStrategy(new BeanFactoryAwareGeneratorStrategy(classLoader));
    enhancer.setCallbackFilter(CALLBACK_FILTER);
    enhancer.setCallbackTypes(CALLBACK_FILTER.getCallbackTypes());
    return enhancer;
}

• 1
• 2
• 3
• 4
• 5
• 6
• 7
• 8
• 9
• 10
• 11
• 12
• 13
• 14

通過 cglib 代理的類在調用方法時，會通過 CallbackFilter 調用，這裏的 CALLBACK_FILTER 如下：

// The callbacks to use. Note that these callbacks must be stateless.
private static final Callback[] CALLBACKS = new Callback[] {
        new BeanMethodInterceptor(),
        new BeanFactoryAwareMethodInterceptor(),
        NoOp.INSTANCE
};

private static final ConditionalCallbackFilter CALLBACK_FILTER = 
        new ConditionalCallbackFilter(CALLBACKS);

• 1
• 2
• 3
• 4
• 5
• 6
• 7
• 8
• 9

其中 BeanMethodInterceptor 匹配方法如下：

@Override
public boolean isMatch(Method candidateMethod) {
    return BeanAnnotationHelper.isBeanAnnotated(candidateMethod);
}

//BeanAnnotationHelper
public static boolean isBeanAnnotated(Method method) {
    return AnnotatedElementUtils.hasAnnotation(method, Bean.class);
}

• 1
• 2
• 3
• 4
• 5
• 6
• 7
• 8
• 9

也就是當方法有 @Bean 註解的時候，就會執行這個回調方法。

另一個 BeanFactoryAwareMethodInterceptor 匹配的方法如下：

@Override
public boolean isMatch(Method candidateMethod) {
    return (candidateMethod.getName().equals("setBeanFactory") &&
            candidateMethod.getParameterTypes().length == 1 &&
            BeanFactory.class == candidateMethod.getParameterTypes()[0] &&
            BeanFactoryAware.class.isAssignableFrom(candidateMethod.getDeclaringClass()));
}

• 1
• 2
• 3
• 4
• 5
• 6
• 7

當前類還需要實現 BeanFactoryAware 接口，上面的 isMatch 就是匹配的這個接口的方法。

@Bean 註解方法執行策略

先給一個簡單的示例代碼：

@Configuration
public class MyBeanConfig {

    @Bean
    public Country country(){
        return new Country();
    }

    @Bean
    public UserInfo userInfo(){
        return new UserInfo(country());
    }

}

• 1
• 2
• 3
• 4
• 5
• 6
• 7
• 8
• 9
• 10
• 11
• 12
• 13
• 14

相信大多數人第一次看到上面 userInfo() 中調用 country() 時，會認爲這裏的 Country 和上面 @Bean 方法返回的 Country 可能不是同一個對象，因此可能會通過下面的方式來替代這種方式：

@Autowired
private Country country;

實際上不需要這麼做（後面會給出需要這樣做的場景），直接調用 country() 方法返回的是同一個實例。

下面看調用 country() 和 userInfo() 方法時的邏輯。

現在我們已經知道 @Configuration 註解的類是如何被處理的了，現在關注上面的 BeanMethodInterceptor，看看帶有 @Bean 註解的方法執行的邏輯。下面分解來看 intercept 方法。

//首先通過反射從增強的 Configuration 註解類中獲取 beanFactory
ConfigurableBeanFactory beanFactory = getBeanFactory(enhancedConfigInstance);

//然後通過方法獲取 beanName，默認爲方法名，可以通過 @Bean 註解指定
String beanName = BeanAnnotationHelper.determineBeanNameFor(beanMethod);

//確定這個 bean 是否指定了代理的範圍
//默認下面 if 條件 false 不會執行
Scope scope = AnnotatedElementUtils.findMergedAnnotation(beanMethod, Scope.class);
if (scope != null && scope.proxyMode() != ScopedProxyMode.NO) {
    String scopedBeanName = ScopedProxyCreator.getTargetBeanName(beanName);
    if (beanFactory.isCurrentlyInCreation(scopedBeanName)) {
        beanName = scopedBeanName;
    }
}

//中間跳過一段 Factorybean 相關代碼

//判斷當前執行的方法是否爲正在執行的 @Bean 方法
//因爲存在在 userInfo() 方法中調用 country() 方法
//如果 country() 也有 @Bean 註解，那麼這個返回值就是 false.
if (isCurrentlyInvokedFactoryMethod(beanMethod)) {
    // 判斷返回值類型，如果是 BeanFactoryPostProcessor 就寫警告日誌
    if (logger.isWarnEnabled() &&
            BeanFactoryPostProcessor.class.isAssignableFrom(beanMethod.getReturnType())) {
        logger.warn(String.format(
            "@Bean method %s.%s is non-static and returns an object " +
            "assignable to Spring's BeanFactoryPostProcessor interface. This will " +
            "result in a failure to process annotations such as @Autowired, " +
            "@Resource and @PostConstruct within the method's declaring " +
            "@Configuration class. Add the 'static' modifier to this method to avoid " +
            "these container lifecycle issues; see @Bean javadoc for complete details.",
            beanMethod.getDeclaringClass().getSimpleName(), beanMethod.getName()));
    }
    //直接調用原方法創建 bean
    return cglibMethodProxy.invokeSuper(enhancedConfigInstance, beanMethodArgs);
}
//如果不滿足上面 if，也就是在 userInfo() 中調用的 country() 方法
return obtainBeanInstanceFromFactory(beanMethod, beanMethodArgs, beanFactory, beanName);

• 1
• 2
• 3
• 4
• 5
• 6
• 7
• 8
• 9
• 10
• 11
• 12
• 13
• 14
• 15
• 16
• 17
• 18
• 19
• 20
• 21
• 22
• 23
• 24
• 25
• 26
• 27
• 28
• 29
• 30
• 31
• 32
• 33
• 34
• 35
• 36
• 37
• 38
• 39

關於 isCurrentlyInvokedFactoryMethod 方法

可以參考 SimpleInstantiationStrategy 中的 instantiate 方法，這裏先設置的調用方法：

currentlyInvokedFactoryMethod.set(factoryMethod);
return factoryMethod.invoke(factoryBean, args);

• 1
• 2

而通過方法內部直接調用 country() 方法時，不走上面的邏輯，直接進的代理方法，也就是當前的 intercept方法，因此當前的工廠方法和執行的方法就不相同了。

obtainBeanInstanceFromFactory 方法比較簡單，就是通過 beanFactory.getBean 獲取 Country，如果已經創建了就會直接返回，如果沒有執行過，就會通過 invokeSuper 首次執行。

因此我們在 @Configuration 註解定義的 bean 方法中可以直接調用方法，不需要 @Autowired 注入後使用。

@Component 注意

@Component 註解並沒有通過 cglib 來代理@Bean 方法的調用，因此像下面這樣配置時，就是兩個不同的 country。

@Component
public class MyBeanConfig {

    @Bean
    public Country country(){
        return new Country();
    }

    @Bean
    public UserInfo userInfo(){
        return new UserInfo(country());
    }

}

• 1
• 2
• 3
• 4
• 5
• 6
• 7
• 8
• 9
• 10
• 11
• 12
• 13
• 14

有些特殊情況下，我們不希望 MyBeanConfig 被代理（代理後會變成WebMvcConfig$$EnhancerBySpringCGLIB$$8bef3235293）時，就得用 @Component，這種情況下，上面的寫法就需要改成下面這樣：

@Component
public class MyBeanConfig {

    @Autowired
    private Country country;

    @Bean
    public Country country(){
        return new Country();
    }

    @Bean
    public UserInfo userInfo(){
        return new UserInfo(country);
    }

}

• 1
• 2
• 3
• 4
• 5
• 6
• 7
• 8
• 9
• 10
• 11
• 12
• 13
• 14
• 15
• 16
• 17

這種方式可以保證使用的同一個 Country 實例。