Spring @Configuration和@Component的區(qū)別
Spring @Configuration 和 @Component 區(qū)別
一句話概括就是 @Configuration 中所有帶 @Bean 注解的方法都會被動態(tài)代理,因此調(diào)用該方法返回的都是同一個實例。
下面看看實現(xiàn)的細節(jié)。
@Configuration 注解:
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Component
public @interface Configuration {
String value() default "";
}
從定義來看,@Configuration 注解本質(zhì)上還是@Component,因此<context:component-scan/> 或者 @ComponentScan都能處理@Configuration注解的類。
@Configuration標記的類必須符合下面的要求:
- 配置類必須以類的形式提供(不能是工廠方法返回的實例),允許通過生成子類在運行時增強(cglib 動態(tài)代理)。
- 配置類不能是 final 類(沒法動態(tài)代理)。
- 配置注解通常為了通過 @Bean 注解生成 Spring 容器管理的類,
- 配置類必須是非本地的(即不能在方法中聲明,不能是 private)。
- 任何嵌套配置類都必須聲明為static。
- @Bean 方法可能不會反過來創(chuàng)建進一步的配置類(也就是返回的 bean 如果帶有 @Configuration,也不會被特殊處理,只會作為普通的 bean)。
加載過程
Spring 容器在啟動時,會加載默認的一些PostPRocessor,其中就有ConfigurationClassPostProcessor,這個后置處理程序?qū)iT處理帶有@Configuration注解的類,這個程序會在bean 定義加載完成后,在bean初始化前進行處理。主要處理的過程就是使用cglib動態(tài)代理增強類,而且是對其中帶有@Bean注解的方法進行處理。
在ConfigurationClassPostProcessor 中的 postProcessBeanFactory 方法中調(diào)用了下面的方法:
/**
* 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);
}
}
}
在方法的第一次循環(huán)中,查找到所有帶有@Configuration注解的 bean 定義,然后在第二個 for 循環(huán)中,通過下面的方法對類進行增強:
Class<?> enhancedClass = enhancer.enhance(configClass, this.beanClassLoader);
然后使用增強后的類替換了原有的beanClass:
beanDef.setBeanClass(enhancedClass);
所以到此時,所有帶有@Configuration注解的 bean 都已經(jīng)變成了增強的類。
下面關注上面的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 代理的類在調(diào)用方法時,會通過CallbackFilter調(diào)用,這里的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匹配方法如下:
@Override
public boolean isMatch(Method candidateMethod) {
return BeanAnnotationHelper.isBeanAnnotated(candidateMethod);
}
//BeanAnnotationHelper
public static boolean isBeanAnnotated(Method method) {
return AnnotatedElementUtils.hasAnnotation(method, Bean.class);
}
也就是當方法有@Bean注解的時候,就會執(zhí)行這個回調(diào)方法。
另一個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()));
}
當前類還需要實現(xiàn)BeanFactoryAware接口,上面的isMatch就是匹配的這個接口的方法。
@Bean 注解方法執(zhí)行策略
先給一個簡單的示例代碼:
@Configuration
public class MyBeanConfig {
@Bean
public Country country(){
return new Country();
}
@Bean
public UserInfo userInfo(){
return new UserInfo(country());
}
}
相信大多數(shù)人第一次看到上面 userInfo() 中調(diào)用 country() 時,會認為這里的 Country 和上面 @Bean 方法返回的 Country 可能不是同一個對象,因此可能會通過下面的方式來替代這種方式:
@Autowired
private Country country;實際上不需要這么做(后面會給出需要這樣做的場景),直接調(diào)用 country() 方法返回的是同一個實例。
下面看調(diào)用 country() 和 userInfo() 方法時的邏輯。
現(xiàn)在我們已經(jīng)知道@Configuration注解的類是如何被處理的了,現(xiàn)在關注上面的BeanMethodInterceptor,看看帶有 @Bean注解的方法執(zhí)行的邏輯。下面分解來看intercept方法。
//首先通過反射從增強的 Configuration 注解類中獲取 beanFactory
ConfigurableBeanFactory beanFactory = getBeanFactory(enhancedConfigInstance);
//然后通過方法獲取 beanName,默認為方法名,可以通過 @Bean 注解指定
String beanName = BeanAnnotationHelper.determineBeanNameFor(beanMethod);
//確定這個 bean 是否指定了代理的范圍
//默認下面 if 條件 false 不會執(zhí)行
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 相關代碼
//判斷當前執(zhí)行的方法是否為正在執(zhí)行的 @Bean 方法
//因為存在在 userInfo() 方法中調(diào)用 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()));
}
//直接調(diào)用原方法創(chuàng)建 bean
return cglibMethodProxy.invokeSuper(enhancedConfigInstance, beanMethodArgs);
}
//如果不滿足上面 if,也就是在 userInfo() 中調(diào)用的 country() 方法
return obtainBeanInstanceFromFactory(beanMethod, beanMethodArgs, beanFactory, beanName);
關于isCurrentlyInvokedFactoryMethod方法
可以參考 SimpleInstantiationStrategy 中的 instantiate 方法,這里先設置的調(diào)用方法:
currentlyInvokedFactoryMethod.set(factoryMethod); return factoryMethod.invoke(factoryBean, args);
而通過方法內(nèi)部直接調(diào)用 country() 方法時,不走上面的邏輯,直接進的代理方法,也就是當前的 intercept方法,因此當前的工廠方法和執(zhí)行的方法就不相同了。
obtainBeanInstanceFromFactory方法比較簡單,就是通過beanFactory.getBean獲取Country,如果已經(jīng)創(chuàng)建了就會直接返回,如果沒有執(zhí)行過,就會通過invokeSuper首次執(zhí)行。
因此我們在@Configuration注解定義的 bean 方法中可以直接調(diào)用方法,不需要@Autowired注入后使用。
@Component 注意
@Component注解并沒有通過 cglib 來代理@Bean方法的調(diào)用,因此像下面這樣配置時,就是兩個不同的 country。
@Component
public class MyBeanConfig {
@Bean
public Country country(){
return new Country();
}
@Bean
public UserInfo userInfo(){
return new UserInfo(country());
}
}
有些特殊情況下,我們不希望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);
}
}
這種方式可以保證使用的同一個Country實例。
總結(jié)
以上就是這篇文章的全部內(nèi)容了,希望本文的內(nèi)容對大家的學習或者工作具有一定的參考學習價值,謝謝大家對腳本之家的支持。如果你想了解更多相關內(nèi)容請查看下面相關鏈接
- SpringBoot中@Configuration和@Bean和@Component相同點詳解
- Spring解讀@Component和@Configuration的區(qū)別以及源碼分析
- Spring中@Configuration和@Component注解的區(qū)別及原理
- Spring中@Configuration注解和@Component注解的區(qū)別詳解
- 詳解Spring中@Component和@Configuration的區(qū)別
- Spring注解@Configuration和@Component區(qū)別詳解
- Spring注解中@Configuration和@Component到底有啥區(qū)別
- 揭秘Spring核心注解@Configuration與@Component的本質(zhì)區(qū)別
相關文章
SpringBoot Redis配置多數(shù)據(jù)源的項目實踐
springboot中默認的redis配置是只能對單個redis庫進行操作的, 那么我們需要多個庫操作的時候這個時候就可以采用redis多數(shù)據(jù)源 ,本文就介紹了SpringBoot Redis配置多數(shù)據(jù)源,感興趣的可以了解一下2023-07-07
SpringBoot結(jié)合mockito測試實戰(zhàn)
與集成測試將系統(tǒng)作為一個整體測試不同,單元測試更應該專注于某個類。所以當被測試類與外部類有依賴的時候,尤其是與數(shù)據(jù)庫相關的這種費時且有狀態(tài)的類,很難做單元測試。但好在可以通過“Mockito”這種仿真框架來模擬這些比較費時的類,從而專注于測試某個類內(nèi)部的邏輯2022-11-11
Idea如何關閉或開啟引用提示Usages和Annotations
這篇文章主要介紹了Idea如何關閉或開啟引用提示Usages和Annotations問題,具有很好的參考價值,希望對大家有所幫助,如有錯誤或未考慮完全的地方,望不吝賜教2024-01-01
2022年最新java?8?(?jdk1.8u321)安裝圖文教程
這篇文章主要介紹了2022年最新java?8?(?jdk1.8u321)安裝圖文教程,截止2022年1月,官方出的jdk1.8目前已更新到8u321的版本,本文通過圖文并茂的形式給大家介紹安裝過程,需要的朋友可以參考下2022-08-08
Nacos docker單機模式部署實現(xiàn)過程詳解
這篇文章主要介紹了Nacos docker單機模式部署實現(xiàn)過程詳解,文中通過示例代碼介紹的非常詳細,對大家的學習或者工作具有一定的參考學習價值,需要的朋友可以參考下2020-09-09

