MyBatis（九）动态SQL语句

布满荆棘的人生 2021-06-22 15:37 658阅读 0赞

### 目录 ###

*  Mybatis的动态SQL语句
 *  一、前期准备
 *  二、\`\`标签
 *  三、 \`\`标签
 *  四、\`\`标签
 *   *  1. QueryVo
     *  2. 持久层Dao接口
     *  3. IUserDao.xml配置文件
     *  4. 测试方法
     *  5. 查询结果
 *  五、简化sql片段

# Mybatis的动态SQL语句 #

我们在前面的mybatis的映射文件中，前面我们的SQL都是比较简单的，有些时候业务逻辑复杂的时候，我们的SQL是动态变化的，此时在前面的学习中我们的SQL语句就不能满足要求了。  
我们可以看到官方文档的介绍：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTQ1NjUxMjc_size_16_color_FFFFFF_t_70]

> 动态 SQL 是 MyBatis 的强大特性之一。如果你使用过 JDBC 或其它类似的框架，你应该能理解根据不同条件拼接 SQL语句有多痛苦，例如拼接时要确保不能忘记添加必要的空格，还要注意去掉列表最后一个列名的逗号。利用动态 SQL，可以彻底摆脱这种痛苦。
> 
> 使用动态 SQL 并非一件易事，但借助可用于任何 SQL 映射语句中的强大的动态 SQL 语言，MyBatis显著地提升了这一特性的易用性。
> 
> 如果你之前用过 JSTL 或任何基于类 XML 语言的文本处理器，你对动态 SQL 元素可能会感觉似曾相识。在 MyBatis之前的版本中，需要花时间了解大量的元素。借助功能强大的基于 OGNL 的表达式，MyBatis 3替换了之前的大部分元素，大大精简了元素种类，现在要学习的元素种类比原来的一半还要少。
> 
> if  
> choose (when, otherwise)  
> trim (where, set)  
> foreach

# 一、前期准备 #

我们创建一个新的maven工程：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTQ1NjUxMjc_size_16_color_FFFFFF_t_70 1]  
我们还是把上个项目中的src文件夹全部复制过来，并且导入依赖信息：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTQ1NjUxMjc_size_16_color_FFFFFF_t_70 2]

<dependencies>
        <dependency>
            <groupId>org.mybatis</groupId>
            <artifactId>mybatis</artifactId>
            <version>3.4.5</version>
        </dependency>
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>5.1.6</version>
        </dependency>
        <dependency>
            <groupId>log4j</groupId>
            <artifactId>log4j</artifactId>
            <version>1.2.12</version>
        </dependency>
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>4.10</version>
        </dependency>
    </dependencies>

然后我们删除一些东西，排除我们的干扰：  
我们把IUserDao中多余的方法都删掉，只留下四个查询的方法：  
![在这里插入图片描述][20200501083231631.png]  
并且删除IUserDao.xml中相应的配置。

# 二、`<if>`标签 #

我们新建一个查询方法，根据条件查询，不过条件是未知的，有可能有用户名，有可能有性别，有可能有地址，还有可能都有，也有可能都没有。  
**IUserDao：**

/** * 根据传入参数条件进行查询 * @param user 查询的条件，有可能有用户名，有可能有性别，有可能有地址，还有可能都有，也有可能都没有 * @return */
    List<User> findUserByCondition(User user);

**这个时候我们要在IUserDao.xml文件中怎么配置呢？**  
注意：`<if>`标签的 test 属性中写的是对象的属性名，如果是包装类的对象要使用 OGNL 表达式的写法。 另外要注意 `where 1=1` 的作用。

<select id="findUserByCondition" resultType="user" parameterType="user">
        select * from user where 1=1
        <if test="username != null">
            and username = #{username}
        </if>
        <if test="sex != null">
            and sex = #{sex}
        </if>
        <if test="address != null">
            and address = #{address}
        </if>
    </select>

然后我们在一个测试类中新建一个测试方法，

/** * 测试条件查询 */
    @Test
    public void testFindUserByCondition() { 
        User user = new User();
        user.setUsername("刘伟佳");
        List<User> users = userDao.findUserByCondition(user);
        if (users.isEmpty()){ 
            System.out.println("没有查询结果！");
        }
        for (User u : users) { 
            System.out.println(u);
        }
    }

查询结果：  
![在这里插入图片描述][20200501105424287.png]

# 三、 `<where>`标签 #

为了简化上面的开发，我们可以使用`<where>`标签来简化where1=1的条件拼装。也就是：

<select id="findUserByCondition" resultType="user" parameterType="user">
        select * from user
        <where>
            <if test="username != null">
                and username like #{username}
            </if>
            <if test="sex != null">
                and sex = #{sex}
            </if>
            <if test="address != null">
                and address = #{address}
            </if>
        </where>
    </select>

# 四、`<foreach>`标签 #

**我们设想一种场景：**  
我们如果想传入多个 id 查询用户信息，可以用下边两个 sql 实现：

SELECT * FROM user WHERE (id =41 OR id =42 OR id=43) 
    SELECT * FROM user WHERE id IN (41,42,43)

这样我们在进行范围查询时，就要将一个集合中的值，作为参数动态添加进来。  
这样我们将如何进行参数的传递？

## 1. QueryVo ##

首先我们在QueryVo中加入一个List集合用于封装参数：

/** * 查询条件对象。 */
    public class QueryVo { 
        private User user;
        private List<Integer> ids;
        public List<Integer> getIds() { 
            return ids;
        }
        public void setIds(List<Integer> ids) { 
            this.ids = ids;
        }
        public User getUser() { 
            return user;
        }
        public void setUser(User user) { 
            this.user = user;
        }
    }

## 2. 持久层Dao接口 ##

/** * 根据ID集合查询用户信息 * * @param vo * @return */
    List<User> findInIds(QueryVo vo);

## 3. IUserDao.xml配置文件 ##

<select id="findInIds" resultType="user" parameterType="queryVo">
        select * from user
        <where>
            <if test="ids != null and ids.size>0">
                <foreach collection="ids" open="and id in(" close=")" item="id" separator=",">
                    #{id}
                </foreach>
            </if>
        </where>
    </select>

我们预期的语句是：

select 字段 from user where id in (?)

**`<foreach>`标签用于遍历集合，它的属性：**  
`collection`:代表要遍历的集合元素，注意编写时不要写`#{ }`；  
`open`:代表语句的开始部分；  
`close`:代表结束部分；  
`item`:代表遍历集合的每个元素，生成的变量名；  
`sperator`:代表分隔符。

## 4. 测试方法 ##

/** * 测试通过id集合查询 */
    @Test
    public void testFindByQueryVo() { 
        QueryVo vo = new QueryVo();
        List<Integer> ids = new ArrayList<Integer>();
        ids.add(41);
        ids.add(42);
        ids.add(43);
        vo.setIds(ids);
        List<User> users = userDao.findInIds(vo);
        for (User user : users) { 
            System.out.println(user);
        }
    }

## 5. 查询结果 ##

![在这里插入图片描述][2020050117192297.png]  
完全符合我们预期。

# 五、简化sql片段 #

我们写多了IUserDao.xml的配置后发现，SQL语句中有一个片段几乎是所有的SQL都要用的，就是`select * from user`。  
我们可以想办法把它抽取出来，定义代码片段：

<sql id="defaultSql">
        select * from user
    </sql>

然后在后面的语句中引用就可以了，比如查询所有可以简写成：

<select id="findAll" resultType="user">
        <include refid="defaultSql"></include>
    </select>

根据id查询可以简写成：

<select id="findById" parameterType="INT" resultType="user">
        <include refid="defaultSql"></include>
        where id = #{id}
    </select>

--------------------

END.

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTQ1NjUxMjc_size_16_color_FFFFFF_t_70]: /images/20210615/3fba42f8090f4f579eea0878a58a45f5.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTQ1NjUxMjc_size_16_color_FFFFFF_t_70 1]: /images/20210615/760162a237b34369aceed38770f85313.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTQ1NjUxMjc_size_16_color_FFFFFF_t_70 2]: /images/20210615/d741a3223a9141c8870bebf690719e74.png
[20200501083231631.png]: /images/20210615/1ca65f451cf141dba26cb624ab8d5141.png
[20200501105424287.png]: /images/20210615/08256d17607d41e194fe0b9655a2ff6b.png
[2020050117192297.png]: /images/20210615/67b4d9e5e53647738a77c018bafd79be.png