Mybatis之动态SQL使用小结(全网最新)

1 动态SQL

1.1 引言

MyBatis令人喜欢的一大特性就是动态SQL。 在使用JDBC的过程中， 根据条件进行SQL的拼接是很麻烦且很容易出错的。MyBatis动态SQL的出现， 解决了这个麻烦。
MyBatis通过OGNL来进行动态SQL的使用的。
目前， 动态 SQL 支持以下几种标签

1.2 数据准备

为了后面的演示， 创建了一个Maven项目 mybatis-dynamic, 创建了对应的数据库和表

DROP TABLE IF EXISTS `student`;
CREATE TABLE `student` (
  `student_id` int(10) unsigned NOT NULL AUTO_INCREMENT COMMENT '编号',
  `name` varchar(20) DEFAULT NULL COMMENT '姓名',
  `phone` varchar(20) DEFAULT NULL COMMENT '电话',
  `email` varchar(50) DEFAULT NULL COMMENT '邮箱',
  `sex` tinyint(4) DEFAULT NULL COMMENT '性别',
  `locked` tinyint(4) DEFAULT NULL COMMENT '状态(0:正常,1:锁定)',
  `create_time` datetime DEFAULT CURRENT_TIMESTAMP COMMENT '存入数据库的时间',
  `update_time` datetime DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP COMMENT '修改的时间',
  `delete` int(11) DEFAULT NULL,
  PRIMARY KEY (`student_id`)
) ENGINE=InnoDB AUTO_INCREMENT=7 DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_0900_ai_ci COMMENT='学生表';

对应的项目结构

1.3 if 标签

if 标签是我们最常使用的。在查询、删除、更新的时候很可能会使用到。必须结合test属性联合使用

1.3.1 在 WHERE 条件中使用 if 标签

这是常见的一种现象， 我们在进行按条件查询的时候， 可能会有多种情况。
查询条件
根据输入的学生信息进行条件检索

• 当只输入用户名时， 使用用户名进行模糊检索；
• 当只输入性别时， 使用性别进行完全匹配
• 当用户名和性别都存在时， 用这两个条件进行查询匹配查询

动态SQL

<select id="selectByStudentSelective" resultMap="BaseResultMap" parameterType="com.homejim.mybatis.entity.Student">
    select
    <include refid="Base_Column_List" />
    from student
    where 1=1
    <if test="name != null and name !=''">
      and name like concat('%', #{name}, '%')
    </if>
    <if test="sex != null">
      and sex=#{sex}
    </if>
  </select>

在此 SQL 语句中， where 1=1 是多条件拼接时的小技巧， 后面的条件查询就可以都用 and 了。
同时， 我们添加了 if 标签来处理动态 SQL

<if test="name != null and name !=''">
      and name like concat('%', #{name}, '%')
    </if>
    <if test="sex != null">
      and sex=#{sex}
    </if>

此 if 标签的test属性值是一个符合OGNL的表达式， 表达式可以是true或false。如果表达式返回的是数值， 则0为false,非 0为true

1.3.2 在 UPDATE 更新列中使用 if 标签

有时候我们不希望更新所有的字段， 只更新有变化的字段。

示例SQL

<update id="updateByPrimaryKeySelective" parameterType="com.homejim.mybatis.entity.Student">
    update student
    <set>
      <if test="name != null">
        `name` = #{name,jdbcType=VARCHAR},
      </if>
      <if test="phone != null">
        phone = #{phone,jdbcType=VARCHAR},
      </if>
      <if test="email != null">
        email = #{email,jdbcType=VARCHAR},
      </if>
      <if test="sex != null">
        sex = #{sex,jdbcType=TINYINT},
      </if>
      <if test="locked != null">
        locked = #{locked,jdbcType=TINYINT},
      </if>
      <if test="createTime != null">
        create_time= #{createTime ,jdbcType=TIMESTAMP},
      </if>
      <if test="updateTime != null">
        update_time = #{updateTime ,jdbcType=TIMESTAMP},
      </if>
    </set>
    where student_id = #{studentId,jdbcType=INTEGER}

1.3.3 在 INSERT 动态插入中使用 if 标签

我们插入数据库中的一条记录， 不是每一个字段都有值的， 而是动态变化的。在这时候使用 if 标签， 可帮我们解决这个问题。

如果只有非空属性才插入则对应的SQL

<insert id="insertSelective" parameterType="com.homejim.mybatis.entity.Student">
    insert into student
    <trim prefix="(" suffix=")" suffixOverrides=",">
      <if test="studentId != null">
        student_id,
      </if>
      <if test="name != null">
        `name`,
      </if>
      <if test="phone != null">
        phone,
      </if>
      <if test="email != null">
        email,
      </if>
      <if test="sex != null">
        sex,
      </if>
      <if test="locked != null">
        locked,
      </if>
      <if test="createTime!= null">
        create_time,
      </if>
      <if test="updateTime != null">
        update_time,
      </if>
    </trim>
    <trim prefix="values (" suffix=")" suffixOverrides=",">
      <if test="studentId != null">
        #{studentId,jdbcType=INTEGER},
      </if>
      <if test="name != null">
        #{name,jdbcType=VARCHAR},
      </if>
      <if test="phone != null">
        #{phone,jdbcType=VARCHAR},
      </if>
      <if test="email != null">
        #{email,jdbcType=VARCHAR},
      </if>
      <if test="sex != null">
        #{sex,jdbcType=TINYINT},
      </if>
      <if test="locked != null">
        #{locked,jdbcType=TINYINT},
      </if>
      <if test="createTime != null">
        #{createTime,jdbcType=TIMESTAMP},
      </if>
      <if test="updateTime != null">
        #{updateTime,jdbcType=TIMESTAMP},
      </if>
    </trim>
  </insert>

1.4 choose 标签

choose when otherwise标签可以帮我们实现if else的逻辑。
一个choose标签至少有一个when, 最多一个otherwise

假如查询条件：

• 假设 name 具有唯一性， 查询一个学生
• 当 studen_id 有值时， 使用 studen_id 进行查询；
• 当 studen_id 没有值时， 使用 name 进行查询；
• 否则返回空

动态SQL

<select id="selectByIdOrName" resultMap="BaseResultMap" parameterType="com.homejim.mybatis.entity.Student">
    select
    <include refid="Base_Column_List" />
    from student
    where 1=1
    <choose>
      <when test="studentId != null">
        and student_id=#{studentId}
      </when>
      <when test="name != null and name != ''">
        and name=#{name}
      </when>
      <otherwise>
        and 1=2
      </otherwise>
    </choose>
  </select>

1.5 trim(set、where)

这三个其实解决的是类似的问题。如我们在写前面的[在WHERE条件中使用if 标签 SQL的时候， where 1=1 这个条件我们是不希望存在的。

1.5.1 where

查询条件：

• 根据输入的学生信息进行条件检索
• 当只输入用户名时， 使用用户名进行模糊检索；
• 当只输入性别时， 使用性别进行完全匹配
• 当用户名和性别都存在时， 用这两个条件进行查询匹配查询
  不使用 where 1=1

动态 SQL

 <select id="selectByStudentSelectiveWhereTag" resultMap="BaseResultMap" parameterType="com.homejim.mybatis.entity.Student">
    select
    <include refid="Base_Column_List" />
    from student
   <where>
    <if test="name != null and name !=''">
      and name like concat('%', #{name}, '%')
    </if>
    <if test="sex != null">
      and sex=#{sex}
    </if>
   </where>
  </select>

1.5.2 set

set标签也类似， 在UPDATE更新列中使用if 标签中， 如果我们的方法 updateByPrimaryKeySelective 没有使用 标签， 那么我们就要想办法处理字段全为空的条件， 字段不为空的条件等。有了这个， 我们只需要写 if 标签即可， 不需要处理类似的问题。

1.5.3 trim

set和where其实都是trim标签的一种类型， 该两种功能都可以使用trim标签进行实现。

1.5.3.1 trim 来表示 where

如where标签， 我们也可以写成

<trim prefix="where" prefixOverrides="AND |OR">
</trim>

表示当trim中含有内容时， 添加where， 且第一个为and或or时， 会将其去掉。而如果没有内容， 则不添加where。

1.5.3.2 trim 来表示 set

相应的，set标签可以如下表示

<trim prefix="set" suffixOverrides=",">
</trim>

表示当trim中含有内容时， 添加set， 且最后的内容为,时， 会将其去掉。而没有内容， 不添加 set

1.5.3.3 trim 的几个属性

prefix：当trim元素包含有内容时， 增加prefix所指定的前缀
prefixOverrides：当trim元素包含有内容时， 去除prefixOverrides指定的 前缀

• suffix：当trim元素包含有内容时， 增加suffix所指定的后缀
• suffixOverrides：当trim元素包含有内容时， 去除suffixOverrides指定的后缀

1.6 foreach 标签

foreach标签可以对数组，Map或实现Iterable接口。
foreach中有以下几个属性：

• collection：必填，集合/数组/Map的名称
• item：变量名。即从迭代的对象中取出的每一个值
• index：索引的属性名。当迭代的对象为 Map 时， 该值为 Map 中的 Key
• open：循环开头的字符串
• close：循环结束的字符串
• separator：每次循环的分隔符

其他的比较好理解， collection 中的值应该怎么设定呢？
跟接口方法中的参数相关。只有一个数组参数或集合参数默认情况：集合collection=list， 数组是collection=array

使用@Param来指定参数的名称， 如我们在参数前@Param("ids")， 则就填写collection=ids如果参数是Map，指定为Map中的对应的Key即可。其实上面的 @Param 最后也是转化为 Map 的。
如果参数是对象使用属性.属性即可。

1.6.1 在 where 中使用 foreach

在 where条件中使用， 如按id集合查询， 按id集合删除等。

查询条件，我们希望查询用户 id 集合中的所有用户信息。
对应 SQL

<select id="selectByStudentIdList" resultMap="BaseResultMap">
    select
    <include refid="Base_Column_List" />
    from student
    where student_id in
    <foreach collection="list" item="id" open="(" close=")" separator="," index="i">
      #{id}
    </foreach>
  </select>

1.6.2 foreach 实现批量插入

可以通过foreach来实现批量插入
动态SQL

 <insert id="insertList">
    insert into student(name, phone, email, sex, locked)
    values
    <foreach collection="list" item="student" separator=",">
      (
      #{student.name}, #{student.phone},#{student.email},
      #{student.sex},#{student.locked}
      )
    </foreach>
  </insert>

1.7 bind 标签

bind标签是通过OGNL表达式去定义一个上下文的变量， 这样方便我们使用。
如在selectByStudentSelective方法中， 有如下

<if test="name != null and name !=''">
      and name like concat('%', #{name}, '%')
</if>

在 MySQL 中， 该函数支持多参数， 但在 Oracle 中只支持两个参数。那么我们可以使用 bind 来让该 SQL 达到支持两个数据库的作用

<if test="name != null and name !=''">
     <bind name="nameLike" value="'%'+name+'%'"/>
     and name like #{nameLike}
</if>