03 Mybatis应用篇---XML配置之typeAliases 类型命名

typeAliases 类型命名

     类型别名是为java类型设置一个短的名字。它只和XML配置有关，存在意义仅在于用来减少类完全限定名的冗余。例如：

不使用别名：

     XML配置文件中不需要做别名的配置，Mapper文件如下：

<insert id="insert" parameterType="hzq.mybatis.source.demo1.entity.User">
    INSERT  INTO
        <include refid="tableName"></include>
    (
        <include refid="field"></include>
    )VALUES (
        <include refid="fieldValue"></include>
    )

</insert>

使用别名：

 XML配置文件中做如下别名的配置

<typeAliases>
    <!--定义别名 类型别名是为 Java 类型设置一个短的名字。它只和 XML 配置有关，存在的意义仅在于用来减少类完全限定名的冗余。-->
    <typeAlias type="hzq.mybatis.source.demo1.entity.User" alias="User"/>
</typeAliases>

Mapper文件：

<insert id="insert" parameterType="User">
    INSERT  INTO
        <include refid="tableName"></include>
    (
        <include refid="field"></include>
    )VALUES (
        <include refid="fieldValue"></include>
    )
</insert>

   

     使用以上配置方法，User可以用在任何使用hzq.mybatis.source.demo1.entity.User 的地方。

     MyBatis官方还指定了另一种方式，可以指定一个包名，Mybatis会在包名下面搜索需要的Java Bean，比如：

<typeAliases>
    <package name="hzq.mybatis.source.demo1.entity"/>
</typeAliases>

     每一个在包hzq.mybatis.source.demo1.entity中的Java Bean,在没有使用注解的情况下，会使用Bean的首字母小写的非限定类名作为它的别名。比如hzq.mybatis.source.demo1.entity.User的别名为user,若有注解，则别名为其注解值，看如下源码：

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实体名称。

String alias = type.getSimpleName();

     如果有注解，替换调原先的别名:

Alias aliasAnnotation = type.getAnnotation(Alias.class);
if (aliasAnnotation != null) {
  alias = aliasAnnotation.value();
} 

MyBatis是如何处理我们在XML配置文件中配置的别名呢？

看如下源码：

private void typeAliasesElement(XNode parent) {
  if (parent != null) {
    for (XNode child : parent.getChildren()) {
      if ("package".equals(child.getName())) {
        String typeAliasPackage = child.getStringAttribute("name");
        configuration.getTypeAliasRegistry().registerAliases(typeAliasPackage);
      } else {
        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);
        }
      }
    }
  }
}

 

这里是对我们配置的XML进行解析和使用 typeAliasRegistry.registerAlias(clazz); ，  typeAliasRegistry.registerAlias(alias, clazz); 注册别名。

常用的许多Java类型Mybatis内部已经建立了相应的类型别名。他们都是大小写不敏感的，需要注意的是基本类型名称重复导致的特殊处理。

1、为什么大小写不敏感？

     我们看源码怎么说，TypeAliasRegistry类中。

public void registerAlias(String alias, Class<?> value) {
  if (alias == null) {
    throw new TypeException("The parameter alias cannot be null");
  }
  // issue #748
  String key = alias.toLowerCase(Locale.ENGLISH);
  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);
}

String key = alias.toLowerCase(Locale.ENGLISH);将所有的别名转换成为小写。

2、有哪些是内建别名，那些又做了特殊处理呢？ -------继续看源码，还是TypeAliasRegistry类中，看构造方法。

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

     这里我主要介绍了MyBatis的typeAliases类型命名的基本使用和关键性的源码。接下来我会以断点的形式跟踪，揭晓MyBatis整个别名的注册流程。