Mybatis 開發(fā) Dao

前言 | 使用Mybatis 開發(fā) dao，通常有兩個(gè)方法，即原始 dao 開發(fā)方法和 Mapper 動態(tài)代理開發(fā)方法。

一、需求

  • 使用MyBatis開發(fā)DAO實(shí)現(xiàn)以下的功能：
    1)、根據(jù)用戶id查詢一個(gè)用戶信息
    2)、根據(jù)用戶名稱模糊查詢用戶信息列表
    3)、添加用戶信息

二、SqlSession的使用范圍

SqlSession 中封裝了對數(shù)據(jù)庫的操作，如：查詢、插入、更新、刪除等。
SqlSession 通過 SqlSessionFactory 創(chuàng)建。
SqlSessionFactory 是通過 SqlSessionFactoryBuilder 進(jìn)行創(chuàng)建。

  1. SqlSessionFactoryBuilder
    SqlSessionFactoryBuilder用于創(chuàng)建SqlSessionFacoty，SqlSessionFacoty一旦創(chuàng)建完成就不需要SqlSessionFactoryBuilder了，因?yàn)镾qlSession是通過SqlSessionFactory創(chuàng)建的。所以可以將SqlSessionFactoryBuilder當(dāng)成一個(gè)工具類使用，最佳使用范圍是方法范圍即方法體內(nèi)局部變量。

  2. SqlSessionFactory
    SqlSessionFactory是一個(gè)接口，接口中定義了openSession的不同重載方法，SqlSessionFactory的最佳使用范圍是整個(gè)應(yīng)用運(yùn)行期間，一旦創(chuàng)建后可以重復(fù)使用，通常以單例模式管理SqlSessionFactory。

  3. SqlSession
    SqlSession是一個(gè)面向用戶的接口，sqlSession中定義了數(shù)據(jù)庫操作方法。
    每個(gè)線程都應(yīng)該有它自己的SqlSession實(shí)例。SqlSession的實(shí)例不能共享使用，它也是線程不安全的。因此最佳的范圍是請求或方法范圍。絕對不能將SqlSession實(shí)例的引用放在一個(gè)類的靜態(tài)字段或?qū)嵗侄沃小?/strong>
    打開一個(gè) SqlSession；使用完畢就要關(guān)閉它。通常把這個(gè)關(guān)閉操作放到 finally 塊中以確保每次都能執(zhí)行關(guān)閉。如下：

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

三、原始 Dao 開發(fā)方式

原始Dao開發(fā)方法需要程序員編寫Dao接口和Dao實(shí)現(xiàn)類。

  1. sql 映射文件
<?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，
    使用動態(tài)代理開發(fā)DAO，namespace必須和Mapper接口類路徑一致 -->
<mapper namespace="test">
    <!-- 根據(jù)id查詢用戶 -->
    <select id="queryUserById" parameterType="int"
       resultType="cn.itcast.mybatis.pojo.User">
       select * from user where id = #{id}
    </select>
    <!-- 根據(jù)username模糊查詢用戶 -->
    <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>
  1. dao 接口
public interface UserDao {
    /**
     * 根據(jù)id查詢用戶
     * @param id
     * @return
     */
    User queryUserById(int id);

    /**
     * 根據(jù)用戶名模糊查詢用戶
     * @param username
     * @return
     */
    List<User> queryUserByUsername(String username);

    /**
     * 保存用戶
     * @param user
     */
    void saveUser(User user);
}
  1. dao 實(shí)現(xiàn)類
public class UserDaoImpl implements UserDao {

    private SqlSessionFactory sqlSessionFactory;
    public UserDaoImpl(SqlSessionFactory sqlSessionFactory) {
       super();
       this.sqlSessionFactory = sqlSessionFactory;
    }

    @Override
    public User queryUserById(int id) {
       // 創(chuàng)建SqlSession
       SqlSession sqlSession = this.sqlSessionFactory.openSession();
       // 執(zhí)行查詢邏輯
       User user = sqlSession.selectOne("queryUserById", id);
       // 釋放資源
       sqlSession.close();
       return user;
    }

    @Override
    public List<User> queryUserByUsername(String username) {
       // 創(chuàng)建SqlSession
       SqlSession sqlSession = this.sqlSessionFactory.openSession();
       // 執(zhí)行查詢邏輯
       List<User> list = sqlSession.selectList("queryUserByUsername", username);
       // 釋放資源
       sqlSession.close();
       return list;
    }

    @Override
    public void saveUser(User user) {
       // 創(chuàng)建SqlSession
       SqlSession sqlSession = this.sqlSessionFactory.openSession();
       // 執(zhí)行保存邏輯
       sqlSession.insert("saveUser", user);
       // 提交事務(wù)
       sqlSession.commit();
       // 釋放資源
       sqlSession.close();
    }
}
  1. dao 測試
public class UserDaoTest {

    private SqlSessionFactory sqlSessionFactory;
    @Before
    public void init() throws Exception {
       // 創(chuàng)建SqlSessionFactoryBuilder
       SqlSessionFactoryBuilder sqlSessionFactoryBuilder = new SqlSessionFactoryBuilder();
       // 加載SqlMapConfig.xml配置文件
       InputStream inputStream = Resources.getResourceAsStream("SqlMapConfig.xml");
       // 創(chuàng)建SqlsessionFactory
       this.sqlSessionFactory = sqlSessionFactoryBuilder.build(inputStream);
    }

    @Test
    public void testQueryUserById() {
       // 創(chuàng)建DAO
       UserDao userDao = new UserDaoImpl(this.sqlSessionFactory);
       // 執(zhí)行查詢
       User user = userDao.queryUserById(1);
       System.out.println(user);
    }

    @Test
    public void testQueryUserByUsername() {
       // 創(chuàng)建DAO
       UserDao userDao = new UserDaoImpl(this.sqlSessionFactory);
       // 執(zhí)行查詢
       List<User> list = userDao.queryUserByUsername("張");
       for (User user : list) {
           System.out.println(user);
       }
    }

    @Test
    public void testSaveUser() {
       // 創(chuàng)建DAO
       UserDao userDao = new UserDaoImpl(this.sqlSessionFactory);
       // 創(chuàng)建保存對象
       User user = new User();
       user.setUsername("劉備");
       user.setBirthday(new Date());
       user.setSex("1");
       user.setAddress("蜀國");
       // 執(zhí)行保存
       userDao.saveUser(user);
       System.out.println(user);
    }
}
  1. 問題
  • 原始Dao開發(fā)中存在以下問題：
    1)、Dao方法體存在重復(fù)代碼：通過SqlSessionFactory創(chuàng)建SqlSession，調(diào)用SqlSession的數(shù)據(jù)庫操作方法；
    2)、調(diào)用sqlSession的數(shù)據(jù)庫操作方法需要指定statement的id，這里存在硬編碼，不利于開發(fā)維護(hù)。

四、Mapper 動態(tài)代理開發(fā)方式

  1. 開發(fā)規(guī)范
    Mapper接口開發(fā)方法只需要程序員編寫Mapper接口（相當(dāng)于Dao接口），由Mybatis框架根據(jù)接口定義創(chuàng)建接口的動態(tài)代理對象，代理對象的方法體同上邊Dao接口實(shí)現(xiàn)類方法。
  • Mapper接口開發(fā)需要遵循以下規(guī)范：
    1)、Mapper.xml文件中的namespace與mapper接口的類路徑相同。
    2)、Mapper接口方法名和Mapper.xml中定義的每個(gè)statement的id相同。
    3)、Mapper接口方法的輸入?yún)?shù)類型和mapper.xml中定義的每個(gè)sql 的parameterType的類型相同。
    4)、Mapper接口方法的輸出參數(shù)類型和mapper.xml中定義的每個(gè)sql的resultType的類型相同。
  1. 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 -->
<!-- 還有一個(gè)很重要的作用，使用動態(tài)代理開發(fā)DAO，1\. namespace必須和Mapper接口類路徑一致 -->
<mapper namespace="cn.itcast.mybatis.mapper.UserMapper">
    <!-- 根據(jù)用戶id查詢用戶 -->
    <!-- 2\. id必須和Mapper接口方法名一致 -->
    <!-- 3\. parameterType必須和接口方法參數(shù)類型一致 -->
    <!-- 4\. resultType必須和接口方法返回值類型一致 -->
    <select id="queryUserById" parameterType="int" resultType="cn.itcast.mybatis.pojo.User">
       select * from user where id = #{id}
    </select>

    <!-- 根據(jù)用戶名查詢用戶 -->
    <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>
  1. UserMapper(接口文件)
public interface UserMapper {
    /**
     * 根據(jù)id查詢
     * @param id
     * @return
     */
    User queryUserById(int id);

    /**
     * 根據(jù)用戶名查詢用戶
     * @param username
     * @return
     */
    List<User> queryUserByUsername(String username);

    /**
     * 保存用戶
     * @param user
     */
    void saveUser(User user);
}
  1. 加載UserMapper.xml文件
    <!-- 加載映射文件 -->
    <mappers>
       <mapper resource="sqlmap/User.xml" />
       <mapper resource="mapper/UserMapper.xml" />
    </mappers>
  1. 測試
public class UserMapperTest {
    private SqlSessionFactory sqlSessionFactory;
    @Before
    public void init() throws Exception {
       // 創(chuàng)建SqlSessionFactoryBuilder
       SqlSessionFactoryBuilder sqlSessionFactoryBuilder = new SqlSessionFactoryBuilder();
       // 加載SqlMapConfig.xml配置文件
       InputStream inputStream = Resources.getResourceAsStream("SqlMapConfig.xml");
       // 創(chuàng)建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);
       // 執(zhí)行查詢方法
       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);
       // 執(zhí)行查詢方法
       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);
       // 創(chuàng)建保存對象
       User user = new User();
       user.setUsername("劉備");
       user.setBirthday(new Date());
       user.setSex("1");
       user.setAddress("蜀國");
       // 執(zhí)行查詢方法
       userMapper.saveUser(user);
       System.out.println(user);
       // 和spring整合后由spring管理
       sqlSession.commit();
       sqlSession.close();
    }
}
  1. 小結(jié)

  • selectOne 和 selectList
    動態(tài)代理對象調(diào)用sqlSession.selectOne()和sqlSession.selectList()是根據(jù)mapper接口方法的返回值決定，如果返回list則調(diào)用selectList方法，如果返回單個(gè)對象則調(diào)用selectOne方法。

  • namespace
    mybatis官方推薦使用mapper代理方法開發(fā)mapper接口，程序員不用編寫mapper接口實(shí)現(xiàn)類，使用mapper代理方法時(shí)，輸入?yún)?shù)可以使用pojo包裝對象或map對象，保證dao的通用性。

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成，瀏覽時(shí)請結(jié)合常識與多方信息審慎甄別。
平臺聲明：文章內(nèi)容（如有圖片或視頻亦包括在內(nèi)）由作者上傳并發(fā)布，文章內(nèi)容僅代表作者本人觀點(diǎn)，簡書系信息發(fā)布平臺，僅提供信息存儲服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容