MyBatis 配置 typeAliases 详解

0x00：前言参考

之前的《MyBatis 中 SqlMapConfig 配置文件详解》记了一下 MyBatis 中的核心配置文件各个标签的作用和使用场景，这篇文章细说一下配置文件中 typeAliases 标签的详细使用。

0x01：标签介绍

在 MyBatis 的 sql 映射配置文件中，需要使用 paramterType、resultType 来设置 sql 语句的输入输出参数，一般参数都是基本的数据类型或封装类型，但都需要声明该类型的全路径，java.lang.String，或者 cn.com.mybatis.pojo.User, 这时就可以通过 typeAliases 别名来设置，简化复杂度

0x02：代码示例

例如之前介绍的模糊查询示例，当不使用别名，而使用全路径时，配置示例代码如下：

    
    

      
      

       
       

      
      
      
      

       
       

        
        <
        
        select id=
        
        "findUserByUsername" parameterType=
        
        "java.lang.String" resultType=
        
        "cn.com.mybatis.pojo.User">
       
       
      
      

      
      

       
       

      
      
      
      

       
       
    
        
        SELECT * FROM USER WHERE username LIKE 
        
        '%${value}%'
       
       
      
      

      
      

       
       

      
      
      
      

       
       

        
        </
        
        select>
       
       
      
      
    
    

当通过设置 MyBatis 的全局配置文件 SqlMapConfig 中的 typeAliases 属性后，就可以为 sql 映射文件中的输入 / 输出参数设置类型别名，然后在 sql 映射配置文件中指定输入输出参数类型时使用的别名。首先，SqlMapConfig 配置文件示例如下：

    
    

      
      

       
       

      
      
      
      

       
       

        
        <typeAliases>
       
       
      
      

      
      

       
       

      
      
      
      

       
       
    
        
        <typeAlias 
        
        alias
        
        =
        
        "user"
        
         
        
        type
        
        =
        
        "cn.com.mybatis.pojo.User"
        
        />
       
       
      
      

      
      

       
       

      
      
      
      

       
       
    
        
        <typeAlias 
        
        alias
        
        =
        
        "str"
        
         
        
        type
        
        =
        
        "java.lang.String"
        
        />
       
       
      
      

      
      

       
       

      
      
      
      

       
       

        
        </typeAliases>
       
       
      
      
    
    

这样就可以在 sql 映射配置文件中使用别名来指定输入 / 输出参数的类型了，其示例代码如下：

    
    

      
      

       
       

      
      
      
      

       
       

        
        <
        
        select id=
        
        "findUserByUsername" parameterType=
        
        "str" resultType=
        
        "user">
       
       
      
      

      
      

       
       

      
      
      
      

       
       
    
        
        SELECT * FROM USER WHERE username LIKE 
        
        '%${value}%'
       
       
      
      

      
      

       
       

      
      
      
      

       
       

        
        </
        
        select>
       
       
      
      
    
    

0x03：别名拓展

像刚才的 JavaBean，User 是放在 cn.com.mybatis.pojo 包里的，包里可能也会存在其他多个 JavaBean，这时候一个一个配置别名就会很麻烦，这时候就需要批量定义别名，批量指定很简单，只要指定包名即可，之后程序会为包下的所有类都自动加上别名，其定义别名的规范就是对应包装类的类名首字母变为小写，其示例代码如下：

    
    

      
      

       
       

      
      
      
      

       
       

        
        <typeAliases>
       
       
      
      

      
      

       
       

      
      
      
      

       
       
    
        
        <package name="cn.com.mybatis.pojo"/>
       
       
      
      

      
      

       
       

      
      
      
      

       
       

        
        </typeAliases>
       
       
      
      
    
    

这时设置的包名下的类就都有了别名，别名就是类名（首字母小写），像刚才的 User 类，其别名就为 user。
除了在配置文件中单独的配置别名和批量的配置别名两种方式外，还有一种方式，就是通过注解的方式来配置别名，方法也很简单，在需要配置别名的类前通过 @Alias 注解即可，参数就是别名名称，例如以下示例代码：

    
    

      
      

       
       

      
      
      
      

       
       

        
        @Alias
        
        (
        
        "user"
        
        )
       
       
      
      

      
      

       
       

      
      
      
      

       
       

        
        public 
        
        class
        
         
        
        User{
       
       
      
      

      
      

       
       

      
      
      
      

       
       
    
        
        //其他代码
       
       
      
      

      
      

       
       

      
      
      
      

       
       

        
        }
       
       
      
      
    
    

0x04：常见类型别名汇总

MyBatis 已经为 Java 常见类型默认指定了别名，可以直接使用。因为有一些基本数据类型和包装类型的名称一样（例如基本数据类型 byte 和包装类型 java.lang.Byte），所以在基本的数据类型前面加了下划线 “_” 来以此区分（byte 别名就是_byte，java.lang.Byte 别名就是 byte）。常见的类型对应别名如下：

 

 

 

0x05：总结

在开发中，经常使用别名，可以提高开发效率，简化配置。

---

                                                                      公众号推荐：aFa攻防实验室

                         分享关于信息搜集、Web安全、内网安全、代码审计、红蓝对抗、Java、Python等方面的东西。