【Mybatis 系列10-结合源码解析mybatis 执行流程】
【Mybatis 系列8-结合源码解析select、resultMap的用法】
【Mybatis 系列7-结合源码解析核心CRUD配置及用法】
【Mybatis 系列6-结合源码解析节点配置objectFactory、databaseIdProvider、plugins、mappers】
【Mybatis 系列5-结合源码解析TypeHandler】
【Mybatis 系列4-结合源码解析节点typeAliases】
【Mybatis 系列3-结合源码解析properties节点和environments节点】
上篇系列3中 介绍了properties与environments， 本篇继续讲剩下的配置节点之一：typeAliases。
typeAliases节点主要用来设置别名，其实这是挺好用的一个功能， 通过配置别名，我们不用再指定完整的包名，并且还能取别名。
例如： 我们在使用 com.demo.entity. UserEntity 的时候，我们可以直接配置一个别名user, 这样以后在配置文件中要使用到com.demo.entity. UserEntity的时候，直接使用User即可。
我们来实现一下，看看typeAliases的配置方法：
1 <configuration> 2 <typeAliases> 3 <!-- 4 通过package, 可以直接指定package的名字， mybatis会自动扫描你指定包下面的javabean, 5 并且默认设置一个别名，默认的名字为： javabean 的首字母小写的非限定类名来作为它的别名。 6 也可在javabean 加上注解@Alias 来自定义别名， 例如： @Alias(user) 7 <package name="com.dy.entity"/> 8 --> 9 <typeAlias alias="UserEntity" type="com.dy.entity.User"/> 10 </typeAliases> 11 12 ...... 13 14 </configuration>
再写一段测试代码，看看有没生效：（我只写一段伪代码）
1 Configuration con = sqlSessionFactory.getConfiguration(); 2 Map<String, Class<?>> typeMap = con.getTypeAliasRegistry().getTypeAliases(); 3 for(Entry<String, Class<?>> entry: typeMap.entrySet()) { 4 System.out.println(entry.getKey() + " ================> " + entry.getValue().getSimpleName()); 5 } 6 7 =======================================我是源码分割线============================================== 8 上面给大家简单介绍了typeAliases的用法， 接下来就看看Mybatis中的源码了： 9 老规矩，先从对xml的解析讲起： 10 11 /** 12 2 * 解析typeAliases节点 13 3 */ 14 4 private void typeAliasesElement(XNode parent) { 15 5 if (parent != null) { 16 6 for (XNode child : parent.getChildren()) { 17 7 //如果子节点是package, 那么就获取package节点的name属性， mybatis会扫描指定的package 18 8 if ("package".equals(child.getName())) { 19 9 String typeAliasPackage = child.getStringAttribute("name"); 20 10 //TypeAliasRegistry 负责管理别名， 这儿就是通过TypeAliasRegistry 进行别名注册， 下面就会看看TypeAliasRegistry源码 21 11 configuration.getTypeAliasRegistry().registerAliases(typeAliasPackage); 22 12 } else { 23 13 //如果子节点是typeAlias节点，那么就获取alias属性和type的属性值 24 14 String alias = child.getStringAttribute("alias"); 25 15 String type = child.getStringAttribute("type"); 26 16 try { 27 17 Class<?> clazz = Resources.classForName(type); 28 18 if (alias == null) { 29 19 typeAliasRegistry.registerAlias(clazz); 30 20 } else { 31 21 typeAliasRegistry.registerAlias(alias, clazz); 32 22 } 33 23 } catch (ClassNotFoundException e) { 34 24 throw new BuilderException("Error registering typeAlias for '" + alias + "'. Cause: " + e, e); 35 25 } 36 26 } 37 27 } 38 28 } 39 29 }
源码在这儿： TypeAliasRegistry：
1 public class TypeAliasRegistry { 2 3 //这就是核心所在啊， 原来别名就仅仅通过一个HashMap来实现， key为别名， value就是别名对应的类型（class对象） 4 private final Map<String, Class<?>> TYPE_ALIASES = new HashMap<String, Class<?>>(); 5 6 /** 7 * 以下就是mybatis默认为我们注册的别名 8 */ 9 public TypeAliasRegistry() { 10 registerAlias("string", String.class); 11 12 registerAlias("byte", Byte.class); 13 registerAlias("long", Long.class); 14 registerAlias("short", Short.class); 15 registerAlias("int", Integer.class); 16 registerAlias("integer", Integer.class); 17 registerAlias("double", Double.class); 18 registerAlias("float", Float.class); 19 registerAlias("boolean", Boolean.class); 20 21 registerAlias("byte[]", Byte[].class); 22 registerAlias("long[]", Long[].class); 23 registerAlias("short[]", Short[].class); 24 registerAlias("int[]", Integer[].class); 25 registerAlias("integer[]", Integer[].class); 26 registerAlias("double[]", Double[].class); 27 registerAlias("float[]", Float[].class); 28 registerAlias("boolean[]", Boolean[].class); 29 30 registerAlias("_byte", byte.class); 31 registerAlias("_long", long.class); 32 registerAlias("_short", short.class); 33 registerAlias("_int", int.class); 34 registerAlias("_integer", int.class); 35 registerAlias("_double", double.class); 36 registerAlias("_float", float.class); 37 registerAlias("_boolean", boolean.class); 38 39 registerAlias("_byte[]", byte[].class); 40 registerAlias("_long[]", long[].class); 41 registerAlias("_short[]", short[].class); 42 registerAlias("_int[]", int[].class); 43 registerAlias("_integer[]", int[].class); 44 registerAlias("_double[]", double[].class); 45 registerAlias("_float[]", float[].class); 46 registerAlias("_boolean[]", boolean[].class); 47 48 registerAlias("date", Date.class); 49 registerAlias("decimal", BigDecimal.class); 50 registerAlias("bigdecimal", BigDecimal.class); 51 registerAlias("biginteger", BigInteger.class); 52 registerAlias("object", Object.class); 53 54 registerAlias("date[]", Date[].class); 55 registerAlias("decimal[]", BigDecimal[].class); 56 registerAlias("bigdecimal[]", BigDecimal[].class); 57 registerAlias("biginteger[]", BigInteger[].class); 58 registerAlias("object[]", Object[].class); 59 60 registerAlias("map", Map.class); 61 registerAlias("hashmap", HashMap.class); 62 registerAlias("list", List.class); 63 registerAlias("arraylist", ArrayList.class); 64 registerAlias("collection", Collection.class); 65 registerAlias("iterator", Iterator.class); 66 67 registerAlias("ResultSet", ResultSet.class); 68 } 69 70 71 /** 72 * 处理别名， 直接从保存有别名的hashMap中取出即可 73 */ 74 @SuppressWarnings("unchecked") 75 public <T> Class<T> resolveAlias(String string) { 76 try { 77 if (string == null) return null; 78 String key = string.toLowerCase(Locale.ENGLISH); // issue #748 79 Class<T> value; 80 if (TYPE_ALIASES.containsKey(key)) { 81 value = (Class<T>) TYPE_ALIASES.get(key); 82 } else { 83 value = (Class<T>) Resources.classForName(string); 84 } 85 return value; 86 } catch (ClassNotFoundException e) { 87 throw new TypeException("Could not resolve type alias '" + string + "'. Cause: " + e, e); 88 } 89 } 90 91 /** 92 * 配置文件中配置为package的时候， 会调用此方法，根据配置的报名去扫描javabean ，然后自动注册别名 93 * 默认会使用 Bean 的首字母小写的非限定类名来作为它的别名 94 * 也可在javabean 加上注解@Alias 来自定义别名， 例如： @Alias(user) 95 */ 96 public void registerAliases(String packageName){ 97 registerAliases(packageName, Object.class); 98 } 99 100 public void registerAliases(String packageName, Class<?> superType){ 101 ResolverUtil<Class<?>> resolverUtil = new ResolverUtil<Class<?>>(); 102 resolverUtil.find(new ResolverUtil.IsA(superType), packageName); 103 Set<Class<? extends Class<?>>> typeSet = resolverUtil.getClasses(); 104 for(Class<?> type : typeSet){ 105 // Ignore inner classes and interfaces (including package-info.java) 106 // Skip also inner classes. See issue #6 107 if (!type.isAnonymousClass() && !type.isInterface() && !type.isMemberClass()) { 108 registerAlias(type); 109 } 110 } 111 } 112 113 public void registerAlias(Class<?> type) { 114 String alias = type.getSimpleName(); 115 Alias aliasAnnotation = type.getAnnotation(Alias.class); 116 if (aliasAnnotation != null) { 117 alias = aliasAnnotation.value(); 118 } 119 registerAlias(alias, type); 120 } 121 122 //这就是注册别名的本质方法， 其实就是向保存别名的hashMap新增值而已， 呵呵， 别名的实现太简单了，对吧 123 public void registerAlias(String alias, Class<?> value) { 124 if (alias == null) throw new TypeException("The parameter alias cannot be null"); 125 String key = alias.toLowerCase(Locale.ENGLISH); // issue #748 126 if (TYPE_ALIASES.containsKey(key) && TYPE_ALIASES.get(key) != null && !TYPE_ALIASES.get(key).equals(value)) { 127 throw new TypeException("The alias '" + alias + "' is already mapped to the value '" + TYPE_ALIASES.get(key).getName() + "'."); 128 } 129 TYPE_ALIASES.put(key, value); 130 } 131 132 public void registerAlias(String alias, String value) { 133 try { 134 registerAlias(alias, Resources.classForName(value)); 135 } catch (ClassNotFoundException e) { 136 throw new TypeException("Error registering type alias "+alias+" for "+value+". Cause: " + e, e); 137 } 138 } 139 140 /** 141 * 获取保存别名的HashMap, Configuration对象持有对TypeAliasRegistry的引用，因此，如果需要，我们可以通过Configuration对象获取 142 */ 143 public Map<String, Class<?>> getTypeAliases() { 144 return Collections.unmodifiableMap(TYPE_ALIASES); 145 } 146 147 }
由源码可见，设置别名的原理就这么简单，Mybatis默认给我们设置了不少别名，在上面代码中都可以见到。
下篇将继续讲解还没讲完的配置节点。