Spring 中的 BeanFactory 與 FactoryBean
1.前提概要
很多java開發者在使用Spring框架中都見過後綴為FactoryBean的類,比如Mybatis-Spring中的SqlSessionFactoryBean。說到這裡就不得不提BeanFactory。FactoryBean和BeanFactory特別容易讓人混淆,面試還經常問到這兩種概念。其實它們的作用和使用場景是不一樣的
2.BeanFactory
先來說說BeanFactory。 用於訪問Spring bean容器的根介面。這是Spring bean容器的基本客戶端檢視。原來是獲取Spring Bean的介面,也就是IoC容器。然後我們看類圖
原來我們更常用的ApplicationContext就是一個BeanFactory。我們通過bean的名稱或者型別都可以從BeanFactory來獲取bean。對於BeanFactory這麼介紹相信都不陌生了。讓我們把關注點轉向FactoryBean上。
3.FactoryBean
FactoryBean 是個什麼玩意兒呢?來看看原始碼
public interface FactoryBean<T> { @Nullable T getObject() throws Exception; @Nullable Class<?> getObjectType(); default boolean isSingleton() { return true; } }
- T getObject() 獲取泛型T的例項。用來建立Bean。當IoC容器通過getBean方法來FactoryBean建立的例項時實際獲取的不是FactoryBean 本身而是具體建立的T泛型例項。等下我們會來驗證這個事情。
- Class<?> getObjectType() 獲取 T getObject()中的返回值 T 的具體型別。這裡強烈建議如果T是一個介面,返回其具體實現類的型別。
- default boolean isSingleton() 用來規定 Factory建立的的bean是否是單例。這裡通過預設方法定義為單例。
3.1 FactoryBean使用場景
FactoryBean 用來建立一類bean。比如你有一些同屬鳥類的bean需要被建立,但是它們自己有各自的特點,你只需要把他們的特點注入FactoryBean中就可以生產出各種鳥類的例項。舉一個更加貼近實際生產的例子。甚至這個例子你可以應用到實際java開發中去。我們需要自己造一個定時任務的輪子。用FactoryBean 再合適不過了。我們來用程式碼說話一步步來演示FactoryBean的使用場景。
3.2 構建一個FactoryBean
我們宣告定時任務一般具有下列要素:
- 時間週期,肯定會使用到cron表示式。
- 一個任務的執行抽象介面。
- 定時任務具體行為的執行者。
Task任務執行抽象介面的實現。實現包含兩個方面:
- SomeService 是具體任務的執行邏輯。
- cron時間表達式
public class CustomTask implements Task {
private SomeService someService;
private String cronExpression;
public CustomTask(SomeService someService) {
this.someService = someService;
}
@Override
public void execute() {
//do something
someService.doTask();
}
@Override
public void setCron(String cronExpression) {
this.cronExpression = cronExpression;
}
@Override
public String getCron() {
return cronExpression;
}
}
通過以上的定義。任務的時間和任務的邏輯可以根據不同的業務做到差異化配置。然後我們實現一個關於Task的FactoryBean。
public class TaskFactoryBean implements FactoryBean<Task> {
private SomeService someService;
private String cronExpression;
@Override
public Task getObject() throws Exception {
CustomTask customTask = new CustomTask(someService);
customTask.setCron(cronExpression);
return customTask;
}
@Override
public Class<?> getObjectType() {
return CustomTask.class;
}
@Override
public boolean isSingleton() {
return true;
}
public SomeService getSomeService() {
return someService;
}
public void setSomeService(SomeService someService) {
this.someService = someService;
}
public String getCronExpression() {
return cronExpression;
}
public void setCronExpression(String cronExpression) {
this.cronExpression = cronExpression;
}
}
3.3 FactoryBean 注入IoC
你可以使用xml的注入方式,當然也可以使用javaConfig的配置方式。這裡我們使用javaConfig注入。我們將兩個FactroyBean注入到Spring容器中去。
@Configuration
public class Config {
@Bean
public TaskFactoryBean customTask() {
TaskFactoryBean taskFactoryBean = new TaskFactoryBean();
taskFactoryBean.setCronExpression("0 15 10 * * ?");
String word = "定時任務一";
SomeService someService = new SomeService();
someService.setWord(word);
taskFactoryBean.setSomeService(someService);
return taskFactoryBean;
}
@Bean
public TaskFactoryBean otherTask() {
TaskFactoryBean taskFactoryBean = new TaskFactoryBean();
taskFactoryBean.setCronExpression("0 15 17 * * ?");
String word = "定時任務二";
SomeService someService = new SomeService();
someService.setWord(word);
taskFactoryBean.setSomeService(someService);
return taskFactoryBean;
}
}
3.4 FactoryBean的一些特點
一般如上聲明後,@Bean註解如果不顯式宣告bean名稱則方法名作為bean的名稱,而且返回值作為注入的Bean。但是我們通過debug發現卻是這樣的:
也就是說通過方法名是返回FactoryBean 建立的Bean。那麼如何返回該FactoryBean呢?上圖中也給出了答案在方法前增加引用符“&”。具體的原因還用從BeanFactory中尋找,真是不是冤家不聚頭
我們對上面宣告的兩個bean進行測試,也出色地完成了不同的定時任務業務邏輯。
@Autowired
private Task customTask;
@Autowired
private Task otherTask;
@Test
public void task() {
customTask.execute();
otherTask.execute();
}
4. 總結
在後續的使用中你可以通過宣告不同的cron表示式,以及不同SomeService來定製更多的定時任務。通過這個例子相信你會對FactoryBean有的清晰的認識。demo就不提供了,非常簡單,強烈建議你自己試一試以加深理解。
關注公眾號:碼農小胖哥 獲