Mybatis报错分析：The alias ‘‘ is already mapped to the value ‘xxx‘

项目上报了个奇怪的错，关于 mybatis 的

The alias '' is already mapped to the value 'cn.cceking.blog.novel.model.dto.Article$1'

详细异常信息如下

Caused by: org.springframework.beans.factory.BeanCreationException: Error creating bean with name 'sqlSessionFactory' defined in class path resource [tk/mybatis/mapper/autoconfigure/MapperAutoConfiguration.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.apache.ibatis.type.TypeException: The alias '' is already mapped to the value 'cn.cceking.blog.novel.model.dto.Article$1'.

一般而言，这个异常的出现是存在同名类导致的，也就是包名和类名一样，这个可能在引入不同的 jar 存在同名类导致的。
但项目中的可不一样，无论我用 IDEA 怎么搜，都没发现同名类，而且重复的别名 alias 是 ‘’ 。

排查

debug 源码，异常的源头在 TypeAliasRegistry 这个类下的 registerAlias 方法，在 mybatis 初始化注册的时候存在重复的别名 “”

public void registerAlias(Class<?> type)

经过一步步 debug 排查，终于找到问题了，是实体类中的匿名类 TypeReference 导致的。
实体类中存在两个匿名类，而匿名类默认都是别名都是 “” 这个空字符串，冲突导致的。

相关代码如下（类似）

    public void getContent() throws JsonProcessingException {
        ObjectMapper objectMapper = new ObjectMapper();
        String foo1 = objectMapper.readValue(url, new TypeReference<String>() {
        });
        Integer foo2 = objectMapper.readValue(url, new TypeReference<Integer>() {
        });
    }

解决方法

声明匿名类，或者更换 mybatis-spring 版本（看了下在 2.0.2 已经修复，此处有问题的是 2.0.1）。

<dependency>
    <groupId>org.mybatis</groupId>
    <artifactId>mybatis-spring</artifactId>
    <version>2.0.2</version>
</dependency>

复现

尝试在本地复现，但发现运行时不会报异常，只是看代码看不出，那就只能看会项目了。
查看有问题的项目代码，比较引入的依赖和 jar 源码

项目中报错的调用链如下

SqlSessionFactoryBean.getObject() 
    SqlSessionFactoryBean.afterPropertiesSet()
    SqlSessionFactoryBean.buildSqlSessionFactory() 
    	SqlSessionFactoryBean.scanClasses(String packagePatterns, Class<?> assignableType) 	
    		PathMatchingResourcePatternResolver.getResources(String locationPattern) 
    	TypeAliasRegistry.registerAlias(Class<?> type)

经过比较分析，发现都是 mybatis-spring 相同的位置出错。
同样的实体类代码，本地的 1.0.3 版本可执行，项目中的 2.0.1 版本执行错误，项目中的高版本反而有问题。

前者通过 tk.mybatis:mapper-spring-boot:2.0.4 引入
后者通过 org.myvatis.spring.boot:mybatis-spring-boot-starter:2.0.1 引入（tk 使用 tk.mybatis:mapper:4.1.5 引入）

仔细比较了两个版本的源码，差别在于 org.mybatis.spring.SqlSessionFactoryBean.buildSqlSessionFactory() 方法中，对 typeAliasesPackage 处理的不一样导致的。

原理分析

在 mybatis-spring:1.3.2 中的源码

    if (hasLength(this.typeAliasesPackage)) {
      String[] typeAliasPackageArray = tokenizeToStringArray(this.typeAliasesPackage,
          ConfigurableApplicationContext.CONFIG_LOCATION_DELIMITERS);
      for (String packageToScan : typeAliasPackageArray) {
        configuration.getTypeAliasRegistry().registerAliases(packageToScan,
                typeAliasesSuperType == null ? Object.class : typeAliasesSuperType);
        if (LOGGER.isDebugEnabled()) {
          LOGGER.debug("Scanned package: '" + packageToScan + "' for aliases");
        }
      }
    }

在 mybatis-spring:2.0.1 中的源码

if (hasLength(this.typeAliasesPackage)) {
    scanClasses(this.typeAliasesPackage, this.typeAliasesSuperType)
        .forEach(targetConfiguration.getTypeAliasRegistry()::registerAlias);
}

两者实际处理别名的是 registerAliases(String packageName, Class<?> superType) 和 registerAlias(Class<?> type)
再看这两个方法

mybatis-spring:1.3.2 调用的

  public void registerAliases(String packageName, Class<?> superType){
    ResolverUtil<Class<?>> resolverUtil = new ResolverUtil<Class<?>>();
    resolverUtil.find(new ResolverUtil.IsA(superType), packageName);
    Set<Class<? extends Class<?>>> typeSet = resolverUtil.getClasses();
    for(Class<?> type : typeSet){
      // Ignore inner classes and interfaces (including package-info.java)
      // Skip also inner classes. See issue #6
      if (!type.isAnonymousClass() && !type.isInterface() && !type.isMemberClass()) {
        registerAlias(type);
      }
    }
  }

mybatis-spring:2.0.1 调用的

  public void registerAlias(Class<?> type) {
    String alias = type.getSimpleName();
    Alias aliasAnnotation = type.getAnnotation(Alias.class);
    if (aliasAnnotation != null) {
      alias = aliasAnnotation.value();
    } 
    registerAlias(alias, type);
  }

两者实际上，首先都会对包下的编译好的全部 class 文件进行处理，都是先全部加载为 Class 对象处理，此时都会把匿名内部类也算进去。

但区别在于，前者（1.3.2 ）会先对判断类是否为匿名类 !type.isAnonymousClass() （该值由 ClassLoader 在加载类时处理） 再调用 registerAlias(Class<?> type) ，而后者（2.0.1 ）则是直接调用 registerAlias(Class<?> type) 。

而使用 TypeReference 的这种写法，则是创建了两个匿名内部类

        String foo1 = objectMapper.readValue(url, new TypeReference<String>() {
        });
        Integer foo2 = objectMapper.readValue(url, new TypeReference<Integer>() {
        });

此时匿名内部类的别名同通过 Class.getSimpleName() 获取，返回的都是 “” 空字符串，所以就冲突了。

而这个bug，在 mybatis-spring 的 2.0.2 中已经修复了，所以用高版本的代替即可解决。

参考：https://github.com/mybatis/spring/commit/e526eab16bc7ed56d77d1c22a1f5971ceeb56242