MyBatis 动态 SQL 使用指南

news2024/10/1 3:32:14

MyBatis 是一个流行的持久层框架，它通过 XML 或注解将接口方法与 SQL 映射在一起。动态 SQL 是 MyBatis 的一大特性，它使得构建灵活的查询变得简单。本文将通过一个 User 表的示例，介绍 MyBatis 中常用的动态 SQL 方法。

1. 什么是动态 SQL？

动态 SQL 是指在运行时构建 SQL 语句，可以根据条件生成不同的 SQL 语句。这种方法在处理复杂查询时尤为重要，可以有效避免 SQL 注入和冗余代码。

2. 示例表：用户表

我们以 User 表为例，表结构如下：

//Lombok
@Data
@AllArgsConstructor
@NoArgsConstructor
@Builder
public class User implements Serializable {
    private Long id;            // 用户id
    private String username;    // 用户名
    private String password;    // 密码
    private String phone;       // 注册手机号
    private String info;        // 详细信息
    private Integer status;     // 使用状态（1正常 2冻结）
    private Integer balance;     // 账户余额
    private Date createTime;    // 创建时间
    private Date updateTime;    // 更新时间
}

3. 常用动态 SQL 方法

3.1 `where`

使用 where 标签可以自动处理 SQL 条件前的 AND 和 OR。

<select id="findByConditions" resultType="com.lps.domain.User">
    SELECT * FROM user
    <where>
        <if test="username != null and username != ''">
            AND USERNAME LIKE CONCAT('%', #{username}, '%')
        </if>
        <if test="phone != null and phone != ''">
            AND PHONE LIKE CONCAT('%', #{phone}, '%')
        </if>
    </where>
</select>

3.2 `foreach`

foreach 标签用于处理集合，可以生成 IN 查询。

<select id="findByIds" resultType="com.lps.domain.User">
    SELECT * FROM user WHERE id IN
    <foreach item="id" collection="idList" open="(" separator="," close=")">
        #{id}
    </foreach>
</select>

3.3 `if`

if 标签用于动态决定是否包含某个 SQL 片段。

<update id="updateUser">
    UPDATE user
    <set>
        <if test="username != null">username = #{username},</if>
        <if test="phone != null">phone = #{phone},</if>
    </set>
    WHERE id = #{id}
</update>

3.4 `choose`, `when`, `otherwise`

这些标签实现了类似 Java 中 switch 的功能。

<select id="findByStatus" resultType="com.lps.domain.User">
    SELECT * FROM user
    <where>
        <choose>
            <when test="status == 1">AND status = 1</when>
            <when test="status == 2">AND status = 2</when>
            <otherwise>AND status IS NULL</otherwise>
        </choose>
    </where>
</select>

3.5 `trim`

trim 标签可以去掉 SQL 语句开头或结尾的特定字符。

<select id="findUsersWithTrim" resultType="com.lps.domain.User">
    SELECT * FROM user
    <trim prefix="WHERE" prefixOverrides="AND |OR ">
        <if test="username != null">AND username = #{username}</if>
        <if test="phone != null">AND phone = #{phone}</if>
        <if test="status != null">AND status = #{status}</if>
    </trim>
</select>

3.6 `bind`

bind 标签用于在 SQL 查询中动态绑定变量，通常用于处理 LIKE 查询时拼接通配符。下面是一个通过 bind 实现模糊查询的示例：

<select id="selectUserByLike" resultType="com.lps.domain.User">
    <bind name="username" value="'%' + username + '%'" />
    SELECT * FROM user
    WHERE username LIKE #{username}
</select>

在这个示例中，bind 标签将输入的 username 动态地拼接上 % 通配符，以支持模糊查询。在查询时，MyBatis 会自动将参数 username 转换为带通配符的值并替换到 SQL 中，从而实现类似于 SQL 中 LIKE '%xxx%' 的效果（类似于3.1WHERE中用到的的CONCAT方法）