Configuration源碼,你了解多少?
Configuration
最近看源碼時,經常看了下@Configuration(proxyBeanMethods = false)這樣的配置,但從命名上看應該是與代理有關的,于是抽個時間了解了下
proxyBeanMethods
首先這個是@Configuration注解中的一個參數,我們都知道,@Configuration是Spring中的配置類,一般用來申明Bean,在默認情況下proxyBeanMethods為true
含義
從源碼中可以看到對該參數的描述如下:
Specify whether @Bean methods should get proxied in order to enforce bean lifecycle behavior, e.g. to return shared singleton bean instances even in case of direct @Bean method calls in user code. This feature requires method interception, implemented through a runtime-generated CGLIB subclass which comes with limitations such as the configuration class and its methods not being allowed to declare final.
The default is true, allowing for 'inter-bean references' via direct method calls within the configuration class as well as for external calls to this configuration's @Bean methods, e.g. from another configuration class. If this is not needed since each of this particular configuration's @Bean methods is self-contained and designed as a plain factory method for container use, switch this flag to false in order to avoid CGLIB subclass processing.
Turning off bean method interception effectively processes @Bean methods individually like when declared on non-@Configuration classes, a.k.a. "@Bean Lite Mode" (see @Bean's javadoc). It is therefore behaviorally equivalent to removing the @Configuration stereotype.
- 該屬性的作用是指定標注了@Bean的方法在執行生命周期的時候是否應該被代理。比如在代碼中直接調用@Bean標注的方法時要返回共享的單例Bean實例(關閉代理之后不會返回共享的Bean實例)。
- 該特性是通過運行時CGLIB子類 實現的方法攔截。該子類有一些限制,比如配置類和它的方法不允許聲明為final類型。
- 默認為true,即允許 “inter-bean references” 通過配置類內部的直接方法調用,也可以通過外部調用該配置類的@Bean標注的方法。如果該配置類是一個特殊的配置類:每一個@Bean標注的方法 都是自包含的,并設計為供容器使用的普通工廠方法,可以設置該屬性為false,以避免CGLIB子類處理。
- 關閉Bean方法攔截可以高效的單獨處理@Bean方法,就像聲明在一個non-@Configuration類上一樣,@Bean Lite Mode。這種行為類似于刪除@Configuration原型。
當直接在Configuration中直接通過方法,實現實例件的屬性依賴時,IDEA會有這樣一段提示:
Method annotated with @Bean is called directly in a @Configuration where proxyBeanMethods set to false. Set proxyBeanMethods to true or use dependency injection.
示例
先通過下面的示例看下現象:
兩個配置類,寫法差不多,區別在與proxyBeanMethods的配置以及AnimalCage屬性的注入方法。
@Configuration(proxyBeanMethods = false)
public class GenericConfiguration {
@Bean
public DogCage dogCage(){
return new DogCage();
}
@Bean
public AnimalCage animalEden(){
AnimalCage animalCage = new AnimalCage();
animalCage.addCage(dogCage());
return animalCage;
}
}
@Configuration(proxyBeanMethods = true)
public class ProxyConfiguration {
@Bean
public DogCage dogCage(){
return new DogCage();
}
@Bean
public AnimalCage animalEden(@Autowired List<Cage> cages){
return new AnimalCage(cages);
}
}
先看下GenericConfiguration配置的情況:
public class Tests {
@Autowired
private BeanFactory beanFactory;
@Autowired
private GenericConfiguration genericConfiguration;
@Autowired
private AnimalCage animalCage;
@Autowired
private DogCage dogCage;
@Test
public void runConfig() {
log.info("configuration: {}", genericConfiguration); // 原始對象類型
log.info("Configuration中的Bean: {}", genericConfiguration.dogCage() == genericConfiguration.dogCage()); // 兩次結果不一樣
log.info("容器中的Bnea: {}", beanFactory.getBean(DogCage.class) == beanFactory.getBean(DogCage.class));// 從Spring容器中取值都是一樣的
animalCage.cages.forEach(cage -> {
if (cage instanceof DogCage) {
log.info("dogCage : {} ", cage == dogCage); // 和上面的對象不一致,非單例
}
});
}
}
再看下ProxyConfiguration配置的情況:
public class Tests {
@Test
public void runConfig() {
log.info("configuration: {}", proxyConfiguration); // 1、CGLIB代理的對象
log.info("Configuration中的Bean: {}", proxyConfiguration.dogCage() == proxyConfiguration.dogCage()); // 2、兩次結果相同
log.info("容器中的Bnea: {}", beanFactory.getBean(DogCage.class) == beanFactory.getBean(DogCage.class));// 3、從Spring容器中取值都是一樣的
animalCage.cages.forEach(cage -> {
if (cage instanceof DogCage) {
log.info("dogCage : {} ", cage == dogCage); // 和上面的對象不一致,非單例
}
});
}
}
會得到這樣的現象:
- proxyBeanMethods = true時,從Spring容器中取出的Configuration是一個Cglib代理配置,否則是一個原始類型配置
- proxyBeanMethods = true時,多次調用Bean方法,每次都是一個新對象,否則都是同一個對象
- 從Spring容器中取出Bean,不管多少次,都是同一個對象,也就是單例的
Lite Full Mode
看到上面的現象后,我們有必要了解下Spring配置中的Lite和Full兩種模式
lite模式包含:
- 被@Component修飾的類
- 通過@ComponentScan掃描的類
- 通過@Import導入的配置類
- 通過@ImportResource導入的Spring配置文件
- 沒有任何Spring相關注解,類里面有@Bean修飾的方法
- 被@Configuration修飾,但proxyBeanMethods = false
full模式包含:
- 被@Configuration修飾,且屬性proxyBeanMethods = true(默認)
full模式使用特性:
- full模式下的配置類會被Cglib代理生成代理類取代原始類型保存到在容器中
- full模式下的@Bean方法不能是private和final,因為方法會被重寫
- 單例scope下不同@Bean方法可以互相引用,實現單實例的語義
lite模式使用特性:
- lite模式下的配置類不生成代理,原始類型進入容器
- lite模式下的@Bean方法可以是private和final
- 單例scope下不同@Bean方法引用時無法做到單例,通過@Bean方法生成的對象都是新的實例
結束語
@Configuration(proxyBeanMethods = false)的配置其實是Lite模式,這種模式下,配置類不會生成代理類,速度會更快,但是要注意,在配置類中的@Bean方法,不能用來實現單例級別的依賴。