萬盛學電腦網

您现在的位置: 萬盛學電腦網 >> 程式設計 >  >> 網路程式設計 >> ASP.NET 程式設計

ASP.NET 使用 IDataParameter 呼叫存儲過程並取得輸出參數

前言

呼叫帶輸出參數的存儲過程是資料庫程式設計常見需求。本文示範使用 IDataParameter 介面搭配 SqlParameter 建立參數陣列,並透過封裝的 DbHelperSQL.RunProcedure 方法執行與取回 OUTPUT 值。

完整呼叫範例

public string GenerateExamPaper(string paperType, string driverId, string macAddr)
{
    // 1. 準備參數陣列(含輸出參數)
    var parameters = new IDataParameter[]
    {
        new SqlParameter("@paperType", paperType),
        new SqlParameter("@driverID", driverId),
        new SqlParameter("@MacAddr", macAddr),
        new SqlParameter("@sReturn", SqlDbType.Char, 50) 
        { 
            Direction = ParameterDirection.Output 
        }
    };

    // 2. 執行存儲過程
    string outputValue = string.Empty;
    int affected = DbHelperSQL.RunProcedureParOut("Pro_GenerateExamPaper", parameters, out outputValue);
    
    // 3. 回傳輸出參數值
    return outputValue;
}

資料存取輔助類關鍵方法

public static class DbHelperSQL
{
    private static readonly string ConnectionString = ConfigurationManager.ConnectionStrings["Default"].ConnectionString;

    /// 
    /// 執行存儲過程,回傳影響列數與輸出參數
    /// 
    public static int RunProcedureParOut(string procName, IDataParameter[] parameters, out string outputValue)
    {
        outputValue = string.Empty;
        int rowsAffected = 0;

        using (var conn = new SqlConnection(ConnectionString))
        using (var cmd = new SqlCommand(procName, conn) { CommandType = CommandType.StoredProcedure })
        {
            if (parameters != null) cmd.Parameters.AddRange(parameters);
            
            // 可選:回傳值參數
            var returnParam = cmd.Parameters.Add("ReturnValue", SqlDbType.Int);
            returnParam.Direction = ParameterDirection.ReturnValue;

            conn.Open();
            rowsAffected = cmd.ExecuteNonQuery();
            
            // 讀取輸出參數
            var outParam = cmd.Parameters["@sReturn"];
            outputValue = outParam.Value?.ToString() ?? string.Empty;
        }
        return rowsAffected;
    }

    /// 
    /// 通用執行存儲過程(DataReader/ DataSet/ ExecuteNonQuery 多載)
    /// 
    public static SqlDataReader ExecuteReader(string procName, params SqlParameter[] parameters)
    {
        var conn = new SqlConnection(ConnectionString);
        var cmd = new SqlCommand(procName, conn) { CommandType = CommandType.StoredProcedure };
        if (parameters != null) cmd.Parameters.AddRange(parameters);
        
        conn.Open();
        // CommandBehavior.CloseConnection 確保 Reader 關閉時連線也關閉
        return cmd.ExecuteReader(CommandBehavior.CloseConnection);
    }
}

存儲過程範例

CREATE PROCEDURE Pro_GenerateExamPaper
    @paperType VARCHAR(20),
    @driverID VARCHAR(50),
    @MacAddr VARCHAR(50),
    @sReturn CHAR(50) OUTPUT
AS
BEGIN
    SET NOCOUNT ON;
    -- 業務邏輯...
    SET @sReturn = 'EXAM_20240115_001'; -- 產生的試卷編號
    RETURN 0; -- 回傳值
END

關鍵細節總結

  1. ParameterDirection.Output:標記為輸出參數,ExecuteNonQuery 後 Parameter.Value 會被填入資料庫回傳值。
  2. ParameterDirection.ReturnValue:對應存儲過程 RETURN @val,只能有一個,通常用於狀態碼。
  3. using 區塊:確保 SqlConnection、SqlCommand 正確釋放,避免連線洩漏。
  4. CommandBehavior.CloseConnection:ExecuteReader 回傳 DataReader 時,呼叫端關閉 Reader 會自動關閉連線。
  5. IDataParameter 介面:理論上可支援多資料庫,實務上多直接用 SqlParameter;若需抽象可自行包裝 Factory。

常見錯誤排查

錯誤原因修正
輸出參數為 null未設定 Direction=Output明確指定 Direction = ParameterDirection.Output
參數名稱不符前後端大小寫/前綴(@)不一致SQL Server 不區分大小寫,但建議統一加 @
連線未關閉DataReader 未正確 Dispose使用 using 或 CommandBehavior.CloseConnection

結語

掌握 IDataParameter 與 ParameterDirection 讓您能靈活呼叫複雜存儲過程。建議將資料存取層封裝為泛型 Repository,統一管理參數建立、連線生命週期與例外處理,提升代碼復用與可測試性。

copyright © 萬盛學電腦網 all rights reserved