MyBatis如何調(diào)用存儲過程與存儲函數(shù)

更新時間：2021年11月30日 14:38:22 作者：pan_junbiao

這篇文章主要介紹了MyBatis如何調(diào)用存儲過程與存儲函數(shù)，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教

1、MyBatis調(diào)用存儲過程

MyBatis支持使用存儲過程的配置。當使用存儲過程時，需要設(shè)置一個參數(shù)“mode”，其值有IN（輸入?yún)?shù)）、OUT（輸出參數(shù)）和INOUT（輸入/輸出參數(shù)）。

MyBatis定義存儲過程如下：

<!-- 存儲過程 -->
<select id="selectSomeThing" statementType="CALLABLE" parameterType="hashmap" resultType="com.pjb.mybatis.po.User">
    {CALL PROC_FOR_INPUT(#{information,mode=IN,jdbcType=VARCHAR})}
</select>

【示例】創(chuàng)建存儲過程，實現(xiàn)分頁查詢用戶列表，并返回數(shù)據(jù)總數(shù)和總頁數(shù)，通過MyBatis調(diào)用該存儲過程。

（1）在MySQL數(shù)據(jù)庫中創(chuàng)建用戶信息表（tb_user）。

-- 創(chuàng)建“用戶信息”數(shù)據(jù)表
CREATE TABLE IF NOT EXISTS tb_user
( 
	id INT AUTO_INCREMENT PRIMARY KEY COMMENT '用戶編號',
	user_name VARCHAR(50) NOT NULL COMMENT '用戶姓名',
	sex CHAR(2) DEFAULT '男' COMMENT '性別'
) COMMENT = '用戶信息表';

（2）創(chuàng)建存儲過程，實現(xiàn)分頁查詢用戶列表，并返回數(shù)據(jù)總數(shù)和總頁數(shù)。

-- 將結(jié)束標志符更改為$$
DELIMITER $$
 
/*
  -- 存儲過程：分頁查詢用戶列表，并返回數(shù)據(jù)總數(shù)和總頁數(shù)
  -- 輸入?yún)?shù)：page_index：當前頁碼
  -- 輸入?yún)?shù)：page_size：分頁大小
  -- 輸出參數(shù)：total_count：數(shù)據(jù)總數(shù)
  -- 輸出參數(shù)：total_page：總頁數(shù)
*/
CREATE PROCEDURE proc_search_user(IN page_index INT,IN page_size INT, OUT total_count INT, OUT total_page INT)
BEGIN
	DECLARE begin_no INT;
	SET begin_no = (page_index-1)*page_size;
 
	-- 分頁查詢列表
	SELECT * FROM tb_user
	WHERE id >= (
		SELECT id FROM tb_user
		ORDER BY id ASC
		LIMIT begin_no,1
	)
	ORDER BY id ASC
	LIMIT page_size;
 
	-- 計算數(shù)據(jù)總數(shù)
	SELECT COUNT(1) INTO total_count FROM tb_user;
 
	-- 計算總頁數(shù)
	SET total_page = FLOOR((total_count + page_size - 1) / page_size);
END$$
 
-- 將結(jié)束標志符更改回分號
DELIMITER ;

（3）創(chuàng)建用戶信息持久化類（User.java）。

package com.pjb.mybatis.po;
 
/**
 * 用戶信息的持久化類
 * @author pan_junbiao
 **/
public class User
{
    private int id; //用戶編號
    private String userName; //用戶姓名
    private String sex; //性別
 
    //省略getter與setter方法...
}

（4）編寫SQL映射配置。

<!-- 存儲過程：分頁查詢用戶列表，并返回數(shù)據(jù)總數(shù)和總頁數(shù) -->
<select id="proc_search_user" statementType="CALLABLE" parameterType="hashmap" resultType="com.pjb.mybatis.po.User">
    {CALL proc_search_user(#{page_index,mode=IN,jdbcType=INTEGER},
      #{page_size,mode=IN,jdbcType=INTEGER},
      #{total_count,mode=OUT,jdbcType=INTEGER},
      #{total_page,mode=OUT,jdbcType=INTEGER})}
</select>

（5）編寫執(zhí)行方法。

/**
 * 使用MyBatis調(diào)用存儲過程：分頁查詢用戶列表，并返回數(shù)據(jù)總數(shù)和總頁數(shù)
 * @author pan_junbiao
 */
@Test
public void procSearchUser()
{
    DataConnection dataConnection = new DataConnection();
    SqlSession sqlSession = dataConnection.getSqlSession();
    //封裝查詢參數(shù)
    Map params = new HashMap();
    params.put("page_index",2);  //輸入?yún)?shù)：當前頁碼
    params.put("page_size",10);  //輸入?yún)?shù)：分頁大小
    params.put("total_count",0); //輸出參數(shù)：數(shù)據(jù)總數(shù)
    params.put("total_page",0);  //輸出參數(shù)：總頁數(shù)
    //調(diào)用存儲過程
    List<User> userList = sqlSession.selectList("test.proc_search_user",params);
    System.out.println("查詢第"+ params.get("page_index") +"頁的數(shù)據(jù)，每頁共"+params.get("page_size")+"條數(shù)據(jù)");
    //遍歷用戶列表
    for (User user : userList)
    {
        System.out.println("編號：" + user.getId() +" 姓名：" + user.getUserName() + " 性別：" + user.getSex());
    }
    //獲取輸出參數(shù)
    System.out.println("數(shù)據(jù)總數(shù)：" + params.get("total_count"));
    System.out.println("總頁數(shù)：" + params.get("total_page"));
    sqlSession.close();
}

執(zhí)行結(jié)果：

【示例】創(chuàng)建存儲過程，實現(xiàn)新增用戶信息，并返回自增主鍵，通過MyBatis調(diào)用該存儲過程。

（1）創(chuàng)建存儲過程。

-- 將結(jié)束標志符更改為$$
DELIMITER $$
 
/*
  -- 存儲過程：新增用戶信息，返回自增主鍵
  -- 輸入?yún)?shù)：user_name：用戶姓名
  -- 輸入?yún)?shù)：sex：性別
  -- 輸出參數(shù)：user_id：自增主鍵
*/
CREATE PROCEDURE proc_add_user(IN user_name VARCHAR(50),IN sex CHAR(2), OUT user_id INT)
BEGIN
	-- 新增用戶
	INSERT INTO tb_user(user_name,sex) VALUE (user_name,sex);
	
	-- 獲取自增主鍵
	SELECT LAST_INSERT_ID() INTO user_id;
END$$
 
-- 將結(jié)束標志符更改回分號
DELIMITER ;

（2）編寫SQL映射配置。

<!-- 存儲過程：新增用戶信息，返回自增主鍵 -->
<insert id="proc_add_user" statementType="CALLABLE" parameterType="com.pjb.mybatis.po.User">
  {CALL proc_add_user(#{userName,mode=IN,jdbcType=VARCHAR},
    #{sex,mode=IN,jdbcType=CHAR},
    #{id,mode=OUT,jdbcType=INTEGER})}
</insert>

（3）編寫執(zhí)行方法。

/**
 * 使用MyBatis調(diào)用存儲過程：新增用戶信息，返回自增主鍵
 * @author pan_junbiao
 */
@Test
public void procAddUser()
{
    DataConnection dataConnection = new DataConnection();
    SqlSession sqlSession = dataConnection.getSqlSession();
    //新增的用戶對象
    User user = new User();
    user.setUserName("pan_junbiao的博客");
    user.setSex("男");
    //調(diào)用存儲過程執(zhí)行新增
    int reuslt = sqlSession.insert("test.proc_add_user",user);
    sqlSession.commit();
    //打印結(jié)果
    System.out.println("執(zhí)行結(jié)果："+reuslt);
    System.out.println("自增主鍵："+user.getId());
    sqlSession.close();
}

執(zhí)行結(jié)果：

其實，新增數(shù)據(jù)后，獲取自增主鍵是可以使用MyBatis提供的<selectKey>標簽，SQL映射配置如下：

<!-- 存儲過程：新增用戶信息，返回自增主鍵 -->
<insert id="proc_add_user" statementType="CALLABLE" parameterType="com.pjb.mybatis.po.User">
  <selectKey keyProperty="id" order="AFTER" resultType="java.lang.Integer">
      SELECT LAST_INSERT_ID()
  </selectKey>
  {CALL proc_add_user(#{userName,mode=IN,jdbcType=VARCHAR},
    #{sex,mode=IN,jdbcType=CHAR})}
</insert>

但上述示例是為了能讓該存儲過程擁有一個返回的參數(shù)。

2、MyBatis調(diào)用存儲函數(shù)

【示例】創(chuàng)建存儲函數(shù)，根據(jù)用戶編號，獲取用戶名稱，通過MyBatis調(diào)用該存儲函數(shù)。

（1）創(chuàng)建存儲函數(shù)，根據(jù)用戶編號，獲取用戶名稱。

-- 將結(jié)束標志符更改為$$
DELIMITER $$
 
/*
  -- 存儲函數(shù)：根據(jù)用戶編號，獲取用戶名稱
  -- 輸入?yún)?shù)：in_id：用戶編號
  -- 返回結(jié)果：用戶名稱
*/
CREATE FUNCTION func_get_user_name(in_id INT)
RETURNS VARCHAR(50)
BEGIN
	-- 定義返回變量
	DECLARE out_name VARCHAR(50);
 
	-- 查詢用戶信息，獲取用戶名稱
	SELECT user_name INTO out_name FROM tb_user WHERE id = in_id;
 
	-- 返回結(jié)果
	RETURN out_name;
END$$
 
-- 將結(jié)束標志符更改回分號
DELIMITER ;

（2）編寫SQL映射配置。

<!-- 存儲函數(shù)：根據(jù)用戶編號，獲取用戶名稱 -->
<select id="func_get_user_name" statementType="CALLABLE" parameterType="hashMap" >
    {#{userName,mode=OUT,jdbcType=VARCHAR} = CALL func_get_user_name(#{userId,mode=IN,jdbcType=INTEGER})}
</select>

（3）編寫執(zhí)行方法。

/**
 * 使用MyBatis調(diào)用存儲函數(shù)：根據(jù)用戶編號，獲取用戶名稱
 * @author pan_junbiao
 */
@Test
public void funcGetUserName()
{
    DataConnection dataConnection = new DataConnection();
    SqlSession sqlSession = dataConnection.getSqlSession();
    //封裝參數(shù)
    Map userMap = new HashMap();
    userMap.put("userName","");
    userMap.put("userId",8);
    sqlSession.selectOne("test.func_get_user_name",userMap);
    System.out.println("用戶名稱：" + userMap.get("userName"));
    sqlSession.close();
}

執(zhí)行結(jié)果：