【框架】MyBatis的代理开发

【框架】Mapper代理开发

Mapper代理开发是Mybatis的一个功能，如不知道Mybatis如何使用，请移步MyBatis快速入门。

1、Mapper代理开发概述

之前我们写的代码是基本使用方式，它也存在硬编码的问题，如下：

这里调用 selectList() 方法传递的参数是映射配置文件中的 namespace.id值。这样写也不便于后期的维护。如果使用 Mapper 代理方式（如下图）则不存在硬编码问题。

通过上面的描述可以看出 Mapper 代理方式的目的：

• 解决原生方式中的硬编码
• 简化后期执行SQL

Mybatis 官网也是推荐使用 Mapper 代理的方式。下图是截止官网的图片

2、使用Mapper代理要求

使用Mapper代理方式，必修满足以下要求：

• 定义与SQL映射文件同名的Mapper接口，并且将Mapper接口和SQL映射文件放置在同一个目录下。如下图

• 设置SQL映射文件的namespace属性为Mapper接口全限定名
  

• 在Mapper接口中定义方法，方法名就是SQL映射文件中SQL语句的id，并保持参数类型和返回值类型一致
  

3、Mapper代理代码实现

• 在com.qfedu.mapper包下创建UserMapper接口，代码如下

public interface UserMapper{
    List<User> selectUsers();
}

• 在resources下创建com/qfedu/mapper目录，并在该目录下创建UserMapper.xml映射配置文件

<!--
namespace:名称空间。必须是对应接口的全限定名
-->
<mapper namespace="com.qfedu.mapper.UserMapper">
    <select id="selectUsers" resultType="com.qfedu.pojo.User">
    select * from stu
  </select>
</mapper>

• 在com.qfedu包下创建MyBatisDemo1测试类，代码如下：

public class MyBatisDemo1 {
    public static void main(String[] args) throws IOException {
        //1.加载mybatis的核心配置文件，获取SqlSessionFactory
        String resource = "mybatis-config.xml";
        InputStream inputStream = Resources.getResourceAsStream(resource);
        SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
        //2.获取SqlSession对象，用它来执行sql
        SqlSession sqlSession = sqlSessionFactory.openSession();
        //3.执行sql
        //3.1获取UserMapper接口的代理对象
        UserMapper mapper = sqlSession.getMapper(UserMapper.class);
        List<User> users = mapper.selectUsers();
        System.out.println(users);
        //4.释放资源
        sqlSession.close();
        inputStream.close();
    }
}

注意

如果Mapper接口名称和SQL映射文件名称相同，并在同一目录下，则可以使用包扫描的方式简化SQL映射文件的加载。也就是将核心配置文件的加载映射配置文件的配置修改为

<mappers>
    <!--加载sql映射文件-->
    <!-- <mapper resource="com/qfedu/mapper/UserMapper.xml"/>-->
    <!--Mapper代理方式-->
    <package name="com.qfedu.mapper"/>
</mappers>

本文到此完毕