Mapper动态代理开发

妖狐艹你老母 2022-05-17 01:12 207阅读 0赞

#### 原理及开发规范 ####

Mapper接口开发只需要开发人员编写Mapper接口（Dao接口），由Mybatis框架根据接口的定义创建接口的动态代理对象，代理对象的作用等同于Dao接口的实现类的方法

Mapper接口开发需要遵循以下规范：

1.  Mapper.xml文件中的namespace与mapper接口的类路径相同。即Mapper配置文件与接口放在同一个包中
2.  配置文件的名字跟接口名字一样，比如UserMapper.xml和UserMapper接口。
3.  Mapper接口的方法名和Mapper.xml中定义的每个statement的id相同
4.  Mapper接口方法的输入参数类型和mapper.xml中定义的每个sql 的parameterType的类型相同
5.  Mapper接口方法的输出参数类型和mapper.xml中定义的每个sql的resultType的类型相同

**图解**  
![这里写图片描述][70]

#### 开发步骤 ####

*  准备UserMapper.xml配置文件

<?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.itcast.mybatis.mapper.UserMapper">
        
        
        
        
        <select id="queryUserById" parameterType="int" resultType="cn.itcast.mybatis.pojo.User">
            select * from user where id = #{id}
        </select>
    
        
        <select id="queryUserByUsername" parameterType="string" resultType="cn.itcast.mybatis.pojo.User">
            select * from user where username like '%${value}%'
        </select>
    
        
        <insert id="saveUser" parameterType="cn.itcast.mybatis.pojo.User">
            <selectKey keyProperty="id" keyColumn="id" order="AFTER" resultType="int">
                select last_insert_id()
            </selectKey>
            insert into user(username,birthday,sex,address) values
            (#{username},#{birthday},#{sex},#{address});
        </insert>
    
    </mapper>

*  准备UserMapper接口

public interface UserMapper { 
        /** * 根据id查询 * * @param id * @return */
        User queryUserById(int id);
    
        /** * 根据用户名查询用户 * * @param username * @return */
        List<User> queryUserByUsername(String username);
    
        /** * 保存用户 * * @param user */
        void saveUser(User user);
    }

*  在SqlMapConfig.xml中加载映射文件

<mappers>
            <mapper resource="sqlmap/User.xml" />
            <mapper resource="mapper/UserMapper.xml" />
        </mappers>

*  测试

public class UserMapperTest { 
        private SqlSessionFactory sqlSessionFactory;
    
        @Before
        public void init() throws Exception {
            // 创建SqlSessionFactoryBuilder
            SqlSessionFactoryBuilder sqlSessionFactoryBuilder = new SqlSessionFactoryBuilder();
            // 加载SqlMapConfig.xml配置文件
            InputStream inputStream = Resources.getResourceAsStream("SqlMapConfig.xml");
            // 创建SqlsessionFactory
            this.sqlSessionFactory = sqlSessionFactoryBuilder.build(inputStream);
        }
    
        @Test
        public void testQueryUserById() {
            // 获取sqlSession，和spring整合后由spring管理
            SqlSession sqlSession = this.sqlSessionFactory.openSession();
    
            // 从sqlSession中获取Mapper接口的代理对象
            UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
            // 执行查询方法
            User user = userMapper.queryUserById(1);
            System.out.println(user);
    
            // 和spring整合后由spring管理
            sqlSession.close();
        }
    
        @Test
        public void testQueryUserByUsername() {
            // 获取sqlSession，和spring整合后由spring管理
            SqlSession sqlSession = this.sqlSessionFactory.openSession();
    
            // 从sqlSession中获取Mapper接口的代理对象
            UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
            // 执行查询方法
            List<User> list = userMapper.queryUserByUsername("张");
            for (User user : list) {
                System.out.println(user);
            }
    
            // 和spring整合后由spring管理
            sqlSession.close();
        }
    
        @Test
        public void testSaveUser() {
            // 获取sqlSession，和spring整合后由spring管理
            SqlSession sqlSession = this.sqlSessionFactory.openSession();
    
            // 从sqlSession中获取Mapper接口的代理对象
            UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
            // 创建保存对象
            User user = new User();
            user.setUsername("刘备");
            user.setBirthday(new Date());
            user.setSex("1");
            user.setAddress("蜀国");
            // 执行查询方法
            userMapper.saveUser(user);
            System.out.println(user);
    
    
            // 和spring整合后由spring管理
            sqlSession.commit();
            sqlSession.close();
        }
    }

#### 小结 ####

*  查询单个或集合  
    动态代理对象调用sqlSession.selectOne()和sqlSession.selectList()是根据Mapper接口的方法返回值决定的，如果返回list就调用selectList方法，返回单个对象，就调用selectOne方法
 *  namespace  
    mybatis官方推荐使用mapper代理方法开发mapper接口，程序员不用编写mapper接口实现类，使用mapper代理方法时，输入参数可以使用pojo包装对象或map对象，保证dao的通用性。

[70]: /images/20220517/50e45106f015429eaf81525aed6e8f91.png