JDBCTM 指南:入門7-CallableStatement

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


7.1 概述
CallableStatement 對象爲所有的 DBMS 提供了一種以標準形式調用已儲存過程的方法。已儲存過程儲存在數據庫中。對已儲存過程的調用是 CallableStatement 對象所含的內容。這種調用是用一種換碼語法來寫的，有兩種形式：一種形式帶結果參數，另一種形式不帶結果參數（有關換碼語法的信息，參見第 4 節“語句”）。結果參數是一種輸出 (OUT) 參數，是已儲存過程的返回值。兩種形式都可帶有數量可變的輸入（IN 參數）、輸出（OUT 參數）或輸入和輸出（INOUT 參數）的參數。問號將用作參數的佔位符。

在 JDBC 中調用已儲存過程的語法如下所示。注意，方括號表示其間的內容是可選項；方括號本身並不是語法的組成部份。

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

返回結果參數的過程的語法爲：

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

不帶參數的已儲存過程的語法類似：

{call 過程名}

通常，創建 CallableStatement 對象的人應當知道所用的 DBMS 是支持已儲存過程的，並且知道這些過程都是些什麼。然而，如果需要檢查，多種 DatabaseMetaData 方法都可以提供這樣的信息。例如，如果 DBMS 支持已儲存過程的調用，則 supportsStoredProcedures 方法將返回 true，而 getProcedures 方法將返回對已儲存過程的描述。

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


7.1.1 創建 CallableStatement 對象
CallableStatement 對象是用 Connection 方法 prepareCall 創建的。下例創建 CallableStatement 的實例，其中含有對已儲存過程 getTestData 調用。該過程有兩個變量，但不含結果參數：

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

其中 ? 佔位符爲 IN、 OUT 還是 INOUT 參數，取決於已儲存過程 getTestData。


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

如果已儲存過程返回 OUT 參數，則在執行 CallableStatement 對象以前必須先註冊每個 OUT 參數的 JDBC 類型（這是必需的，因爲某些 DBMS 要求 JDBC 類型）。註冊 JDBC 類型是用 registerOutParameter 方法來完成的。語句執行完後，CallableStatement 的 getXXX 方法將取回參數值。正確的 getXXX 方法是爲各參數所註冊的 JDBC 類型所對應的 Java 類型（從 JDBC 類型到 Java 類型的標準映射見 8.6.1 節中的表）。換言之， registerOutParameter 使用的是 JDBC 類型（因此它與數據庫返回的 JDBC 類型匹配），而 getXXX 將之轉換爲 Java 類型。

作爲示例，下述代碼先註冊 OUT 參數，執行由 cstmt 所調用的已儲存過程，然後檢索在 OUT 參數中返回的值。方法 getByte 從第一個 OUT 參數中取出一個 Java 字節，而 getBigDecimal 從第二個 OUT 參數中取出一個 BigDecimal 對象（小數點後面帶三位數）：

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 值的特殊機制。


7.1.3 INOUT 參數
既支持輸入又接受輸出的參數（INOUT 參數）除了調用 registerOutParameter 方法外，還要求調用適當的 setXXX 方法（該方法是從 PreparedStatement 繼承來的）。setXXX 方法將參數值設置爲輸入參數，而 registerOutParameter 方法將它的 JDBC 類型註冊爲輸出參數。setXXX 方法提供一個 Java 值，而驅動程序先把這個值轉換爲 JDBC 值，然後將它送到數據庫中。

這種 IN 值的 JDBC 類型和提供給 registerOutParameter 方法的 JDBC 類型應該相同。然後，要檢索輸出值，就要用對應的 getXXX 方法。例如，Java 類型爲 byte 的參數應該使用方法 setByte 來賦輸入值。應該給 registerOutParameter 提供類型爲 TINYINT 的 JDBC 類型，同時應使用 getByte 來檢索輸出值 （第 8 節“JDBC 和 Java 類型之間的映射”將給出詳細信息和類型映射表）。

下例假設有一個已儲存過程 reviseTotal，其唯一參數是 INOUT 參數。方法 setByte 把此參數設爲 25，驅動程序將把它作爲 JDBC TINYINT 類型送到數據庫中。接着，registerOutParameter 將該參數註冊爲 JDBC TINYINT。執行完該已儲存過程後，將返回一個新的 JDBC TINYINT 值。方法 getByte 將把這個新值作爲 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 先檢索結果，再檢索 OUT 參數
由於某些 DBMS 的限制，爲了實現最大的可移植性，建議先檢索由執行 CallableStatement 對象所產生的結果，然後再用 CallableStatement.getXXX 方法來檢索 OUT 參數。

如果 CallableStatement 對象返回多個 ResultSet 對象（通過調用 execute 方法），在檢索 OUT 參數前應先檢索所有的結果。這種情況下，爲確保對所有的結果都進行了訪問，必須對 Statement 方法 getResultSet、getUpdateCount 和 getMoreResults 進行調用，直到不再有結果爲止。

檢索完所有的結果後，就可用 CallableStatement.getXXX 方法來檢索 OUT 參數中的值。


7.1.5 檢索作爲 OUT 參數的 NULL 值
返回到 OUT 參數中的值可能會是 JDBC NULL。當出現這種情形時，將對 JDBC NULL 值進行轉換以使 getXXX 方法所返回的值爲 null、0 或 false，這取決於 getXXX 方法類型。對於 ResultSet 對象，要知道 0 或 false 是否源於 JDBC NULL 的唯一方法，是用方法 wasNull 進行檢測。如果 getXXX 方法讀取的最後一個值是 JDBC NULL，則該方法返回 true，否則返回 flase。第 5 節“ResultSet”將給出詳細信息。