Spring @Configuration和@Component的區別

2024-07-14 08:43:21

字體：大中小

來源：轉載

供稿：網友

Spring @Configuration 和 @Component 區別

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

下面看看實現的細節。

@Configuration 注解：

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

從定義來看，@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);    }  }}

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

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

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

beanDef.setBeanClass(enhancedClass);

所以到此時，所有帶有@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;}

通過 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);

其中BeanMethodInterceptor匹配方法如下：

@Overridepublic boolean isMatch(Method candidateMethod) {  return BeanAnnotationHelper.isBeanAnnotated(candidateMethod);}//BeanAnnotationHelperpublic static boolean isBeanAnnotated(Method method) {  return AnnotatedElementUtils.hasAnnotation(method, Bean.class);}

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

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

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

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

@Bean 注解方法執行策略

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

@Configurationpublic class MyBeanConfig {  @Bean  public Country country(){    return new Country();  }  @Bean  public UserInfo userInfo(){    return new UserInfo(country());  }}

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

@Autowired
private Country country;

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

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

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

//首先通過反射從增強的 Configuration 注解類中獲取 beanFactoryConfigurableBeanFactory 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);

關于isCurrentlyInvokedFactoryMethod方法

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

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

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

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

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

@Component 注意

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

@Componentpublic class MyBeanConfig {  @Bean  public Country country(){    return new Country();  }  @Bean  public UserInfo userInfo(){    return new UserInfo(country());  }}

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

@Componentpublic class MyBeanConfig {  @Autowired  private Country country;  @Bean  public Country country(){    return new Country();  }  @Bean  public UserInfo userInfo(){    return new UserInfo(country);  }}

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

總結

以上就是這篇文章的全部內容了，希望本文的內容對大家的學習或者工作具有一定的參考學習價值，謝謝大家對VeVb武林網的支持。

注：相關教程知識閱讀請移步到JAVA教程頻道。

上一篇：MyBatis Map結果的Key轉為駝峰式

下一篇：Spring Boot 靜態資源處理