SqlSession使用范圍
- SqlSessionFactoryBuilder
通過SqlSessionFactoryBuilder
創建會話工廠SqlSessionFactory
將SqlSessionFactoryBuilder
當成一個工具類使用即可,不需要使用單例管理SqlSessionFactoryBuilder
。在需要創建SqlSessionFactory
時候, 只需要new一次SqlSessionFactoryBuilder
即可。
SqlSessionFactory
通過SqlSessionFactory
創建SqlSession
,使用單例模式管理sqlSessionFactory
(工廠一旦創建,使用一個實例)。將來mybatis和spring整合后,使用單例模式管理sqlSessionFactory
。
SqlSession
SqlSession
是一個面向用戶(程序員)的接口。SqlSession中提供了很多操作數據庫的方法:如:selectOne
(返回單個對象)、selectList
(返回單個或多個對象)。
SqlSession
是線程不安全的,在SqlSesion
實現類中除了有接口中的方法(操作數據庫的方法)還有數據域屬性。
SqlSession
最佳應用場合在方法體內,定義成局部變量使用。
原始dao開發方法
程序員需要寫dao接口和dao實現類
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; 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">1
-
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方法中建議不要使用包裝類型(不利於業務層的可擴展)。