MyBatis系列（二）——MyBatis的动态代理和映射文件动态配置

前言

我们在上一篇文章中讲了MyBatis的入门操作，但在入门操作篇中MyBatis在使用上还是有着一定的不便和冗余，本篇文章将对MyBatis的动态代理和如何在映射文件中编写动态sql进行讲解，希望对各位读者有所帮助。

想要了解更多MyBaits系列文章，可以从下面的传送门阅读：

MyBatis系列（一）——MyBatis的介绍和CRUD

一、MyBatis的动态代理
（一）回顾传统的实现mapper接口方式

讲动态代理之前，我们先来回顾一下我们之前使用实现查询所有用户方法的实现步骤：

  1. 创建接口
public interface UserMapper {
    // 查询所有用户
    List<User> getAllUser() throws Exception;
}
  1. 创建实现类
public class UserMapperImpl implements UserMapper {
    public List<User> getAllUser() throws Exception {
        InputStream is = Resources.getResourceAsStream("sqlMapConfig.xml");
        SqlSessionFactory factory = new SqlSessionFactoryBuilder().build(is);
        SqlSession sqlSession = factory.openSession();
        List<User> users = sqlSession.selectList("userMapper.getAllUser");
        System.out.println(users);
        sqlSession.close();
        return users;
    }
}
  1. 调用方法
public class UserDaoTest {
    @Test
    public void testGetAllUser() throws Exception {
        UserMapper userMapper = new UserMapperImpl();
        userMapper.getAllUser();
    }
}

上述的实现方式固然没有问题，但每次创建mapper接口时，我们都必须要创建其对应的实现，但实际上对应的实现中真正需要我们手动做的就只有sqlSession调用的具体方法和传入参数。为了减少我们开发的繁琐步骤，MyBatis提供了动态代理实现接口子类的功能，我们可以不用写mapper接口的实现子类，由MyBaits动态帮我们去创建。
·

（二）MyBatis动态创建mapper接口的方式

要先使用MyBatis的动态代理功能，Mapper 接口开发需要遵循以下规范：

  • Mapper.xml文件中的namespace与mapper接口的全限定名相同
  • Mapper接口方法名和Mapper.xml中定义的每个statement的id相同
  • Mapper接口方法的输入参数类型和mapper.xml中定义的每个sql的parameterType的类型相同

  • Mapper接口方法的输出参数类型和mapper.xml中定义的每个sql的resultType的类型相同


确认接口和mapper映射文件就都满足要求后，只需要直接调用sqlSession.getMapper方法即可

public class UserDaoTest {
    @Test
    public void GetAllUserByDanamic() throws Exception {
        InputStream is = Resources.getResourceAsStream("sqlMapConfig.xml");
        SqlSessionFactory factory = new SqlSessionFactoryBuilder().build(is);
        SqlSession sqlSession = factory.openSession();
        UserMapper mapper = sqlSession.getMapper(UserMapper.class);
        List<User> allUser = mapper.getAllUser();
        System.out.println(allUser);
        sqlSession.close();
    }
}

二、MyBatis映射文件的动态SQL配置

我们在工作中可能会遇到这样一个需求，用户可以任意选择某些字段作为表的查询条件，这种情况下我们显然是无法得知用户最终的选择，而在类中穷举用户所有的选择方案虽然理论上可行，但会极大的增加我们的工作量，我们一般也不会采取。常见的解决方案是，通过where 1 = 1 and的方式，在代码中对用户传来的数据进行判断，再拼接到sql上形成最后的sql语句。
但在MyBatis中我们的sql语句是写在映射文件中的，自然不可能用java代码进行判断。所以MyBatis在映射文件中提供了if、where、sql、foreach等标签来帮助我们处理这些场景。

（一）if标签的使用

if标签使用起来很简单，类似于java中的if，只有满足if中test属性的条件，才会拼接if标签中的sql语句

要求：执行用户查询语句，可能查询的条件有用户ID、用户名和密码
映射文件内容如下：

    <select id="getUserByConditions" parameterType="user" resultType="user">
        select * from user
        where 1 = 1
        <if test="uid != null">
            and uid = #{uid}
        </if>
        <if test="username != null">
            and username = #{username}
        </if>
        <if test="password != null">
            and password = #{password}
        </if>
    </select>

调用方法

    @Test
    public void testGetUserByCondition() throws Exception {
        User user = new User(null,"小黄",null);
        InputStream is = Resources.getResourceAsStream("sqlMapConfig.xml");
        SqlSessionFactory factory = new SqlSessionFactoryBuilder().build(is);
        SqlSession sqlSession = factory.openSession();
        UserMapper mapper = sqlSession.getMapper(UserMapper.class);
        List<User> allUser = mapper.getUserByConditions(user);
        System.out.println(allUser);
        sqlSession.close();
    }
（二）where标签的使用

where标签的使用可以说是比较智能地简化掉我们的where 1 =1写法，但判断where标签中其他条件符合，就会自动帮我们拼接上where 1 = 1，否则就不拼接

我们用if标签中的例子来进行改良
映射文件中sql不再手动写where 1 = 1

    <select id="getUserByConditions" parameterType="user" resultType="user">
        select * from user
        <where>
            <if test="uid != null">
                and uid = #{uid}
            </if>
            <if test="username != null">
                and username = #{username}
            </if>
            <if test="password != null">
                and password = #{password}
            </if>
        </where>
    </select>

调用方法进行测试

    @Test
    public void testGetUserByCondition2() throws Exception {
        User user = new User();
        InputStream is = Resources.getResourceAsStream("sqlMapConfig.xml");
        SqlSessionFactory factory = new SqlSessionFactoryBuilder().build(is);
        SqlSession sqlSession = factory.openSession();
        UserMapper mapper = sqlSession.getMapper(UserMapper.class);
        List<User> allUser = mapper.getUserByConditions(user);
        System.out.println(allUser);
        sqlSession.close();
    }


我们可以看到，where标签的使用可以帮我们省略手写where 1 = 1的步骤

（三）foreach标签

foreach标签在实际工作中可能用的比较少，主要是用于参数类型为集合的场景。比如说现在的需求是随机选择一些
用户ID，要求查询这些用户的所有信息，如果使用select * from xxx in ( ) 的方式解决，我们就可以使用foreach标签来对参数集进行遍历。

映射文件编写如下：

    <select id="getUserByUids" resultType="user" parameterType="list">
        select * from user
        <where>
            <foreach collection="list" open="uid in (" close=")" item="uid" separator=",">
                #{uid}
            </foreach>
        </where>
    </select>

简单介绍一下foreach标签的使用， collection表示参数的集合类型，open和close表示拼接的起始和结束语句，item表示每一个遍历出来的元素，separator表示各个元素之间的分隔符

调用方法进行测试

    @Test
    public void testGetUserByIds() throws Exception {
        List<Integer> list = Arrays.asList(1, 2, 3);
        InputStream is = Resources.getResourceAsStream("sqlMapConfig.xml");
        SqlSessionFactory factory = new SqlSessionFactoryBuilder().build(is);
        SqlSession sqlSession = factory.openSession();
        UserMapper mapper = sqlSession.getMapper(UserMapper.class);
        List<User> allUser = mapper.getUserByUids(list);
        System.out.println(allUser);
        sqlSession.close();
    }
（四）sql标签的使用

MyBatis可支持我们将重复的 sql 提取出来，使用时用 include 标签引用即可，最终达到 sql 重用的目的
我们这里就沿用我们foreach标签中的案例来演示吧

映射文件编写如下：

    <sql id="selectUser">
        select uid,username,password from user
    </sql>

    <select id="getUserByUids" resultType="user" parameterType="list">
        <include refid="selectUser"></include>
        <where>
            <foreach collection="list" open="uid in (" close=")" item="uid" separator=",">
                #{uid}
            </foreach>
        </where>
    </select>

方法代码不变，点击运行。我们可以发现，sql抽取的方法可以被正常使用


写在最后

本篇文章主要介绍MyBatis提供的动态代理和映射文件动态sql实现的特性，本质上来说，这两个特性都是为了我们更简便地完成持久层的操作，大家在学习新技术的时候不要忘记了新技术本身出现的意义。

posted @ 2021-04-01 18:15  moutory  阅读(16)  评论(0)  编辑  收藏  举报  来源