mybatis中的动态SQL

在实际开发中，数据库的查询很难一蹴而就，我们往往要根据各种不同的场景拼接出不同的SQL语句，这无疑是一项复杂的工作，我们在使用mybatis时，mybatis给我们提供了动态SQL，可以让我们根据具体的业务逻辑来拼接不同的SQL语句。OK，那么我们今天就来看看如何使用mybatis中的动态SQL。
mybatis中的动态SQL主要包含如下几种元素：if、choose、when、otherwise、trim、where、set以及foreach几种，我们下面分别来看看这几种。

if

if是mybatis动态SQL中的判断元素，这个有点类似于Java中的if语句，不同的是这里的if一般常常和test配合使用。我们来看一个简单的例子：

<select id="getUser" resultMap="u" parameterType="String">
        select * from user2
        <if test="address!=null and address !=''">
            WHERE address LIKE concat('%',#{address},'%')
        </if>
    </select>

当用户传入的address不为null或者空字符串的时候，我就加上一个where条件，否则就什么条件都不加入。然后我们再来看看我们在UserMapper这个接口中定义的相关方法：

public List<User> getUser(@Param("address") String address);

我们在调用这个方法的时候，如果传入了address参数，那么查询条件中就有address，否则就没有。来看看测试代码：

SqlSession sqlSession = null;
        try {
            sqlSession = DBUtils.openSqlSession();
            UserMapper mapper = sqlSession.getMapper(UserMapper.class);
            List<User> list = mapper.getUser("西安");
            for (User user : list) {
                System.out.println(user);
            }
            sqlSession.commit();
        } catch (Exception e) {
            System.err.println(e.getMessage());
            sqlSession.rollback();
        } finally {
            if (sqlSession != null) {
                sqlSession.close();
            }
        }

查询结果：

如果我将查询条件设为空字符串，如下：

SqlSession sqlSession = null;
        try {
            sqlSession = DBUtils.openSqlSession();
            UserMapper mapper = sqlSession.getMapper(UserMapper.class);
            List<User> list = mapper.getUser("");
            for (User user : list) {
                System.out.println(user);
            }
            sqlSession.commit();
        } catch (Exception e) {
            System.err.println(e.getMessage());
            sqlSession.rollback();
        } finally {
            if (sqlSession != null) {
                sqlSession.close();
            }
        }

小伙伴们注意两个查询结果截图中打印出来的SQL语句的差异。

choose

choose有点类似于Java中的switch，常常配合when和otherwise一起来使用。我们来看一个简单的例子：

<select id="getUser2" resultMap="u">
        SELECT * FROM user2 WHERE 1=1
        <choose>
            <when test="id!=null">
                AND id=#{id}
            </when>
            <when test="address!=null">
                AND address=#{address}
            </when>
            <when test="username!=null">
                AND user_name LIKE concat(#{username},'%')
            </when>
            <otherwise>
                AND 10>id
            </otherwise>
        </choose>
    </select>

在查询条件中，如果用户传来了id，那么我就查询该id的数据，如果用户传来了address，那么我就我们添加address的查询条件，如果用户传来了username，那么我就添加username的查询条件，最后如果用户任何一个查询条件都没有添加进来，那么默认查询条件就是查询id小于10的所有数据。

where

在上面的案例中小伙伴们可能都发现了一个问题，就是我们在添加查询条件的时候，在查询条件之前都先添加了where 1=1，然后后面直接在这之后再追加and什么什么的，那么每次这样来写显然有点麻烦，有没有简单一点的方案呢？当然有，我们可以通过where元素，如下：

<select id="getUser3" resultMap="u">
        SELECT * FROM user2
        <where>
            <choose>
                <when test="id!=null">
                    AND id=#{id}
                </when>
                <when test="address!=null">
                    AND address=#{address}
                </when>
                <when test="username!=null">
                    AND user_name LIKE concat(#{username},'%')
                </when>
                <otherwise>
                    AND 10>id
                </otherwise>
            </choose>
        </where>
    </select>

这样，只有where元素中有条件成立，才会将where关键字组装到SQL中，这样就比前一种方式简单许多。

trim

trim有点元素替换的意思，还是上面的案例，我们可以将and替换为where，如下：

<select id="getUser4" resultMap="u">
        SELECT * FROM user2
        <trim prefix="where" prefixOverrides="and">
            AND id=1
        </trim>
    </select>

这个最终执行的sql是SELECT * FROM user2 where id=1。

set

set是我们在更新表的时候使用的元素，通过set元素，我们可以逐字段的修改一条数据，如下：

<update id="update">
        UPDATE user2
        <set>
            <if test="username!=null">
                user_name=#{username},
            </if>
            <if test="password!=null">
                password=#{password}
            </if>
        </set>
        WHERE id=#{id}
    </update>

在set元素中，如果遇到了逗号，系统会自动将之去除。

foreach

foreach元素用来遍历集合，比如我想查询多个城市的人，我的sql语句可能是这样SELECT * FROM user2
WHERE address IN（'西安'，'北京'），我在查询的时候可能只是传入了一个list集合，该集合中有西安和北京两个查询条件，那我如何将这个集合组装成一个sql语句呢？很简单，如下：

<select id="getUserInCities" resultMap="u">
        SELECT * FROM user2
        WHERE address IN
        <foreach collection="cities" index="city" open="(" separator="," close=")" item="city">
            #{city}
        </foreach>
    </select>

collection表示传入的参数中集合的名称，index表示是当前元素在集合中的下标，open和close则表示如何将集合中的数据包装起来，separator表示分隔符，item则表示循环时的当前元素。这样一段配置最终组合成的sql就是SELECT * FROM user2
WHERE address IN（'西安'，'北京'）。

bind

使用bind元素我们可以预先定义一些变量，然后在查询语句中使用，如下：

<select id="getUserByName" resultMap="u">
        <bind name="un" value="username+'%'"></bind>
            SELECT* FROM user2 WHERE user_name LIKE #{un}

    </select>

这个貌似没什么难度，不再赘述。

以上。

本文案例下载：
本文案例GitHub地址https://github.com/lenve/JavaEETest/tree/master/Test27-mybatis9

以上。

参考资料：
《深入浅出MyBatis 技术原理与实战》第五章

 

关注公众号【江南一点雨】，专注于 Spring Boot+微服务以及前后端分离等全栈技术，定期视频教程分享，关注后回复 Java ，领取松哥为你精心准备的 Java 干货！