Configuration--typeAliases(三-2)

上一篇文章我们分析了解析properties标签做的事情,发现最终会将properties中定义的值转化成Properties,设置到Configuration的variables属性中.这一篇我们来分析下一个标签typeAliases.

typeAliases标签的作用就是给类定义别名,因为完整的类名需要包含包名,一般来说是非常长的,而我们会经常用到这些类,如果每次都写完整的包名,既麻烦又不易读,所以mybatis就给我们设置了一个别名的功能,就是使用typeAliases标签进行定义.

<typeAliases>
  <typeAlias alias="Author" type="domain.blog.Author"/>
  <typeAlias alias="Blog" type="domain.blog.Blog"/>
  <typeAlias alias="Comment" type="domain.blog.Comment"/>
  <typeAlias alias="Post" type="domain.blog.Post"/>
  <typeAlias alias="Section" type="domain.blog.Section"/>
  <typeAlias alias="Tag" type="domain.blog.Tag"/>
  <package name="domain.blog"/>
</typeAliases>

可以到看,typeAliases标签下有可以给每个类分别定义别名的typeAlias标签,也有给某个包下所有类生成别名的package标签.

现在就让我们一起来看看typeAliasesElement(root.evalNode(“typeAliases”))方法中到底做了什么:

  private void typeAliasesElement(XNode parent) {
    if (parent != null) {
      // 遍历typeAliases标签下所有的子标签
      for (XNode child : parent.getChildren()) {

        if ("package".equals(child.getName())) { // 子标签为package时
          // 获取package的name属性值
          String typeAliasPackage = child.getStringAttribute("name");

          // Configuration中TypeAliasRegistry typeAliasRegistry = new TypeAliasRegistry();这个属性用来存储别名和类的对应关系,其实在之前文章中说到Configuration的构造方法时,我们就见过这个属性,因为在Configuration的构造方法中,设置了很多类的别名.还记得当时说过这个类内部其实是用了一个Map来存储别名和类的对应关系.
          // 我们在下面会分析TypeAliasRegistry的registerAliases()方法,其实大家也可以猜到,这个方法就是将包中的每个类取一个默认规则生成得别名,然后将其存储到TypeAliasRegistry中的Map中.
          configuration.getTypeAliasRegistry().registerAliases(typeAliasPackage);

        } else {

          // 获取typeAlias标签alias属性值(也就是别名)
          String alias = child.getStringAttribute("alias");
          // 获取typeAlias标签type属性值(也就是完整的类名)
          String type = child.getStringAttribute("type");
          try {
            // 加载该类
            Class<?> clazz = Resources.classForName(type);

            // 从这里对alias的判断我们可以猜到,如果我们没有指定alias别名,可能会根据默认规则生成一个别名,所以alias属性不是必须的.具体的逻辑我们下面将继续分析TypeAliasRegistry类的registerAlias()方法
            // 这里使用的typeAliasRegistry属性其实是在XMLConfigBuilder的父类BaseBuilder的构造方法中通过this.typeAliasRegistry = this.configuration.getTypeAliasRegistry()设置的,所以这个typeAliasRegistry属性也就是当前Configuration中的typeAliasRegistry,至于为什么要单独将这个属性在BaseBuilder中保存一份,应该是该类的其他子类可能会用到这些别名的对应关系.
            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);
          }
        }

      }
    }
  }

根据上面代码的分析,我们可以看到,具体的注册别名逻辑是在TypeAliasRegistry类中实现的,所以我们现在主要来看看TypeAliasRegistry的registerAliases()方法和registerAlias()方法,不过在此之前让我们先看看该类的构造方法:

  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的构造方法,TypeAliasRegistry本身的构造方法中也注册了很多类的别名,这就是为什么即使我们在配置文件中什么别名都没有配置过,我们依然可以使用一些基本类的别名的原因.

现在我们就来看看registerAliases()方法和registerAlias()方法到底做了什么:

  // 设置package标签时调用的方法
  public void registerAliases(String packageName){
    registerAliases(packageName, Object.class);
  }

  public void registerAliases(String packageName, Class<?> superType){
    // 去查找一个包下所有的类,这里传入的superType为Object.class,主要是在查找类时,类必须是继承自Object.class,也就是说该类必须是Java的类,因为在搜索时,实际上是去搜索文件名以.class结尾的文件,并不能保证以.class结尾的文件就是Java的类.具体的原因和代码大家有兴趣可以看一下,这不是本系列文章的重点,这里就不再赘述了.
    ResolverUtil<Class<?>> resolverUtil = new ResolverUtil<Class<?>>();
    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) {
    // 通过JDK提供的方法获取该类的简称
    String alias = type.getSimpleName();

    // 这里是mybaits提供的在类上定义@Alias注解来设置别名的实现
    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 (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);
  }

  // 从这里可以看出,确实是使用一个Map来存储别名和类的对应关系
  private final Map<String, Class<?>> TYPE_ALIASES = new HashMap<String, Class<?>>();

从上面的代码我们可以看出,两个不同的类不能取同样的别名,但是一个类可以有多个别名.

并且当我们使用typeAlias标签指定了一个类的alias时,该类的注解@Alias定义的别名就不会生效,除非你同时定义了package标签,并且这个类在定义的package下.至于为什么,想想上面源码的逻辑,肯定难不倒你的!