使用含輸出參數的預存程序

下載 JDBC 驅動程式

您可以呼叫的 SQL Server 預存程序是會傳回一或多個 OUT 參數的預存程序，預存程序會使用這些參數將資料傳回給呼叫端應用程式。 Microsoft JDBC Driver for SQL Server 提供 SQLServerCallableStatement 類別，您可以使用此類別，呼叫此種類的預存程序並處理其傳回的資料。

使用 JDBC 驅動程式呼叫這類型的預存程序時，必須搭配使用 call SQL 逸出序列與 SQLServerConnection 類別的 prepareCall 方法。 含有 OUT 參數之 call 逸出序列的語法如下：

{call procedure-name[([parameter][,[parameter]]...)]}

注意

如需 SQL 逸出序列的詳細資訊，請參閱使用 SQL 逸出序列。

建構 call 逸出序列時，請使用 ? (問號) 字元來指定 IN 參數。 此字元會充當預留位置，代表將從預存程序傳回的參數值。 若要指定 OUT 參數的值，在執行預存程序之前，您必須使用 SQLServerCallableStatement 類別的 registerOutParameter 方法來指定每個參數的資料類型。

您在 registerOutParameter 方法中指定給 OUT 參數的值，必須是 java.sql.Types 包含的其中一個 JDBC 資料類型，然後該資料類型會對應到其中一個原生 SQL Server 資料類型。 如需 JDBC 和 SQL Server 資料類型的詳細資訊，請參閱了解 JDBC 驅動程式資料類型。

當您將值傳遞到 OUT 參數的 registerOutParameter 方法時，不只要指定用於參數的資料類型，還要指定參數在預存程序中的序數位置或名稱。 比方說，如果預存程序包含單一 OUT 參數，則其序數值為 1；如果預存程序包含兩個參數，則第一個序數值為 1，第二個序數值為 2。

注意

JDBC 驅動程式不支援使用 CURSOR、SQLVARIANT、TABLE 及 TIMESTAMP SQL Server 資料類型作為 OUT 參數。

例如，在 AdventureWorks2022 範例資料庫中建立下列預存程序：

CREATE PROCEDURE GetImmediateManager  
   @employeeID INT,  
   @managerID INT OUTPUT  
AS  
BEGIN  
   SELECT @managerID = ManagerID
   FROM HumanResources.Employee
   WHERE EmployeeID = @employeeID  
END

此預存程序傳回單一 OUT 參數 (managerID)，它是一個整數，是以指定的 IN 參數 (employeeID) 為基礎，這個 IN 參數也是一個整數。 在 OUT 參數中傳回的值是 ManagerID，它是以 HumanResources.Employee 資料表包含的 EmployeeID 為基礎。

在下列範例中，AdventureWorks2022 範例資料庫的開啟連線會傳入函式中，並使用 execute 方法來呼叫 GetImmediateManager 預存程序：

public static void executeStoredProcedure(Connection con) throws SQLException {  
    try(CallableStatement cstmt = con.prepareCall("{call dbo.GetImmediateManager(?, ?)}");) {  
        cstmt.setInt(1, 5);  
        cstmt.registerOutParameter(2, java.sql.Types.INTEGER);  
        cstmt.execute();  
        System.out.println("MANAGER ID: " + cstmt.getInt(2));  
    }  
}

這個範例會使用序數位置來識別參數。 或者，您可以使用參數的名稱而非參數的序數位置來識別該參數。 下列程式碼範例會修改上一個範例來示範如何在 Java 應用程式中使用指名參數。 請注意，參數名稱會為對應到預存程序定義中的參數名稱：

public static void executeStoredProcedure(Connection con) throws SQLException {  
    try(CallableStatement cstmt = con.prepareCall("{call dbo.GetImmediateManager(?, ?)}"); ) {  
        cstmt.setInt("employeeID", 5);  
        cstmt.registerOutParameter("managerID", java.sql.Types.INTEGER);  
        cstmt.execute();  
        System.out.println("MANAGER ID: " + cstmt.getInt("managerID"));  
    }  
}

針對驅動程式 12.6 版和更新版本，引進了新的連線屬性 useFlexibleCallableStatements。 當設定為 true 時，這個屬性會保留驅動程式的舊行為，讓使用者在識別參數時使用序數位置和參數名稱的混合。 當設定為 false 時，使用者必須使用其中一個，但不能同時使用兩者。

此外，當屬性設定為 true 時，在可以設定彈性順序陳述式參數時，useFlexibleCallableStatements 可以保留既有行為。 不過，當設定為 false 時，順序必須符合預存程序定義。 下列範例中可以看到 useFlexibleCallableStatements=true 的這兩項功能：

public static void executeStoredProcedure(Connection con) throws SQLException {  
    try(CallableStatement cstmt = con.prepareCall("{call dbo.GetImmediateManager(?, ?)}"); ) {
        cstmt.registerOutParameter("managerID", java.sql.Types.INTEGER);
        cstmt.setInt(1, 5);  
        cstmt.execute();  
        System.out.println("MANAGER ID: " + cstmt.getInt("managerID"));  
    }  
}

注意

這些範例會使用 SQLServerCallableStatement 類別的 execute 方法來執行預存程序。 會使用這個是因為預存程序並不同時傳回結果集。 如果它已傳回結果集，則會使用 executeQuery 方法。

預存程序可以傳回更新計數和多個結果集。 Microsoft JDBC Driver for SQL Server 遵循 JDBC 3.0 規格，其中說明在擷取 OUT 參數前，應該擷取多個結果集和更新計數。 也就是說，應用程式在使用 CallableStatement.getter 方法擷取 OUT 參數之前，應該先擷取所有 ResultSet 物件與更新計數。 否則，在擷取 OUT 參數時，將會遺失尚未擷取的 ResultSet 物件和更新計數。 如需更新計數和多個結果集的詳細資訊，請參閱使用含更新計數的預存程序和使用多個結果集。

另請參閱

搭配預存程序使用陳述式