factorybean 声明_Spring之FactoryBean接口实例化神器

Java编程规范中声明,Java接口类是不能直接实例化的,但是我们在平时的开发中经常会遇到只声明接口就可以直接使用的。

eg:

Mybatis中只用使用@MapperScan声明要扫描的Mapper接口类就可以直接从Spring中获取使用,进行操作数据库

Dubbo中只要用Dubbo提供的@Service注解,同样可以直接从Spring中获取使用进行远程调用。

那么以上这些功能在Spring中是如何实现的呢?

由此就引出本篇主要介绍的接口FactoryBean

public interface FactoryBean {

@Nullable

T getObject() throws Exception;

@Nullable

Class> getObjectType();

default boolean isSingleton() {

return true;

}

}

在Spring中当发现一个Bean的类型是FactoryBean,此时实例化时候就会执行,该对象的getObject()方法从而来进行实例化。那么如何获取真实FactoryBean呢?只需要在实例化的Bean的name前面加&符号才是获取真正FactoryBean的实例对象。

Java编程规范中声明,Java接口类是不能直接实例化的,Spring实现接口的实例化操作,本质上只是调用FactoryBean的getObject()方法,而真正的实例化操作,还是有开发者来实现的。以我们常见的使用框架为例。MyBatis and Dubbo

MyBatis中实现FactoryBean的类MapperFactoryBean

Dubbo中实现FactoryBean的类ReferenceBean

在此我们以MyBatis为例,讲述MyBatis是如何实现FactoryBean来实现接口实例化操作的。

对Spring的源码有研究的同学知道,在Spring中Bean的读取会生成BeanDefinition对象,实例化实际就是找到Bean对象的BeanDefinition对象,然后根据

BeanDefinition信息来实例的。那么在这里我们首先要看下MyBatis是如何为接口生成BeanDefinition对象的吧。

我们一起看下ImportBeanDefinitionRegistrar接口。ImportBeanDefinitionRegistrar接口就是允许开发者来根据开发者的规则来生成BeanDefinition的并注册到BeanDefinitionRegistry中。因为Spring默认是根据自己的规则去生成BeanDefinition的，但是这里也提供了一个切口,供开发者使用。

public interface ImportBeanDefinitionRegistrar {

public void registerBeanDefinitions(

AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry);

}

MyBatis中MapperScannerRegistrar实现了ImportBeanDefinitionRegistrar。扫描Mapper接口所在的包,为每个接口生成特定的BeanDefinition

MapperScannerRegistrar

public void registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry) {

//扫描Mapper接口所在的包

AnnotationAttributes annoAttrs = AnnotationAttributes.fromMap(importingClassMetadata.getAnnotationAttributes(MapperScan.class.getName()));

ClassPathMapperScanner scanner = new ClassPathMapperScanner(registry);

....

//为每个接口生成特定的BeanDefinition

scanner.doScan(StringUtils.toStringArray(basePackages));

}

ClassPathMapperScanner

在doScan方法为每个标记的Mapper接口生成一个BeanName。而实例化工厂都指定为MapperFactoryBean。只用调用其getObject()方法即可完成接口的实例化。

public Set doScan(String... basePackages) {

Set beanDefinitions = super.doScan(basePackages);

if (beanDefinitions.isEmpty()) {

logger.warn("No MyBatis mapper was found in '" + Arrays.toString(basePackages) + "' package. Please check your configuration.");

} else {

//开始配置自己的规则

processBeanDefinitions(beanDefinitions);

}

return beanDefinitions;

}

private void processBeanDefinitions(Set beanDefinitions) {

GenericBeanDefinition definition;

for (BeanDefinitionHolder holder : beanDefinitions) {

definition = (GenericBeanDefinition) holder.getBeanDefinition();

//设置每个Bean的工厂类，MapperFactoryBean

definition.setBeanClass(this.mapperFactoryBean.getClass());

...

}

}

}

我们举一个例子

@Mapper

public interface TUserMapper {

int insert(TUser record);

List selectAll();

TUser selectOne(@Param("id") Integer id);

TUser selectByName(@Param("name") String name);

}

这里BeanDefinition的名字就是TUserMapper，而工厂方法就是MapperFactoryBean。如下伪代码,getBean(“TUserMapper”),就是调用MapperFactoryBean.getObject(),而getBean("&TUserMapper")才是获取MapperFactoryBean的实例。

@Test

public void factoryBeanTest(){

System.out.println(applicationContextTools.getApp().getBean("&TUserMapper"));

//org.mybatis.spring.mapper.MapperFactoryBean@3ab6678b

}

我们如何定制自己的解析的注解呢?

编写一个类似于MapperScan的注解类,MyMapperScan。

注意: 自定义的注解只能声明在配置类上才有效，配置类就是一定要被@Configuration修饰。

@Retention(RetentionPolicy.RUNTIME)

@Target(ElementType.TYPE)

@Documented

@Import(MyMapperScannerRegistrar.class)

public @interface MyMapperScan {

String value();

}

public class MyMapperScannerRegistrar implements ImportBeanDefinitionRegistrar {

@Override

public void registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry) {

AnnotationAttributes annoAttrs = AnnotationAttributes.fromMap(importingClassMetadata.getAnnotationAttributes(MyMapperScan.class.getName()));

String value = annoAttrs.getString("value");

System.out.println(value);

System.out.println("配置类:"+importingClassMetadata.getClassName());

}

}

验证

@Configuration

@MyMapperScan(value = "ConfigBean")

public class ConfigBean {

}

@SpringBootApplication //被@Configuration修饰就等同于配置类

@MyMapperScan(value = "test")

@MapperScan(value = "orm.example.dal.mapper")

public class LxchinesszzMybatisStudyApplication {

public static void main(String[] args) {

new SpringApplicationBuilder().web(WebApplicationType.NONE).run(args);

}

}

ConfigBean

配置类:orm.example.ConfigBean

test

配置类:orm.example.LxchinesszzMybatisStudyApplication