在mybatis配置实体类的别名的两种常用配置方法

为什么要给实体类配置别名?

  • 目的是为了在引用实体类时可以使用实体类的别名来代替实体类,达到简写的目的

配置的方法(都是在mybatis的配置xml文件中进行配置)

  • 第一种方法,给单独的某个实体类配置别名,如同下面的形式
<!--为实体类com.demo.dao.User配置一个别名User-->
<typeAliases>
    <typeAlias type="com.demo.dao.User" alias="User"/>
</typeAliases>
  • 第二种方法,批量为某个包下的所有实体类设置别名,配置形式如下
<!-- 为com.demo.dao包下的所有实体类配置别名,
MyBatis默认的设置别名的方式就是去除类所在的包后的简单的类名,
比如com.demo.dao.User这个实体类的别名就会被设置成User
 -->
<typeAliases>
        <package name="com.demo.dao"/>
</typeAliases>

代码例子说明

  • 没有配置前的mapper文件夹的xml文件:如UserDao对应的UserMapper.xml文件如下
<?xml version="1.0" encoding="UTF-8" ?>   
<!DOCTYPE mapper   
PUBLIC "-//ibatis.apache.org//DTD Mapper 3.0//EN"  
"http://ibatis.apache.org/dtd/ibatis-3-mapper.dtd">
<mapper namespace="com.demo.dao.UserDao">
 
    <select id="findUserById" resultType="com.demo.entity.User">
        select * from user where id = #{id}
    </select>
    
    <insert id="addUser" parameterType="com.demo.entity.User" useGeneratedKeys="true" keyProperty="id">
        insert into user(name,password,age) values(#{name},#{password},#{age})
    </insert>
    
    <delete id="deleteUser" parameterType="int">
        delete from user where id = #{id}
    </delete>
    
    <update id="updateUser" parameterType="com.demo.entity.User">
        update user set name = #{name}, password = #{password}, age = #{age} where id = #{id}
    </update>
 
</mapper>

从这个配置文件中,我们可以看到<select>、<insert>和<update>三个标签元素的resultType都是User对象,需要设置这个User对象的类全限定名,即packname.classname。
我们发现一个问题,那就是这个类名,我们需要写多次,如果要改这个类名的话,我们需要在多个地方进行修改。很明显,这样配置的话很容易造成修改上的遗漏,同时也书写上也比较麻烦。因此,MyBatis为我们提供了一个简单方便的配置方法,那就是使用<typeAliases>标签元素,给实体类设置一个别名。

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE configuration  
    PUBLIC "-//mybatis.org//DTD Config 3.0//EN"  
    "http://mybatis.org/dtd/mybatis-3-config.dtd">
<configuration>
 
    <properties resource="mysql.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/demo?characterEncoding=utf-8"/>
    </properties>
 
    <settings>
        <setting name="logImpl" value="LOG4J" />
    </settings>
    
    <typeAliases>
        <typeAlias alias="User" type="com.demo.entity.User"/> 
    </typeAliases>
 
    <!-- 和spring整合后 environments配置将废除 -->
    <environments default="development">
        <environment id="development">
            <!-- 使用jdbc事务管理 -->
            <transactionManager type="JDBC" />
            <!-- 数据库连接池 -->
            <dataSource type="POOLED">
                <property name="driver" value="${driver}" />
                <property name="url" value="${url}" />
                <property name="username" value="${username}" />
                <property name="password" value="${password}" />
            </dataSource>
        </environment>
    </environments>
 
    <mappers>
        <mapper resource="com\demo\resource\mapper\UserMapper.xml" />
    </mappers>
 
</configuration>

如上所示,我们在原来的mybatis配置文件中增加了<typeAliases>标签,并将com.demo.dao.User这个实体类重命名为User,然后我们在mapper配置文件中就可以如下使用了。

备注:这里需要注意的是,typeAliases配置需要放置在settings之后,否则会出异常!!!

<?xml version="1.0" encoding="UTF-8" ?>   
<!DOCTYPE mapper   
PUBLIC "-//ibatis.apache.org//DTD Mapper 3.0//EN"  
"http://ibatis.apache.org/dtd/ibatis-3-mapper.dtd">
<mapper namespace="com.demo.dao.UserDao">
 
    <select id="findUserById" resultType="User">
        select * from user where id = #{id}
    </select>
    
    <insert id="addUser" parameterType="User" useGeneratedKeys="true" keyProperty="id">
        insert into user(name,password,age) values(#{name},#{password},#{age})
    </insert>
    
    <delete id="deleteUser" parameterType="int">
        delete from user where id = #{id}
    </delete>
    
    <update id="updateUser" parameterType="User">
        update user set name = #{name}, password = #{password}, age = #{age} where id = #{id}
    </update>
 
</mapper>

这样即使实体类名修改了,所需要修改的地方也只有一处,便于集中管理.

在具体项目中,实体类是非常多的,所有更多时候我们需要批量为某个包下的所有实体类设置别名,所以只要在上面配置单个实体类的别名的地方,改成批量配置别名的方式即可,如下图

 <typeAliases>
        <!-- 为实体类com.demo.entity.User配置一个别名User -->
        <!-- <typeAlias type="com.demo.entity.User" alias="User"/> -->
        <!-- 为com.demo.entity包下的所有实体类配置别名,MyBatis默认的设置别名的方式就是去除类所在的包后的简单的类名
        比如com.demo.entity.User这个实体类的别名就会被设置成User
         -->
        <package name="com.demo.entity"/>
    </typeAliases>

参考了此处的文章:
https://blog.csdn.net/majinggogogo/article/details/71503263

©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容

  • 1. 简介 1.1 什么是 MyBatis ? MyBatis 是支持定制化 SQL、存储过程以及高级映射的优秀的...
    笨鸟慢飞阅读 5,838评论 0 4
  • 小样,祝你幸福 当文字落在纸上时,又到了炎炎夏日。和你分开已经多年,不知你的近况,只希望你过的比我好,祝你...
    慣看春秋阅读 411评论 0 1
  • 我轻轻登上沧海边的礁石上,瞭望大海。水波轻轻荡漾,像一条绿丝带般轻轻的拂过。对面的山岛耸立着,树木在上面正默默地汲...
    智九云阅读 503评论 1 4
  • 每近春节,我都会把我这一年的朋友圈都翻阅一遍,看看来时的路,不忘初心,然后有仪式感地跟过去告别,纵情向前。虽然人类...
    老藏漂小康阅读 350评论 0 1