Dapper如何执行带输出参数的存储过程 Dapper Output参数用法

Dapper支持SQL Server存储过程的OUTPUT参数(非INSERT...OUTPUT子句),需通过SqlParameter或DynamicParameters显式声明Output方向,执行后读取Value或用Get获取,注意参数名一致、存储过程内赋值及类型转换。

Dapper 本身不直接支持 SQL Server 的 OUTPUT 参数(即存储过程中用 OUTPUT 关键字返回的参数),但它完全支持 ADO.NET 风格的 输出参数(SqlParameter with Direction = ParameterDirection.Output。也就是说,如果你的存储过程定义了 OUTPUT 类型的参数(比如 @ResultID INT OUTPUT),Dapper 可以通过传入带方向的 SqlParameter 来获取其返回值。

使用 SqlParameter 显式声明 Output 参数

这是最常用、最可靠的方式。你需要手动创建 SqlParameter,设置 ParameterDirection.OutputInputOutput,再传给 Dapper 方法。

  • 确保参数名与存储过程中定义的名称完全一致(包括 @ 符号)
  • 输出参数的 Value 初始值可以为 DBNull.Value 或任意占位值(Dapper 不读取它的输入值,但 ADO.NET 要求非 null 引用)
  • 执行后从 param.Value 中读取结果,注意类型转换(如 (int)param.Value

示例(C#):

var idParam = new SqlParameter("@ResultID", SqlDbType.Int) { Direction = ParameterDirection.Output };
var nameParam = new SqlParameter("@Name", "张三") { Direction = ParameterDirection.Input };

connection.Execute("sp_InsertUser", new[] { idParam, nameParam }, commandType: CommandType.StoredProcedure);

int newId = (int)idParam.Value; // 获取输出值

用 DynamicParameters 简化 Output 参数管理

Dapper.DynamicParameters 是 Dapper 提供的增强型参数容器,对 Input/Output/ReturnValue 参数支持更友好,语法也更简洁。

  • Add() 方法添加参数时,指定 dbTypedirection 和可选的 value
  • 执行后调用 Get("paramName") 获取输出值(推荐),或直接访问 parameters.Get("paramName")
  • 支持多个输出参数,也兼容返回值(ParameterDirection.ReturnValue

示例:

var p = new DynamicParameters();
p.Add("@Name", "李四", DbType.String, ParameterDirection.Input);
p.Add("@UserId", dbType: DbType.Int32, direction: ParameterDirection.Output);
p.Add("@ReturnCode", dbType: DbType.Int32, direction: ParameterDirection.ReturnValue);

connection.Execute("sp_InsertUser", p, commandType: CommandType.StoredProcedure);

int userId = p.Get("@UserId");
int returnCode = p.Get("@ReturnCode");

注意:Output 参数 ≠ OUTPUT 子句(SQL Server 的 INSERT...OUTPUT)

别混淆两个概念:

  • OUTPUT 参数:存储过程定义的带 OUTPUT 关键字的 T-SQL 参数,属于“过程级返回值”,需用 SqlParameter.Direction = Output 捕获
  • INSERT...OUTPUT 子句:SQL 语句级功能,用于返回被插入/更新/删除的行数据(如 OUTPUT INSERTED.Id)。Dapper 对它天然支持——只要你的存储过程里写了 SELECT 或直接 OUTPUT 返回结果集,Dapper 就能用 Query() 接收,无需特殊参数设置

常见问题提醒

  • 存储过程必须用 commandType: CommandType.StoredProcedure,否则参数名匹配可能失败
  • SQL Server 中 OUTPUT 参数默认是 NULL,务必在存储过程中显式赋值(如 SET @ResultID = SCOPE_IDENTITY()
  • 如果输出参数是字符串,建议指定 Size(如 Size = 50),避免截断或长度推断异常
  • Dapper 不支持匿名对象自动映射 Output 参数(比如 new { @Name = "a", @Id = Output }),必须用 DynamicParameters 或原生 SqlParameter

基本上就这些。用好 DynamicParameters,Output 参数处理就很清晰自然。