MyBatis框架中动态语句实现 if 标签与 forearch标签

红太狼 2021-03-12 14:36 582阅读 0赞

#### 引言 ####

在我们进行多条件查询时，往往需要进行sql语句的拼接，在mybatis框架中，提供了两个标签用以拼接动态sql语句，分别是 if 判断 和 forach 循环标签。  
我们都知道在java中数据库的连接代价是高昂的，如果打开了多个连接没有释放会严重影响服务器的效率，严重时会造成宕机，因此我们在查询数据库时最好减少连接次数，多条件查询时使用 if 和 forach 标签可以动态的拼接sql语句，这也是一种优化方案。

#### 环境搭建 ####

###### 1.数据库 ######

这里使用MySql数据库,自己创建一个简单的 User 表用以测试，包含id，username，password，name四个字段；

###### 2.创建Maven工程 ######

目录结构：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzQ2NDk2NA_size_16_color_FFFFFF_t_70]

###### 3.实体类对象代码 ######

package cn.xiaozhang.domain;
    
    import java.io.Serializable;
    
    /**
     * 感谢詹姆斯.高斯林!
     * 有志者,事竟成!
     * 少壮不努力,老大徒伤悲!
     */
    
    /**
     * 用以测试的User
     */
    public class User implements Serializable{
    
        private Integer id;
        private String username;
        private String password;
        private String name;
    
        public Integer getId() {
            return id;
        }
    
        public void setId(Integer id) {
            this.id = id;
        }
    
        public String getUsername() {
            return username;
        }
    
        public void setUsername(String username) {
            this.username = username;
        }
    
        public String getPassword() {
            return password;
        }
    
        public void setPassword(String password) {
            this.password = password;
        }
    
        public String getName() {
            return name;
        }
    
        public void setName(String name) {
            this.name = name;
        }
        @Override
        public String toString() {
            return "User{" +
                    "id=" + id +
                    ", username='" + username + '\'' +
                    ", password='" + password + '\'' +
                    ", name='" + name + '\'' +
                    '}';
        }
    }

###### 4.持久层Mapper ######

package cn.xiaozhang.dao;
    
    import cn.xiaozhang.domain.User;
    
    import java.util.List;
    
    /**
     * 感谢詹姆斯.高斯林!
     * 有志者,事竟成!
     * 少壮不努力,老大徒伤悲!
     */
    
    public interface UserMapper {
    
        /**
         * 根据条件查询
         * @param user
         * @return
         */
        public List<User> findByUser(User user);
        
    }

###### 5.核心配置文件SqlMapConfig,xml ######

<?xml version="1.0" encoding="UTF-8"?>
    <!DOCTYPE configuration
            PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
            "http://mybatis.org/dtd/mybatis-3-config.dtd">
    <configuration>
    
        
        <environments default="mysql">
            
            <environment id="mysql">
                
                <transactionManager type="JDBC"></transactionManager>
    
                
                <dataSource type="POOLED">
                
                    <property name="driver" value="com.mysql.jdbc.Driver"/>
                    <property name="url" value="jdbc:mysql://localhost:3306/test"/>
                    <property name="username" value="root"/>
                    <property name="password" value="root"/>
                </dataSource>
            </environment>
        </environments>
    
        
        <mappers>
    
            
            
    
            
            
    
            
            <package name="cn.xiaozhang.dao"/>
        </mappers>
    </configuration>

###### 6.映射配置文件UserMapper.xml ######

注意: 该文件最好与对应UserMapper类的路径相同，且名称一致。

### if 标签 ###

介绍: if标签用以判断,test属性中可以填写条件,符合条件会解析标签内语句。  
注意 ：where 1=1 可以使用where标签替换，这里不做赘述。

<?xml version="1.0" encoding="UTF-8"?>
    <!DOCTYPE mapper
            PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
            "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
    <mapper namespace="cn.xiaozhang.domain.User">
    
        <select id="findByUser" resultType="cn.xiaozhang.dao.UserMapper" parameterType="cn.xiaozhang.domain.User">
            
            
            select * from user where 1=1
    
            
             
            <if test="username!=null and username != ''   ">
                and username like #{username}
            </if>
            <if test="name != null">
                and name like #{name}
            </if>
    
        </select>
    
    </mapper>

###### 测试类 ######

import cn.xiaozhang.dao.UserMapper;
    import cn.xiaozhang.domain.User;
    import org.apache.ibatis.io.Resources;
    import org.apache.ibatis.session.SqlSession;
    import org.apache.ibatis.session.SqlSessionFactory;
    import org.apache.ibatis.session.SqlSessionFactoryBuilder;
    import org.junit.After;
    import org.junit.Before;
    import org.junit.Test;
    
    import java.io.IOException;
    import java.io.InputStream;
    import java.util.List;
    
    /**
     * 感谢詹姆斯.高斯林!
     * 有志者,事竟成!
     * 少壮不努力,老大徒伤悲!
     */
    
    /**
     * 测试类
     */
    public class MybatisTest {
    
        private UserMapper userMapper;
    
        private InputStream in;
    
        private SqlSession session;
    
        /**
         * 初始化资源的方法
         */
        @Before
        public void init(){
            try {
                // 1.导入 org.apache.ibatis.session.SqlSession个,不要导错包!
                in = Resources.getResourceAsStream("SqlMapConfig.xml");
                // 2.工厂构建者
                SqlSessionFactoryBuilder builder = new SqlSessionFactoryBuilder();
    
                // 3.获得SqlSession
                SqlSessionFactory factory = builder.build(in);
                session = factory.openSession();
                // 4.创建dao层接口代理对象
                userMapper = session.getMapper(UserMapper.class);
            } catch (IOException e) {
                e.printStackTrace();
            }
        }
    
        /**
         * 释放资源
         */
        @After
        public void destroy() throws IOException {
            // 遵循先打开,后释放的原则
            session.close();
            in.close();
        }
    
    
        /**
         * 测试If标签
         */
        @Test
        public void testIf(){
            User u = new User();
            u.setUsername("%li%");
            u.setName("%李%");
    
            List<User> users = userMapper.findByUser(u);
            for(User user : users) {
                System.out.println(user);
            }
        }
    }

###### foreach标签遍历集合查询 ######

**应用场景：** 在我们需要查询多条数据库信息时，往往会使用主 id 封装集合进行查询，foreach标签就派上了用场。

**foreach标签的属性：**  
collection:代表要遍历的集合元素，当传入QueryVo时，我们取的是他的属性，collection的值要与该属性名一致，如果传入的直接是集合，这里要填list（不区分大小写），这是因为Mybatis对一些常用的类进行了命名，注意不要带\#\{\}

open:代表语句的开始部分  
close:代表结束部分  
item:代表遍历集合的每个元素，生成的变量名  
sperator:代表分隔符

给UserMapper增加方法:

/**
         * 根据 id 数组查询用户
         * @param ids
         * @return
         */
        List<User> findInIds(List<Integer> ids);

映射配置文件中增加：

<sql id="defaultSql">
            select * from user
        </sql>
    
        <select id="findInIds" resultType="cn.xiaozhang.domain.User">
            
            
            <include refid="defaultSql"></include>
            <where>
                <if test=" list != null and list.size() > 0">
                    
    
                    <foreach collection="list" open="id in (" close=")" item="id" separator=",">
                        #{id}
                    </foreach>
                </if>
            </where>
        </select>

测试方法：

/**
         * 测试foreach标签
         */
        @Test
        public void testForeach(){
            // 准备集合id
            List ids = new ArrayList<Integer>();
            ids.add(1);
            ids.add(2);
            ids.add(3);
            // 执行sql
            List<User> users = userMapper.findInIds(ids);
            for (User user : users) {
                System.out.println(user);
            }
        }

Mybatis一个非常实用的框架，希望本人能和大家一起学好并利用好它。

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzQ2NDk2NA_size_16_color_FFFFFF_t_70]: /images/1615559766168.png