Mybatis實現Mapper動態代理方式

一、實現原理

        Mapper接口開發方法只需要程序員編寫Mapper接口（相當於Dao接口），由Mybatis框架根據接口定義創建接口的動態代理對象，代理對象的方法體同上邊Dao接口實現類方法。

        Mapper接口開發需要遵循以下規范：
                1、 Mapper.xml文件中的namespace與mapper接口的類路徑相同。
                2、  Mapper接口方法名和Mapper.xml中定義的每個statement的id相同 
                3、 Mapper接口方法的輸入參數類型和mapper.xml中定義的每個sql 的parameterType的類型相同
                4、 Mapper接口方法的輸出參數類型和mapper.xml中定義的每個sql的resultType的類型相同

二、Mapper.xml映射文件

         定義mapper映射文件UserMapper.xml（內容同Users.xml），需要修改namespace的值為 UserMapper接口路徑。將UserMapper.xml放在classpath 下mapper目錄 下。

 

<?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">
<!-- 根據id獲取用戶信息 -->
    <select id="findUserById" parameterType="int" resultType="cn.itcast.mybatis.po.User">
        select * from user where id = #{id}
    </select>
<!-- 自定義條件查詢用戶列表 -->
    <select id="findUserByUsername" parameterType="java.lang.String"
            resultType="cn.itcast.mybatis.po.User">
       select * from user where username like '%${value}%'
    </select>
<!-- 添加用戶 -->
    <insert id="insertUser" parameterType="cn.itcast.mybatis.po.User">
    <selectKey keyProperty="id" order="AFTER" resultType="java.lang.Integer">
        select LAST_INSERT_ID()
    </selectKey>
      insert into user(username,birthday,sex,address)
      values(#{username},#{birthday},#{sex},#{address})
    </insert>

</mapper>

 

 

三、Mapper.java（接口文件）

 

 

/**
 * 用戶管理mapper
 */
Public interface UserMapper {
    //根據用戶id查詢用戶信息
    public User findUserById(int id) throws Exception;
    //查詢用戶列表
    public List<User> findUserByUsername(String username) throws Exception;
    //添加用戶信息
    public void insertUser(User user)throws Exception;
}

         接口定義有如下特點：
                  1、Mapper接口方法名和Mapper.xml中定義的statement的id相同
                  2、Mapper接口方法的輸入參數類型和mapper.xml中定義的statement的parameterType的類型相同
                  3、Mapper接口方法的輸出參數類型和mapper.xml中定義的statement的resultType的類型相同

 

四、加載UserMapper.xml文件

         修改sqlMapConfig.xml文件：

 

<!-- 加載映射文件 -->
 <mappers>
   <mapper resource="mapper/UserMapper.xml"/>
 </mappers>

 

 

五、測試

 

 

Public class UserMapperTest extends TestCase {

    private SqlSessionFactory sqlSessionFactory;

    protected void setUp() throws Exception {
        //mybatis配置文件
        String resource = "sqlMapConfig.xml";
        InputStream inputStream = Resources.getResourceAsStream(resource);
        //使用SqlSessionFactoryBuilder創建sessionFactory
        sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
    }


    Public void testFindUserById() throws Exception {
        //獲取session
        SqlSession session = sqlSessionFactory.openSession();
        //獲取mapper接口的代理對象
        UserMapper userMapper = session.getMapper(UserMapper.class);
        //調用代理對象方法
        User user = userMapper.findUserById(1);
        System.out.println(user);
        //關閉session
        session.close();

    }
    @Test
    public void testFindUserByUsername() throws Exception {
        SqlSession sqlSession = sqlSessionFactory.openSession();
        UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
        List<User> list = userMapper.findUserByUsername("張");
        System.out.println(list.size());

    }
Public void testInsertUser() throws Exception {
        //獲取session
        SqlSession session = sqlSessionFactory.openSession();
        //獲取mapper接口的代理對象
        UserMapper userMapper = session.getMapper(UserMapper.class);
        //要添加的數據
        User user = new User();
        user.setUsername("張三");
        user.setBirthday(new Date());
        user.setSex("1");
        user.setAddress("北京市");
        //通過mapper接口添加用戶
        userMapper.insertUser(user);
        //提交
        session.commit();
        //關閉session
        session.close();
    }


}

 

 

六、總結

 

         selectOne和selectList
         動態代理對象調用sqlSession.selectOne()和sqlSession.selectList()是根據mapper接口方法的返回值決定，如果返回list則調用selectList方法，如果返回單個對象則調用selectOne方法。

         namespace
         mybatis官方推薦使用mapper代理方法開發mapper接口，程序員不用編寫mapper接口實現類，使用mapper代理方法時，輸入參數可以使用pojo包裝對象或map對象，保證dao的通用性。