Mybatis别名原理解析：TypeAliasRegistry

城陌者

于 2023-06-10 15:14:47 发布

阅读量210

点赞数

文章标签： mybatis java

本文链接：https://blog.csdn.net/lhc521zxd/article/details/131142394

版权

Mybatis别名原理解析：TypeAliasRegistry

1.注册别名

别名在使用之前需要先在mybatis全局配置文件中注册，使用typeAliases标签实现别名的注册。三种注册方式：

使用注册
使用注册
使用结合@Alias（“别名”）注册

2.源码分析

mybatis别名的注册、解析等各种操作都是由org.apache.ibatis.type.TypeAliasRegistry类实现。

TypeAliasRegistry源码

package org.apache.ibatis.type;

import java.math.BigDecimal;
import java.math.BigInteger;
import java.sql.ResultSet;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.Date;
import java.util.HashMap;
import java.util.Iterator;
import java.util.List;
import java.util.Locale;
import java.util.Map;
import java.util.Set;

import org.apache.ibatis.io.ResolverUtil;
import org.apache.ibatis.io.Resources;

public class TypeAliasRegistry {

 /**
 *	 别名与类型的映射关系由变量名为typeAliases的Map对象存储
 *  key：存储别名
 *  value：存储具体类型
 */
 private final Map<String, Class<?>> typeAliases = new HashMap<>();

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

 /**
 *	    【解析别名】：
 *     首先判断别名字符串是否为空。
 *	    然后将别名转换为小写【这也是为什么别名不区分大小写的原因】
 *  	最后先在别名和类型映射的map中按照key进行查找，如果找到了直接返回对应的类型，  
 *     如果没找到，会将这个名称当做完整的类名去解析成Class对象，
 *     如果这2步解析都无法识别这种类型，就会报错。 
 **/
 @SuppressWarnings("unchecked")
 public <T> Class<T> resolveAlias(String string) {
   try {
     if (string == null) {
       return null;
     }
     String key = string.toLowerCase(Locale.ENGLISH);
     Class<T> value;
     if (typeAliases.containsKey(key)) {
       value = (Class<T>) typeAliases.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);
   }
 }

 /**
 *	  【注册别名】：registerAliases的五个重载方法方法用于注册别名
 **/
 public void registerAliases(String packageName) {
   registerAliases(packageName, Object.class);
 }

 public void registerAliases(String packageName, Class<?> superType) {
   ResolverUtil<Class<?>> resolverUtil = new ResolverUtil<>();
   resolverUtil.find(new ResolverUtil.IsA(superType), packageName);
   Set<Class<? extends Class<?>>> typeSet = resolverUtil.getClasses();
   for (Class<?> type : typeSet) {
     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);
 }

 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);
   if (typeAliases.containsKey(key) && typeAliases.get(key) != null && !typeAliases.get(key).equals(value)) {
     throw new TypeException("The alias '" + alias + "' is already mapped to the value '" + typeAliases.get(key).getName() + "'.");
   }
   typeAliases.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);
   }
 }

 public Map<String, Class<?>> getTypeAliases() {
   return Collections.unmodifiableMap(typeAliases);
 }

}

3.其他别名

mybatis启动时会加载全局配置文件，将其转换为一个org.apache.ibatis.session.Configuration对象，存储在内存中，Configuration类中也注册了一些别名。如下所示:

protected final TypeAliasRegistry typeAliasRegistry = new TypeAliasRegistry(); 


public Configuration() {
   //注册事务工厂的别名
   typeAliasRegistry.registerAlias("JDBC", JdbcTransactionFactory.class);
   typeAliasRegistry.registerAlias("MANAGED", ManagedTransactionFactory.class);

   //注册数据源工厂的别名
   typeAliasRegistry.registerAlias("JNDI", JndiDataSourceFactory.class);
   typeAliasRegistry.registerAlias("POOLED", PooledDataSourceFactory.class);
   typeAliasRegistry.registerAlias("UNPOOLED", UnpooledDataSourceFactory.class);

   //注册缓存机制实现类的别名
   //PerpetualCache是MyBatis中默认的缓存实现类
   typeAliasRegistry.registerAlias("PERPETUAL", PerpetualCache.class);
   typeAliasRegistry.registerAlias("FIFO", FifoCache.class);
   typeAliasRegistry.registerAlias("LRU", LruCache.class);
   typeAliasRegistry.registerAlias("SOFT", SoftCache.class);
   typeAliasRegistry.registerAlias("WEAK", WeakCache.class);

   typeAliasRegistry.registerAlias("DB_VENDOR", VendorDatabaseIdProvider.class);

   typeAliasRegistry.registerAlias("XML", XMLLanguageDriver.class);
   typeAliasRegistry.registerAlias("RAW", RawLanguageDriver.class);

   //注册日志实现类的别名
   typeAliasRegistry.registerAlias("SLF4J", Slf4jImpl.class);
   typeAliasRegistry.registerAlias("COMMONS_LOGGING", JakartaCommonsLoggingImpl.class);
   typeAliasRegistry.registerAlias("LOG4J", Log4jImpl.class);
   typeAliasRegistry.registerAlias("LOG4J2", Log4j2Impl.class);
   typeAliasRegistry.registerAlias("JDK_LOGGING", Jdk14LoggingImpl.class);
   typeAliasRegistry.registerAlias("STDOUT_LOGGING", StdOutImpl.class);
   typeAliasRegistry.registerAlias("NO_LOGGING", NoLoggingImpl.class);
   
   typeAliasRegistry.registerAlias("CGLIB", CglibProxyFactory.class);
   typeAliasRegistry.registerAlias("JAVASSIST", JavassistProxyFactory.class);

   languageRegistry.setDefaultDriverClass(XMLLanguageDriver.class);
   languageRegistry.register(RawLanguageDriver.class);
 }

<environments default="development">
       <environment id="development">
           <transactionManager type="JDBC"/>
           <dataSource type="POOLED">
               <property name="driver" value="${driver}"/>
               <property name="url" value="${url}"/>
               <property name="username" value="${username}"/>
               <property name="password" value="${password}"/>
           </dataSource>
       </environment>
</environments>