zl程序教程

您现在的位置是:首页 >  Java

当前栏目

Java工程师必须搞明白:BeanFactory与FactoryBean是个啥?

2023-04-18 14:15:57 时间

1.前提概要

很多java开发者在使用Spring框架中都见过后缀为FactoryBean的类,比如Mybatis-Spring中的SqlSessionFactoryBean。说到这里就不得不提BeanFactory。FactoryBean和BeanFactory特别容易让人混淆,面试还经常问到这两种概念。其实它们的作用和使用场景是不一样的

2.BeanFactory

先来说说BeanFactory。 用于访问Spring bean容器的根接口。这是Spring bean容器的基本客户端视图。原来是获取Spring Bean的接口,也就是IoC容器。然后我们看类图

Java工程师必须搞明白:BeanFactory与FactoryBean是个啥?

原来我们更常用的ApplicationContext就是一个BeanFactory。我们通过bean的名称或者类型都可以从BeanFactory来获取bean。对于BeanFactory这么介绍相信都不陌生了。让我们把关注点转向FactoryBean上。

3.FactoryBean

FactoryBean 是个什么玩意儿呢?来看看源码

  1. public interface FactoryBean<T> { 
  2.  @Nullable 
  3.  T getObject() throws Exception; 
  4.   
  5.  @Nullable 
  6.  Class<?> getObjectType(); 
  7.   
  8.  default boolean isSingleton() { 
  9.  return true
  10.  } 
  11.  } 
  • 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时间表达式
  1. public class CustomTask implements Task { 
  2.  private SomeService someService; 
  3.  private String cronExpression; 
  4.  public CustomTask(SomeService someService) { 
  5.  this.someService = someService; 
  6.  } 
  7.  @Override 
  8.  public void execute() { 
  9.  //do something 
  10.  someService.doTask(); 
  11.  } 
  12.  @Override 
  13.  public void setCron(String cronExpression) { 
  14.  this.cronExpression = cronExpression; 
  15.  } 
  16.  @Override 
  17.  public String getCron() { 
  18.  return cronExpression; 
  19.  } 

通过以上的定义。任务的时间和任务的逻辑可以根据不同的业务做到差异化配置。然后我们实现一个关于Task的FactoryBean。

  1. public class TaskFactoryBean implements FactoryBean<Task> { 
  2.  private SomeService someService; 
  3.  private String cronExpression; 
  4.  @Override 
  5.  public Task getObject() throws Exception { 
  6.  CustomTask customTask = new CustomTask(someService); 
  7.  customTask.setCron(cronExpression); 
  8.  return customTask; 
  9.  } 
  10.  @Override 
  11.  public Class<?> getObjectType() { 
  12.  return CustomTask.class; 
  13.  } 
  14.  @Override 
  15.  public boolean isSingleton() { 
  16.  return true
  17.  } 
  18.  public SomeService getSomeService() { 
  19.  return someService; 
  20.  } 
  21.  public void setSomeService(SomeService someService) { 
  22.  this.someService = someService; 
  23.  } 
  24.  public String getCronExpression() { 
  25.  return cronExpression; 
  26.  } 
  27.  public void setCronExpression(String cronExpression) { 
  28.  this.cronExpression = cronExpression; 
  29.  } 

3.3 FactoryBean 注入IoC

你可以使用xml的注入方式,当然也可以使用javaConfig的配置方式。这里我们使用javaConfig注入。我们将两个FactroyBean注入到Spring容器中去。

  1. @Configuration 
  2. public class Config { 
  3.  @Bean 
  4.  public TaskFactoryBean customTask() { 
  5.  TaskFactoryBean taskFactoryBean = new TaskFactoryBean(); 
  6.  taskFactoryBean.setCronExpression("0 15 10 * * ?"); 
  7.  String word = "定时任务一"
  8.  SomeService someService = new SomeService(); 
  9.  someService.setWord(word); 
  10.  taskFactoryBean.setSomeService(someService); 
  11.  return taskFactoryBean; 
  12.  } 
  13.  @Bean 
  14.  public TaskFactoryBean otherTask() { 
  15.  TaskFactoryBean taskFactoryBean = new TaskFactoryBean(); 
  16.  taskFactoryBean.setCronExpression("0 15 17 * * ?"); 
  17.  String word = "定时任务二"
  18.  SomeService someService = new SomeService(); 
  19.  someService.setWord(word); 
  20.  taskFactoryBean.setSomeService(someService); 
  21.  return taskFactoryBean; 
  22.  } 

3.4 FactoryBean的一些特点

一般如上声明后,@Bean注解如果不显式声明bean名称则方法名作为bean的名称,而且返回值作为注入的Bean。但是我们通过debug发现却是这样的:

Java工程师必须搞明白:BeanFactory与FactoryBean是个啥?

也就是说通过方法名是返回FactoryBean 创建的Bean。那么如何返回该FactoryBean呢?上图中也给出了答案在方法前增加引用符“&”。具体的原因还用从BeanFactory中寻找,真是不是冤家不聚头

Java工程师必须搞明白:BeanFactory与FactoryBean是个啥?

我们对上面声明的两个bean进行测试,也出色地完成了不同的定时任务业务逻辑。

  1. @Autowired 
  2.  private Task customTask; 
  3.  @Autowired 
  4.  private Task otherTask; 
  5.  @Test 
  6.  public void task() { 
  7.  customTask.execute(); 
  8.  otherTask.execute(); 
  9.  } 

4. 总结

在后续的使用中你可以通过声明不同的cron表达式,以及不同SomeService来定制更多的定时任务。通过这个例子相信你会对FactoryBean有的清晰的认识。demo就不提供了,非常简单,强烈建议你自己试一试以加深理解。