mybatis源码-@Mapper @MapperScan配置及注入原理

在项目中大多数用的都是@MapperScan注解,指定basePackages,扫描mybatis Mapper接口类,另外一种方式是用@Mapper注解,其实这两种方法扫描配置用的是一个地方,只是扫描入口不同。

@MapperScan是根据其注解上MapperScannerRegistrar进行自动配置的,最终调用的自动配置代码和下面的代码一致

@Mapper自动配置的程序入口是 MybatisAutoConfiguration类的最下面,位置在mybatis-spring-boot-starter包下面的mybatis-spring-boot-autoconfigure,根据名字可以看出,这个是自动配置,这个地方用到了spring-boot的自动配置相关注解

1 全局配置入口

上面代码的逻辑是 如果标注了@MapperScan 的注解,将会生成 MapperFactoryBean, 如果没有标注@MapperScan 也就是没有MapperFactoryBean的实例,就走@Import里面的配置,下面看看AutoConfiguredMapperScannerRegistrar的配置,它是MybatisAutoConfiguration类下的内部类

2 标记有 @mapper注解的类 扫描配置

上面的代码的逻辑就是初始化ClassPathMapperScanner扫描器,这个扫描器继承了spirng的ClassPathBeanDefinitionScanner的主要作用就是扫描Mapper接口类进行配置并注册为spring bean,首先看看核心的doScan()方法,@MapperScan注解的自动配置也是用了这个注解,这个方法做了什么,也是贴图如下:


3  ClassPathMapperScanner类红的核心方法 doScan()

这个类主要就是调用父类ClassPathBeanDefinitionScanner中的doScan()方法,获取所有的类定义,之后添加自己的逻辑:processBeanDefinitions()

下面看看processBeanDefinitions()方法主要做了什么,也是贴出核心代码

4 ClassPathMapperScanner类中处理类定义的核心方法processBeanDefinitions()

注意上面涂黄的代码,这个方法主要做的事情就是重新设置上面扫描出的BeanDefinition,设置构造器的参数,构造器的参数为标注了@Mapper的类的class,

做的事情其实是重写BeanDefinition的BeanClass字段为MapperFactoryBean.class,并且将beanClass其实也就是MapperFactoryBean的构造器参数设置为实际的标注了@Mapper的接口,之后当Mapper接口注入的时候,实际调用的是MapperFactoryBean中的getObject()获取特定的mapper实例

如下是MapperFactoryBean的核心逻辑,mapperInterface字段是通过上面的 

definition.getConstructorArgumentValues().addGenericArgumentValue(definition.getBeanClassName());这段代码注入的


5 MapperFactoryBean的核心代码

可见这个类实现了FactoryBean的接口(自由拓展注入的类),以及继承了SqlSessionDaoSupport,继承SqlSessionDaoSupport的主要目的是为了获取SqlSession,通过SqlSession获取具体的mapper代理类(这个也是核心方法),

综上所述,首先根据标注的@MapperScan 获取basePackage或者根据@Mapper获取所在packages,之后通过 ClassPathMapperScanner去扫描包,获取所有Mapper接口类的BeanDefinition,之后具体配置,设置beanClass为MapperFactoryBean,设置MapperFactoryBean的构造器参数为实际的Mapper接口类,通过ClassPathBeanDefinitionScanner父类进行bean注册,自动注入的时候,就会调用MapperFactoryBean的getObject方法获取实际类型的实例。

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

推荐阅读更多精彩内容