Mybatis 的动态 SQL

红太狼 2023-07-25 14:23 13阅读 0赞

Mybatis 的映射文件中，当业务逻辑复杂时， SQL 语句是动态变化的。  
本文在 [使用Mybatis完成CRUD操作，并从源码分析执行过程][Mybatis_CRUD]这个案例的基础上展开。  
[\-------->项目源码][--------]

# <if>标签 #

先在DAO接口中添加方法，可以通过不同的条件实现查询：

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

映射配置中使用<if>标签来判定条件：

<select id="findUserByCondition" resultMap="userMap" parameterType="user">
            select * from user where 1=1
            <if test="userName != null">
              and username = #{userName}
            </if>
        </select>

上面的配置就是当传入的user的userName属性非空，则进行SQL语句拼接，实现条件查询。  
如果有多个条件，那么再添加<if>标签即可。  
测试方法中测试，查询名字为奶茶妹妹的记录：

/** * 测试查询所有（带条件） */
        @Test
        public void testFindByCondition(){ 
            User u = new User();
            u.setUserName("奶茶妹妹");
    
            //执行查询所有方法
            List<User> users = userDao.findUserByCondition(u);
            for(User user : users){ 
                System.out.println(user);
            }
    
        }

![在这里插入图片描述][20200415201651135.png]

# <where>标签 #

上面的写法，SQL语句中始终带着“where 1=1”这个条件，看起来并不是太清晰，那么可以使用 <where>标签来解决。  
修改映射配置文件如下：

<select id="findUserByCondition" resultMap="userMap" parameterType="user">
            select * from user
            <where>
                <if test="userName != null">
                    and username = #{userName}
                </if>
                <if test="userSex != null">
                    and sex = #{userSex}
                </if>
            </where>
        </select>

也就是将if标签嵌套与where之中，十分简洁明了。

# <foreach>标签 #

当需要传入多个 id 查询用户信息，可以通过下边的 sql 实现：

SELECT * FROM USER WHERE username  IN (4,7,10)

这样我们在进行范围查询时，就要将一个集合中的值作为参数动态添加进来。  
我们该如何进行参数的传递？<**foreach**>标签就能派上用场了。

我们先在QueryVo类中添加属性(List集合)用于封装参数：

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

再在DAO接口中添加方法：

/** * 根据queryVo中的条件查询用户 * * @param vo * @return */
        List<User> findUserByVo(QueryVo vo);

重点来啦，映射配置的写法:

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

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

最后测试方法添加：

/** * 测试foreach标签的使用 */
        @Test
        public void testFindInIds(){ 
            QueryVo vo = new QueryVo();
            List<Integer> list = new ArrayList<Integer>();
            list.add(4);
            list.add(6);
            list.add(7);
            vo.setIds(list);
    
            //5.执行查询所有方法
            List<User> users = userDao.findUserInIds(vo);
            for(User user : users){ 
                System.out.println(user);
            }
        }

![在这里插入图片描述][20200415212733432.png]  
从上图可以看出拼接后的语句为 select \* from user WHERE id in ( ? , ? , ? ) ，最后把list中的元素逐个填入，完成SQL。

# 简化重复SQL #

之前的例子中，"select \* from user"这个SQL片段出现了很多次，可以在映射配置中提取出来：

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

那么其他地方就可以进行替换了（refid=“sql标签的id属性”）：

<select id="findUserInIds" resultMap="userMap" parameterType="queryvo">
            <include refid="defaultUser"></include>
            <where>
                <if test="ids != null and ids.size()>0">
                    <foreach collection="ids" open="and id in (" close=")" item="uid" separator=",">
                        #{uid}
                    </foreach>
                </if>
            </where>
        </select>

[Mybatis_CRUD]: https://blog.csdn.net/z714405489/article/details/105472912
[--------]: https://github.com/MagicalPiggy/Mybatis-learning-example/tree/master/mybatis_learning/mybatis_06_dynamicSQL
[20200415201651135.png]: /images/20230528/9ef8c45bc0cd490993b7dff4fcc544b9.png
[20200415212733432.png]: /images/20230528/3ee9568b934a4a0c87fa4df44bfc34de.png