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

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

前言

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

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

：预定义可以复用的sql语句

：根据id引用定义的sql语句

：空白补全，配合标签使用

：条件判断，该语句返回的true，则该标签内的语句就生效

：创建一个变量，并且可以绑定到上下文

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：

uuid = #{uuid},

username = #{username},

password = #{password},

keyProperty="id"

useGeneratedKeys="true"

parameterType="User">

INSERT INTO

user

(uuid,username,password)

VALUES

(#{uuid},#{username},#{password})

keyProperty="id"

useGeneratedKeys="true"

parameterType="User">

INSERT INTO

user

(uuid,username,password)

VALUES

(#{uuid},#{username},#{password})

parameterType="User">

DELETE FROM user WHERE id = #{id}

parameterType="User">

DELETE FROM user WHERE id = #{id}

parameterType="User">

UPDATE

user

WHERE

id = #{id}

parameterType="User">

UPDATE

user

WHERE

id = #{id}

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

2、统一的查询

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

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

UserMapper.java：

@Mapper

@Repository

public interface UserMapper {

/**

* 查询所有user集合（可分页，可多条件，可单条件）

* @param user 用户对象

* @return user集合

*/

List selectList(User user);

/**

* 查询一条user记录（可多条件，可单条件）

* @param user

* @return 一条用户对象

*/

User selectOne(User user);

/**

* 查询记录数（可条件查询）

* @param user 用户对象

* @return 记录数

*/

Long count(User user);

}

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

对应的UserMapper.xml：

AND u.id = #{id}

AND u.uuid = #{uuid}

AND u.username = #{username}

AND u.password = #{password}

#{offset},#{rows}

u.id AS uId,

u.uuid AS uUuid,

u.username AS uUsername,

u.password AS uPassword

parameterType="User"

resultMap="userMap">

SELECT

FROM

user u

ORDER BY

u.id

parameterType="User"

resultMap="userMap">

SELECT

FROM

user u

ORDER BY

u.id

parameterType="User"

resultMap="userMap">

SELECT

FROM

user u

parameterType="User"

resultMap="userMap">

SELECT

FROM

user u

parameterType="User"

resultType="long">

SELECT

count(u.id)

FROM

user u

parameterType="User"

resultType="long">

SELECT

count(u.id)

FROM

user u

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

查询全表：查询字段、可全条件、可分页

查询单个：查询字段、可全条件

查询记录数：可全条件

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

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

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

标签的使用，利用标签引入相应的sql语句后，再用标签包围，注意好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 selectList(User user);

/**

* 查询一条user记录（可多条件，可单条件）

* @param user

* @return 一条用户对象

*/

User selectOne(User user);

/**

* 查询记录数（可条件查询）

* @param user 用户对象

* @return 记录数

*/

Long count(User user);

}

UserMapper.xml：

AND u.id = #{id}

AND u.uuid = #{uuid}

AND u.username = #{username}

AND u.password = #{password}

uuid = #{uuid},

username = #{username},

password = #{password},

#{offset},#{rows}

u.id AS uId,

u.uuid AS uUuid,

u.username AS uUsername,

u.password AS uPassword

keyProperty="id"

useGeneratedKeys="true"

parameterType="User">

INSERT INTO

user

(uuid,username,password)

VALUES

(#{uuid},#{username},#{password})

keyProperty="id"

useGeneratedKeys="true"

parameterType="User">

INSERT INTO

user

(uuid,username,password)

VALUES

(#{uuid},#{username},#{password})

parameterType="User">

DELETE FROM user WHERE id = #{id}

parameterType="User">

DELETE FROM user WHERE id = #{id}

parameterType="User">

UPDATE

user

WHERE

id = #{id}

parameterType="User">

UPDATE

user

WHERE

id = #{id}

parameterType="User"

resultMap="userMap">

SELECT

user u

JOIN role r on u.roleId = r.id

ORDER BY

u.id

parameterType="User"

resultMap="userMap">

SELECT

user u

JOIN role r on u.roleId = r.id

ORDER BY

u.id

parameterType="User"

resultMap="userMap">

SELECT

FROM

user u

parameterType="User"

resultMap="userMap">

SELECT

FROM

user u

parameterType="User"

resultType="long">

SELECT

count(u.id)

FROM

user u

parameterType="User"

resultType="long">

SELECT

count(u.id)

FROM

user u

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

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：

PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"

"http://mybatis.org/dtd/mybatis-3-mapper.dtd">

AND arg = #{arg}

arg = #{arg},

#{offset},#{rows}

keyProperty="id"

useGeneratedKeys="true"

parameterType="${PRE}.pojo.${Pojo}">

INSERT INTO

${TABLE_NAME}

()

VALUES

()

keyProperty="id"

useGeneratedKeys="true"

parameterType="${PRE}.pojo.${Pojo}">

INSERT INTO

${TABLE_NAME}

()

VALUES

()

parameterType="${PRE}.pojo.${Pojo}">

DELETE FROM

${TABLE_NAME}

WHERE

id = #{id}

parameterType="${PRE}.pojo.${Pojo}">

DELETE FROM

${TABLE_NAME}

WHERE

id = #{id}

parameterType="${PRE}.pojo.${Pojo}">

UPDATE

${TABLE_NAME}

WHERE

id = #{id}

parameterType="${PRE}.pojo.${Pojo}">

UPDATE

${TABLE_NAME}

WHERE

id = #{id}

parameterType="${PRE}.pojo.${Pojo}"

resultMap="${Pojo}Map">

SELECT

*

FROM

${TABLE_NAME}

ORDER BY

id

parameterType="${PRE}.pojo.${Pojo}"

resultMap="${Pojo}Map">

SELECT

*

FROM

${TABLE_NAME}

ORDER BY

id

parameterType="${PRE}.pojo.${Pojo}"

resultMap="${Pojo}Map">

SELECT

*

FROM

${TABLE_NAME}

parameterType="${PRE}.pojo.${Pojo}"

resultMap="${Pojo}Map">

SELECT

*

FROM

${TABLE_NAME}

parameterType="${PRE}.pojo.${Pojo}"

resultType="long">

SELECT

count(id)

FROM

${TABLE_NAME}

parameterType="${PRE}.pojo.${Pojo}"

resultType="long">

SELECT

count(id)

FROM

${TABLE_NAME}

${PRE}：包的前缀

${Pojo}：对象的类名

${TABLE_NAME}：表名

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

5、连接关系表

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

parameterType="com.fangaoxs.userserver.pojo.User"

resultMap="userMap">

SELECT

,

FROM

user u

JOIN role r on u.roleId = r.id

ORDER BY

u.id

parameterType="com.fangaoxs.userserver.pojo.User"

resultMap="userMap">

SELECT

,

FROM

user u

JOIN role r on u.roleId = r.id

ORDER BY

u.id

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

总结

版权声明：本文内容由网络用户投稿，版权归原作者所有，本站不拥有其著作权，亦不承担相应法律责任。如果您发现本站中有涉嫌抄袭或描述失实的内容，请联系我们jiasou666@gmail.com 处理，核实后本网站将在24小时内删除侵权内容。