MyBatis 学习记录7 一个Bug引发的思考

主题

　　这次学习MyBatis的主题我想记录一个使用起来可能会遇到,但是没有经验的话很不好解决的BUG,在特定情况下很容易发生.

异常

java.lang.IllegalArgumentException: Mapped Statements collection already contains value for com.xxx.package.ClassA.fun1

这个错误非常非常常见,百度一下大部分问题都能解决.这个问题90%出现的原因是一个Mapper文件中有2个节点的id相同就会出现. 只要仔细检查下id就OK了. 

可能很多问题Mybatis都会报这个错,id重复是其中之一,也是最常见的,这点上来说MyBatis的错误提示不够好.

现在我来分享一种情况也会出现这个错误,但是不是id重复的情况.

1.用MyBatis Generator自动生成Mapper和XML,并且

<javaClientGenerator targetPackage="" targetProject="" type="MIXEDMAPPER"/>

type="MIXEDMAPPER" 也就是自定生成的文件是混用注解和XML的时候有一定概率产生.

这种生成下Mapper中的select语句有注解@ResultMap, 同时resultMap是定义在XML中的.

2.因为一般项目自动生成的XML和自己手写的会分开,所以会有多个XML. 并且自己定义的XML中也有resultMap.

3.一点点运气,这个和XML加载顺序有关系,在idea没有打成jar包,也就是文件是按文件名排序的时候不会有概率问题(开发debug加载顺序是确定的),但是mapper.XML被打成jar在jar里的时候加载顺序不是按照字母顺序,(发布打成jar发布到生产上的时候看起来是乱序)的时候就有一定概率发生(不是必现错误,需要看当时XML的加载顺序)

原理

正如之前文章分享的那样,MyBatis在启动的时候会读取Mapper XML去解析生产MapperedStatement.

假设我有1个Mapper A, 对应XML1和XML2.  2个XML文件.

A.fun1方法上有@ResultMap注解,在XML2中定义对应的resultMap.

启动的时候如果先读取到了XML1这个XML. 这个时候会调用XMLMapperBuilder.parse

  public void parse() {
    if (!configuration.isResourceLoaded(resource)) {
      configurationElement(parser.evalNode("/mapper"));
      configuration.addLoadedResource(resource);
      bindMapperForNamespace();
    }

    parsePendingResultMaps();
    parsePendingCacheRefs();
    parsePendingStatements();
  }