Mybatis Alias

  • Author: HuiFer
  • Description: 该文介绍 mybatis Alias 源码
  • 源码阅读工程: SourceHot-Mybatis
  • 源码位置 :org.apache.ibatis.type.Alias
  • 与 Alias 相关的一个方法org.apache.ibatis.type.TypeAliasRegistry.registerAlias(java.lang.String, java.lang.Class<?>)(别名注册)
  1.     /**
  2.      * 别名注册,
  3.      * typeAliases 是一个map key=>别名,value=>字节码
  4.      *
  5.      * @param alias 别名名称
  6.      * @param value 别名的字节码
  7.      */
  8.     public void registerAlias(String alias, Class<?> value) {
  9.         if (alias == null) {
  10.             throw new TypeException("The parameter alias cannot be null");
  11.         }
  12.         // issue #748
  13.         String key = alias.toLowerCase(Locale.ENGLISH);
  14.         if (typeAliases.containsKey(key) && typeAliases.get(key) != null && !typeAliases.get(key).equals(value)) {
  15.             throw new TypeException("The alias '" + alias + "' is already mapped to the value '" + typeAliases.get(key).getName() + "'.");
  16.         }
  17.         typeAliases.put(key, value);
  18.     }
  • registerAlias 操作的对象是一个map对象
  2.     /**
  3.      * 别名存放仓库
  4.      * 是一个map key=>别名,value=>字节码
  5.      */
  6.     private final Map<String, Class<?>> typeAliases = new HashMap<>();

不难看出这个对象存放的内容是 别名 -> clazz.

  • 相关注解Alias
  1. @Documented
  2. @Retention(RetentionPolicy.RUNTIME)
  3. @Target(ElementType.TYPE)
  4. public @interface Alias {
  5.     /**
  6.      * Return the alias name.
  7.      *
  8.      * @return the alias name
  9.      */
  10.     String value();
  11. }
  • 看一下实现方式
  1.     /**
  2.      * 加载{@link Alias} 注解的内容
  3.      *
  4.      * @param type
  5.      */
  6.     public void registerAlias(Class<?> type) {
  7.         String alias = type.getSimpleName();
  8.         Alias aliasAnnotation = type.getAnnotation(Alias.class);
  9.         if (aliasAnnotation != null) {
  10.             // 获取 别名注解
  11.             alias = aliasAnnotation.value();
  12.         }
  13.         // 转换为 别名,clazz
  14.         registerAlias(alias, type);
  15.     }

最后回到了org.apache.ibatis.type.TypeAliasRegistry.registerAlias(java.lang.String, java.lang.Class<?>)方法 我们可以简单编写一个测试类

  1. @Alias(value = "hc")
  2. public class Hc {
  3. }
  5.     /**
  6.      * 对注解 {@link Alias} 的测试用例
  7.      */
  8.     @Test
  9.     void testAnnotation() {
  10.         TypeAliasRegistry typeAliasRegistry = new TypeAliasRegistry();
  11.         typeAliasRegistry.registerAlias(Hc.class);
  12.         assertEquals("org.apache.ibatis.type.Hc", typeAliasRegistry.resolveAlias("hc").getName());
  13.     }

其他与Alias相关的测试类位于: org.apache.ibatis.type.TypeAliasRegistryTest