前言

在初入門(mén)Mybatis的時(shí)候可能都犯過(guò)一個(gè)錯(cuò)誤，那就是在寫(xiě)Mapper接口的時(shí)候都重載過(guò)其中的方法，但是運(yùn)行起來(lái)總是報(bào)錯(cuò)，那時(shí)候真的挺郁悶的，但是自己也查不出來(lái)原因，只能默默的改了方法名，哈哈，多么卑微的操作。

今天就寫(xiě)一篇文章從源碼角度為大家解惑為什么Mybatis中的方法不能重載？

環(huán)境配置

本篇文章講的一切內(nèi)容都是基于Mybatis3.5和SpringBoot-2.3.3.RELEASE。

錯(cuò)誤示范

舉個(gè)栗子：假設(shè)現(xiàn)在有兩個(gè)需求，一個(gè)是根據(jù)用戶(hù)的id篩選用戶(hù)，一個(gè)是根據(jù)用戶(hù)的性別篩選，此時(shí)在Mapper中重載的方法如下：

public interface UserMapper { List<UserInfo> selectList(@Param('userIds') List<String> userIds); List<UserInfo> selectList(Integer gender); }

這個(gè)并沒(méi)有什么錯(cuò)誤，但是啟動(dòng)項(xiàng)目，報(bào)出如下的錯(cuò)誤：

Caused by: org.springframework.beans.factory.BeanCreationException: Error creating bean with name ’sqlSessionFactory’ defined in class path resource [org/mybatis/spring/boot/autoconfigure/MybatisAutoConfiguration.class]: Bean instantiation via factory method failed; 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_projectdemotargetclassesmapperUserInfoMapper.xml]’; nested exception is org.apache.ibatis.builder.BuilderException: Error parsing Mapper XML. The XML location is ’file [H:work_projectdemotargetclassesmapperUserInfoMapper.xml]’. Cause: java.lang.IllegalArgumentException: Mapped Statements collection already contains value for cn.cb.demo.dao.UserMapper.selectList. please check file [H:work_projectdemotargetclassesmapperUserInfoMapper.xml] and file [H:work_projectdemotargetclassesmapperUserInfoMapper.xml]at org.springframework.beans.factory.support.ConstructorResolver.instantiate(ConstructorResolver.java:655)at org.springframework.beans.factory.support.ConstructorResolver.instantiateUsingFactoryMethod(ConstructorResolver.java:635)at org.springframework.beans.factory.support.AbstractAutowireCapableBeanFactory.instantiateUsingFactoryMethod(AbstractAutowireCapableBeanFactory.java:1336)at org.springframework.beans.factory.support.AbstractAutowireCapableBeanFactory.createBeanInstance(AbstractAutowireCapableBeanFactory.java:1176)at org.springframework.beans.factory.support.AbstractAutowireCapableBeanFactory.doCreateBean(AbstractAutowireCapableBeanFactory.java:556)at org.springframework.beans.factory.support.AbstractAutowireCapableBeanFactory.createBean(AbstractAutowireCapableBeanFactory.java:516)at org.springframework.beans.factory.support.AbstractBeanFactory.lambda$doGetBean$0(AbstractBeanFactory.java:324)at org.springframework.beans.factory.support.DefaultSingletonBeanRegistry.getSingleton(DefaultSingletonBeanRegistry.java:226)at org.springframework.beans.factory.support.AbstractBeanFactory.doGetBean(AbstractBeanFactory.java:322)at org.springframework.beans.factory.support.AbstractBeanFactory.getBean(AbstractBeanFactory.java:202)at org.springframework.beans.factory.config.DependencyDescriptor.resolveCandidate(DependencyDescriptor.java:276)at org.springframework.beans.factory.support.DefaultListableBeanFactory.doResolveDependency(DefaultListableBeanFactory.java:1307)at org.springframework.beans.factory.support.DefaultListableBeanFactory.resolveDependency(DefaultListableBeanFactory.java:1227)at org.springframework.beans.factory.support.AbstractAutowireCapableBeanFactory.autowireByType(AbstractAutowireCapableBeanFactory.java:1509)... 81 more

這么一大串什么意思？懵逼了~

大致的意思：cn.cb.demo.dao.UserMapper.selectList這個(gè)id已經(jīng)存在了，導(dǎo)致創(chuàng)建sqlSessionFactory失敗。

為什么不能重載？

通過(guò)上面的異常提示可以知道創(chuàng)建sqlSessionFactory失敗了，這個(gè)想必已經(jīng)不陌生吧，顧名思義，就是創(chuàng)建SqlSession的工廠(chǎng)。 Springboot與Mybatis會(huì)有一個(gè)啟動(dòng)器的自動(dòng)配置類(lèi)MybatisAutoConfiguration，其中有一段代碼就是創(chuàng)建sqlSessionFactory，如下圖：

既然是創(chuàng)建失敗，那么肯定是這里出現(xiàn)異常了，這里的「大致思路」就是：

解析XML文件和Mapper接口，將Mapper中的方法與XML文件中<select>、<insert>等標(biāo)簽一一對(duì)應(yīng)，那么Mapper中的方法如何與XML中<select>這些標(biāo)簽對(duì)應(yīng)了，當(dāng)然是唯一的id對(duì)應(yīng)了，具體如何這個(gè)id的值是什么，如何對(duì)應(yīng)？下面一一講解。

如上圖的SqlSessionFactory的創(chuàng)建過(guò)程中，前面的部分代碼都是設(shè)置一些配置，并沒(méi)有涉及到解析XML的內(nèi)容，因此答案肯定是在最后一行return factory.getObject();，于是此處打上斷點(diǎn)，一點(diǎn)點(diǎn)看。于是一直到了org.mybatis.spring.SqlSessionFactoryBean#buildSqlSessionFactory這個(gè)方法中，其中一段代碼如下：

這里的xmlMapperBuilder.parse();就是解析XML文件與Mapper接口，繼續(xù)向下看。

略過(guò)不重要的代碼，在org.apache.ibatis.builder.xml.XMLMapperBuilder#configurationElement這個(gè)方法中有一行重要的代碼，如下圖：

此處就是根據(jù)XML文件中的select|insert|update|delete這些標(biāo)簽開(kāi)始構(gòu)建MappedStatement了。繼續(xù)跟進(jìn)去看。

略過(guò)不重要的代碼，此時(shí)看到org.apache.ibatis.builder.MapperBuilderAssistant#addMappedStatement這個(gè)方法返回值就是MappedStatement，不用多說(shuō)，肯定是這個(gè)方法了，仔細(xì)一看，很清楚的看到了構(gòu)建id的代碼，如下圖：

從上圖可以知道，創(chuàng)建id的代碼就是id = applyCurrentNamespace(id, false);，具體實(shí)現(xiàn)如下圖：

上圖的代碼已經(jīng)很清楚了，MappedStatement中的id=Mapper的全類(lèi)名+’.’+方法名。如果重載話(huà)，肯定會(huì)存在id相同的MappedStatement。

到了這其實(shí)并不能說(shuō)明方法不能重載啊，重復(fù)就重復(fù)唄，并沒(méi)有沖突啊。這里需要看一個(gè)結(jié)構(gòu)，如下：

protected final Map<String, MappedStatement> mappedStatements = new StrictMap<MappedStatement>('Mapped Statements collection') .conflictMessageProducer((savedValue, targetValue) -> '. please check ' + savedValue.getResource() + ' and ' + targetValue.getResource());

構(gòu)建好的MappedStatement都會(huì)存入mappedStatements中，如下代碼：

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

StrictMap的put(k,v)方法如下圖：

到了這里應(yīng)該理解了吧，這下拋出的異常和上面的異常信息對(duì)應(yīng)起來(lái)了吧。這個(gè)StrictMap不允許有重復(fù)的key，而存入的key就是id。因此Mapper中的方法不能重載。

如何找到XML中對(duì)應(yīng)的SQL？

在使用Mybatis的時(shí)候只是簡(jiǎn)單的調(diào)用Mapper中的方法就可以執(zhí)行SQL，如下代碼：

List<UserInfo> userInfos = userMapper.selectList(Arrays.asList('192','198'));

一行簡(jiǎn)單的調(diào)用到底如何找到對(duì)應(yīng)的SQL呢？其實(shí)就是根據(jù)id從Map<String, MappedStatement> mappedStatements中查找對(duì)應(yīng)的MappedStatement。

在org.apache.ibatis.session.defaults.DefaultSqlSession#selectList方法有這一行代碼如下圖：

MappedStatement

ms = configuration.getMappedStatement(statement);這行代碼就是根據(jù)id從mappedStatements獲取對(duì)應(yīng)的MappedStatement，源碼如下:

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

總結(jié)

文章寫(xiě)到這，想必已經(jīng)很清楚Mapper中的方法為什么不能重載了，歸根到底就是因?yàn)檫@個(gè)這個(gè)id=Mapper的全類(lèi)名+’.’+方法名。

到此這篇關(guān)于Mybatis的Mapper中的方法為什么不能重載的文章就介紹到這了,更多相關(guān)Mybatis Mapper重載內(nèi)容請(qǐng)搜索好吧啦網(wǎng)以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持好吧啦網(wǎng)！