Spring @Configuration和@Component的区别
Spring@Configuration和@Component区别
一句话概括就是@Configuration中所有带@Bean注解的方法都会被动态代理,因此调用该方法返回的都是同一个实例。
下面看看实现的细节。
@Configuration注解:
@Target(ElementType.TYPE) @Retention(RetentionPolicy.RUNTIME) @Documented @Component public@interfaceConfiguration{ Stringvalue()default""; }
从定义来看,@Configuration注解本质上还是@Component,因此
@Configuration标记的类必须符合下面的要求:
- 配置类必须以类的形式提供(不能是工厂方法返回的实例),允许通过生成子类在运行时增强(cglib动态代理)。
- 配置类不能是final类(没法动态代理)。
- 配置注解通常为了通过@Bean注解生成Spring容器管理的类,
- 配置类必须是非本地的(即不能在方法中声明,不能是private)。
- 任何嵌套配置类都必须声明为static。
- @Bean方法可能不会反过来创建进一步的配置类(也就是返回的bean如果带有@Configuration,也不会被特殊处理,只会作为普通的bean)。
加载过程
Spring容器在启动时,会加载默认的一些PostPRocessor,其中就有ConfigurationClassPostProcessor,这个后置处理程序专门处理带有@Configuration注解的类,这个程序会在bean定义加载完成后,在bean初始化前进行处理。主要处理的过程就是使用cglib动态代理增强类,而且是对其中带有@Bean注解的方法进行处理。
在ConfigurationClassPostProcessor中的postProcessBeanFactory方法中调用了下面的方法:
/** *Post-processesaBeanFactoryinsearchofConfigurationclassBeanDefinitions; *anycandidatesarethenenhancedbya{@linkConfigurationClassEnhancer}. *CandidatestatusisdeterminedbyBeanDefinitionattributemetadata. *@seeConfigurationClassEnhancer */ publicvoidenhanceConfigurationClasses(ConfigurableListableBeanFactorybeanFactory){ MapconfigBeanDefs=newLinkedHashMap (); for(StringbeanName:beanFactory.getBeanDefinitionNames()){ BeanDefinitionbeanDef=beanFactory.getBeanDefinition(beanName); if(ConfigurationClassUtils.isFullConfigurationClass(beanDef)){ //省略部分代码 configBeanDefs.put(beanName,(AbstractBeanDefinition)beanDef); } } if(configBeanDefs.isEmpty()){ //nothingtoenhance->returnimmediately return; } ConfigurationClassEnhancerenhancer=newConfigurationClassEnhancer(); for(Map.Entry entry:configBeanDefs.entrySet()){ AbstractBeanDefinitionbeanDef=entry.getValue(); //Ifa@Configurationclassgetsproxied,alwaysproxythetargetclass beanDef.setAttribute(AutoProxyUtils.PRESERVE_TARGET_CLASS_ATTRIBUTE,Boolean.TRUE); try{ //Setenhancedsubclassoftheuser-specifiedbeanclass Class>configClass=beanDef.resolveBeanClass(this.beanClassLoader); Class>enhancedClass=enhancer.enhance(configClass,this.beanClassLoader); if(configClass!=enhancedClass){ //省略部分代码 beanDef.setBeanClass(enhancedClass); } } catch(Throwableex){ thrownewIllegalStateException( "Cannotloadconfigurationclass:"+beanDef.getBeanClassName(),ex); } } }
在方法的第一次循环中,查找到所有带有@Configuration注解的bean定义,然后在第二个for循环中,通过下面的方法对类进行增强:
Class>enhancedClass=enhancer.enhance(configClass,this.beanClassLoader);
然后使用增强后的类替换了原有的beanClass:
beanDef.setBeanClass(enhancedClass);
所以到此时,所有带有@Configuration注解的bean都已经变成了增强的类。
下面关注上面的enhance增强方法,多跟一步就能看到下面的方法:
/** *CreatesanewCGLIB{@linkEnhancer}instance. */ privateEnhancernewEnhancer(Class>superclass,ClassLoaderclassLoader){ Enhancerenhancer=newEnhancer(); enhancer.setSuperclass(superclass); enhancer.setInterfaces(newClass>[]{EnhancedConfiguration.class}); enhancer.setUseFactory(false); enhancer.setNamingPolicy(SpringNamingPolicy.INSTANCE); enhancer.setStrategy(newBeanFactoryAwareGeneratorStrategy(classLoader)); enhancer.setCallbackFilter(CALLBACK_FILTER); enhancer.setCallbackTypes(CALLBACK_FILTER.getCallbackTypes()); returnenhancer; }
通过cglib代理的类在调用方法时,会通过CallbackFilter调用,这里的CALLBACK_FILTER如下:
//Thecallbackstouse.Notethatthesecallbacksmustbestateless. privatestaticfinalCallback[]CALLBACKS=newCallback[]{ newBeanMethodInterceptor(), newBeanFactoryAwareMethodInterceptor(), NoOp.INSTANCE }; privatestaticfinalConditionalCallbackFilterCALLBACK_FILTER= newConditionalCallbackFilter(CALLBACKS);
其中BeanMethodInterceptor匹配方法如下:
@Override publicbooleanisMatch(MethodcandidateMethod){ returnBeanAnnotationHelper.isBeanAnnotated(candidateMethod); } //BeanAnnotationHelper publicstaticbooleanisBeanAnnotated(Methodmethod){ returnAnnotatedElementUtils.hasAnnotation(method,Bean.class); }
也就是当方法有@Bean注解的时候,就会执行这个回调方法。
另一个BeanFactoryAwareMethodInterceptor匹配的方法如下:
@Override publicbooleanisMatch(MethodcandidateMethod){ return(candidateMethod.getName().equals("setBeanFactory")&& candidateMethod.getParameterTypes().length==1&& BeanFactory.class==candidateMethod.getParameterTypes()[0]&& BeanFactoryAware.class.isAssignableFrom(candidateMethod.getDeclaringClass())); }
当前类还需要实现BeanFactoryAware接口,上面的isMatch就是匹配的这个接口的方法。
@Bean注解方法执行策略
先给一个简单的示例代码:
@Configuration publicclassMyBeanConfig{ @Bean publicCountrycountry(){ returnnewCountry(); } @Bean publicUserInfouserInfo(){ returnnewUserInfo(country()); } }
相信大多数人第一次看到上面userInfo()中调用country()时,会认为这里的Country和上面@Bean方法返回的Country可能不是同一个对象,因此可能会通过下面的方式来替代这种方式:
@Autowired
privateCountrycountry;实际上不需要这么做(后面会给出需要这样做的场景),直接调用country()方法返回的是同一个实例。
下面看调用country()和userInfo()方法时的逻辑。
现在我们已经知道@Configuration注解的类是如何被处理的了,现在关注上面的BeanMethodInterceptor,看看带有@Bean注解的方法执行的逻辑。下面分解来看intercept方法。
//首先通过反射从增强的Configuration注解类中获取beanFactory ConfigurableBeanFactorybeanFactory=getBeanFactory(enhancedConfigInstance); //然后通过方法获取beanName,默认为方法名,可以通过@Bean注解指定 StringbeanName=BeanAnnotationHelper.determineBeanNameFor(beanMethod); //确定这个bean是否指定了代理的范围 //默认下面if条件false不会执行 Scopescope=AnnotatedElementUtils.findMergedAnnotation(beanMethod,Scope.class); if(scope!=null&&scope.proxyMode()!=ScopedProxyMode.NO){ StringscopedBeanName=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( "@Beanmethod%s.%sisnon-staticandreturnsanobject"+ "assignabletoSpring'sBeanFactoryPostProcessorinterface.Thiswill"+ "resultinafailuretoprocessannotationssuchas@Autowired,"+ "@Resourceand@PostConstructwithinthemethod'sdeclaring"+ "@Configurationclass.Addthe'static'modifiertothismethodtoavoid"+ "thesecontainerlifecycleissues;see@Beanjavadocforcompletedetails.", beanMethod.getDeclaringClass().getSimpleName(),beanMethod.getName())); } //直接调用原方法创建bean returncglibMethodProxy.invokeSuper(enhancedConfigInstance,beanMethodArgs); } //如果不满足上面if,也就是在userInfo()中调用的country()方法 returnobtainBeanInstanceFromFactory(beanMethod,beanMethodArgs,beanFactory,beanName);
关于isCurrentlyInvokedFactoryMethod方法
可以参考SimpleInstantiationStrategy中的instantiate方法,这里先设置的调用方法:
currentlyInvokedFactoryMethod.set(factoryMethod); returnfactoryMethod.invoke(factoryBean,args);
而通过方法内部直接调用country()方法时,不走上面的逻辑,直接进的代理方法,也就是当前的intercept方法,因此当前的工厂方法和执行的方法就不相同了。
obtainBeanInstanceFromFactory方法比较简单,就是通过beanFactory.getBean获取Country,如果已经创建了就会直接返回,如果没有执行过,就会通过invokeSuper首次执行。
因此我们在@Configuration注解定义的bean方法中可以直接调用方法,不需要@Autowired注入后使用。
@Component注意
@Component注解并没有通过cglib来代理@Bean方法的调用,因此像下面这样配置时,就是两个不同的country。
@Component publicclassMyBeanConfig{ @Bean publicCountrycountry(){ returnnewCountry(); } @Bean publicUserInfouserInfo(){ returnnewUserInfo(country()); } }
有些特殊情况下,我们不希望MyBeanConfig被代理(代理后会变成WebMvcConfig$$EnhancerBySpringCGLIB$$8bef3235293)时,就得用@Component,这种情况下,上面的写法就需要改成下面这样:
@Component publicclassMyBeanConfig{ @Autowired privateCountrycountry; @Bean publicCountrycountry(){ returnnewCountry(); } @Bean publicUserInfouserInfo(){ returnnewUserInfo(country); } }
这种方式可以保证使用的同一个Country实例。
总结
以上就是这篇文章的全部内容了,希望本文的内容对大家的学习或者工作具有一定的参考学习价值,谢谢大家对毛票票的支持。如果你想了解更多相关内容请查看下面相关链接