MyBatis:动态SQL高级标签使用方法指南

一、引言

目前互联网大厂在搭建后端Java服务时,常使用Springboot搭配Mybatis/Mybatis-plus的框架。Mybatis/Mybatis-plus之所以能成为当前国内主流的持久层框架,与其本身的优点有关:支持定制动态 SQL、存储过程及高级映射,简化数据库操作。

可能有人会问, 为什么要用动态SQL,在开发过程中把SQL写死不是比较方便、更加不容易出错吗?其实这是由开发过程中具体业务需求决定的,比如在用户注册场景下,用户注册填写信息时,会有必填字段和非必填字段,不同用户注册时传给后端的参数有区别,对应的插入用户表的SQL也不一样,因此,在这些的场景下开发人员需要使用动态SQL来完成。本文首先介绍Springboot项目中SQL映射方式,最后介绍动态SQL和支持动态SQL的核心标签。

欢迎关注工 众号:ItBeeCoder,查看更多高质量技术文章,发送"后端"获取资料

二、SQL映射方式

1、XML映射文件,该文件通常位于 resources/自定义的包路径/mapper 目录。

示例:

xml 复制代码
  <!-- UserMapper.xml -->
  <mapper namespace="com.example.UserMapper">
    <select id="selectUserById" resultType="User">
      SELECT * FROM user WHERE id = #{id}
    </select>
  </mapper>

2、注解映射

适用场景:简单 SQL 可直接在接口方法上使用注解。

示例:

java 复制代码
public interface UserMapper {
    @Insert("INSERT INTO user(name) VALUES(#{name})")
    @Options(useGeneratedKeys = true, keyProperty = "id")
    void insertUser(User user);
  }

欢迎关注工 众号:ItBeeCoder,查看更多高质量技术文章,发送"后端"获取资料

三、动态SQL及常用标签

在 MyBatis中,动态SQL允许开发人员根据不同的条件构建不同的 SQL 语句。执行原理为,使用OGNL从SQL参数对象中计算表达式的值,根据表达式的值动态拼接SQL,以此来完成动态SQL的功能。动态SQL中常用的核心标签有:、、、、、等。

1、动态 SQL

  • 以下SQL为XML文件中复杂动态SQL的示例:
sql 复制代码
  <select id="searchUsers" resultType="User">
    SELECT * FROM user
    <where>
      <if test="name != null">
         AND name LIKE CONCAT('%', #{name}, '%')
      </if>
      <if test="roles != null">
        AND role IN
        <foreach item="role" collection="roles" open="(" separator="," close=")">
          #{role}
        </foreach>
      </if>
    </where>
  </select>

2、常用标签

1)<if> 标签

a)用途:条件判断,满足条件时包含 SQL 片段。

b)示例

xml 复制代码
<select id="findUser" resultType="User">
    SELECT * FROM user
    WHERE 1=1
    <if test="name != null">
      AND name = #{name}
    </if>
  </select>
2)<where> 标签

a)用途:自动添加 WHERE 关键字,并去除首条多余的 AND/OR

b)示例

sql 复制代码
<select id="selectByStudent" resultMap="BaseResultMap" parameterType="com.xxx.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>

说明:以上SQL中,当条件都不满足时:此时 SQL 中应该要不能有 where , 否则导致出错。当 if 有条件满足时:SQL 中需要有 where, 且第一个成立的 if 标签下的 and | or 等要去掉,这时候,我们可以使用 where 标签。

3)<set> 标签

a)用途:主要用于SQL的UPDATE命令中,自动添加 SET 关键字,并去除末尾多余的逗号。

b)示例:

sql 复制代码
 <update id="updateUser">
    UPDATE user
    <set>
      <if test="name != null">name = #{name},</if>
      <if test="age != null">age = #{age},</if>
    </set>
    WHERE id = #{id}
  </update>
4)<foreach> 标签

a)用途:遍历集合(如 IN 查询、批量插入)。

b)该标签的属性:

复制代码
  - collection:集合参数名。

  - item:遍历元素的变量名。

  - open/close:包裹结果的前缀/后缀。

  - separator:元素间的分隔符。

c)示例:

sql 复制代码
<!-- IN 查询 -->
  SELECT * FROM user WHERE id IN
  <foreach item="id" collection="ids" open="(" separator="," close=")">
    #{id}
  </foreach>
  
  <!-- 批量插入 -->
  INSERT INTO user (name) VALUES
  <foreach item="user" collection="list" separator=",">
    (#{user.name})
  </foreach>

注意:在使用标签时,最好在标签前加上标签,判断列表是否为null或者有数据,如果列表没数据,不加标签直接使用标签会报错。第一个查询SQL的动态SQL建议写法:

sql 复制代码
 SELECT * FROM user 
<if test = "ids != null and ids.size > 0">
    WHERE id IN
<foreach item="id" collection="ids" open="(" separator="," close=")">
    #{id}
</foreach>
</if>
5)<choose>/<when>/<otherwise> 标签

a)用途:多条件分支(功能类似于switch-case)。

b)示例:

sql 复制代码
<select id="findUser" resultType="User">
    SELECT * FROM user
    <where>
      <choose>
        <when test="name != null">AND name = #{name}</when>
        <when test="email != null">AND email = #{email}</when>
        <otherwise>AND is_active = 1</otherwise>
      </choose>
    </where>
  </select>
6)<trim> 标签

a)用途:自定义字符串修剪(可替代 标签 或 标签)。

b)属性:

复制代码
  - prefix:添加前缀。

  - prefixOverrides:去除首部匹配的字符。

  - suffix:添加后缀。

  - suffixOverrides:去除尾部匹配的字符。

c)示例:

sql 复制代码
<!-- 替代 <where> -->
  <trim prefix="WHERE" prefixOverrides="AND |OR ">
<if test="name != null and name != ``">
AND name = #{name}
</if>
  </trim>
  <!-- 替代 <set> -->
  <trim prefix="SET" suffixOverrides=",">
    <if test="name != null">name = #{name},</if>
  </trim>
7)<bind> 标签

a)用途:创建变量并绑定到上下文,用于复杂表达式或重复逻辑。

b)示例:

sql 复制代码
  <select id="searchUser">
    <bind name="pattern" value="'%' + keyword + '%'" />  <!-- 拼接模糊查询参数 -->
    SELECT * FROM user
    WHERE name LIKE #{pattern}
  </select>

欢迎关注工 众号:ItBeeCoder,查看更多高质量技术文章,发送"后端"获取资料

四、使用注意事项

1)OGNL表达式中:test 属性中使用的表达式语言,支持复杂逻辑,例如:==, !=, &&, || 等操作。例如:

sql 复制代码
<if test="name != null and name != ''">  <!-- 同时检查非空和非空字符串 -->

2)参数处理:

  • mapper接口中抽象方法的集合参数需通过 @Param 命名

    List<User> findUsersByIds(@Param("ids") List<Integer> ids);

  • 空值检查需显式处理(如 test="name != null and name != ''")。

3)动态 SQL 性能:避免写过度复杂的动态SQL,过度复杂的SQL可能影响数据库执行计划,导致查询性能差。

4)动态表名/列名不建议使用 ${},建议使用#{},以防止 SQL 注入。

5)在Springboot搭配使用Mybatis时,为了能将Mapper接口上加了@Mapper@Dao的Bean注入到spring容器中,需要在启动类中添加@MapperScan注解,@MapperScan注解中的包路径名称为mapper接口的路径。如下所示:

java 复制代码
  @SpringBootApplication
  @MapperScan("com.example.mapper")
  public class Application {
    public static void main(String[] args) {
      SpringApplication.run(Application.class, args);
      // 其它业务代码
    }
  }

欢迎关注工 众号:ItBeeCoder,查看更多高质量技术文章,发送"后端"获取资料

五、一些最佳实践

1、在Mybatis的XML文件中对于某些频繁用到的SQL,为了避免重复写以及重复写导致的出错,可以引用某个常用的SQL,如下即为引用SQL的做法:

sql 复制代码
<sql id="all">
select * from user
</sql>

<select id="selectUserByUid" resultType="user">
<include refid="all"/>
where uid = #{uid}
</select>

<select id="selectIf" resultType="user">
<include refid="all"/>
<where>
<if test="username != null">
username = #{username}
</if>
</where>
</select>

2、判断list集合是否包含指定数据

sql 复制代码
<if test="list.contains('0')">
#{逻辑}
</if>

3、XML的SQL中比较符号的写法

复制代码
gt 对应 >
gte 对应 >=
lt 对应 <(会报错 相关联的 "test" 属性值不能包含 '<' 字符)
lte 对应 <=(会报错 相关联的 "test" 属性值不能包含 '<' 字符)
<![CDATA[ sql 语句 ]]>
<![CDATA[ >= ]]>

4、MyBatis的XML中使用内部类的方式

内部类需要使用$符号连接,而不是点.,以下为正确写法:

java 复制代码
com.xxx.model.SMSESBResult$ReceiveResult$ResultInfo

六、写在最后的话

总之,MyBatis的动态SQL功能允许开发者根据不同条件灵活构建SQL语句,避免手动拼接字符串,另外,常用查询列和查询SQL还可以借助动态SQL实现复用,提高XML中SQL代码的可维护性和安全性。


欢迎关注工 众号:ItBeeCoder,查看更多高质量技术文章,发送"后端"获取资料

又到了金三银四求职季,我整理了一些互联网大厂的面试题,有需要的可关注工 众号:ItBeeCoder,发送"后端"获取


相关推荐
小天努力学java4 分钟前
【面试题】如何用两个线程轮流输出0-200的值
java·开发语言
response_L1 小时前
国产系统统信uos和麒麟v10在线打开word给表格赋值
java·c#·word·信创·在线编辑
苹果酱05671 小时前
Golang标准库——runtime
java·vue.js·spring boot·mysql·课程设计
User_芊芊君子1 小时前
【Java】类和对象
java·开发语言
martian6651 小时前
Spring Boot后端开发全攻略:核心概念与实战指南
java·开发语言·spring boot
跟着珅聪学java3 小时前
spring boot +Elment UI 上传文件教程
java·spring boot·后端·ui·elementui·vue
我命由我123454 小时前
Spring Boot 自定义日志打印(日志级别、logback-spring.xml 文件、自定义日志打印解读)
java·开发语言·jvm·spring boot·spring·java-ee·logback
lilye664 小时前
程序化广告行业(55/89):DMP与DSP对接及数据统计原理剖析
java·服务器·前端
战族狼魂7 小时前
CSGO 皮肤交易平台后端 (Spring Boot) 代码结构与示例
java·spring boot·后端
xyliiiiiL8 小时前
ZGC初步了解
java·jvm·算法