7 - CallableStatement
本概述是從《JDBCTM Database Access from JavaTM: A Tutorial and Annotated Reference 》這本書中摘引來的。JavaSoft 目前正在準(zhǔn)備這本書。這本書是一本教程，同時(shí)也是 JDBC 的重要參考手冊(cè)，它將作為 Java 系列的組成部份在 1997 年春季由 Addison-Wesley 出版公司出版。


7.1 概述
CallableStatement 對(duì)象為所有的 DBMS 提供了一種以標(biāo)準(zhǔn)形式調(diào)用已儲(chǔ)存過程的方法。已儲(chǔ)存過程儲(chǔ)存在數(shù)據(jù)庫中。對(duì)已儲(chǔ)存過程的調(diào)用是 CallableStatement 對(duì)象所含的內(nèi)容。這種調(diào)用是用一種換碼語法來寫的，有兩種形式：一種形式帶結(jié)果參數(shù)，另一種形式不帶結(jié)果參數(shù)（有關(guān)換碼語法的信息，參見第 4 節(jié)“語句”）。結(jié)果參數(shù)是一種輸出 (OUT) 參數(shù)，是已儲(chǔ)存過程的返回值。兩種形式都可帶有數(shù)量可變的輸入（IN 參數(shù)）、輸出（OUT 參數(shù)）或輸入和輸出（INOUT 參數(shù)）的參數(shù)。問號(hào)將用作參數(shù)的占位符。

在 JDBC 中調(diào)用已儲(chǔ)存過程的語法如下所示。注意，方括號(hào)表示其間的內(nèi)容是可選項(xiàng)；方括號(hào)本身并不是語法的組成部份。

{call 過程名[(?, ?, ...)]}

返回結(jié)果參數(shù)的過程的語法為：

{? = call 過程名[(?, ?, ...)]}

不帶參數(shù)的已儲(chǔ)存過程的語法類似：

{call 過程名}

通常，創(chuàng)建 CallableStatement 對(duì)象的人應(yīng)當(dāng)知道所用的 DBMS 是支持已儲(chǔ)存過程的，并且知道這些過程都是些什么。然而，如果需要檢查，多種 DatabaseMetaData 方法都可以提供這樣的信息。例如，如果 DBMS 支持已儲(chǔ)存過程的調(diào)用，則 supportsStoredProcedures 方法將返回 true，而 getProcedures 方法將返回對(duì)已儲(chǔ)存過程的描述。

CallableStatement 繼承 Statement 的方法（它們用于處理一般的 SQL 語句），還繼承了 PreparedStatement 的方法（它們用于處理 IN 參數(shù)）。CallableStatement 中定義的所有方法都用于處理 OUT 參數(shù)或 INOUT 參數(shù)的輸出部分：注冊(cè) OUT 參數(shù)的 JDBC 類型（一般 SQL 類型）、從這些參數(shù)中檢索結(jié)果，或者檢查所返回的值是否為 JDBC NULL。


7.1.1 創(chuàng)建 CallableStatement 對(duì)象
CallableStatement 對(duì)象是用 Connection 方法 prepareCall 創(chuàng)建的。下例創(chuàng)建 CallableStatement 的實(shí)例，其中含有對(duì)已儲(chǔ)存過程 getTestData 調(diào)用。該過程有兩個(gè)變量，但不含結(jié)果參數(shù)：

CallableStatement cstmt = con.prepareCall(
"{call getTestData(?, ?)}");

其中 ? 占位符為 IN、 OUT 還是 INOUT 參數(shù)，取決于已儲(chǔ)存過程 getTestData。


7.1.2 IN 和 OUT 參數(shù)
將 IN 參數(shù)傳給 CallableStatement 對(duì)象是通過 setXXX 方法完成的。該方法繼承自 PreparedStatement。所傳入?yún)��?shù)的類型決定了所用的 setXXX 方法（例如，用 setFloat 來傳入 float 值等）。

如果已儲(chǔ)存過程返回 OUT 參數(shù)，則在執(zhí)行 CallableStatement 對(duì)象以前必須先注冊(cè)每個(gè) OUT 參數(shù)的 JDBC 類型（這是必需的，因?yàn)槟承?DBMS 要求 JDBC 類型）。注冊(cè) JDBC 類型是用 registerOutParameter 方法來完成的。語句執(zhí)行完后，CallableStatement 的 getXXX 方法將取回參數(shù)值。正確的 getXXX 方法是為各參數(shù)所注冊(cè)的 JDBC 類型所對(duì)應(yīng)的 Java 類型（從 JDBC 類型到 Java 類型的標(biāo)準(zhǔn)映射見 8.6.1 節(jié)中的表）。換言之， registerOutParameter 使用的是 JDBC 類型（因此它與數(shù)據(jù)庫返回的 JDBC 類型匹配），而 getXXX 將之轉(zhuǎn)換為 Java 類型。

作為示例，下述代碼先注冊(cè) OUT 參數(shù)，執(zhí)行由 cstmt 所調(diào)用的已儲(chǔ)存過程，然后檢索在 OUT 參數(shù)中返回的值。方法 getByte 從第一個(gè) OUT 參數(shù)中取出一個(gè) Java 字節(jié)，而 getBigDecimal 從第二個(gè) OUT 參數(shù)中取出一個(gè) BigDecimal 對(duì)象（小數(shù)點(diǎn)后面帶三位數(shù)）：

CallableStatement cstmt = con.prepareCall(
"{call getTestData(?, ?)}");
cstmt.registerOutParameter(1, java.sql.Types.TINYINT);
cstmt.registerOutParameter(2, java.sql.Types.DECIMAL, 3);
cstmt.executeQuery();
byte x = cstmt.getByte(1);
java.math.BigDecimal n = cstmt.getBigDecimal(2, 3);

CallableStatement 與 ResultSet 不同，它不提供用增量方式檢索大 OUT 值的特殊機(jī)制。


7.1.3 INOUT 參數(shù)
既支持輸入又接受輸出的參數(shù)（INOUT 參數(shù)）除了調(diào)用 registerOutParameter 方法外，還要求調(diào)用適當(dāng)?shù)?setXXX 方法（該方法是從 PreparedStatement 繼承來的）。setXXX 方法將參數(shù)值設(shè)置為輸入?yún)��?shù)，而 registerOutParameter 方法將它的 JDBC 類型注冊(cè)為輸出參數(shù)。setXXX 方法提供一個(gè) Java 值，而驅(qū)動(dòng)程序先把這個(gè)值轉(zhuǎn)換為 JDBC 值，然后將它送到數(shù)據(jù)庫中。

這種 IN 值的 JDBC 類型和提供給 registerOutParameter 方法的 JDBC 類型應(yīng)該相同。然后，要檢索輸出值，就要用對(duì)應(yīng)的 getXXX 方法。例如，Java 類型為 byte 的參數(shù)應(yīng)該使用方法 setByte 來賦輸入值。應(yīng)該給 registerOutParameter 提供類型為 TINYINT 的 JDBC 類型，同時(shí)應(yīng)使用 getByte 來檢索輸出值 （第 8 節(jié)“JDBC 和 Java 類型之間的映射”將給出詳細(xì)信息和類型映射表）。

下例假設(shè)有一個(gè)已儲(chǔ)存過程 reviseTotal，其唯一參數(shù)是 INOUT 參數(shù)。方法 setByte 把此參數(shù)設(shè)為 25，驅(qū)動(dòng)程序?qū)�把它作�?JDBC TINYINT 類型送到數(shù)據(jù)庫中。接著，registerOutParameter 將該參數(shù)注冊(cè)為 JDBC TINYINT。執(zhí)行完該已儲(chǔ)存過程后，將返回一個(gè)新的 JDBC TINYINT 值。方法 getByte 將把這個(gè)新值作為 Java byte 類型檢索。

CallableStatement cstmt = con.prepareCall(
"{call reviseTotal(?)}");
cstmt.setByte(1, 25);
cstmt.registerOutParameter(1, java.sql.Types.TINYINT);
cstmt.executeUpdate();
byte x = cstmt.getByte(1);

7.1.4 先檢索結(jié)果，再檢索 OUT 參數(shù)
由于某些 DBMS 的限制，為了實(shí)現(xiàn)最大的可移植性，建議先檢索由執(zhí)行 CallableStatement 對(duì)象所產(chǎn)生的結(jié)果，然后再用 CallableStatement.getXXX 方法來檢索 OUT 參數(shù)。

如果 CallableStatement 對(duì)象返回多個(gè) ResultSet 對(duì)象（通過調(diào)用 execute 方法），在檢索 OUT 參數(shù)前應(yīng)先檢索所有的結(jié)果。這種情況下，為確保對(duì)所有的結(jié)果都進(jìn)行了訪問，必須對(duì) Statement 方法 getResultSet、getUpdateCount 和 getMoreResults 進(jìn)行調(diào)用，直到不再有結(jié)果為止。

檢索完所有的結(jié)果后，就可用 CallableStatement.getXXX 方法來檢索 OUT 參數(shù)中的值。


7.1.5 檢索作為 OUT 參數(shù)的 NULL 值
返回到 OUT 參數(shù)中的值可能會(huì)是 JDBC NULL。當(dāng)出現(xiàn)這種情形時(shí)，將對(duì) JDBC NULL 值進(jìn)行轉(zhuǎn)換以使 getXXX 方法所返回的值為 null、0 或 false，這取決于 getXXX 方法類型。對(duì)于 ResultSet 對(duì)象，要知道 0 或 false 是否源于 JDBC NULL 的唯一方法，是用方法 wasNull 進(jìn)行檢測(cè)。如果 getXXX 方法讀取的最后一個(gè)值是 JDBC NULL，則該方法返回 true，否則返回 flase。第 5 節(jié)“ResultSet”將給出詳細(xì)信息。