Mybatis 系列4
阿新 • • 發佈：2018-05-06
配置文件 system 可見 resource anon 報名 english 不用 ron
上篇系列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默認給我們設置了不少別名，在上面代碼中都可以見到。
下篇將繼續講解還沒講完的配置節點。
Mybatis 系列4