首页
登录 | 注册

Spring @Configuration 和 @Component 区别

Spring @Configuration 和 @Component 区别

一句话概括就是 @Configuration 中所有带 @Bean 注解的方法都会被动态代理,因此调用该方法返回的都是同一个实例。

下面看看实现的细节。

1 @Configuration 注解:
2 @Target(ElementType.TYPE)
3 @Retention(RetentionPolicy.RUNTIME)
4 @Documented
5 @Component
6 public @interface Configuration {
7 String value() default "";
8 }


从定义来看, @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 方法中调用了下面的方法:

 1 /**
 2      * Post-processes a BeanFactory in search of Configuration class BeanDefinitions;
 3      * any candidates are then enhanced by a {@link ConfigurationClassEnhancer}.
 4      * Candidate status is determined by BeanDefinition attribute metadata.
 5      * @see ConfigurationClassEnhancer
 6      */
 7     public void enhanceConfigurationClasses(ConfigurableListableBeanFactory beanFactory) {
 8         Map<String, AbstractBeanDefinition> configBeanDefs = new LinkedHashMap<String, AbstractBeanDefinition>();
 9         for (String beanName : beanFactory.getBeanDefinitionNames()) {
10             BeanDefinition beanDef = beanFactory.getBeanDefinition(beanName);
11             if (ConfigurationClassUtils.isFullConfigurationClass(beanDef)) {
12 //省略部分代码
13                 configBeanDefs.put(beanName, (AbstractBeanDefinition) beanDef);
14             }
15         }
16         if (configBeanDefs.isEmpty()) {
17 // nothing to enhance -> return immediately
18             return;
19         }
20         ConfigurationClassEnhancer enhancer = new ConfigurationClassEnhancer();
21         for (Map.Entry<String, AbstractBeanDefinition> entry : configBeanDefs.entrySet()) {
22             AbstractBeanDefinition beanDef = entry.getValue();
23 // If a @Configuration class gets proxied, always proxy the target class
24             beanDef.setAttribute(AutoProxyUtils.PRESERVE_TARGET_CLASS_ATTRIBUTE, Boolean.TRUE);
25             try {
26 // Set enhanced subclass of the user-specified bean class
27                 Class<?> configClass = beanDef.resolveBeanClass(this.beanClassLoader);
28                 Class<?> enhancedClass = enhancer.enhance(configClass, this.beanClassLoader);
29                 if (configClass != enhancedClass) {
30 //省略部分代码
31                     beanDef.setBeanClass(enhancedClass);
32                 }
33             }
34             catch (Throwable ex) {
35                 throw new IllegalStateException(
36                         "Cannot load configuration class: " + beanDef.getBeanClassName(), ex);
37             }
38         }
39     }

在方法的第一次循环中,查找到所有带有 @Configuration 注解的 bean 定义,然后在第二个 for 循环中,通过下面的方法对类进行增强:

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

然后使用增强后的类替换了原有的 beanClass:

1 beanDef.setBeanClass(enhancedClass);

所以到此时,所有带有 @Configuration 注解的 bean 都已经变成了增强的类。

下面关注上面的 enhance 增强方法,多跟一步就能看到下面的方法:

 1 /**
 2      * Creates a new CGLIB {@link Enhancer} instance.
 3      */
 4     private Enhancer newEnhancer(Class<?> superclass, ClassLoader classLoader) {
 5         Enhancer enhancer = new Enhancer();
 6         enhancer.setSuperclass(superclass);
 7         enhancer.setInterfaces(new Class<?>[] {EnhancedConfiguration.class});
 8         enhancer.setUseFactory(false);
 9         enhancer.setNamingPolicy(SpringNamingPolicy.INSTANCE);
10         enhancer.setStrategy(new BeanFactoryAwareGeneratorStrategy(classLoader));
11         enhancer.setCallbackFilter(CALLBACK_FILTER);
12         enhancer.setCallbackTypes(CALLBACK_FILTER.getCallbackTypes());
13         return enhancer;
14     }

通过 cglib 代理的类在调用方法时,会通过 CallbackFilter 调用,这里的 CALLBACK_FILTER 如下:

1 // The callbacks to use. Note that these callbacks must be stateless.
2     private static final Callback[] CALLBACKS = new Callback[] {
3             new BeanMethodInterceptor(),
4             new BeanFactoryAwareMethodInterceptor(),
5             NoOp.INSTANCE
6     };
7 
8     private static final ConditionalCallbackFilter CALLBACK_FILTER =
9             new ConditionalCallbackFilter(CALLBACKS);

其中 BeanMethodInterceptor 匹配方法如下:

1     @Override
2     public boolean isMatch(Method candidateMethod) {
3         return BeanAnnotationHelper.isBeanAnnotated(candidateMethod);
4     }
5 
6     //BeanAnnotationHelper
7     public static boolean isBeanAnnotated(Method method) {
8         return AnnotatedElementUtils.hasAnnotation(method, Bean.class);
9     }

也就是当方法有 @Bean 注解的时候,就会执行这个回调方法。

另一个 BeanFactoryAwareMethodInterceptor 匹配的方法如下:

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

当前类还需要实现 BeanFactoryAware 接口,上面的 isMatch 就是匹配的这个接口的方法。

@Bean 注解方法执行策略
先给一个简单的示例代码:

 1     @Configuration
 2     public class MyBeanConfig {
 3 
 4         @Bean
 5         public Country country(){
 6             return new Country();
 7         }
 8 
 9         @Bean
10         public UserInfo userInfo(){
11             return new UserInfo(country());
12         }
13 
14     }

相信大多数人第一次看到上面 userInfo() 中调用 country() 时,会认为这里的 Country 和上面 @Bean 方法返回的 Country 可能不是同一个对象,因此可能会通过下面的方式来替代这种方式:

1 @Autowired 
2 private Country country;

实际上不需要这么做(后面会给出需要这样做的场景),直接调用 country() 方法返回的是同一个实例。

下面看调用 country() 和 userInfo() 方法时的逻辑。

现在我们已经知道 @Configuration 注解的类是如何被处理的了,现在关注上面的 BeanMethodInterceptor,看看带有 @Bean 注解的方法执行的逻辑。下面分解来看 intercept 方法。

 1 //首先通过反射从增强的 Configuration 注解类中获取 beanFactory
 2 ConfigurableBeanFactory beanFactory = getBeanFactory(enhancedConfigInstance);
 3 
 4 //然后通过方法获取 beanName,默认为方法名,可以通过 @Bean 注解指定
 5 String beanName = BeanAnnotationHelper.determineBeanNameFor(beanMethod);
 6 
 7 //确定这个 bean 是否指定了代理的范围
 8 //默认下面 if 条件 false 不会执行
 9 Scope scope = AnnotatedElementUtils.findMergedAnnotation(beanMethod, Scope.class);
10 if (scope != null && scope.proxyMode() != ScopedProxyMode.NO) {
11 String scopedBeanName = ScopedProxyCreator.getTargetBeanName(beanName);
12 if (beanFactory.isCurrentlyInCreation(scopedBeanName)) {
13 beanName = scopedBeanName;
14 }
15 }
16 
17 //中间跳过一段 Factorybean 相关代码
18 
19 //判断当前执行的方法是否为正在执行的 @Bean 方法
20 //因为存在在 userInfo() 方法中调用 country() 方法
21 //如果 country() 也有 @Bean 注解,那么这个返回值就是 false.
22 if (isCurrentlyInvokedFactoryMethod(beanMethod)) {
23 // 判断返回值类型,如果是 BeanFactoryPostProcessor 就写警告日志
24 if (logger.isWarnEnabled() &&
25 BeanFactoryPostProcessor.class.isAssignableFrom(beanMethod.getReturnType())) {
26 logger.warn(String.format(
27 "@Bean method %s.%s is non-static and returns an object " +
28 "assignable to Spring's BeanFactoryPostProcessor interface. This will " +
29 "result in a failure to process annotations such as @Autowired, " +
30 "@Resource and @PostConstruct within the method's declaring " +
31 "@Configuration class. Add the 'static' modifier to this method to avoid " +
32 "these container lifecycle issues; see @Bean javadoc for complete details.",
33 beanMethod.getDeclaringClass().getSimpleName(), beanMethod.getName()));
34 }
35 //直接调用原方法创建 bean
36 return cglibMethodProxy.invokeSuper(enhancedConfigInstance, beanMethodArgs);
37 }
38 //如果不满足上面 if,也就是在 userInfo() 中调用的 country() 方法
39 return obtainBeanInstanceFromFactory(beanMethod, beanMethodArgs, beanFactory, beanName);

关于 isCurrentlyInvokedFactoryMethod 方法

可以参考 SimpleInstantiationStrategy 中的 instantiate 方法,这里先设置的调用方法:

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

而通过方法内部直接调用 country() 方法时,不走上面的逻辑,直接进的代理方法,也就是当前的 intercept方法,因此当前的工厂方法和执行的方法就不相同了。

obtainBeanInstanceFromFactory 方法比较简单,就是通过 beanFactory.getBean 获取 Country,如果已经创建了就会直接返回,如果没有执行过,就会通过 invokeSuper 首次执行。

因此我们在 @Configuration 注解定义的 bean 方法中可以直接调用方法,不需要 @Autowired 注入后使用。

@Component 注意
@Component 注解并没有通过 cglib 来代理@Bean 方法的调用,因此像下面这样配置时,就是两个不同的 country。
 1    @Component
 2     public class MyBeanConfig {
 3 
 4         @Bean
 5         public Country country(){
 6             return new Country();
 7         }
 8 
 9         @Bean
10         public UserInfo userInfo(){
11             return new UserInfo(country());
12         }
13 
14     }

有些特殊情况下,我们不希望 MyBeanConfig 被代理(代理后会变成WebMvcConfig$$EnhancerBySpringCGLIB$$8bef3235293)时,就得用 @Component,这种情况下,上面的写法就需要改成下面这样:

 1     @Component
 2     public class MyBeanConfig {
 3 
 4         @Autowired
 5         private Country country;
 6 
 7         @Bean
 8         public Country country(){
 9             return new Country();
10         }
11 
12         @Bean
13         public UserInfo userInfo(){
14             return new UserInfo(country);
15         }
16 
17     }

这种方式可以保证使用的同一个 Country 实例。

 

转自:https://blog.csdn.net/isea533/article/details/78072133


相关文章

  • Spring入门(二):自动化装配bean
    Spring从两个角度来实现自动化装配: 组件扫描(component scanning):Spring会自动发现应用上下文中需要创建的bean. 自动装配(autowiring):Spring会自动满足bean之间的依赖. 为了更形象的解 ...
  • 目录 引入 简单工厂 抽象工厂 Spring的bean工厂 模拟Spring工厂实现 模拟IOC 引入 假设有一个司机, 需要到某个城市, 于是我们给他一辆汽车 public class Demo { public static void ...
  • 为什么说 Java 程序员到了必须掌握 Spring Boot 的时候?
    Spring Boot 2.0 的推出又激起了一阵学习 Spring Boot 热,就单从我个人的博客的访问量大幅增加就可以感受到大家对学习 Spring Boot 的热情,那么在这么多人热衷于学习 Spring Boot 之时,我自己也在 ...
  • Spring的历史及哲学
    Spring的历史和哲学 1.Spring 历史 时间回到2002年,当时正是 Java EE 和 EJB 大行其道的时候,很多知名公司都是采用此技术方案进行项目开发.这时候有一个美国的小伙子认为 EJB 太过臃肿,并不是所有的项目都需要使 ...
  • Spring Boot入门(五):使用JDBC访问MySql数据库
    本系列博客记录自己学习Spring Boot的历程,如帮助到你,不胜荣幸,如有错误,欢迎指正! 在程序开发的过程中,操作数据库是必不可少的部分,前面几篇博客中,也一直未涉及到数据库的操作,本篇博客 就讲解下在Spring Boot中如何使用 ...
  • Springcloud Gateway 路由管理
    Spring Cloud Gateway 是 Spring Cloud 的一个全新项目,该项目是基于 Spring 5.0,Spring Boot 2.0 和 Project Reactor 等技术开发的网关,它旨在为微服务架构提供一种简单 ...

2019 cecdns.com webmaster#cecdns.com
12 q. 0.078 s.
京ICP备10005923号