"　　上篇文章《[链接]》介绍了 properties 与 environments，本篇继续讲剩下的配置节点之一：typeAliases。 typeAliases 节点主要用来设置别名，其实这是挺好用的一个功能，通过配置别名，我们不用再指定完整的包名，并且还能取别名。　　例如：我们在使用 ...."

someone1
AI专业者开发社区 1 号成员
AI开发者社区 • 0 回帖 • 1 浏览 • 5 个月前

深入浅出Mybatis系列（四）---配置详解之typeAliases别名（mybatis源码篇）

　　上篇文章《深入浅出 Mybatis 系列（三）--- 配置详解之 properties 与 environments（mybatis 源码篇）》介绍了 properties 与 environments，本篇继续讲剩下的配置节点之一：typeAliases。 typeAliases 节点主要用来设置别名，其实这是挺好用的一个功能，通过配置别名，我们不用再指定完整的包名，并且还能取别名。

　　例如：我们在使用 com.demo.entity. UserEntity 的时候，我们可以直接配置一个别名 user, 这样以后在配置文件中要使用到 com.demo.entity. UserEntity 的时候，直接使用 User 即可。

　　就以上例为例，我们来实现一下，看看 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 的解析讲起：

 1 /**
 2  * 解析 typeAliases 节点
 3  */
 4 private void typeAliasesElement(XNode parent) {
 5     if (parent != null) {
 6       for (XNode child : parent.getChildren()) {
 7         //如果子节点是 package, 那么就获取 package 节点的 name 属性， mybatis 会扫描指定的 package
 8         if ("package".equals(child.getName())) {
 9           String typeAliasPackage = child.getStringAttribute("name");
10           //TypeAliasRegistry 负责管理别名， 这儿就是通过 TypeAliasRegistry 进行别名注册， 下面就会看看 TypeAliasRegistry 源码
11           configuration.getTypeAliasRegistry().registerAliases(typeAliasPackage);
12         } else {
13           //如果子节点是 typeAlias 节点，那么就获取 alias 属性和 type 的属性值
14           String alias = child.getStringAttribute("alias");
15           String type = child.getStringAttribute("type");
16           try {
17             Class<?> clazz = Resources.classForName(type);
18             if (alias == null) {
19               typeAliasRegistry.registerAlias(clazz);
20             } else {
21               typeAliasRegistry.registerAlias(alias, clazz);
22             }
23           } catch (ClassNotFoundException e) {
24             throw new BuilderException("Error registering typeAlias for'"+ alias +"'. Cause:" + e, e);
25           }
26         }
27       }
28     }
29   }

重要的源码在这儿：

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(</span>"byte", Byte.<span style="color: rgba(0, 0, 255, 1)">class</span><span style="color: rgba(0, 0, 0, 1)">);
registerAlias(</span>"long", Long.<span style="color: rgba(0, 0, 255, 1)">class</span><span style="color: rgba(0, 0, 0, 1)">);
registerAlias(</span>"short", Short.<span style="color: rgba(0, 0, 255, 1)">class</span><span style="color: rgba(0, 0, 0, 1)">);
registerAlias(</span>"int", Integer.<span style="color: rgba(0, 0, 255, 1)">class</span><span style="color: rgba(0, 0, 0, 1)">);
registerAlias(</span>"integer", Integer.<span style="color: rgba(0, 0, 255, 1)">class</span><span style="color: rgba(0, 0, 0, 1)">);
registerAlias(</span>"double", Double.<span style="color: rgba(0, 0, 255, 1)">class</span><span style="color: rgba(0, 0, 0, 1)">);
registerAlias(</span>"float", Float.<span style="color: rgba(0, 0, 255, 1)">class</span><span style="color: rgba(0, 0, 0, 1)">);
registerAlias(</span>"boolean", Boolean.<span style="color: rgba(0, 0, 255, 1)">class</span><span style="color: rgba(0, 0, 0, 1)">);

registerAlias(</span>"byte[]", Byte[].<span style="color: rgba(0, 0, 255, 1)">class</span><span style="color: rgba(0, 0, 0, 1)">);
registerAlias(</span>"long[]", Long[].<span style="color: rgba(0, 0, 255, 1)">class</span><span style="color: rgba(0, 0, 0, 1)">);
registerAlias(</span>"short[]", Short[].<span style="color: rgba(0, 0, 255, 1)">class</span><span style="color: rgba(0, 0, 0, 1)">);
registerAlias(</span>"int[]", Integer[].<span style="color: rgba(0, 0, 255, 1)">class</span><span style="color: rgba(0, 0, 0, 1)">);
registerAlias(</span>"integer[]", Integer[].<span style="color: rgba(0, 0, 255, 1)">class</span><span style="color: rgba(0, 0, 0, 1)">);
registerAlias(</span>"double[]", Double[].<span style="color: rgba(0, 0, 255, 1)">class</span><span style="color: rgba(0, 0, 0, 1)">);
registerAlias(</span>"float[]", Float[].<span style="color: rgba(0, 0, 255, 1)">class</span><span style="color: rgba(0, 0, 0, 1)">);
registerAlias(</span>"boolean[]", Boolean[].<span style="color: rgba(0, 0, 255, 1)">class</span><span style="color: rgba(0, 0, 0, 1)">);

registerAlias(</span>"_byte", <span style="color: rgba(0, 0, 255, 1)">byte</span>.<span style="color: rgba(0, 0, 255, 1)">class</span><span style="color: rgba(0, 0, 0, 1)">);
registerAlias(</span>"_long", <span style="color: rgba(0, 0, 255, 1)">long</span>.<span style="color: rgba(0, 0, 255, 1)">class</span><span style="color: rgba(0, 0, 0, 1)">);
registerAlias(</span>"_short", <span style="color: rgba(0, 0, 255, 1)">short</span>.<span style="color: rgba(0, 0, 255, 1)">class</span><span style="color: rgba(0, 0, 0, 1)">);
registerAlias(</span>"_int", <span style="color: rgba(0, 0, 255, 1)">int</span>.<span style="color: rgba(0, 0, 255, 1)">class</span><span style="color: rgba(0, 0, 0, 1)">);
registerAlias(</span>"_integer", <span style="color: rgba(0, 0, 255, 1)">int</span>.<span style="color: rgba(0, 0, 255, 1)">class</span><span style="color: rgba(0, 0, 0, 1)">);
registerAlias(</span>"_double", <span style="color: rgba(0, 0, 255, 1)">double</span>.<span style="color: rgba(0, 0, 255, 1)">class</span><span style="color: rgba(0, 0, 0, 1)">);
registerAlias(</span>"_float", <span style="color: rgba(0, 0, 255, 1)">float</span>.<span style="color: rgba(0, 0, 255, 1)">class</span><span style="color: rgba(0, 0, 0, 1)">);
registerAlias(</span>"_boolean", <span style="color: rgba(0, 0, 255, 1)">boolean</span>.<span style="color: rgba(0, 0, 255, 1)">class</span><span style="color: rgba(0, 0, 0, 1)">);

registerAlias(</span>"_byte[]", <span style="color: rgba(0, 0, 255, 1)">byte</span>[].<span style="color: rgba(0, 0, 255, 1)">class</span><span style="color: rgba(0, 0, 0, 1)">);
registerAlias(</span>"_long[]", <span style="color: rgba(0, 0, 255, 1)">long</span>[].<span style="color: rgba(0, 0, 255, 1)">class</span><span style="color: rgba(0, 0, 0, 1)">);
registerAlias(</span>"_short[]", <span style="color: rgba(0, 0, 255, 1)">short</span>[].<span style="color: rgba(0, 0, 255, 1)">class</span><span style="color: rgba(0, 0, 0, 1)">);
registerAlias(</span>"_int[]", <span style="color: rgba(0, 0, 255, 1)">int</span>[].<span style="color: rgba(0, 0, 255, 1)">class</span><span style="color: rgba(0, 0, 0, 1)">);
registerAlias(</span>"_integer[]", <span style="color: rgba(0, 0, 255, 1)">int</span>[].<span style="color: rgba(0, 0, 255, 1)">class</span><span style="color: rgba(0, 0, 0, 1)">);
registerAlias(</span>"_double[]", <span style="color: rgba(0, 0, 255, 1)">double</span>[].<span style="color: rgba(0, 0, 255, 1)">class</span><span style="color: rgba(0, 0, 0, 1)">);
registerAlias(</span>"_float[]", <span style="color: rgba(0, 0, 255, 1)">float</span>[].<span style="color: rgba(0, 0, 255, 1)">class</span><span style="color: rgba(0, 0, 0, 1)">);
registerAlias(</span>"_boolean[]", <span style="color: rgba(0, 0, 255, 1)">boolean</span>[].<span style="color: rgba(0, 0, 255, 1)">class</span><span style="color: rgba(0, 0, 0, 1)">);

registerAlias(</span>"date", Date.<span style="color: rgba(0, 0, 255, 1)">class</span><span style="color: rgba(0, 0, 0, 1)">);
registerAlias(</span>"decimal", BigDecimal.<span style="color: rgba(0, 0, 255, 1)">class</span><span style="color: rgba(0, 0, 0, 1)">);
registerAlias(</span>"bigdecimal", BigDecimal.<span style="color: rgba(0, 0, 255, 1)">class</span><span style="color: rgba(0, 0, 0, 1)">);
registerAlias(</span>"biginteger", BigInteger.<span style="color: rgba(0, 0, 255, 1)">class</span><span style="color: rgba(0, 0, 0, 1)">);
registerAlias(</span>"object", Object.<span style="color: rgba(0, 0, 255, 1)">class</span><span style="color: rgba(0, 0, 0, 1)">);

registerAlias(</span>"date[]", Date[].<span style="color: rgba(0, 0, 255, 1)">class</span><span style="color: rgba(0, 0, 0, 1)">);
registerAlias(</span>"decimal[]", BigDecimal[].<span style="color: rgba(0, 0, 255, 1)">class</span><span style="color: rgba(0, 0, 0, 1)">);
registerAlias(</span>"bigdecimal[]", BigDecimal[].<span style="color: rgba(0, 0, 255, 1)">class</span><span style="color: rgba(0, 0, 0, 1)">);
registerAlias(</span>"biginteger[]", BigInteger[].<span style="color: rgba(0, 0, 255, 1)">class</span><span style="color: rgba(0, 0, 0, 1)">);
registerAlias(</span>"object[]", Object[].<span style="color: rgba(0, 0, 255, 1)">class</span><span style="color: rgba(0, 0, 0, 1)">);

registerAlias(</span>"map", Map.<span style="color: rgba(0, 0, 255, 1)">class</span><span style="color: rgba(0, 0, 0, 1)">);
registerAlias(</span>"hashmap", HashMap.<span style="color: rgba(0, 0, 255, 1)">class</span><span style="color: rgba(0, 0, 0, 1)">);
registerAlias(</span>"list", List.<span style="color: rgba(0, 0, 255, 1)">class</span><span style="color: rgba(0, 0, 0, 1)">);
registerAlias(</span>"arraylist", ArrayList.<span style="color: rgba(0, 0, 255, 1)">class</span><span style="color: rgba(0, 0, 0, 1)">);
registerAlias(</span>"collection", Collection.<span style="color: rgba(0, 0, 255, 1)">class</span><span style="color: rgba(0, 0, 0, 1)">);
registerAlias(</span>"iterator", Iterator.<span style="color: rgba(0, 0, 255, 1)">class</span><span style="color: rgba(0, 0, 0, 1)">);

registerAlias(</span>"ResultSet", ResultSet.<span style="color: rgba(0, 0, 255, 1)">class</span><span style="color: rgba(0, 0, 0, 1)">);

}
/**

处理别名， 直接从保存有别名的 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 默认给我们设置了不少别名，在上面代码中都可以见到。

好啦，本篇内容就是这么简单，到此为止。下篇将继续讲解还没讲完的配置节点。

深入浅出Mybatis系列（四）---配置详解之typeAliases别名（mybatis源码篇）

相关帖子

随便看看

深入浅出Mybatis系列（四）---配置详解之typeAliases别名（mybatis源码篇）