掌握Mybatis动态映射，我可是下了功夫的

关注“Java后端技术全栈”

回复“面试”获取全套面试资料

动态 SQL 是 MyBatis 的强大特性之一。如果你使用过 JDBC 或其它类似的框架，你应该能理解根据不同条件拼接 SQL 语句有多痛苦，例如拼接时要确保不能忘记添加必要的空格，还要注意去掉列表最后一个列名的逗号。利用动态 SQL，可以彻底摆脱这种痛苦。

使用动态 SQL 并非一件易事，但借助可用于任何 SQL 映射语句中的强大的动态 SQL 语言，MyBatis 显著地提升了这一特性的易用性。

如果你之前用过 JSTL 或任何基于类 XML 语言的文本处理器，你对动态 SQL 元素可能会感觉似曾相识。在 MyBatis 之前的版本中，需要花时间了解大量的元素。借助功能强大的基于 OGNL 的表达式，MyBatis 3 替换了之前的大部分元素，大大精简了元素种类，现在要学习的元素种类比原来的一半还要少。


if：利用if实现简单的条件选择。

choose(when,otherwise)：相当于java中的switch语句，通常与when和otherwise搭配。

set：解决动态更新语句。

trim：灵活的去除多余的关键字。

foreach：迭代一个集合，通常用于in条件。

实际工作中很多时候，这几个标签都是组合着使用。

今天的演示使用的是Spring-Boot+Mybatis进行演示，对于Spring-Boot整合Mybatis推荐：

if+where实现多条件查询

创建一种昂数据库表：

  1. CREATE TABLE `m_user` (
  2.   `id` int(11) NOT NULL AUTO_INCREMENT,
  3.   `name` varchar(255) DEFAULT NULL,
  4.   `age` int(11) DEFAULT NULL,
  5.   `gender` int(11) DEFAULT NULL COMMENT '0:女生 1:男生',
  6.   PRIMARY KEY (`id`)
  7. ) ENGINE=InnoDB AUTO_INCREMENT=11 DEFAULT CHARSET=utf8mb4;

初始化几条数据：


















先来看UserMapper.xml文件：

  1. <mapper namespace="com.tian.mybatis.mapper.UserMapper">
  2.     <resultMap id="User" type="com.tian.mybatis.entity.User">
  3.         <id column="id" property="id"/>
  4.         <result column="name" property="userName"/>
  5.     </resultMap>
  6.     <select id="selectUserById"  resultMap="User">
  7.         select * from m_user
  8.         <where>
  9.             <if test="id != null">
  10.                 id = #{id}
  11.             </if>
  12.             <if test="name != null and name != ''">
  13.                 and `name` = #{name}
  14.             </if>
  15.         </where>
  16.     </select>
  17. </mapper>

UserMapper.java内容：

  1. import com.tian.mybatis.entity.User;
  2. import org.apache.ibatis.annotations.Param;
  3. import org.springframework.stereotype.Repository;
  4.  
  5. @Repository
  6. public interface UserMapper {
  7.     User selectUserById(@Param("name") String userName, @Param("id") Integer id);
  8. }

UserService.java内容：

  1. public interface UserService {
  2.     User selectUserById(String userName, Integer id);
  3. }

UserServiceImpl.java内容：

  1. import com.tian.mybatis.entity.User;
  2. import com.tian.mybatis.mapper.UserMapper;
  3. import com.tian.mybatis.service.UserService;
  4. import org.springframework.stereotype.Service;
  5.  
  6. import javax.annotation.Resource;
  7.  
  8. @Service
  9. public class UserServiceImpl implements UserService {
  10.  
  11.     @Resource
  12.     private UserMapper userMapper;
  13.  
  14.     @Override
  15.     public User selectUserById(String userName, Integer id) {
  16.         return userMapper.selectUserById(userName, id);
  17.     }
  18. }

UserController.java内容：

  1. import com.tian.mybatis.entity.User;
  2. import com.tian.mybatis.service.UserService;
  3. import org.springframework.web.bind.annotation.GetMapping;
  4. import org.springframework.web.bind.annotation.RestController;
  5.  
  6. import javax.annotation.Resource;
  7.  
  8. @RestController
  9. public class UserController {
  10.  
  11.     @Resource
  12.     private UserService userService;
  13.  
  14.     @GetMapping("/test")
  15.     public User selectUserById() {
  16.         return userService.selectUserById("tian", 1);
  17.     }
  18. }

Application.java内容：

  1. import org.mybatis.spring.annotation.MapperScan;
  2. import org.springframework.boot.SpringApplication;
  3. import org.springframework.boot.autoconfigure.SpringBootApplication;
  4.  
  5. @SpringBootApplication
  6. @MapperScan("com.tian.mybatis.mapper")
  7. public class Application {
  8.     public static void main(String[] args) {
  9.         SpringApplication.run(Application.class, args);
  10.     }
  11. }

把项目启动起来，然后进行访问/test。

http://localhost:9002/test

返回：













上面的这个案例也是我们工作中的代码案例，我们工作但部分都使用这种方式。





















下面的所有演示都是基于上面这些代码进行调整而成的。

回到正题。

上面的案例中使用了where+if。案例中貌似有个问题：

如果id=null，岂不是多了个and吗？

我们修改controller中的代码

  1.     @GetMapping("/test")
  2.     public User selectUserById() {
  3.         return userService.selectUserById("tian", null);
  4.     }

为了能让sql输出，我们在配置文件添加了一个配置项：

  1. logging:
  2.   level:
  3.     com:
  4.       tian:
  5.         mybatis:
  6.           mapper: debug

再次执行，输出和前面是一样的。控制台输出的sql中并没有and。这就是所谓的动态映射的强大功能之一。

如果我们不使用动态映射标签，在处理or或者and的时候很有可能出问题。

where元素可以智能的处理and 和 or 的多余问题， 不需担心多余关键字导致语法错误。

if元素的test用于判断表达式是否符合，符合则继续拼接SQL语句。

建议

建议使用这种动态标签，不要使用原生态，因为有时候总有意想不到的判断导致多了一个and或者or，于是就出现bug，严重的可能导致线上某个功能不可能用。

if+trim+foreach实现多条件查询

对前面的代码进行调整

  1. <select id="selectUsersByIds" resultMap="User">
  2.         select * from m_user
  3.         <trim prefix="where" prefixOverrides="and | or">
  4.             <if test="idList != null">
  5.                 id in
  6.                 <foreach collection="idList" item="id" open="(" close=")" separator=",">
  7.                     #{id}
  8.                 </foreach>
  9.             </if>
  10.             <if test="gender != null and gender != 0">
  11.                 AND gender = #{gender}
  12.             </if>
  13.         </trim>
  14. </select>

UserMapper.java增加

List<User> selectUsersByIds(@Param("idList") List<Integer> idList, @Param("gender") Integer gender);

controller新增方法：

  1.     @GetMapping("/users")
  2.     public List<User> selectUsersByIds() {
  3.         List<Integer> idList = new ArrayList<>();
  4.         idList.add(1);
  5.         idList.add(2);
  6.         idList.add(3);
  7.         idList.add(4);
  8.         idList.add(5);
  9.         return userService.selectUsersByIds(idList, null);
  10.     }

项目跑起来，访问

http://localhost:9002/users

输出：
























sql输出：

对上面相关属性进行说明

trim的属性

  • prefix：前缀: 作用是通过自动识别是否有返回值后，在trim包含的内容上加上前缀，如上述示例的where。

  • suffix：后缀: 作用是在trim包含的内容上加上后缀。

  • prefixOverrides:：对于trim包含内容的首部进行指定内容，(如上述示例的 and | or) 的忽略(去余);

  • suffixOverrides:：对于trim包含内容的首位部进行指定内容的忽略。

foreach的属性

  • item：表示集合中每一个元素进行迭代时的别名。

  • index:：指定一个名称，表示在迭代的过程中，每次迭代到的位置。

  • open：表示该语句以什么开始(既然是in条件语句，必然是 ' ( ' 开始)

  • separator:：表示每次进行迭代的时候以什么符号作为分隔符(既然是in条件语句，必然是 ' ， ' 分隔)

  • close:：表示该语句以什么结束(既然是in条件语句，必然是 ' ) ' 结束)

  • collection：最关键，并且最容易出错的属性。需注意，该属性必须指定，不同情况下，该属性值是不同的，

    主要有三种情况：

@Param是Mybatis中的注解，写的时候别引用错了，@Param("name")，这里的name就是我们在Mapper.xml中使用的名称。

在项目中我见过很多人这么干，就是当where语句后面不太确定能有条件出现时，使用

slect ...from...where 1=1

看看你的代码是否也有？

set

set元素可以用于动态包含需要更新的列，忽略其它不更新的列。

UserMapper.xml新增

  1. <update id="updateAuthorIfNecessary">
  2.         update m_user
  3.         <set>
  4.             <if test="userName != null and userName != ''">
  5.                `name` = #{userName},
  6.             </if>
  7.             <if test="gender != null and gender != 0">
  8.                 gender = #{gender},
  9.             </if>
  10.             <if test="age != null and age != 0">
  11.                 age = #{age},
  12.             </if>
  13.         </set>
  14.         where id=#{id}
  15. </update>

UserMapper.java新增

int updateAuthorIfNecessary(User user);

controller新增

  1.     @PostMapping("/updateUser")
  2.     public String update() {
  3.         User user = new User();
  4.         user.setAge(18);
  5.         user.setUserName("田哥");
  6.         user.setId(1);
  7.         return userService.updateAuthorIfNecessary(user) == 1 ? "success" : "fail";
  8.     }

重启项目，访问

http://localhost:9002/updateUser

输出：success

数据库表中数据已经修改成功：

















SQL输出

这个例子中，set 元素会动态地在行首插入 SET 关键字，并会删掉额外的逗号（这些逗号是在使用条件语句给列赋值时引入的）。

换一种方式

  1. <trim prefix="SET" suffixOverrides=",">
  2.   ...
  3. </trim>

我们把上面的xml中diam进行调整：

  1.     <update id="updateAuthorIfNecessary">
  2.         update m_user
  3.         <trim prefix="SET" suffixOverrides=",">
  4.             <if test="userName != null and userName != ''">
  5.                 `name` = #{userName},
  6.             </if>
  7.             <if test="gender != null and gender != 0">
  8.                 gender = #{gender},
  9.             </if>
  10.             <if test="age != null and age != 0">
  11.                 age = #{age},
  12.             </if>
  13.         </trim>
  14.         where id=#{id}
  15.     </update>

controller修改：

  1.     @PostMapping("/updateUser")
  2.     public String update() {
  3.         User user = new User();
  4.         user.setAge(19);
  5.         user.setUserName("tian");
  6.         user.setId(1);
  7.         return userService.updateAuthorIfNecessary(user) == 1 ? "success" : "fail";
  8.     }

最后看看SQL输出：

自动给我们加上了SET关键字。并且数据库修改成功。












choose

相当于Java中的switch语句，通常与when和otherwise搭配。

有时候，我们不想使用所有的条件，而只是想从多个条件中选择一个使用。针对这种情况，MyBatis 提供了 choose 元素，它有点像 Java 中的 switch 语句。

下面我们继续使用上面的案例代码进行演示。

UserMapper.xml新增方法：

  1. <select id="selectUsersByName" resultMap="User">
  2.         select * from m_user where age = 19
  3.         <choose>
  4.             <when test="userName != null and userName != ''">
  5.                 and `name` = #{userName}
  6.             </when>
  7.             <otherwise>
  8.                 AND gender = 1
  9.             </otherwise>
  10.         </choose>
  11. </select>

controller新增方法：

  1. @GetMapping("/user/name")
  2.     public  List<User>  selectUsersByName() {
  3.         return userService.selectUsersByName("tian");
  4. }

返回：











SQL输出：

正确的输出。如果我们userName没有是null呢？

输出和上面正常，在看看SQL输出：

因为我们的userName的条件不满足的情况下，直接执行了gender。

上面<otherwise>就类似于相当于我们java语法中switch中的default，当前面条件不满足的时候，执行default模块一样。

Bind

这种方式使用的不是很多，但是也是有用的。bind 元素允许你在 OGNL 表达式以外创建一个变量，并将其绑定到当前的上下文。比如：

  1. <select id="selectUserByName" resultType="User">
  2.   <bind name="pattern" value="'%' + userName + '%'" />
  3.   select * from m_user
  4.   WHERE `name` LIKE #{pattern}
  5. </select>

还有就是script，这个就没有必要在演示了，在工作中基本上用不上。它就是把SQL卸载Java代码中。比如

  1.     @Update({"<script>",
  2.       "update m_user",
  3.       "  <set>",
  4.       "    <if test='username != null'>`name`=#{username},</if>",
  5.       "    <if test='gender != null and gender != 0'>gender=#{gender},</if>",
  6.       "  </set>",
  7.       "where id=#{id}",
  8.       "</script>"})
  9.     void updateUserValues(User user);

总结

文章中部分知识为了演示，可能有些代码不是很规范，尤其是sql部分，我们在开发中，针对使用Mybatis开发，我个人总结了几个点：

  • 表中是否已经有索引，有索引的时候我们的SQL中是否有用上。

  • 返回字段尽量不要写星号*，建议写成需要的字段。

  • 关键字建议都写成大写，更好的区别非关键字。

  • 遇到表中字段和数据库关键一样的时候，记得单引号。

  • 使用@Param注解注意一定要使用Mybatis中的注解。

  • 使用不管是一个参数还是多个参数时，使用注解@Param指定名称，方便日后需要再次添加字段。

  • 强烈建议使用动态标签，避免出现多出and或者or关键字的SQL错误，同时也不用再写where 1=1



    欢迎关注公众号：Java后端技术全栈