EF Core怎么调用存储过程 EF Core调用存储过程教程

EF Core调用存储过程有三类方法:查数据用FromSqlInterpolated/FromSqlRaw并映射实体或DTO;增删改用ExecuteSqlCommand获取影响行数;返回标量值用SqlQuery;复杂场景建议用DbCommand手动执行或StoredProcedureEFCore等第三方库。

EF Core 调用存储过程不难,但得选对方法——核心就两条路:要查数据FromSql* 系列;要增删改或只关心影响行数,用 ExecuteSqlCommand。关键不在“能不能”,而在“返回值类型”和“参数安全”怎么处理好。

查数据:用 FromSqlRaw 或 FromSqlInterpolated

适合返回结果集的存储过程(比如 GetCustomersByCity @city),必须映射到一个实体类型(如 Customer),且字段名、类型、数量要严格匹配。

  • 推荐用 FromSqlInterpolated,自动参数化防 SQL 注入:
    _context.Customers.FromSqlInterpolated($"EXEC GetCustomersByCity @City={city}")
  • 如果返回字段和实体不完全一致(比如少几个字段、多了计算列),得新建一个轻量 DTO 类,再配合 HasNoKey() 配置:
    OnModelCreating 里写:
    modelBuilder.Entity().HasNoKey().ToSqlQuery("EXEC GetCustomerSummary");
  • 不支持多结果集(比如一个 SP 返回两个 SELECT),EF Core 会只取第一个

执行增删改:用 ExecuteSqlCommand

适合没有返回值、或只关心“影响了几行”的场景(如 UpdateOrderStatus @id, @status)。

  • 直接传存储过程名 + 参数(支持命名参数):
    _context.Database.ExecuteSqlCommand("EXEC UpdateOrderStatus @Id, @Status", new SqlParameter("@Id", id), new SqlParameter("@Status", status));
  • 返回值是 int,即受影响行数;返回 -1 表示出错
  • 不能自动映射回实体,调用后如需刷新数据,得手动 _context.Entry(x).Reload() 或重新查询

返回标量值(比如 COUNT、SUM):用 SqlQuery

EF Core 5+ 支持 Database.SqlQuery() 直接获取单值或简单类型集合(注意不是 DbSet 方法)。

  • 例如获取客户总数:
    var count = _context.Database.SqlQuery("EXEC GetCustomerCount").SingleOrDefault();
  • 必须确保存储过程只返回一列、一行(或多行单列),否则会报错或截断
  • 不走 EF 的变更跟踪,纯读取,适合报表类场景

高级需求:自定义扩展或第三方库

如果常要处理输出参数、多结果集、复杂类型映射,原生 API 就有点吃力了。

  • 可封装 DbCommand 手动执行,灵活控制参数方向(ParameterDirection.Output)、读取多个 SqlDataReader.NextResult()
  • 用开源包如 StoredProcedureEFCore(NuGet 可搜),它把存储过程调用包装成强类型方法,支持输入/输出参数、多结果集自动映射
  • 避免自己拼接 SQL 字符串传参,哪怕用 $"EXEC p @p={val}" 也不如用 SqlParameter 安全

基本上就这些。选哪种方式,取决于你存过返回什么、要不要进 EF 生命周期、以及团队维护习惯。没那么复杂,但容易忽略字段匹配和参数安全这两个坑。