深入淺出Mybatis系列四-配置詳解之typeAliases別名（mybatis源碼篇）

注：本文轉載自南軻夢

注：博主 Chloneda：個人博客 | 博客園 | Github | Gitee | 知乎

上篇文章《深入淺出Mybatis系列（三）---配置詳解之properties與environments（mybatis源碼篇）》 介紹了properties與environments， 本篇繼續講剩下的配置節點之一：typeAliases。 typeAliases節點主要用來設置別名，其實這是挺好用的一個功能， 通過配置別名，我們不用再指定完整的包名，並且還能取別名。

例如： 我們在使用 com.demo.entity. UserEntity 的時候，我們可以直接配置一個別名user, 這樣以后在配置文件中要使用到com.demo.entity. UserEntity的時候，直接使用User即可。

就以上例為例，我們來實現一下，看看typeAliases的配置方法:

typeAliases配置

<configuration>
    <typeAliases>
      <!--
      通過package, 可以直接指定package的名字， mybatis會自動掃描你指定包下面的javabean,
      並且默認設置一個別名，默認的名字為： javabean 的首字母小寫的非限定類名來作為它的別名。
      也可在javabean 加上注解@Alias 來自定義別名， 例如： @Alias(user) 
      <package name="com.dy.entity"/>
       -->
      <typeAlias alias="UserEntity" type="com.dy.entity.User"/>
  </typeAliases>
  
  ......
  
</configuration>

再寫一段測試代碼，看看有沒生效：（我只寫一段偽代碼）

Configuration con = sqlSessionFactory.getConfiguration();
Map<String, Class<?>> typeMap = con.getTypeAliasRegistry().getTypeAliases();
for(Entry<String, Class<?>> entry: typeMap.entrySet()) {
    System.out.println(entry.getKey() + " ================> " 
	+ entry.getValue().getSimpleName());
}

上面給大家簡單介紹了typeAliases的用法， 接下來就看看Mybatis中的源碼了。

老規矩，先從對xml的解析講起：

typeAliases源碼

/**
 * 解析typeAliases節點
 */
private void typeAliasesElement(XNode parent) {
    if (parent != null) {
      for (XNode child : parent.getChildren()) {
        //如果子節點是package, 那么就獲取package節點的name屬性， mybatis會掃描指定的package
        if ("package".equals(child.getName())) {
          String typeAliasPackage = child.getStringAttribute("name");
          /**
          * TypeAliasRegistry 負責管理別名， 這兒就是通過TypeAliasRegistry 進行別名注冊，
          * 下面就會看看TypeAliasRegistry源碼
          */
          configuration.getTypeAliasRegistry().registerAliases(typeAliasPackage);
        } else {
          //如果子節點是typeAlias節點，那么就獲取alias屬性和type的屬性值
          String alias = child.getStringAttribute("alias");
          String type = child.getStringAttribute("type");
          try {
            Class<?> clazz = Resources.classForName(type);
            if (alias == null) {
              typeAliasRegistry.registerAlias(clazz);
            } else {
              typeAliasRegistry.registerAlias(alias, clazz);
            }
          } catch (ClassNotFoundException e) {
            throw new BuilderException("Error registering typeAlias for '" 
		+ alias + "'. Cause: " + e, e);
          }
        }
      }
    }
  }

重要的源碼在這兒!

TypeAliasRegistry源碼

public class TypeAliasRegistry {
  
  /**
   * 這就是核心所在啊， 原來別名就僅僅通過一個HashMap來實現， 
   * key為別名， value就是別名對應的類型（class對象）
   */
  private final Map<String, Class<?>> TYPE_ALIASES = new HashMap<String, Class<?>>();

  /**
   * 以下就是mybatis默認為我們注冊的別名
   */
  public TypeAliasRegistry() {
    registerAlias("string", String.class);

    registerAlias("byte", Byte.class);
    registerAlias("long", Long.class);
    registerAlias("short", Short.class);
    registerAlias("int", Integer.class);
    registerAlias("integer", Integer.class);
    registerAlias("double", Double.class);
    registerAlias("float", Float.class);
    registerAlias("boolean", Boolean.class);

    registerAlias("byte[]", Byte[].class);
    registerAlias("long[]", Long[].class);
    registerAlias("short[]", Short[].class);
    registerAlias("int[]", Integer[].class);
    registerAlias("integer[]", Integer[].class);
    registerAlias("double[]", Double[].class);
    registerAlias("float[]", Float[].class);
    registerAlias("boolean[]", Boolean[].class);

    registerAlias("_byte", byte.class);
    registerAlias("_long", long.class);
    registerAlias("_short", short.class);
    registerAlias("_int", int.class);
    registerAlias("_integer", int.class);
    registerAlias("_double", double.class);
    registerAlias("_float", float.class);
    registerAlias("_boolean", boolean.class);

    registerAlias("_byte[]", byte[].class);
    registerAlias("_long[]", long[].class);
    registerAlias("_short[]", short[].class);
    registerAlias("_int[]", int[].class);
    registerAlias("_integer[]", int[].class);
    registerAlias("_double[]", double[].class);
    registerAlias("_float[]", float[].class);
    registerAlias("_boolean[]", boolean[].class);

    registerAlias("date", Date.class);
    registerAlias("decimal", BigDecimal.class);
    registerAlias("bigdecimal", BigDecimal.class);
    registerAlias("biginteger", BigInteger.class);
    registerAlias("object", Object.class);

    registerAlias("date[]", Date[].class);
    registerAlias("decimal[]", BigDecimal[].class);
    registerAlias("bigdecimal[]", BigDecimal[].class);
    registerAlias("biginteger[]", BigInteger[].class);
    registerAlias("object[]", Object[].class);

    registerAlias("map", Map.class);
    registerAlias("hashmap", HashMap.class);
    registerAlias("list", List.class);
    registerAlias("arraylist", ArrayList.class);
    registerAlias("collection", Collection.class);
    registerAlias("iterator", Iterator.class);

    registerAlias("ResultSet", ResultSet.class);
  }

  
  /**
   * 處理別名， 直接從保存有別名的hashMap中取出即可
   */
  @SuppressWarnings("unchecked")
  public <T> Class<T> resolveAlias(String string) {
    try {
      if (string == null) return null;
      String key = string.toLowerCase(Locale.ENGLISH); // issue #748
      Class<T> value;
      if (TYPE_ALIASES.containsKey(key)) {
        value = (Class<T>) TYPE_ALIASES.get(key);
      } else {
        value = (Class<T>) Resources.classForName(string);
      }
      return value;
    } catch (ClassNotFoundException e) {
      throw new TypeException("Could not resolve type alias '" 
		+ string + "'.  Cause: " + e, e);
    }
  }
  
  /**
   * 配置文件中配置為package的時候， 會調用此方法，根據配置的報名去掃描javabean ，
   * 然后自動注冊別名，默認會使用 Bean 的首字母小寫的非限定類名來作為它的別名
   * 也可在javabean 加上注解@Alias 來自定義別名， 例如： @Alias(user)
   */
  public void registerAliases(String packageName){
    registerAliases(packageName, Object.class);
  }

  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);
      }
    }
  }

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

  /**
  * 這就是注冊別名的本質方法， 其實就是向保存別名的hashMap新增值而已，
  * 呵呵，別名的實現太簡單了，對吧
  */
  public void registerAlias(String alias, Class<?> value) {
    if (alias == null) throw new TypeException("The parameter alias cannot be null");
    String key = alias.toLowerCase(Locale.ENGLISH); // issue #748
    if (TYPE_ALIASES.containsKey(key) 
		&& TYPE_ALIASES.get(key) != null 
		&& !TYPE_ALIASES.get(key).equals(value)) {
      throw new TypeException("The alias '" + alias 
	  + "' is already mapped to the value '" 
	  + TYPE_ALIASES.get(key).getName() + "'.");
    }
    TYPE_ALIASES.put(key, value);
  }

  public void registerAlias(String alias, String value) {
    try {
      registerAlias(alias, Resources.classForName(value));
    } catch (ClassNotFoundException e) {
      throw new TypeException("Error registering type alias "
		+alias+" for "+value+". Cause: " + e, e);
    }
  }
  
  /**
   * 獲取保存別名的HashMap, Configuration對象持有對TypeAliasRegistry的引用，
   * 因此，如果需要，我們可以通過Configuration對象獲取
   */
  public Map<String, Class<?>> getTypeAliases() {
    return Collections.unmodifiableMap(TYPE_ALIASES);
  }

}

由源碼可見，設置別名的原理就這么簡單，Mybatis默認給我們設置了不少別名，在上面代碼中都可以見到。

好啦，本篇內容就是這么簡單，到此為止。 下篇將繼續講解還沒講完的配置節點。

---