mybatis 存儲過程與游標的使用

　　MyBatis還能對存儲過程進行完全支持，這節開始學習存儲過程。在講解之前，我們需要對存儲過程有一個基本的認識，首先存儲過程是數據庫的一個概念，它是數據庫預先編譯好，放在數據庫內存中的一個程序片段，所以具備性能高，可重復使用的特性。它定義了3種類型的參數：輸入參數、輸出參數、輸入輸出參數。
　　•輸入參數，是外界給的存儲過程參數，在Java互聯網中，也就是互聯網系統給它的參數。
　　•輸出參數，是存儲過程經過計算返回給程序的結果參數。
　　•輸入輸出參數，是一開始作為參數傳遞給存儲過程，而存儲過程修改后將其返回的參數，比如那些商品的庫存就是這樣的。
　　對於返回結果而言，一些常用的簡易類型，比如整形、字符型OUT或者INOUT參數是Java程序比較好處理的，而存儲過程還可能返回游標類型的參數，這需要我們處理，不過在MyBatis中，這些都可以輕松完成。

IN和OUT參數存儲過程

　　先討論IN和OUT參數的基本用法，這里使用的是Oracle數據庫，它對存儲過程有着較好的支持，下面先定義一個場景。
　　根據角色名稱進行模糊查詢其總數，然后把總數和查詢日期返回給調用者。為此先建一個簡單的存儲過程，在Oracle的命令行輸入存儲過程，如代碼清單的代碼。

CREATE OR REPLACE 
PROCEDURE count_role (
    p_role_name IN VARCHAR,
    count_total out INT,
    exec_date out DATE
) IS
BEGIN
    SELECT COUNT (*) INTO count_total
    FROM "t_role"
    WHERE "role_name" LIKE '%' || p_role_name || '%' ; 
    SELECT SYSDATE INTO exec_date FROM dual;
END ;

 

public class PdCountRoleParams {
    private String roleName;
    private int total;
    private Date execDate;
}

    <select id="countRole" parameterType="com.xc.pojo.procedures.PdCountRoleParams" statementType="CALLABLE">
        {call count_role(#{roleName, mode=IN, jdbcType=VARCHAR},
                         #{total, mode=OUT, jdbcType=INTEGER},
                         #{execDate, mode=OUT, jdbcType=DATE})}
    </select>

 

•指定statemetType為CALLABLE，說明它是在使用存儲過程，如果不這樣聲明那么這段代碼將會拋出異常。
•定義了parameterType為PdCountRoleParams參數。
•在調度存儲過程中放入參數對應的屬性，並且在屬性上通過mode設置了其輸入或者輸出參數，指定對應的jdbcType，這樣MyBatis就會使用對應的typeHandler去處理對應的類型轉換。

PdCountRoleParams params = new PdCountRoleParams();
SqlSession sqlSession = null;
try {

    sqlSession = SqlSessionFactoryUtils.openSqlSession();
    RoleMapper roleMapper = sqlSession.getMapper(RoleMapper.class);
    params.setRoleName("法師");
    roleMapper.countRole(params);
    System.out.println(params.getRoleName());
    System.out.println(params.getTotal());
    System.out.println(params.getExecDate());

} catch (Exception e) {
    e.printStackTrace();
} finally {
    if (sqlSession != null) {
        sqlSession.close();
    }
}

 

游標的使用

　　在實際應用中，除了使用簡易的輸入輸出參數，有時候也可能使用游標，MyBatis也對存儲過程的游標提供了支持。如果把jdbcType聲明為CURSOR，那么它就會使用ResultSet對象處理對應的結果，只要設置映射關系，MyBatis就會把結果集映射出來。
　　這里依舊使用Oracle數據庫，先來假設這樣的需求：根據角色名稱（role_name）模糊查詢角色表的數據，但要求支持分頁查詢，於是存在start和end兩個分頁參數。為了知道是否存在下一頁，還會要求查詢出總數（total），於是便存在這樣的一個存儲過程，如代碼清單所示。

CREATE OR REPLACE 
PROCEDURE find_role (
    p_role_name IN VARCHAR,
    p_start IN INT,
    p_end IN INT,
    r_count out INT,
    ref_cur out sys_refcursor
) AS
BEGIN

    SELECT COUNT (*) INTO r_count
    FROM "t_role"
    WHERE "role_name" LIKE '%' || p_role_name || '%'; 

    OPEN ref_cur FOR 
    SELECT "id", "role_name", "note"
    FROM ( SELECT A.*, ROWNUM AS row1
        FROM "t_role" A
        WHERE A."role_name" LIKE '%' || p_role_name || '%' AND ROWNUM <= p_end
        )
    WHERE row1 > p_start ;
END find_role ;

　　p_role_name是輸入參數角色名稱，而p_start和p_end是兩個分頁輸入參數，r_count是計算總數的輸出參數，ref_cur是一個游標，它將記錄當前頁的詳細數據。為了使用這個過程，先定制一個POJO——PdFindRoleParams，如代碼清單所示。

public class PdFindRoleParams {
    private String roleName;
    private int start;
    private int end;
    private int total;
    private List<Role> roleList;
}

　　顯然參數是和存儲過程一一對應的，而游標是由roleList去存儲的，只是這里需要為其提供映射關系，游標映射器，如代碼清單所示。

<resultMap type="role" id="roleMap">
    <id property="id" column="id"/>
    <result property="roleName" column="role_name"/>
    <result property="note" column="note"/>
</resultMap>

<select id="findRoleCall" parameterType="com.xc.pojo.procedures.PdFindRoleParams" statementType="CALLABLE">
    {call find_role(#{roleName, mode=IN, jdbcType=VARCHAR},
                    #{start, mode=IN, jdbcType=INTEGER},
                    #{end, mode=IN, jdbcType=INTEGER},
                    #{total, mode=OUT, jdbcType=INTEGER},
                    #{roleList,mode=OUT,jdbcType=CURSOR, javaType=ResultSet,resultMap=roleMap})}
</select>

　　先定義了resultMap元素，它定義了映射規則。而在存儲過程的調用中，對於roleList，定義了jdbcType為CURSOR，這樣就會把結果使用ResultSet對象處理。為了使得ResultSet對應能夠映射為POJO，設置resultMap為roleMap，這樣MyBatis就會采用配置的映射規則將其映射為POJO了，測試代碼如代碼清單所示。

PdFindRoleParams params = new PdFindRoleParams();
SqlSession sqlSession = null;
try {
    sqlSession = SqlSessionFactoryUtils.openSqlSession();
    RoleMapper roleMapper = sqlSession.getMapper(RoleMapper.class);
    params.setRoleName("法師");
    params.setStart(0);
    params.setEnd(100);
    roleMapper.findRoleCall(params);
    System.out.println(params.getRoleList().size());
    System.out.println(params.getTotal());
} catch (Exception ex) {
    ex.printStackTrace();
} finally {
    if (sqlSession != null) {
        sqlSession.close();
    }
}