Mybatis的Mapper中的方法為什么不能重載
前言
在初入門Mybatis的時候可能都犯過一個錯誤，那就是在寫Mapper接口的時候都重載過其中的方法，但是運行起來總是報錯，那時候真的挺郁悶的，但是自己也查不出來原因，只能默默的改了方法名，哈哈，多么卑微的操作。
今天就寫一篇文章從源碼角度為大家解惑為什么Mybatis中的方法不能重載？
環境配置
本篇文章講的一切內容都是基于Mybatis3.5和SpringBoot-2.3.3.RELEASE。
錯誤示范
舉個栗子：假設現在有兩個需求，一個是根據用戶的id篩選用戶，一個是根據用戶的性別篩選，此時在Mapper中重載的方法如下：
public interface UserMapper { List<UserInfo> selectList(@Param('userIds') List<String> userIds); List<UserInfo> selectList(Integer gender); }
這個并沒有什么錯誤，但是啟動項目，報出如下的錯誤：
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這個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。
到了這其實并不能說明方法不能重載啊，重復就重復唄，并沒有沖突啊。這里需要看一個結構，如下：
protected final Map<String, MappedStatement> mappedStatements = new StrictMap<MappedStatement>('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<UserInfo> 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) { return this.getMappedStatement(id, true); }
總結
文章寫到這，想必已經很清楚Mapper中的方法為什么不能重載了，歸根到底就是因為這個這個id=Mapper的全類名+’.’+方法名。
到此這篇關于Mybatis的Mapper中的方法為什么不能重載的文章就介紹到這了,更多相關Mybatis Mapper重載內容請搜索好吧啦網以前的文章或繼續瀏覽下面的相關文章希望大家以后多多支持好吧啦網！
相關文章：
網公網安備