Mybatis的Mapper中的方法為什麼不能過載？

愛撒謊的男孩發表於2020-09-15
MyBatisAPP

目錄

  • 前言
  • 環境配置
  • 錯誤示範
  • 為什麼不能過載？
  • 如何找到XML中對應的SQL？
  • 總結

前言

  • 在初入門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_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 value for cn.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]
 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的全類名+'.'+方法名。
  • 如果覺得作者寫的不錯，有所收穫的話，點點關注，分享一波，關注微信公眾號碼猿技術專欄第一手文章推送！！！

相關文章