springboot中,mybatis的mapper接口是如何生成代理对象的?

纯mybatis获取mapper对象:

   String resource = "mybatis-config.xml";
   InputStream inputStream = Resources.getResourceAsStream(resource);
   SqlSessionFactory sqlSessionFactory = neSqlSessionFactoryBuilder().build(inputStream);
   SqlSession session = sqlSessionFactory.openSession();
   UserMapper mapper session.getMapper(UserMapper.class);
   mapper.selectAll();

Springboot集成mybatis 获取mapper对象:

- 准备工作
  1. application.properties 配置一个数据源
  2. pom引入mybatis的springboot启动器
    <dependency>
        <groupId>org.mybatis.spring.boot</groupId>
        <artifactId>mybatis-spring-boot-starter</artifctId>
        <version>2.1.3</version>
    </dependency>
  1. 启动类上使用@MapperScan注解扫描mapper接口
- 使用:直接到需要使用的bean里面即可
    @Autowired
    private UserMapper userMapper;
那么问题来了,springboot中,mybatis的mapper接口是如何生成代理对象,并注册到spring ioc容器中的

源码解析

mybatis-spring-boot-starter启动器的作用

引入了以下包


image

其中自动装配的包就是mybatis-spring-boot-autoconfigure。

mybatis-spring-boot-autoconfigure包

META-INF下有一个spring.factories文件


image

导入了这个类MybatisAutoConfiguration


image

根据springboot的spi机制,他会主动去扫描META-INF下的spring.factories中配置的EnableAutoConfiguration的子类,并将其自动装配到spring容器中,这个类的工作就是mybatis集成spring的起源了。
image

MybatisAutoConfiguration 解析

1.用@Bean的方式SqlSessionFactory,并且将我们自行创建的druid数据源作为参数传了进来
image
2.用@Bean的方式创建SqlSessionTemplate,讲将上一步注册到spring容器中的SqlSessionFactory作为参数传递进来。
image

那么是如何扫描Mapper接口的呢?

1. @Mapper注解的工作原理 : AutoConfiguredMapperScannerRegistrar
在每个Mapper接口上都打上@Mapper注解,mybatis-spring扫描到就会,如果没有配置@MapperScan,则会默认扫描与Springboot同层级的包下的@Mapper注解的接口。

注册MapperScannerConfigurer的Bean定义到Spring容器中,并设置扫描包的路径


image

MapperScannerConfigurer 实现BeanDefinitionRegistryPostProcessor接口,实例化的时候会调到postProcessBeanDefinitionRegistry方法,这个方法里会创建一个ClassPathMapperScanner对象,然后去扫描


image

扫描到之后修改BeanDefinition

image
1. @MapperScan注解的工作原理,其实和@Mapper扫描之后做的事情一样,只不过扫描的包为@MapperScan注解的basePackage的值,而且配置了@MapperScan,@Mapper将不再被支持。

@MapperScan注解,会import进来MapperScannerRegistrar这个类


image

MapperScannerRegistrar类实现ImportBeanDefinitionRegistrar接口,实例化的时候会调用registerBeanDefinitions方法

image

和@Mapper一样,同样会创建MapperScannerConfigurer的BeanDefition,用于后续实例化

image

只不过要扫描的包路径变了,不再是默认的,而是@MapperScan配置的包路径

image

后面的话则和@Mapper扫描到之后的工作原理是一样的,扫描到之后,更改BeanDefinition,一毛一样的。

==可以看出@MapperScan最主要的工作原理除了提供BasePackage的值之外,就是用@Import注解导入MapperScannerRegistrar.所以这个注解打在任何可以被spring扫描到的类上都可以,并不一定要打在启动类上(大多数为了只是为了看起来方便,把全局性的配置注解打在启动类上而已)==

2.为什么说配置了@MapperScan,@Mapper将不再被支持。

前面提到,注册扫描@Mapper接口的MapperScannerConfigurer实例的类是AutoConfiguredMapperScannerRegistrar,那么这个类是如何被导入进来的呢

MybatisAutoConfiguration还有一个静态内部类,@Import了AutoConfiguredMapperScannerRegistrar类,但是有@ConditionalOnMissingBean,即spring容器中不存在MapperFactoryBean,MapperScannerConfigurer的实例。

如果@MapperScan注解生效,并且扫描到任意一个Mapper接口(前面被改造成MapperFactoryBean类型的了),那么就不满足注册这个类MapperScannerRegistrarNotFoundConfiguration的实例的条件,继而不会导入AutoConfiguredMapperScannerRegistrar类。


image

MapperFactoryBean

前面提到,所有的Mapper接口被扫描到,封装成BeanDefinition,还经历了一次改造,

最主要的就是将mapper接口BeanDefination的beanClass改成了org.mybatis.spring.mapper.MapperFactoryBean.class
并且将mapper接口BeanDefination的名称作为构造函数的入参传入进去


image

并讲BeanDefinition的autowireMode属性改成 AUTOWIRE_BY_TYPE ,后面实例化该bean的时候会调用属性的描述器,用write的方式注入属性值,最重要的那个属性那就是SqlSessionTemplate. 会通过这种方式将前面MybatisAutoConfiguration中@Bean出来的SqlSessionTemplate注入到其中。

image
beanClass被改成MapperFactoryBean这意味着什么?

我们知道spring ioc容器初始化的时候,是循环BeanDefination的集合,然后再根据每一个BeanDefination的各项属性来实例化bean的。
最主要的一个属性肯定是beanClass,有了beanClass,就可以反射调用构造方法来实例化bean

现在所有的Mapper接口bean的Class都被设置为MapperFactoryBean,这就表示,之后所有Mapper接口的bean都会经由MapperFactoryBean类来创建,
而不是简简单单的直接实例化Mapper接口,当然那也没有任何意义,因为Mapper接口只定义了抽象方法。

看看MapperFactoryBean是如何创建Mapper实例的

类图:


image

这里他实现了FactoryBean,
FactoryBean有以下方法


image

这里是spring的一个拓展点,实现了FactoryBean接口的类,将可以实现getObject() 和getObjectType来实例化额外的一个bean并装到spring容器中

这也是面试中经常问到的关于spring的问题:FactoryBean和BeanFactory啥区别?
答:BeanFactory是一个Bean工厂。
    FactoryBean 则是一个特殊的bean,可以额外的创建出另一个bean,并替代原生的bean,原生bean的名称为 &+名称
    (实现getObject() 和getObjectType())

好吧,其实Mapper代理对象的创建就是在MapperFactoryBean的getObject方法中返回的


image

这里就是熟悉的原生Mybatis创建Mapper接口的味道了。

附上调用的类时序图,回过头来看一下调用的整体流程。

image
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 194,242评论 5 459
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 81,769评论 2 371
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 141,484评论 0 319
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 52,133评论 1 263
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 61,007评论 4 355
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 46,080评论 1 272
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 36,496评论 3 381
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 35,190评论 0 253
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 39,464评论 1 290
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 34,549评论 2 309
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 36,330评论 1 326
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,205评论 3 312
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 37,567评论 3 298
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 28,889评论 0 17
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,160评论 1 250
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 41,475评论 2 341
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 40,650评论 2 335