MyBatis基本配置和實踐(二）

一、前言

從上一篇文章的junit單元測試環節可以看到，每一次調用MyBatis需要先加載SqlMapConfig.xml文件，再通過SqlSessionFactoryBuilder創建SqlSessionFactory，然后從SqlSessionFactory獲取SqlSession，最后調用SqlSession的selectOne、selectList、insert、delete方法完成數據庫操作，編碼效率低下。

二、若干概念的解釋

1、SqlSession的使用范圍
    SqlSession中封裝了對數據庫的操作，如：查詢、插入、更新、刪除等。SqlSession是通過SqlSessionFactory創建，而SqlSessionFactory是通過SqlSessionFactoryBuilder進行創建。

2、SqlSessionFactoryBuilder
    SqlSessionFactoryBuilder用於創建SqlSessionFacoty，SqlSessionFacoty一旦創建完成就不被需要了，因為SqlSession是通過SqlSessionFactory生產，所以可以將SqlSessionFactoryBuilder當成一個工具類使用，最佳使用范圍是方法范圍，即方法體內局部變量。

3、SqlSessionFactory
    SqlSessionFactory是一個接口，接口中定義了openSession的不同重載方法。SqlSessionFactory的最佳使用范圍是整個應用運行期間，一旦創建后可以重復使用，通常以單例模式管理SqlSessionFactory。

4、SqlSession
    SqlSession是一個面向用戶的接口， sqlSession中定義了數據庫操作方法。每個線程都應該有它自己的SqlSession實例。SqlSession的實例不能共享使用，它也是線程不安全的。因此最佳的范圍是請求或方法范圍。絕對不能將SqlSession實例的引用放在一個類的靜態字段或實例字段中。打開一個SqlSession，使用完畢就要關閉它。通常把這個關閉操作放到 finally 塊中以確保每次都能執行關閉。如下：

    SqlSession session = sqlSessionFactory.openSession();
    try {
         // do work
    } finally {
        session.close();
    }

三、使用MyBatis開發DAO的第一種方式：原始DAO開發方式

第一步：復用上一個實驗中的文件（步驟1~步驟7）

第二步：創建接口UserDao（在接口中定義了操作數據庫的Dao方法）

第三步：創建接口UserDao的實現類UserDaoImpl

第四步：單元測試（模擬日常使用）

public class UserDaoTest {

    private SqlSessionFactory sqlSessionFactory;

    /**
     * 通過@Before完成sqlSessionFactory的創建
     */
    @Before
    public void setUp() throws Exception {
        InputStream resourceAsStream = Resources.getResourceAsStream("SqlMapConfig.xml");
        sqlSessionFactory = new SqlSessionFactoryBuilder().build(resourceAsStream);
    }


    /**
     * 每次使用DaoImpl時, 以構造函數傳參的方式將sqlSessionFactory注入給DaoImpl, 然后調用DaoImpl的方法完成數據庫操作
     */
    @Test
    public void testSelectById() throws Exception {
        System.out.println(new UserDaoImpl(sqlSessionFactory).findUserById(10));
    }

    @Test
    public void testSelectByUsername() throws Exception {
        List<User> userByUserName = new UserDaoImpl(sqlSessionFactory).findUserByUserName("王%");

        for (User user : userByUserName) {
            System.out.println(user);
        }
    }
}

問題：

原始Dao開發中存在以下問題：
　　1、Dao方法體存在重復代碼：通過SqlSessionFactory創建SqlSession，調用SqlSession的數據庫操作方法
　　2、調用sqlSession的數據庫操作方法需要指定statement的id，這里存在硬編碼，不利於開發維護。

代碼位置：
   https://github.com/echo1937/mybatis-demo的mybatis-dao模塊

四、使用MyBatis開發DAO的第二種方式：Mapper接口動態代理方式

開發規范：

接口動態代理方式：
　　僅編寫 mapper接口（即Dao接口）和 SQL映射文件，由Mybatis框架自動生成接口的動態代理對象（實現了mapper接口定義的方法）。
Mapper接口開發需要遵循以下規范：
　　1、mapper接口的類路徑與Mapper.xml文件中的namespace相同。
　　2、Mapper接口方法名和Mapper.xml中定義的每個statement的id相同 
　　3、Mapper接口方法的輸入參數類型和mapper.xml中定義的每個sql 的parameterType的類型相同
　　4、Mapper接口方法的輸出參數類型和mapper.xml中定義的每個sql的resultType的類型相同

第一步：復用上一個實驗中的文件（步驟1~步驟5，不再需要第六步的sql映射文件Users.xml；第七步加載Users.xml自然也要修改）

第二步：創建UserMapper.xml映射文件

定義mapper映射文件UserMapper.xml（內容同Users.xml），需要修改namespace的值為 UserMapper接口路徑（規范一）。將UserMapper.xml放在cn.it.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">
<!--
    1、Mapper接口的全路徑名稱和Mapper.xml中的namespace相同
    2、Mapper接口方法名和Mapper.xml中定義的每個statement的id相同
    3、Mapper接口方法的輸入參數類型和mapper.xml中定義的每個sql 的parameterType的類型相同
    4、Mapper接口方法的輸出參數類型和mapper.xml中定義的每個sql的resultType的類型相同
-->

<mapper namespace="cn.it.mapper.UserMapper">

    <select id="findUserById" parameterType="java.lang.Integer" resultType="cn.it.pojo.User">
        select * from user where id = #{id}
    </select>

    <select id="findUserByUsername" parameterType="java.lang.String" resultType="cn.it.pojo.User">
        SELECT * FROM user WHERE username LIKE '${value}'
    </select>

    <insert id="insertUser" parameterType="cn.it.pojo.User">
        <selectKey order="AFTER" resultType="java.lang.Integer" keyProperty="id">
            SELECT LAST_INSERT_ID()
        </selectKey>
        INSERT INTO user(username,birthday,sex,address)VALUES (#{username},#{birthday},#{sex},#{address})
    </insert>

</mapper>

第三步：創建UserMapper.java接口文件

package cn.it.mapper;

import cn.it.pojo.User;

import java.util.List;

/**
 * A. 原生DAO實現  (需要寫DAO接口和DAO實現類)
 * B. 動態代理方式 (只需要寫接口)
 *      1、Mapper接口的全路徑名稱和Mapper.xml中的namespace相同
 *      2、Mapper接口中的方法名和Mapper.xml中定義的statement的id相同
 *      3、Mapper接口中的方法的輸入參數類型和mapper.xml中定義的statement的parameterType的類型相同
 *      4、Mapper接口中方法的輸出參數類型和mapper.xml中定義的statement的resultType的類型相同
 */
public interface UserMapper {
    User findUserById(int id);

    List<User> findUserByUsername(String username);

    void insertUser(User user);

}

第四步：在SqlMapConfig.xml文件中配置sql映射文件，保證可以被讀取

    <mappers>
        <package name="cn.it.mapper"/>
        <!--使用包掃描的方式批量引入Mapper接口: 1、接口名稱和映射文件名稱除擴展名外要完全相同; 2、接口和映射文件必須放在同一個目錄中-->
    </mappers>

第五步：單元測試（Dao接口 + SQL映射文件，MyBatis會自動生成DaoImpl）

public class UserMapperTest {

    private SqlSessionFactory sqlSessionFactory;

    @Before
    public void setUp() throws Exception {
        InputStream resourceAsStream = Resources.getResourceAsStream("SqlMapConfig.xml");
        sqlSessionFactory = new SqlSessionFactoryBuilder().build(resourceAsStream);
    }

    /**
     * 依然需要通過@Before生成sqlSessionFactory, 但不再需要注入給DaoImpl, 因為DaoImpl由MyBatis自動生成.
     * 只需要在方法中生成線程安全的SqlSession, 然后獲取我們需要的Mapper, 即可調用Dao接口中定義的方法
     */
    @Test
    public void findUserById() throws Exception {
        SqlSession openSession = sqlSessionFactory.openSession();
        UserMapper userMapper = openSession.getMapper(UserMapper.class);
        System.out.println(userMapper.findUserById(10));
    }

    @Test
    public void fineUserByUserame() throws Exception {
        SqlSession openSession = sqlSessionFactory.openSession();
        UserMapper userMapper = openSession.getMapper(UserMapper.class);

        List<User> userList = userMapper.findUserByUsername("王%");
        for (User user : userList) {
            System.out.println(user);
        }
    }

    @Test
    public void insertUser() throws Exception {
        SqlSession openSession = sqlSessionFactory.openSession();
        UserMapper userMapper = openSession.getMapper(UserMapper.class);

        User user = new User();
        user.setUsername("阿拉蕾");
        userMapper.insertUser(user);

        System.out.println(user.getId());
        openSession.commit();
    }
}

小結：

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

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

SqlMapConfigxml中<Mapper>配置的幾種方法：

<mapper resource="" />    使用相對於classpath的資源，如：<mapper resource="sqlmap/User.xml" />

<mapper class="" />       使用mapper接口類路徑，如：<mapper class="cn.itcast.mybatis.mapper.UserMapper"/>
                          注意：此種方法要求mapper接口名稱和mapper映射文件名稱相同，且放在同一個目錄中。

<package name=""/>        注冊指定包下的所有mapper接口，如：<package name="cn.itcast.mybatis.mapper"/>
                          注意：此種方法要求mapper接口名稱和mapper映射文件名稱相同，且放在同一個目錄中。

代碼位置：
   https://github.com/echo1937/mybatis-demo的mybatis-mapper模塊