深入MyBatis-配置文件-typeAliases解析

在使用配置mybatis时大家对下面的配配置，一般都不会陌生

1. package 包名的方式进行配置

<!-- 包名的方式进行配置 -->
  <typeAliases>
    <package name="com.it.panghu.domain" />
  </typeAliases>

那我们现在需要看下，mybatis对这些配置会进行如何解析和处理？
当mybatis解析到typeAliases元素时，首先会看否是通过package的方式还是通过全限类名的方式在xml的方式进行配置的，如果是以package包的方式进行配置的。下一步会获取到你配置package的路径，然后通过VFS查找列出包路径下的文件，将经过两次筛选，第一次筛选出满足条件的.class文件，并将.class文件加载为类对像，并进行第二次筛选（不是匿名类，不是接口，不是成员类）。经过上面的查找和两次筛选已经找到了满足条件的类了。然后进行注册别名操作，在进行注册时会看将被注册的类是否使用了Alias注解，如果使用了些注解，会获取并使用此注解中指定的别名的名字，否则使用类的名字做为别名。
主流程代码如下：

        if ("package".equals(child.getName())) {
          String typeAliasPackage = child.getStringAttribute("name");
          configuration.getTypeAliasRegistry().registerAliases(typeAliasPackage);
          }

VFS:

  public List<String> list(String path) throws IOException {
    List<String> names = new ArrayList<>();
    for (URL url : getResources(path)) {
      names.addAll(list(url, path));
    }
    return names;
  }

ResolverUtil.java

  public ResolverUtil<T> find(Test test, String packageName) {
    String path = getPackagePath(packageName);

    try {
      List<String> children = VFS.getInstance().list(path);
      for (String child : children) {
        if (child.endsWith(".class")) {
          addIfMatching(test, child);
        }
      }
    } catch (IOException ioe) {
      log.error("Could not read package: " + packageName, ioe);
    }

    return this;
  }
 protected void addIfMatching(Test test, String fqn) {
    try {
      String externalName = fqn.substring(0, fqn.indexOf('.')).replace('/', '.');
      ClassLoader loader = getClassLoader();
      if (log.isDebugEnabled()) {
        log.debug("Checking to see if class " + externalName + " matches criteria [" + test + "]");
      }

      Class<?> type = loader.loadClass(externalName);
      if (test.matches(type)) {
        matches.add((Class<T>) type);
      }
    } catch (Throwable t) {
      log.warn("Could not examine class '" + fqn + "'" + " due to a "
          + t.getClass().getName() + " with message: " + t.getMessage());
    }
  }

TypeAliasRegistry.java

  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) {
      // 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);
  }
  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 (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);
  }

2. 完整类名的方式进行配置

<typeAliases>
  <typeAlias alias="Author" type="com.it.panghu.domain.Author"/>
  <typeAlias alias="Blog" type="com.it.panghu.domain.Blog"/>
</typeAliases>

这种方式相对来说比package的处理方式会更加简单，直接会获取typeAlias 标签中的alias和type，直接type的值转换成Class类对像，如果配置alias别名就直接使用配置的另名，否则看类是否使用了Alias注解，如果使用了些注解，会获取并使用此注解中指定的别名的名字，否则使用类的名字做为别名。