Spring+SpringMVC+MyBatis深入學習及搭建(二)——MyBatis原始Dao開發和mapper代理開發

轉載請注明出處：http://www.cnblogs.com/Joanna-Yan/p/6869133.html 

前面有寫到Spring+SpringMVC+MyBatis深入學習及搭建(一)——MyBatis的基礎知識。MybatisFirst中存在大量重復的代碼。這次簡化下代碼：

使用MyBatis開發Dao，通常有兩種方法，即原始Dao開發方法和Mapper接口開發方法。

1.SqlSession使用范圍

1.1 SqlsessionFactoryBuilder

通過SqlSessionFactoryBuilder創建會話工廠SqlSessionFactory，將SqlSessionFactoryBuilder當成一個工具類使用即可，不需要使用單例管理SqlSessionFactoryBuilder。

在需要創建SqlSessionFactory時候，只需要new一次SqlSessionFactoryBuilder即可。

1.2 SqlsessionFactory

通過SqlSessionFactory創建SqlSession，使用單例模式管理SqlSessionFactory（工廠一旦創建，使用一個實例）。

將來MyBatis和Spring整合后，使用單例模式管理SqlSessionFactory。

1.3 SqlSession

SqlSession是一個面向用戶（程序員）的接口。

SqlSession提供了很多操作數據庫的方法，如：selectOne（返回單個對象）、selectList（返回單個或多個對象）。

SqlSession是線程不安全的，在SqlSession實現類中除了有接口中的方法（操作數據庫的方法）還有數據域屬性。

SqlSession最佳應用場合在方法體內，定義成局部變量使用。

2.原始dao開發方法（程序員需要寫dao接口和dao實現類）

2.1 思路

程序員需要寫dao接口和dao實現類。

需要向dao的實現類中注入SqlSessionFactory，在方法體內通過SqlSessionFactory創建SqlSession.

2.2 dao接口

public interface UserDao {
    //根據id查詢用戶信息
    public User findUserById(int id) throws Exception;
    //添加用戶信息
    public void insertUser(User user) throws Exception;
    //刪除用戶信息
    public void deleteUser(int id) throws Exception;
}

2.3 dao接口實現類

public class UserDaoImpl implements UserDao{
    //需要向dao實現類中注入SqlSessionFactory
    //這里通過構造方法注入
    private SqlSessionFactory sqlSessionFactory;
    public UserDaoImpl(SqlSessionFactory sqlSessionFactory) {
        super();
        this.sqlSessionFactory = sqlSessionFactory;
    }

    @Override
    public User findUserById(int id) throws Exception {
        SqlSession sqlSession=sqlSessionFactory.openSession();
        User user=sqlSession.selectOne("test.findUserById", id);
        //釋放資源
        sqlSession.close();
        return user;
    }

    @Override
    public void insertUser(User user) throws Exception {
        SqlSession sqlSession=sqlSessionFactory.openSession();
        sqlSession.insert("test.insertUser", user);
        //提交事務
        sqlSession.commit();
        //釋放資源
        sqlSession.close();
    }

    @Override
    public void deleteUser(int id) throws Exception {
        SqlSession sqlSession=sqlSessionFactory.openSession();
        sqlSession.delete("test.deleteUser", id);
        //提交事務
        sqlSession.commit();
        //釋放資源
        sqlSession.close();
    }
}

2.4 測試代碼

public class UserDaoImplTest {
    private SqlSessionFactory sqlSessionFactory;
    
    @Before
    public void setUp() throws IOException{
        //創建sqlSessionFactory
        //mybatis配置文件
        String resource="SqlMapConfig.xml";
        //得到配置文件流
        InputStream inputStream=Resources.getResourceAsStream(resource);
        //創建會話工廠，傳入mybatis的配置文件信息
        sqlSessionFactory=new SqlSessionFactoryBuilder().build(inputStream);
    }
    
    @Test
    public void findUserByIdTest() throws Exception{
        UserDao userDao=new UserDaoImpl(sqlSessionFactory);
        User user=userDao.findUserById(1);
        System.out.println(user);
    }
}

2.5 總結原始dao開發問題

（1）dao接口實現類方法中存在大量模板方法，設想能否將這些代碼提取出來，大大減輕程序員工作量。

（2）調用sqlSession方法時將statement的id硬編碼了。

（3）調用sqlSession方法時傳入的變量，由於sqlSession方法使用泛型，即使變量類型傳入錯誤，在編譯階段也不報錯，不利於程序員開發。

3.mapper代理方法（程序員只需要寫mapper接口（相當於dao接口））

3.1 思路（mapper代理開發規范）

程序員需要編寫mapper.xml映射文件

程序員編寫mapper接口需要遵循一些開發規范，mybatis可以自動生成mapper接口實現類代理對象。

開發規范：

（1）在mapper.xml中namespace等於mapper接口地址

（2）mapper.java接口中的方法名和mapper.xml中statement的id一致

（3）mapper.java接口中的方法輸入參數類型和mapper.xml中statement的parameterType指定的類型一致。

（4）mapper.java接口中的方法返回值類型和mapper.xml中statement的resultType指定的類型一致。

總結：

以上方法開發規范主要是對下邊的代碼進行統一生成：

User user = sqlSession.selectOne("test.findUserById", id);
sqlSession.insert("test.insertUser", user);
......

3.2 mapper.java

package joanna.yan.mybatis.mapper;

import java.util.List;
import joanna.yan.mybatis.entity.User;
/**
 * 相當於dao接口
 * @author Joanna.Yan
 *
 */
public interface UserMapper {
    //根據id查詢用戶信息
    public User findUserById(int id) throws Exception;
    //根據名字查詢用戶
    public List<User> findUserByName(String name) throws Exception;
    //添加用戶信息
    public void insertUser(User user) throws Exception;
    //刪除用戶信息
    public void deleteUser(int id) throws Exception;
}

3.3 mapper.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">
<!--namespace命名空間，作用就是對sql進行分類化的管理，理解為sql隔離
    注意：使用mapper代理開發時，namespace有特殊作用，namespace等於mapper接口地址  -->
<mapper namespace="joanna.yan.mybatis.mapper.UserMapper">
    <select id="findUserById" parameterType="java.lang.Integer" resultType="joanna.yan.mybatis.entity.User">
        select * from user where id=#{id}
    </select>
    <select id="findUserByName" parameterType="java.lang.String" resultType="joanna.yan.mybatis.entity.User">
        select * from user where username LIKE '%${value}%'
    </select>
</mapper>

3.4 在SqlMapConfig.xml中加載mapper.xml

3.5 測試

public class UserMapperTest {
private SqlSessionFactory sqlSessionFactory;
    
    @Before
    public void setUp() throws IOException{
        //創建sqlSessionFactory
        //mybatis配置文件
        String resource="SqlMapConfig.xml";
        //得到配置文件流
        InputStream inputStream=Resources.getResourceAsStream(resource);
        //創建會話工廠，傳入mybatis的配置文件信息
        sqlSessionFactory=new SqlSessionFactoryBuilder().build(inputStream);
    }
    
    @Test
    public void findUserByIdTest() throws Exception{
        SqlSession sqlSession=sqlSessionFactory.openSession();
        //創建UserMapper對象，mybatis自動生成mapper代理對象
        UserMapper userMapper=sqlSession.getMapper(UserMapper.class);
        //調用userMapper的方法
        User user=userMapper.findUserById(1);
        System.out.println(user);
    }
    
    @Test
    public void findUserByNameTest() throws Exception{
        SqlSession sqlSession=sqlSessionFactory.openSession();
        //創建UserMapper對象，mybatis自動生成mapper代理對象
        UserMapper userMapper=sqlSession.getMapper(UserMapper.class);
        //調用userMapper的方法
        List<User> list=userMapper.findUserByName("小明");
        System.out.println(list);
    }
}

3.6一些問題總結

3.6.1 代理對象內部調用selectOne或selectList

如果mapper方法返回單個pojo對象（非集合對象），代理對象內部通過selectOne查詢數據庫。

如果mapper方法返回集合對象，代理對象內部通過selectList查詢數據庫。

3.6.2 mapper接口方法參數只能有一個是否影響系統開發

mapper接口方法參數只能有一個，系統是否不利於擴展維護。

系統框架中，dao層的代碼是被業務層公用的。

即使mapper接口只有一個參數，可以使用包裝類型的pojo滿足不同的業務方法的需求。

注意：持久層方法的參數可以用包裝類型、Map等等，service方法中建議不要使用包裝類型（不利於業務層的可擴展）。

如果此文對您有幫助，微信打賞我一下吧~