MyBatis常用标签及标签使用技巧
Posted weixin_45747080
tags:
篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了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"以上是关于MyBatis常用标签及标签使用技巧的主要内容，如果未能解决你的问题，请参考以下文章