Mybatis的Mapper中的方法为什么不能重载?

在初入门Mybatis的时候可能都犯过一个错误,那就是在写Mapper接口的时候都重载过其中的方法,但是运行起来总是报错,那时候真的挺郁闷的,但是自己也查不出来原因,只能默默的改了方法名,哈哈,多么卑微的操作。

今天就写一篇文章从源码角度为大家解惑为什么Mybatis中的方法不能重载?

环境配置

本篇文章讲的一切内容都是基于Mybatis3.5和SpringBoot-2.3.3.RELEASE。

错误示范

举个栗子:假设现在有两个需求,一个是根据用户的id筛选用户,一个是根据用户的性别筛选,此时在Mapper中重载的方法如下:

publicinterface UserMapper {ListselectList(@Param("userIds")List userIds);ListselectList(Integer gender);}

这个并没有什么错误,但是启动项目,报出如下的错误:

Caused by: org.springframework.beans.factory.BeanCreationException: Error creating bean with name'sqlSessionFactory'definedinclasspathresource[org/mybatis/spring/boot/autoconfigure/MybatisAutoConfiguration.class]:Beaninstantiationviafactorymethodfailed; nested exception is org.springframework.beans.BeanInstantiationException: Failed to instantiate [org.apache.ibatis.session.SqlSessionFactory]: Factory method'sqlSessionFactory'threw exception; nested exception is org.springframework.core.NestedIOException: Failed to parse mapping resource:'file [H:\work_project\demo\target\classes\mapper\UserInfoMapper.xml]'; nested exception is org.apache.ibatis.builder.BuilderException: Error parsing Mapper XML. The XML location is'file [H:\work_project\demo\target\classes\mapper\UserInfoMapper.xml]'. Cause: java.lang.IllegalArgumentException: Mapped Statements collection already contains valueforcn.cb.demo.dao.UserMapper.selectList. please check file [H:\work_project\demo\target\classes\mapper\UserInfoMapper.xml] and file [H:\work_project\demo\target\classes\mapper\UserInfoMapper.xml]atorg.springframework.beans.factory.support.ConstructorResolver.instantiate(ConstructorResolver.java:655)atorg.springframework.beans.factory.support.ConstructorResolver.instantiateUsingFactoryMethod(ConstructorResolver.java:635)atorg.springframework.beans.factory.support.AbstractAutowireCapableBeanFactory.instantiateUsingFactoryMethod(AbstractAutowireCapableBeanFactory.java:1336)atorg.springframework.beans.factory.support.AbstractAutowireCapableBeanFactory.createBeanInstance(AbstractAutowireCapableBeanFactory.java:1176)atorg.springframework.beans.factory.support.AbstractAutowireCapableBeanFactory.doCreateBean(AbstractAutowireCapableBeanFactory.java:556)atorg.springframework.beans.factory.support.AbstractAutowireCapableBeanFactory.createBean(AbstractAutowireCapableBeanFactory.java:516)atorg.springframework.beans.factory.support.AbstractBeanFactory.lambda$doGetBean$0(AbstractBeanFactory.java:324)atorg.springframework.beans.factory.support.DefaultSingletonBeanRegistry.getSingleton(DefaultSingletonBeanRegistry.java:226)atorg.springframework.beans.factory.support.AbstractBeanFactory.doGetBean(AbstractBeanFactory.java:322)atorg.springframework.beans.factory.support.AbstractBeanFactory.getBean(AbstractBeanFactory.java:202)atorg.springframework.beans.factory.config.DependencyDescriptor.resolveCandidate(DependencyDescriptor.java:276)atorg.springframework.beans.factory.support.DefaultListableBeanFactory.doResolveDependency(DefaultListableBeanFactory.java:1307)atorg.springframework.beans.factory.support.DefaultListableBeanFactory.resolveDependency(DefaultListableBeanFactory.java:1227)atorg.springframework.beans.factory.support.AbstractAutowireCapableBeanFactory.autowireByType(AbstractAutowireCapableBeanFactory.java:1509)...81more

这么一大串什么意思?懵逼了~

大致的意思:cn.cb.demo.dao.UserMapper.selectList这个id已经存在了,导致创建sqlSessionFactory失败。

为什么不能重载?

通过上面的异常提示可以知道创建sqlSessionFactory失败了,这个想必已经不陌生吧,顾名思义,就是创建SqlSession的工厂。

Springboot与Mybatis会有一个启动器的自动配置类MybatisAutoConfiguration,其中有一段代码就是创建sqlSessionFactory,如下图:

既然是创建失败,那么肯定是这里出现异常了,这里的「大致思路」就是:

解析XML文件和Mapper接口,将Mapper中的方法与XML文件中<select>、<insert>等标签一一对应,那么Mapper中的方法如何与XML中<select>这些标签对应了,当然是唯一的id对应了,具体如何这个id的值是什么,如何对应?下面一一讲解。

如上图的SqlSessionFactory的创建过程中,前面的部分代码都是设置一些配置,并没有涉及到解析XML的内容,因此答案肯定是在最后一行return factory.getObject();,于是此处打上断点,一点点看。于是一直到了org.mybatis.spring.SqlSessionFactoryBean#buildSqlSessionFactory这个方法中,其中一段代码如下:

这里的xmlMapperBuilder.parse();就是解析XML文件与Mapper接口,继续向下看。

略过不重要的代码,在org.apache.ibatis.builder.xml.XMLMapperBuilder#configurationElement这个方法中有一行重要的代码,如下图:

此处就是根据XML文件中的select|insert|update|delete这些标签开始构建MappedStatement了。继续跟进去看。

略过不重要的代码,此时看到org.apache.ibatis.builder.MapperBuilderAssistant#addMappedStatement这个方法返回值就是MappedStatement,不用多说,肯定是这个方法了,仔细一看,很清楚的看到了构建id的代码,如下图:

从上图可以知道,创建id的代码就是id = applyCurrentNamespace(id, false);,具体实现如下图:

上图的代码已经很清楚了,MappedStatement中的id=Mapper的全类名+'.'+方法名。如果重载话,肯定会存在id相同的MappedStatement。

到了这其实并不能说明方法不能重载啊,重复就重复呗,并没有冲突啊。这里需要看一个结构,如下:

protectedfinalMap mappedStatements =newStrictMap("Mapped Statements collection").conflictMessageProducer((savedValue, targetValue)->". please check "+ savedValue.getResource() +" and "+ targetValue.getResource());

构建好的MappedStatement都会存入mappedStatements中,如下代码:

public void addMappedStatement(MappedStatement ms) {//key 是id mappedStatements.put(ms.getId(), ms);}

StrictMap的put(k,v)方法如下图:

到了这里应该理解了吧,这下抛出的异常和上面的异常信息对应起来了吧。这个StrictMap不允许有重复的key,而存入的key就是id。因此Mapper中的方法不能重载。

如何找到XML中对应的SQL?

在使用Mybatis的时候只是简单的调用Mapper中的方法就可以执行SQL,如下代码:

List userInfos = userMapper.selectList(Arrays.asList("192","198"));

一行简单的调用到底如何找到对应的SQL呢?其实就是根据id从Map<String, MappedStatement> mappedStatements中查找对应的MappedStatement。

在org.apache.ibatis.session.defaults.DefaultSqlSession#selectList方法有这一行代码如下图:

MappedStatement ms = configuration.getMappedStatement(statement);这行代码就是根据id从mappedStatements获取对应的MappedStatement,源码如下:

public MappedStatement getMappedStatement(String id) {returnthis.getMappedStatement(id,true);}

总结

文章写到这,想必已经很清楚Mapper中的方法为什么不能重载了,归根到底就是因为这个这个id=Mapper的全类名+'.'+方法名。

注:文章转自https://www.cnblogs.com/Chenjiabing/p/13671589.html

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