【MyBatis源码分析】properties，typeAliases解析属性配置元素详述

本文链接：https://blog.youkuaiyun.com/qq_35807136/article/details/78863545

本文深入探讨了MyBatis框架中的配置解析过程，包括properties配置的处理方式、优先级及类型别名的解析机制。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

properties解析

接着看一下propertiesElement(root.evalNode("properties"))方法，这句读取的是<configuration>下的<properties>节点，代码实现为：

private void propertiesElement(XNode context) throws Exception {
    if (context != null) {
      Properties defaults = context.getChildrenAsProperties();
      String resource = context.getStringAttribute("resource");
      String url = context.getStringAttribute("url");
      if (resource != null && url != null) {
        throw new BuilderException("The properties element cannot specify both a URL and a resource based property file reference.  Please specify one or the other.");
      }
      if (resource != null) {
        defaults.putAll(Resources.getResourceAsProperties(resource));
      } else if (url != null) {
        defaults.putAll(Resources.getUrlAsProperties(url));
      }
      Properties vars = configuration.getVariables();
      if (vars != null) {
        defaults.putAll(vars);
      }
      parser.setVariables(defaults);
      configuration.setVariables(defaults);
    }
  }

我们可以先来看下三种配置的方式

第一种XML直接配置参数

<properties>  
        <property name="username" value="root"/>  
        <property name="password" value="root"/>  
        <property name="driver" value="com.mysql.jdbc.Driver"/>  
        <property name="url" value="jdbc:mysql://localhost:3306/mybatis?characterEncoding=utf-8"/>  
</properties>

第二种xml配置外部properties文件

<properties resource="properties/db.properties" />

第三种通过API进行java代码进行配置

static {
	     try {
	        ssf = new SqlSessionFactoryBuilder().build(Resources.getResourceAsReader("config.xml"),buildInitProperties());
	      } catch (IOException e) {
		      e.printStackTrace();
	      } catch (Exception e1) {
	    	  e1.printStackTrace();
	      } 
	}
	 private static Properties buildInitProperties(){
	        Properties properties = new Properties();
	        properties.put("driver", "com.mysql.jdbc.Driver");  
	        properties.put("url", "jdbc:mysql://localhost:3306/mybatis?characterEncoding=utf-8");  
	        properties.put("username", "root");  
	        properties.put("password", "root");  
	        return properties;  
	}

我们回到第一段代码。看到第4行~第7行的代码指定了MyBatis的<properties>标签下不能同时指定"resource"属性和"url"属性。

接着第9行~第13行的代码将.properties资源解析为Properties类，最后将Properties类设置到XPathParser和Configuration的variables属性中，variables是一个Propreties变量。

总结配置优先级

第三种（API配置）> 第二种引用外部properties文件 > 第一种xml直接配置name,value;

类型别名解析（typeAliases）

跳过loadCustomVfs(settings)直接看typeAliasesElement(root.evalNode("typeAliases"))这行，前者后面详细讲解，后者是用于定义类型的别名的，储存了所有默认的类型与自定义类型,存储变量引用不可改变。解析的是<configuration>下的<typeAliases>标签，用过MyBatis的应该很熟悉。看一下源码实现：

private void typeAliasesElement(XNode parent) {
    if (parent != null) {
      for (XNode child : parent.getChildren()) {
        if ("package".equals(child.getName())) {
          String typeAliasPackage = child.getStringAttribute("name");
          configuration.getTypeAliasRegistry().registerAliases(typeAliasPackage);
        } else {
          String alias = child.getStringAttribute("alias");
          String type = child.getStringAttribute("type");
          try {
            Class<?> clazz = Resources.classForName(type);
            if (alias == null) {
              typeAliasRegistry.registerAlias(clazz);
            } else {
              typeAliasRegistry.registerAlias(alias, clazz);
            }
          } catch (ClassNotFoundException e) {
            throw new BuilderException("Error registering typeAlias for '" + alias + "'. Cause: " + e, e);
          }
        }
      }
    }
  }

从源码实现中我们可以知道两点，<typeAliases>标签下可以定义<package>和<typeAlias>两种标签，但是看第4行和第7行的判断，这是一段if...else...，因此可以知道<package>标签和<typeAlias>标签只能定义其中的一种。首先看一下解析<package>标签的代码，第6行的registerAliases方法：

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

第3行根据路径packageName寻找它下面的".class"文件拿到所有的".class"文件对应的类的Class，然后遍历所有的Class，做了三层判断

必须不是匿名类
必须不是接口
必须不是成员类

此时此Class对应的类符合条件，会进行注册，通过registerAlias方法进行注册，看一下方法实现：

public void registerAlias(Class<?> type) {
    String alias = type.getSimpleName();
    Alias aliasAnnotation = type.getAnnotation(Alias.class);
    if (aliasAnnotation != null) {
      alias = aliasAnnotation.value();
    } 
    registerAlias(alias, type);
  }

第2行获取Class的simpleName，simpleName指的是移除了包名的名称，比如aa.bb.cc.Mail，getSimpleName()获取的就是Mail。

第3行获取类上面的注解Alias，如果Alias注解中有定义value属性且指定了值，那么第4行~第6行的判断优先取这个值作为Class的别名。

第7行注册别名：

public void registerAlias(String alias, Class<?> value) {
    if (alias == null) {
      throw new TypeException("The parameter alias cannot be null");
    }
    // issue #748
    String key = alias.toLowerCase(Locale.ENGLISH);
    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);
  }

其实就做了两步操作：

将alias全部小写
将alias以及Class对象放到TYPE_ALIASES中，TYPE_ALIASES是一个HashMap

这样一个流程，就将<package>标签name属性路径下的Class（如果符合要求），全部放到了HashMap中以供使用。

接着看一下<typeAlias>标签的解析，也就是前面说的else部分：

String alias = child.getStringAttribute("alias");
          String type = child.getStringAttribute("type");
          try {
            Class<?> clazz = Resources.classForName(type);
            if (alias == null) {
              typeAliasRegistry.registerAlias(clazz);
            } else {
              typeAliasRegistry.registerAlias(alias, clazz);
            }
          } catch (ClassNotFoundException e) {
            throw new BuilderException("Error registering typeAlias for '" + alias + "'. Cause: " + e, e);
          }

这里先解析<typeAlias>中的alias属性，再解析<typeAlias>中的type属性，当然alias也可以不定义，不定义走的就是第6行的registerAlias方法，定义走的就是第8行的registerAlias方法，这两个重载的registerAlias方法前面也都说过了，就不说了。

总结!!!

这里可以配置多个package和多个typeAlias一起，也可以单个配置。如果有注解（@Alias）定义都取注解名称，否则取类名小写作为Key.自定义的Key也是取类小写，否则异常（后面再看）。

如果配置当前有同样的Key（alias）但是存储的类型不一样则会抛出异常

初始化类的时候默认配置了一些基础的类型转换

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

创建Configuration的时候也默认初始化了一些参数

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

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

对于这些数据，我们可以直接使用registerAlias方法的第一个参数对应的字符串而不需要定义这些typeAlias。

<typeAliases>
         <typeAlias type="model.Mail"/> <!-- 指定的类  自动转换类限定名 也可在类上注解配置@Alias("Mail")-->
         <!-- <typeAlias alias="Mail" type="model.Mail"/>  --><!-- 指定的类  自动转换类限定名 配置别名-->
         <!-- <package name="model"/> --><!-- 包扫描 -->
     </typeAliases>

配置方式！

<select id="selectMailList" resultMap="mail">
         select <include refid="fields" /> from mail;
     </select>

可以直接在XML映射中直接使用resultType和parameterType的属性值为定义的javaBean的完全限定名。