Dapper的commandType参数是什么 Dapper CommandType用法详解

CommandType是Dapper中指定SQL命令类型的枚举,必须显式设为CommandType.StoredProcedure才能正确调用存储过程,否则会报错或输出参数失效;默认CommandType.Text用于普通SQL语句。

CommandType 是 Dapper 中用于明确指定 SQL 命令类型的枚举参数,它告诉数据库驱动“你传进来的这段字符串到底该当什么用”——是普通 SQL 语句、存储过程,还是其他类型。不显式指定时,Dapper 默认按 CommandType.Text 处理,也就是当成原始 SQL 字符串执行;但一旦调用存储过程,就必须设为 CommandType.StoredProcedure,否则会报错或行为异常。

什么时候必须显式设置 CommandType

主要出现在以下两类场景:

  • 调用 SQL Server、MySQL 等数据库的存储过程(如 EXEC GetUserByIdCALL sp_get_order
  • 使用某些数据库提供程序(如 MySqlConnector)时,即使写的是 SELECT 语句,若底层协议对命令类型敏感,也可能需要显式声明

常见 CommandType 枚举值及对应用法

CommandType.Text(默认值)
用于标准 SQL 查询或 DML 语句,比如 SELECT * FROM UsersINSERT INTO Logs (...) VALUES (...)。Dapper 会原样发送给数据库执行。

CommandType.StoredProcedure
告诉 ADO.NET 这是一个已命名的存储过程,数据库会按过程名查找并执行,参数也按存储过程定义的顺序和方向(input/output/return)处理。例如:

connection.Query("GetUserById", new { Id = 123 }, commandType: CommandType.StoredProcedure);

CommandType.TableDirect(极少用)
直接访问表本身(绕过 SQL 解析),一般只在特定高性能导出场景中出现,Dapper 中基本不用,也不推荐。

不设 CommandType 的典型问题

如果你调用存储过程却没写 commandType: CommandType.StoredProcedure,会发生这些情况:

  • SQL Server:抛出 Invalid object name 'YourStoredProcedure' 错误(把它当成了表或视图)
  • MySQL:可能执行失败,或返回空结果,因为 CALL sp_name() 被当成了普通查询而未被识别
  • 参数方向失效:比如输出参数(ParameterDirection.Output)不会被读取,DynamicParameters.Get() 拿不到值

配合 DynamicParameters 使用的关键细节

用存储过程 + 输出参数时,CommandType.StoredProcedureDynamicParameters 必须搭配使用:

  • 输入参数可简写为匿名对象,但只要涉及 OutputReturnValue,就得用 DynamicParameters
  • 必须在 ExecuteQuery 调用中传入 commandType: CommandType.StoredProcedure,否则输出参数不会生效
  • 示例中漏掉这一项,parameters.Get("@RowCount") 就永远是默认值

基本上就这些。CommandType 不复杂,但容易忽略——尤其从写 SQL 切换到调用存储过程时,加一行 commandType: CommandType.StoredProcedure 就能避开多数运行时错误。