MyBatis常用标签以及使用技巧总结

更新时间：2021年05月13日 10:15:27 作者：weixin_45747080

在我们的学习过程中，我们经常使用到mybatis，这篇文章主要给大家介绍了关于MyBatis常用标签以及使用技巧的相关资料，需要的朋友可以参考下

前言

MyBatis常用标签及标签使用技巧

MyBatis的常用标签有很多，比如

<sql id="">：预定义可以复用的sql语句

<include refid="">：根据id引用定义的sql语句

<trim>：空白补全，配合<if>标签使用

<if test="">：条件判断，该语句返回的true，则该标签内的语句就生效

<bind name="" value="">：创建一个变量，并且可以绑定到上下文

1、统一的增删改

通过我暂时的开发经验来说，我认为对一张表增删改操作，起码包括：增加一条记录、删除一条记录、修改一条记录。所以一张表的操作起码包括：增删改。

增加一条是主键id自增，删除一条记录是根据主键id删除，修改一条记录是根据主键id修改，返回值都是Integer类型的成功增删改的记录条数。以User对象为例：

UserMapper.java：

@Mapper
@Repository
public interface UserMapper {

    /**
     * 增加一条记录
     * @param user 用户对象
     * @return 增加成功的记录数
     */
    Integer insertOne(User user);

    /**
     * 删除一条记录
     * @param user 用户对象
     * @return 删除成功的记录数
     */
    Integer deleteOne(User user);

    /**
     * 修改用户
     * @param user 用户对象
     * @return 修改成功的记录数
     */
    Integer updateOne(User user);
}

则对应的UserMapper.xml：

<mapper namespace="UserMapper">
    <!--update的条件sql（除了自增主键id）-->
    <sql id="updateCondition">
        <if test=" uuid!=null and uuid!='' ">
            uuid = #{uuid},
        </if>
        <if test=" username!=null and username!='' ">
            username = #{username},
        </if>
        <if test=" password!=null and password!='' ">
            password = #{password},
        </if>
    </sql>
    <!--新增一条-->
    <insert id="insertOne"
            keyProperty="id"
            useGeneratedKeys="true"
            parameterType="User">
        INSERT INTO
            user
            (uuid,username,password)
        VALUES
            (#{uuid},#{username},#{password})
    </insert>
    <!--删除一条-->
    <delete id="deleteOne"
            parameterType="User">
        DELETE FROM user WHERE id = #{id}
    </delete>
    <!--修改一条（根据id主键）-->
    <update id="updateOne"
            parameterType="User">
        UPDATE
            user
        <trim prefix="SET" suffixOverrides=",">
            <include refid="updateCondition"></include>
        </trim>
        WHERE
            id = #{id}
    </update>
</mapper>

由于一般修改语句是根据id，所以在<update>标签中，WHERE id = #{id}是写死了的。一般修改的话，是除了id可以修改其余都是可以修改的，所以一般字段会比较多，利用<sql>标签预定义好除了id的字段，并且利用<if>标签包裹起来，同时特别注意：最后要加上逗号。然后在<trim>标签中利用<include>标签引用预定义的修改语句的条件。<include>标签就相当于直接把该id的sql语句直接粘贴到这里，这里是为了看起整体排版比较舒服所以才这么做的。

2、统一的查询

通过我暂时的开发经验来说，我认为对一张表查询操作，起码包括：查询多条记录（可分页可条件）、查询一条记录（可条件），查询该表的总记录数。所以一张表的操作起码包括：三个查询。

查询列表、单个查询、查询该表的总记录数，同样是以User对象为例：

UserMapper.java：

@Mapper
@Repository
public interface UserMapper {

    /**
     * 查询所有user集合（可分页，可多条件，可单条件）
     * @param user 用户对象
     * @return user集合
     */
    List<User> selectList(User user);

    /**
     * 查询一条user记录（可多条件，可单条件）
     * @param user
     * @return  一条用户对象
     */
    User selectOne(User user);

    /**
     * 查询记录数（可条件查询）
     * @param user  用户对象
     * @return  记录数
     */
    Long count(User user);

}

分别返回User集合、单个User对象以及记录数。

对应的UserMapper.xml：

<mapper namespace="UserMapper">
    <!--select的条件sql（全有）-->
    <sql id="selectCondition">
        <if test=" id!=null and id!='' ">
            AND u.id = #{id}
        </if>
        <if test=" uuid!=null and uuid!='' ">
            AND u.uuid = #{uuid}
        </if>
        <if test=" username!=null and username!='' ">
            AND u.username = #{username}
        </if>
        <if test=" password!=null and password!='' ">
            AND u.password = #{password}
        </if>
    </sql>
    <!--分页的条件sql（当前页，每页记录数）-->
    <sql id="limitCondition">
        <if test=" currentPage!=null and currentPage!='' and pageSize!=null and pageSize!='' ">
            <bind name="offset" value="pageSize*(currentPage-1)"/>
            <bind name="rows" value="pageSize"/>
            #{offset},#{rows}
        </if>
    </sql>
    <!--user表的别名-->
    <sql id="userAs">
        u.id                AS uId,
        u.uuid              AS uUuid,
        u.username          AS uUsername,
        u.password          AS uPassword
    </sql>
    <!--返回的结果集-->
    <resultMap id="userMap" type="User">
        <id column="uId" property="id"/>
        <result column="uUuid" property="uuid"/>
        <result column="uUsername" property="username"/>
        <result column="uPassword" property="password"/>
    </resultMap>
    <!--查询所有（可分页，可单条件，可多条件）-->
    <select id="selectList"
            parameterType="User"
            resultMap="userMap">
        SELECT
            <include refid="userAs"></include>
        FROM
            user u
        <trim prefix="WHERE" prefixOverrides="AND">
            <include refid="selectCondition"></include>
        </trim>
        ORDER BY
            u.id
        <trim prefix="LIMIT">
            <include refid="limitCondition"></include>
        </trim>
    </select>
    <!--查询一条（可单条件，可多条件）-->
    <select id="selectOne"
            parameterType="User"
            resultMap="userMap">
        SELECT
            <include refid="userAs"></include>
        FROM
            user u
        <trim prefix="WHERE" prefixOverrides="AND">
            <include refid="selectCondition"></include>
        </trim>
    </select>
    <!--查询记录数（可单条件，可多条件）-->
    <select id="count"
            parameterType="User"
            resultType="long">
        SELECT
            count(u.id)
        FROM
            user u
        <trim prefix="WHERE" prefixOverrides="AND">
            <include refid="selectCondition"></include>
        </trim>
    </select>
</mapper>

根据三个需求：查询全表、查询单个两个都可以用到条件查询，所以都可以用到同样的sql，所以就可以使用同样的<sql>标签来预定义然后复用。小结一下就是：

查询全表：查询字段、可全条件、可分页
查询单个：查询字段、可全条件
查询记录数：可全条件

得益于<trim>标签和<if>标签的配合（if标签判断条件是否成立，如果成立则if标签内部语句生效，trim判断内部是否有语句，如果有则trim生效），没有条件传入就查询全表，没有分页传入的时候就不分页，做到了有条件则查条件，无条件则全查，有分页则查分页，无分页则全查。同时定义好结果集映射（column是查出来的列，property是Pojo对象的属性，需要对应好）以及配置好查询字段的别名（AS）。定义结果集和配置查询字段的别名是方便以后扩展。

条件查询的<sql>需要注意的是利用AND连接。

分页的<sql>需要注意的是利用<bind>标签来定义变量，注意变量的换算，一般采用的是传入当前页（currentPage）和每页记录数（pageSize），而数据库中limit语句的参数是limit offset,rows，offset（偏移量，也就是从表中的第几个元素开始，0是首位），rows（记录数，也就是返回多少个），总的来说就是从第几个开始，返回第条记录。然后利用简单的数学换算，将currentPage和pageSize转换为offset和rows。

<trim>标签的使用，利用<include>标签引入相应的sql语句后，再用<trim>标签包围，注意好prefix、suffix、prefixOverrides和suffixOverrides。

注意

SQL语句中各关键字的顺序

3、统一的增删改查

最后将增删改和查询总结合并起来就是：

UserMapper.java：

@Mapper
@Repository
public interface UserMapper {

    /**
     * 增加一条记录
     * @param user 用户对象
     * @return 增加成功的记录数
     */
    Integer insertOne(User user);

    /**
     * 删除一条记录
     * @param user 用户对象
     * @return 删除成功的记录数
     */
    Integer deleteOne(User user);

    /**
     * 修改用户
     * @param user 用户对象
     * @return 修改成功的记录数
     */
    Integer updateOne(User user);

    /**
     * 查询所有user集合（可分页，可多条件，可单条件）
     * @param user 用户对象
     * @return user集合
     */
    List<User> selectList(User user);

    /**
     * 查询一条user记录（可多条件，可单条件）
     * @param user
     * @return  一条用户对象
     */
    User selectOne(User user);

    /**
     * 查询记录数（可条件查询）
     * @param user  用户对象
     * @return  记录数
     */
    Long count(User user);

}

UserMapper.xml：

<mapper namespace="UserMapper">
    <!--select的条件sql（全有）-->
    <sql id="selectCondition">
        <if test=" id!=null and id!='' ">
            AND u.id = #{id}
        </if>
        <if test=" uuid!=null and uuid!='' ">
            AND u.uuid = #{uuid}
        </if>
        <if test=" username!=null and username!='' ">
            AND u.username = #{username}
        </if>
        <if test=" password!=null and password!='' ">
            AND u.password = #{password}
        </if>
    </sql>
    <!--update的条件sql（除了自增主键id）-->
    <sql id="updateCondition">
        <if test=" uuid!=null and uuid!='' ">
            uuid = #{uuid},
        </if>
        <if test=" username!=null and username!='' ">
            username = #{username},
        </if>
        <if test=" password!=null and password!='' ">
            password = #{password},
        </if>
    </sql>
    <!--分页的条件sql（当前页，每页记录数）-->
    <sql id="limitCondition">
        <if test=" currentPage!=null and currentPage!='' and pageSize!=null and pageSize!='' ">
            <bind name="offset" value="pageSize*(currentPage-1)"/>
            <bind name="rows" value="pageSize"/>
            #{offset},#{rows}
        </if>
    </sql>
    <!--user表的别名-->
    <sql id="userAs">
        u.id                AS uId,
        u.uuid              AS uUuid,
        u.username          AS uUsername,
        u.password          AS uPassword
    </sql>
    <!--返回的结果集-->
    <resultMap id="userMap" type="User">
        <id column="uId" property="id"/>
        <result column="uUuid" property="uuid"/>
        <result column="uUsername" property="username"/>
        <result column="uPassword" property="password"/>
    </resultMap>
    <!--新增一条-->
    <insert id="insertOne"
            keyProperty="id"
            useGeneratedKeys="true"
            parameterType="User">
        INSERT INTO
            user
            (uuid,username,password)
        VALUES
            (#{uuid},#{username},#{password})
    </insert>
    <!--删除一条-->
    <delete id="deleteOne"
            parameterType="User">
        DELETE FROM user WHERE id = #{id}
    </delete>
    <!--修改一条（根据id主键）-->
    <update id="updateOne"
            parameterType="User">
        UPDATE
            user
        <trim prefix="SET" suffixOverrides=",">
            <include refid="updateCondition"></include>
        </trim>
        WHERE
            id = #{id}
    </update>
    <!--查询所有（可分页，可单条件，可多条件）-->
    <select id="selectList"
            parameterType="User"
            resultMap="userMap">
        SELECT
            <include refid="userAs"></include>
            user u
            JOIN role r on u.roleId = r.id
        <trim prefix="WHERE" prefixOverrides="AND">
            <include refid="selectCondition"></include>
        </trim>
        ORDER BY
            u.id
        <trim prefix="LIMIT">
            <include refid="limitCondition"></include>
        </trim>
    </select>
    <!--查询一条（可单条件，可多条件）-->
    <select id="selectOne"
            parameterType="User"
            resultMap="userMap">
        SELECT
            <include refid="userAs"></include>
        FROM
            user u
        <trim prefix="WHERE" prefixOverrides="AND">
            <include refid="selectCondition"></include>
        </trim>
    </select>
    <!--查询记录数（可单条件，可多条件）-->
    <select id="count"
            parameterType="User"
            resultType="long">
        SELECT
            count(u.id)
        FROM
            user u
        <trim prefix="WHERE" prefixOverrides="AND">
            <include refid="selectCondition"></include>
        </trim>
    </select>
</mapper>

对一张表的操作最起码就应该包括以上：增加一条记录、删除一条记录、修改一条记录、查询列表（可条件、可分页）、查询一条（可条件）、查询记录数（可条件）。

4、利用IDEA的Code Templates自动生成

总结后观察到，每张表都有这6个操作，并且代码基本上都大致相同，差别只是对象的名字和表中字段不一样，那我每次创建Mapper文件都需要手敲吗？NoNoNo，可以利用IDEA的Code Templates功能，预先定义好Mapper Java和Mapper Xml的大致结构，然后利用传参传入对象名就可以了，这样每次就能自动生成大量代码，然后只需要修改极少部分代码就可以了。

Code Templates文件的创建：

打开IDEA，左上角依次点击：File->搜索template->找到File and Code Templates，在右侧创建新文件，输入文件名，扩展名Java：

#if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "") package ${PACKAGE_NAME};#end

import org.apache.ibatis.annotations.Mapper;
import org.springframework.stereotype.Repository;

import java.util.List;
#parse("File Header.java")

@Mapper
@Repository
public interface ${NAME} {

    /**
     * 增加一条记录
     * @param ${pojo} ${name}对象
     * @return 增加成功的记录数
     */
    Integer insertOne(${Pojo} ${pojo});

    /**
     * 删除一条记录
     * @param ${pojo} ${name}对象
     * @return 删除成功的记录数
     */
    Integer deleteOne(${Pojo} ${pojo});

    /**
     * 修改一条记录
     * @param ${pojo} ${name}对象
     * @return 修改成功的记录数
     */
    Integer updateOne(${Pojo} ${pojo});

    /**
     * 查询所有集合（可分页，可多条件，可单条件）
     * @param ${pojo} ${name}对象
     * @return ${pojo}集合
     */
    List<${Pojo}> selectList(${Pojo} ${pojo});
    
    /**
     * 查询一条${pojo}记录（可多条件，可单条件）
     * @param ${pojo} ${name}对象
     * @return  一条${name}对象
     */
    ${Pojo} selectOne(${Pojo} ${pojo});

    /**
     * 查询记录数（可条件查询）
     * @param ${pojo}  ${name}对象
     * @return  记录数
     */
    Long count(${Pojo} ${pojo});

}

${Pojo}：Pojo对象的类名

${pojo}：Pojo对象的变量名

这样下次在新建Mapper.java文件的时候直接利用该template创建就可以了。

同样的，Mapper.xml：

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapper
        PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
        "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="${PRE}.mapper.${NAME}">
    <!--select的条件sql（全有）-->
    <sql id="selectCondition">
        <if test=" arg!=null and arg!='' ">
            AND arg = #{arg}
        </if>
    </sql>
    <!--update的条件sql（除了自增主键id）-->
    <sql id="updateCondition">
        <if test=" arg!=null and arg!='' ">
            arg = #{arg},
        </if>
    </sql>
    <!--分页的条件sql（当前页，每页记录数）-->
    <sql id="limitCondition">
        <if test=" currentPage!=null and currentPage!='' and pageSize!=null and pageSize!='' ">
            <bind name="offset" value="pageSize*(currentPage-1)"/>
            <bind name="rows" value="pageSize"/>
            #{offset},#{rows}
        </if>
    </sql>
    <!--返回的结果集-->
    <resultMap id="${Pojo}Map" type="${PRE}.pojo.${Pojo}">
        <id column="id" property="id"/>
        <result column="" property=""/>
    </resultMap>
    <!--新增一条记录-->
    <insert id="insertOne"
            keyProperty="id"
            useGeneratedKeys="true"
            parameterType="${PRE}.pojo.${Pojo}">
        INSERT INTO
            ${TABLE_NAME}
            ()
        VALUES
            ()
    </insert>
    <!--删除一条记录-->
    <delete id="deleteOne"
            parameterType="${PRE}.pojo.${Pojo}">
        DELETE FROM
            ${TABLE_NAME}
        WHERE
            id = #{id}
    </delete>
    <!--修改一条记录（根据id主键）-->
    <update id="updateOne"
            parameterType="${PRE}.pojo.${Pojo}">
        UPDATE
            ${TABLE_NAME}
        <trim prefix="SET" suffixOverrides=",">
            <include refid="updateCondition"></include>
        </trim>
        WHERE
            id = #{id}
    </update>
    <!--查询所有（可分页，可单条件，可多条件）-->
    <select id="selectList"
            parameterType="${PRE}.pojo.${Pojo}"
            resultMap="${Pojo}Map">
        SELECT
            *
        FROM
            ${TABLE_NAME}
        <trim prefix="WHERE" prefixOverrides="AND">
            <include refid="selectCondition"></include>
        </trim>
        ORDER BY
            id
        <trim prefix="LIMIT">
            <include refid="limitCondition"></include>
        </trim>
    </select>
    <!--查询一条（可单条件，可多条件）-->
    <select id="selectOne"
            parameterType="${PRE}.pojo.${Pojo}"
            resultMap="${Pojo}Map">
        SELECT
            *
        FROM
            ${TABLE_NAME}
        <trim prefix="WHERE" prefixOverrides="AND">
            <include refid="selectCondition"></include>
        </trim>
    </select>
    <!--根据主键id（效率高）查询记录数（可单条件，可多条件）-->
    <select id="count"
            parameterType="${PRE}.pojo.${Pojo}"
            resultType="long">
        SELECT
            count(id)
        FROM
            ${TABLE_NAME}
        <trim prefix="WHERE" prefixOverrides="AND">
            <include refid="selectCondition"></include>
        </trim>
    </select>
</mapper>

${PRE}：包的前缀

${Pojo}：对象的类名

${TABLE_NAME}：表名

即可以非常快速地生成Mapper.java和Mapper.xml了

5、连接关系表

因为Mybatis的特性，它可以连表查询。同样的，我们利用上述的方法创建好RoleMapper，如果想要在UserMapper中使用RoleMapper中定义好的sql，那么直接使用<include refid="包名+id">，下面是在UserMapper.xml中使用user表和role表连表查询列表举例：

	<!--查询所有（可分页，可单条件，可多条件）-->
    <select id="selectList"
            parameterType="com.fangaoxs.userserver.pojo.User"
            resultMap="userMap">
        SELECT
            <include refid="userAs"></include>,
            <include refid="com.xxx.userserver.mapper.RoleMapper.roleAs"></include>
        FROM
            user u
            JOIN role r on u.roleId = r.id
        <trim prefix="WHERE" prefixOverrides="AND">
            <include refid="selectCondition"></include>
        </trim>
        ORDER BY
            u.id
        <trim prefix="LIMIT">
            <include refid="limitCondition"></include>
        </trim>
    </select>

那么，这样就实现了user表和role的联合查询，并且roleMapper.xml中的<sql>也在userMapper.xml中得到了复用。

总结

到此这篇关于MyBatis常用标签以及使用技巧总结的文章就介绍到这了,更多相关MyBatis常用标签使用技巧内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

IntelliJ IDEA中出现"PSI and index do not match"错误的解决办法
今天小编就为大家分享一篇关于IntelliJ IDEA中出现"PSI and index do not match"错误的解决办法，小编觉得内容挺不错的，现在分享给大家，具有很好的参考价值，需要的朋友一起跟随小编来看看吧
2018-10-10
Spring Boot 参数校验的具体实现方式
这篇文章主要介绍了Spring Boot 参数校验的具体实现方式，小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧
2019-06-06
java实现的统计字符算法示例
这篇文章主要介绍了java实现的统计字符算法,涉及java针对字符的遍历、判断、运算等相关操作技巧,需要的朋友可以参考下
2017-10-10
mybatis-plus使用@EnumValue处理枚举类型的示例代码
这篇文章主要介绍了mybatis-plus使用@EnumValue处理枚举类型的示例代码，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2020-09-09
java中获取当前服务器的Ip地址的方法
本篇文章主要介绍了java中获取当前服务器的Ip地址的方法，小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧
2017-02-02
Java中监听器Listener详解
Listener是由Java编写的WEB组件，主要完成对内置对象状态的变化（创建、销毁）和属性的变化进行监听，做进一步的处理，主要对session和application内置对象监听，这篇文章主要介绍了Java中监听器Listener,需要的朋友可以参考下
2023-08-08
JAVA API 实用类 String详解
这篇文章主要介绍了java String的深入理解的相关资料,希望通过本文大家能理解String的用法，需要的朋友可以参考下
2021-10-10
Spring注解之@Import注解的使用和源码分析
今天主要介绍Spring @Import注解，在Spring中@Import使用得比较频繁，它得作用是导入bean，具体的导入方式有多种，特别在SpringBoot项目中，很多地方都使用到了@Import注解，感兴趣的小伙伴可以参考阅读
2023-04-04
Spring Boot Actuator 漏洞利用小结
spring对应两个版本，分别是Spring Boot 2.x和Spring Boot 1.x，因此后面漏洞利用的payload也会有所不同，这篇文章主要介绍了Spring Boot Actuator 漏洞利用小结,需要的朋友可以参考下
2023-11-11
详解Spring 注解之@Import 注入的各种花活
这篇文章主要介绍了详解Spring 注解之@Import 注入的各种花活，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2020-01-01