mybatis學習筆記(4)-開發dao方法

時間  2019-12-09
標籤 mybatis 學習 筆記 開發 dao 方法 欄目 MyBatis 简体版
原文   原文鏈接

mybatis學習筆記(4)-開發dao方法

標籤： mybatisjava

[TOC]mysql

本文講解SqlSession，並對兩種方法(原始dao開發和mapper代理開發)分別作簡單展現git

SqlSession使用範圍

  • SqlSessionFactoryBuilder

經過SqlSessionFactoryBuilder建立會話工廠SqlSessionFactory將SqlSessionFactoryBuilder當成一個工具類使用便可，不須要使用單例管理SqlSessionFactoryBuilder。在須要建立SqlSessionFactory時候，只須要new一次SqlSessionFactoryBuilder便可。程序員

  • SqlSessionFactory

經過SqlSessionFactory建立SqlSession，使用單例模式管理sqlSessionFactory（工廠一旦建立，使用一個實例）。未來mybatis和spring整合後，使用單例模式管理sqlSessionFactory。github

  • SqlSession

SqlSession是一個面向用戶（程序員）的接口。SqlSession中提供了不少操做數據庫的方法：如：selectOne(返回單個對象)、selectList（返回單個或多個對象）。spring

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

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

原始dao開發方法

程序員須要寫dao接口和dao實現類apache

dao接口

public interface UserDao {
    //根據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;
}

dao接口實現類

package com.iot.mybatis.dao;

import com.iot.mybatis.po.User;
import org.apache.ibatis.session.SqlSession;
import org.apache.ibatis.session.SqlSessionFactory;

import java.util.List;

/**
 * Created by Brian on 2016/2/24.
 */
public class UserDaoImpl implements UserDao{
    // 須要向dao實現類中注入SqlSessionFactory
    // 這裏經過構造方法注入
    private SqlSessionFactory sqlSessionFactory;

    public UserDaoImpl(SqlSessionFactory sqlSessionFactory){
        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 List<User> findUserByName(String name) throws Exception {
        SqlSession sqlSession = sqlSessionFactory.openSession();

        List<User> list = sqlSession.selectList("test.findUserByName", name);

        // 釋放資源
        sqlSession.close();

        return list;
    }

    @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();
    }
}

測試代碼

package com.iot.mybatis.dao;

import java.io.InputStream;

import com.iot.mybatis.po.User;
import org.apache.ibatis.io.Resources;
import org.apache.ibatis.session.SqlSessionFactory;
import org.apache.ibatis.session.SqlSessionFactoryBuilder;
import org.junit.Before;
import org.junit.Test;



public class UserDaoImplTest {

	private SqlSessionFactory sqlSessionFactory;

	// 此方法是在執行testFindUserById以前執行
	@Before
	public void setUp() throws Exception {
		// 建立sqlSessionFactory

		// mybatis配置文件
		String resource = "SqlMapConfig.xml";
		// 獲得配置文件流
		InputStream inputStream = Resources.getResourceAsStream(resource);

		// 建立會話工廠，傳入mybatis的配置文件信息
		sqlSessionFactory = new SqlSessionFactoryBuilder()
				.build(inputStream);
	}

	@Test
	public void testFindUserById() throws Exception {
		// 建立UserDao的對象
		UserDao userDao = new UserDaoImpl(sqlSessionFactory);

		// 調用UserDao的方法
		User user = userDao.findUserById(1);
		
		System.out.println(user);
	}

}

總結原始dao開發問題

1.dao接口實現類方法中存在大量模板方法，設想可否將這些代碼提取出來，大大減輕程序員的工做量。安全

2.調用sqlsession方法時將statement的id硬編碼了

3.調用sqlsession方法時傳入的變量，因爲sqlsession方法使用泛型，即便變量類型傳入錯誤，在編譯階段也不報錯，不利於程序員開發。

mapper代理方法

程序員只須要mapper接口（至關 於dao接口）

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

程序員編寫mapper接口須要遵循一些開發規範，mybatis能夠自動生成mapper接口實現類代理對象。

開發規範

  • 在mapper.xml中namespace等於mapper接口地址
<!--
 namespace 命名空間，做用就是對sql進行分類化管理,理解爲sql隔離
 注意：使用mapper代理方法開發，namespace有特殊重要的做用,namespace等於mapper接口地址
 -->
<mapper namespace="com.iot.mybatis.mapper.UserMapper">

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

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

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

<select id="findUserById" parameterType="int" resultType="com.iot.mybatis.po.User">
    SELECT * FROM  user  WHERE id=#{value}
</select>
//根據id查詢用戶信息
public User findUserById(int id) throws Exception;

總結：以上開發規範主要是對下邊的代碼進行統一輩子成：

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

代碼

  • 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有特殊重要的做用
 -->
<mapper namespace="com.iot.mybatis.mapper.UserMapper">
 <!-- 在映射文件中配置不少sql語句 -->
    <!--需求:經過id查詢用戶表的記錄 -->
    <!-- 經過select執行數據庫查詢
     id:標識映射文件中的sql，稱爲statement的id
     將sql語句封裝到mappedStatement對象中，因此將id稱爲statement的id
     parameterType:指定輸入參數的類型
     #{}標示一個佔位符,
     #{value}其中value表示接收輸入參數的名稱，若是輸入參數是簡單類型，那麼#{}中的值能夠任意。

     resultType：指定sql輸出結果的映射的java對象類型，select指定resultType表示將單條記錄映射成java對象
     -->
    <select id="findUserById" parameterType="int" resultType="com.iot.mybatis.po.User">
        SELECT * FROM  user  WHERE id=#{value}
    </select>

    <!-- 根據用戶名稱模糊查詢用戶信息，可能返回多條
	resultType：指定就是單條記錄所映射的java對象類型
	${}:表示拼接sql串，將接收到參數的內容不加任何修飾拼接在sql中。
	使用${}拼接sql，引發 sql注入
	${value}：接收輸入參數的內容，若是傳入類型是簡單類型，${}中只能使用value
	 -->
    <select id="findUserByName" parameterType="java.lang.String" resultType="com.iot.mybatis.po.User">
        SELECT * FROM user WHERE username LIKE '%${value}%'
    </select>


    <!-- 添加用戶
        parameterType：指定輸入 參數類型是pojo（包括 用戶信息）
        #{}中指定pojo的屬性名，接收到pojo對象的屬性值，mybatis經過OGNL獲取對象的屬性值
        -->
    <insert id="insertUser" parameterType="com.iot.mybatis.po.User">
        <!--
         將插入數據的主鍵返回，返回到user對象中

         SELECT LAST_INSERT_ID()：獲得剛insert進去記錄的主鍵值，只適用與自增主鍵

         keyProperty：將查詢到主鍵值設置到parameterType指定的對象的哪一個屬性
         order：SELECT LAST_INSERT_ID()執行順序，相對於insert語句來講它的執行順序
         resultType：指定SELECT LAST_INSERT_ID()的結果類型
          -->
        <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})
        <!--
            使用mysql的uuid（）生成主鍵
            執行過程：
            首先經過uuid()獲得主鍵，將主鍵設置到user對象的id屬性中
            其次在insert執行時，從user對象中取出id屬性值
             -->
        <!--  <selectKey keyProperty="id" order="BEFORE" resultType="java.lang.String">
            SELECT uuid()
        </selectKey>
        insert into user(id,username,birthday,sex,address) value(#{id},#{username},#{birthday},#{sex},#{address}) -->

    </insert>

    <!-- 刪除 用戶
        根據id刪除用戶，須要輸入 id值
         -->
    <delete id="deleteUser" parameterType="java.lang.Integer">
        delete from user where id=#{id}
    </delete>

    <!-- 根據id更新用戶
    分析：
    須要傳入用戶的id
    須要傳入用戶的更新信息
    parameterType指定user對象，包括 id和更新信息，注意：id必須存在
    #{id}：從輸入 user對象中獲取id屬性值
     -->
    <update id="updateUser" parameterType="com.iot.mybatis.po.User">
        update user set username=#{username},birthday=#{birthday},sex=#{sex},address=#{address}
        where id=#{id}
    </update>
    
</mapper>
  • 在SqlMapConfig.xml中加載映射文件
<mappers>  
    <mapper resource="mapper/UserMapper.xml"/>  
</mappers>
  • UserMapper.java
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;

    //更新用戶
    public void updateUser(User user)throws Exception;
}
  • UserMapperTest/java
public class UserMapperTest {  
  
  
    private SqlSessionFactory sqlSessionFactory;  
      
    //註解Before是在執行本類全部測試方法以前先調用這個方法  
    @Before  
    public void setup() throws Exception{  
        //建立SqlSessionFactory  
        String resource="SqlMapConfig.xml";  
          
        //將配置文件加載成流  
        InputStream inputStream = Resources.getResourceAsStream(resource);  
        //建立會話工廠，傳入mybatis配置文件的信息  
        sqlSessionFactory=new SqlSessionFactoryBuilder().build(inputStream);  
    }  
      
    @Test  
    public void testFindUserById() throws Exception{  
          
        SqlSession sqlSession=sqlSessionFactory.openSession();  
          
        //建立UserMapper代理對象  
        UserMapper userMapper=sqlSession.getMapper(UserMapper.class);  
          
        //調用userMapper的方法  
        User user=userMapper.findUserById(1);  
          
        System.out.println(user.getUsername());  
    }  
}

一些問題總結

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

    • 若是mapper方法返回單個pojo對象（非集合對象），代理對象內部經過selectOne查詢數據庫。
    • 若是mapper方法返回集合對象，代理對象內部經過selectList查詢數據庫。

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

mapper接口方法參數只能有一個，系統是否不利於擴展維護?系統框架中，dao層的代碼是被業務層公用的。即便mapper接口只有一個參數，可使用包裝類型的pojo知足不一樣的業務方法的需求。

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

做者@brianway更多文章：我的網站 | CSDN | oschina

相關文章
相關標籤/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公眾號
   歡迎關注本站公眾號,獲取更多信息
聯繫我們 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程