`

深入浅出Mybatis系列(四)---配置详解之typeAliases别名(mybatis源码篇)

阅读更多

  上篇文章《深入浅出Mybatis系列(三)---配置详解之properties与environments(mybatis源码篇)》 介绍了properties与environments, 本篇继续讲剩下的配置节点之一:typeAliases。 typeAliases节点主要用来设置别名,其实这是挺好用的一个功能, 通过配置别名,我们不用再指定完整的包名,并且还能取别名。

  例如: 我们在使用 com.demo.entity. UserEntity 的时候,我们可以直接配置一个别名user, 这样以后在配置文件中要使用到com.demo.entity. UserEntity的时候,直接使用User即可。

  就以上例为例,我们来实现一下,看看typeAliases的配置方法:  

复制代码
<configuration>
    <typeAliases>
      <!--
      通过package, 可以直接指定package的名字, mybatis会自动扫描你指定包下面的javabean,
      并且默认设置一个别名,默认的名字为: javabean 的首字母小写的非限定类名来作为它的别名。
      也可在javabean 加上注解@Alias 来自定义别名, 例如: @Alias(user) 
      <package name="com.dy.entity"/>
       -->
      <typeAlias alias="UserEntity" type="com.dy.entity.User"/>
  </typeAliases>
  
  ......
  
</configuration>
复制代码

再写一段测试代码,看看有没生效:(我只写一段伪代码)

Configuration con = sqlSessionFactory.getConfiguration();
Map<String, Class<?>> typeMap = con.getTypeAliasRegistry().getTypeAliases();
for(Entry<String, Class<?>> entry: typeMap.entrySet()) {
    System.out.println(entry.getKey() + " ================> " + entry.getValue().getSimpleName());
}

 

=======================================我是源码分割线==============================================

上面给大家简单介绍了typeAliases的用法, 接下来就看看Mybatis中的源码了:

老规矩,先从对xml的解析讲起:

复制代码
 1 /**
 2  * 解析typeAliases节点
 3  */
 4 private void typeAliasesElement(XNode parent) {
 5     if (parent != null) {
 6       for (XNode child : parent.getChildren()) {
 7         //如果子节点是package, 那么就获取package节点的name属性, mybatis会扫描指定的package
 8         if ("package".equals(child.getName())) {
 9           String typeAliasPackage = child.getStringAttribute("name");
10           //TypeAliasRegistry 负责管理别名, 这儿就是通过TypeAliasRegistry 进行别名注册, 下面就会看看TypeAliasRegistry源码
11           configuration.getTypeAliasRegistry().registerAliases(typeAliasPackage);
12         } else {
13           //如果子节点是typeAlias节点,那么就获取alias属性和type的属性值
14           String alias = child.getStringAttribute("alias");
15           String type = child.getStringAttribute("type");
16           try {
17             Class<?> clazz = Resources.classForName(type);
18             if (alias == null) {
19               typeAliasRegistry.registerAlias(clazz);
20             } else {
21               typeAliasRegistry.registerAlias(alias, clazz);
22             }
23           } catch (ClassNotFoundException e) {
24             throw new BuilderException("Error registering typeAlias for '" + alias + "'. Cause: " + e, e);
25           }
26         }
27       }
28     }
29   }
复制代码

重要的源码在这儿:

TypeAliasRegistry:

复制代码
public class TypeAliasRegistry {
  
  //这就是核心所在啊, 原来别名就仅仅通过一个HashMap来实现, key为别名, value就是别名对应的类型(class对象)
  private final Map<String, Class<?>> TYPE_ALIASES = new HashMap<String, Class<?>>();

  /**
   * 以下就是mybatis默认为我们注册的别名
   */
  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);
  }

  
  /**
   * 处理别名, 直接从保存有别名的hashMap中取出即可
   */
  @SuppressWarnings("unchecked")
  public <T> Class<T> resolveAlias(String string) {
    try {
      if (string == null) return null;
      String key = string.toLowerCase(Locale.ENGLISH); // issue #748
      Class<T> value;
      if (TYPE_ALIASES.containsKey(key)) {
        value = (Class<T>) TYPE_ALIASES.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);
    }
  }
  
  /**
   * 配置文件中配置为package的时候, 会调用此方法,根据配置的报名去扫描javabean ,然后自动注册别名
   * 默认会使用 Bean 的首字母小写的非限定类名来作为它的别名
   * 也可在javabean 加上注解@Alias 来自定义别名, 例如: @Alias(user)
   */
  public void registerAliases(String packageName){
    registerAliases(packageName, Object.class);
  }

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

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

  //这就是注册别名的本质方法, 其实就是向保存别名的hashMap新增值而已, 呵呵, 别名的实现太简单了,对吧
  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); // issue #748
    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);
  }

  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);
    }
  }
  
  /**
   * 获取保存别名的HashMap, Configuration对象持有对TypeAliasRegistry的引用,因此,如果需要,我们可以通过Configuration对象获取
   */
  public Map<String, Class<?>> getTypeAliases() {
    return Collections.unmodifiableMap(TYPE_ALIASES);
  }

}
复制代码

由源码可见,设置别名的原理就这么简单,Mybatis默认给我们设置了不少别名,在上面代码中都可以见到。

好啦,本篇内容就是这么简单,到此为止。 下篇将继续讲解还没讲完的配置节点。

分享到:
评论

相关推荐

    mybatis-3-config.dtd mybatis-3-mapper.dtd

    例如,DTD定义了`configuration`元素,它是配置文件的根元素,包含了`properties`(用于加载外部属性文件)、`settings`(系统设置)、`typeAliases`(类型别名)、`objectFactory`(对象工厂)、`plugins`(插件)...

    mybatis-3-config+mybatis-3-mapper.dtd

    3. **typeAliases**:类型别名,为 Java 类型提供简短的名字,方便在 XML 映射文件中使用。 4. **environments**:定义不同环境下的数据库配置,通常包括开发、测试和生产环境。 5. **databaseIdProvider**:数据库...

    mybatis-3-mybatis-3.2.5.zip

    通过深入研究这个压缩包中的内容,你可以了解到MyBatis的基本架构,理解其工作原理,并能够熟练运用到实际项目中。同时,也可以通过阅读源码来了解框架的设计思想和最佳实践。对于Java开发人员来说,掌握MyBatis是...

    MyBatis-3.0.3-User-Guide.pdf

    #### 四、Mapper配置XML详解 - **properties:** 配置文件中的属性,可以用于数据库连接信息等。 - **settings:** 框架的一些运行时配置项。 - **typeAliases:** 类型别名配置,简化类型名称。 - **typeHandlers:...

    mybatis-3-mybatis-3.5.6.tar.gz

    MyBatis 是一款深受广大Java开发者喜爱的持久层框架,它简化了数据库操作与Java对象之间的映射工作,使得开发者可以更加专注于业务逻辑的实现...通过阅读源码,开发者可以深入了解其内部工作机制,提升自己的技术水平。

    阿里巴巴P7架构师纯手工打造MyBatis源码——1小时解密底层源码.txt

    本篇文章将基于阿里巴巴P7架构师纯手工打造的MyBatis源码解析资料,深入探讨MyBatis的核心原理及其内部实现机制。本文旨在帮助读者理解MyBatis的工作原理,并为日后进行更深层次的技术研究提供一定的理论基础。 ###...

    mybatis源码+配置步骤+包文件

    一、MyBatis源码解析 MyBatis的源码主要由SqlSessionFactoryBuilder、SqlSessionFactory、SqlSession和Mapper接口等核心组件构成。SqlSessionFactoryBuilder用于创建SqlSessionFactory,它是MyBatis的核心工厂类。...

    mybatis3.x源码深度解析与最佳实践.pdf

    XMLConfigBuilder.parseConfiguration 方法是 MyBatis 中的核心方法之一,该方法负责解析 MyBatis 的配置文件,包括属性解析、加载 settings 节点、加载自定义 VFS、解析类型别名、加载插件、加载对象工厂、创建对象...

    尚硅谷 4月份MyBatis视频教程(国内首套:源码级讲授的MyBatis视频)最新更新

    ### 四、MyBatis的配置详解 #### 4.1 配置文件结构 MyBatis的核心配置文件为`mybatis-config.xml`,主要包含以下节点: - `&lt;settings&gt;`:用于修改MyBatis运行时的行为。 - `&lt;typeAliases&gt;`:为类型起别名。 - `...

    mybatis-3.2.8jar包及其源码jar包

    这个压缩包包含了MyBatis的核心库mybatis-3.2.8.jar以及对应的源码jar包,使得开发者可以深入理解MyBatis的工作原理,进行定制化开发或问题排查。 1. **MyBatis框架核心组件** - **SqlSessionFactoryBuilder**:...

    mybatis-3.2.0说明文档

    根据给定的文件信息,以下是对mybatis-3.2.0说明文档中涉及的关键知识点...以上是mybatis-3.2.0说明文档中的主要知识点概述,涵盖了MyBatis的基本概念、配置、使用方法以及高级特性,为开发者提供了全面而深入的理解。

    mybatis-3.5.4.pdf

    根据提供的文档信息,我们可以深入探讨MyBatis 3.5.4版本的相关知识点,包括其简介、安装步骤、配置方式以及基本用法等。 ### MyBatis 3.5.4概览 #### 1.1 什么是MyBatis? **MyBatis**是一款优秀的一流持久层...

    mybatis-3.4.5框架源代码

    2. **配置文件**:MyBatis的主配置文件(mybatis-config.xml)是整个框架的核心,它定义了数据库连接、事务管理、插件、类型别名等全局设置。在3.4.5版本中,配置文件的解析更加稳定,对XML的处理也更加严谨。 3. *...

    mybatis-3.4.1(jar所有包下载)

    在分析MyBatis源码时,可以了解其实现原理,加深对ORM框架的理解,有助于优化数据库操作和提高开发效率。通过下载的mybatis-3.4.1.zip和mybatis-3-mybatis-3.4.1.zip文件,开发者可以直接查看源代码,学习如何集成到...

    MyBatis和IBatis配置文件中的自动补全功能

    本文将深入探讨如何在MyBatis和iBatis的配置文件中启用自动补全功能,以提高开发效率。 首先,我们来看`sql-map-2.dtd`和`sql-map-config-2.dtd`这两个文件,它们是iBatis时代的配置文件DTD(Document Type ...

    源码:【Spring+MyBatis+MySQL实战入门】一、MyBatis操作入门

    《Spring+MyBatis+MySQL实战入门》系列教程旨在帮助初学者快速掌握这三大核心技术在实际项目中的应用。本文将重点讲解MyBatis操作入门的相关知识,通过源码解析,帮助你深入理解MyBatis的工作原理及使用方法。 1. ...

    mybatis源码包

    3. **Configuration**: MyBatis的核心配置,包含了所有的Mapper配置、全局配置(比如类型别名、环境设置等)。SqlSessionFactoryBuilder和SqlSessionFactory都依赖于Configuration对象。 4. **XML配置与注解映射**:...

    mybatis-settings_Mabtis_源码

    MyBatis 设置详解 MyBatis 是一个优秀的 Java ORM(对象关系映射)框架,它允许开发者将 SQL 语句直接写在 XML 映射文件或注解中,极大地简化了数据访问层的开发工作。这份文档将深入解析 MyBatis 的核心设置,帮助...

    springmvc+mybatis+oracle

    这个文件主要用来配置MyBatis的基本设置,如别名、类型处理器、对象工厂等。 示例配置如下: ```xml &lt;?xml version="1.0" encoding="UTF-8"?&gt; &lt;!DOCTYPE configuration PUBLIC "-//mybatis.org//DTD Config 3.0//...

Global site tag (gtag.js) - Google Analytics