如何在EF Core 使用存储过程
使用EF Core框架能快速的帮助我们进行常规的数据处理和项目开发,但是ORM虽然好用,但是在许多复杂逻辑的数据处理时,我个人还是偏向用SQL和存储过程的方式去处理,但是研究了一下目前最新版本的EF Core(我用的是2.1)以及相关文档,貌似没有找到可以很好支持原始SQL开发的方案,于是就自己简单的扩展了一下
首先说一下我查阅文档找到已知的EF Core可以执行SQL和存储过程的两个函数ExecuteSqlCommand()和FromSql()
1,ExecuteSqlCommand(),代码中的EntityContext即为数据框架上下文对象,这种方法可以执行sql或者存储过程并且传递参数,但是缺点就是函数的返回结果为int类型的受影响行数,无法返回指定的数据集
private EntityContext context = null; public ValuesController(EntityContext _context) { context = _context; } /// <summary> /// 测试代码 /// </summary> /// <returns></returns> [HttpPost("Post")] public int Post() { long uid = 4; int data = context.Database.ExecuteSqlCommand($"exec proc_test {uid}", uid); return data; }
2,FromSql()可以用来执行带参数的sql,这个函数的用法以及优缺点可以看官方文档的这篇文章
https://docs.microsoft.com/en-us/ef/core/querying/raw-sql
3,用DbCommand 简单的扩展数据框架上下文对象,使其可以执行存储过程并返回你想要的数据类型
public static class ExtendDBContext { /// <summary> /// 执行SQL返回受影响的行数 /// </summary> public static int ExecSqlNoQuery<T>(this EntityContext db, string sql, SqlParameter[] sqlParams = null) where T : new() { return ExecuteNoQuery<T>(db, sql, sqlParams); } /// <summary> /// 执行存储过程返回IEnumerable数据集 /// </summary> public static IEnumerable<T> ExecProcReader<T>(this EntityContext db, string sql, SqlParameter[] sqlParams = null) where T : new() { return Execute<T>(db, sql, CommandType.StoredProcedure, sqlParams); } /// <summary> /// 执行sql返回IEnumerable数据集 /// </summary> public static IEnumerable<T> ExecSqlReader<T>(this EntityContext db, string sql, SqlParameter[] sqlParams = null) where T : new() { return Execute<T>(db, sql, CommandType.Text, sqlParams); } private static int ExecuteNoQuery<T>(this EntityContext db, string sql, SqlParameter[] sqlParams) where T : new() { DbConnection connection = db.Database.GetDbConnection(); DbCommand cmd = connection.CreateCommand(); int result = 0; db.Database.OpenConnection(); cmd.CommandText = sql; cmd.CommandType = CommandType.Text; if (sqlParams != null) { cmd.Parameters.AddRange(sqlParams); } result = cmd.ExecuteNonQuery(); db.Database.CloseConnection(); return result; } private static IEnumerable<T> Execute<T>(this EntityContext db, string sql, CommandType type, SqlParameter[] sqlParams) where T : new() { DbConnection connection = db.Database.GetDbConnection(); DbCommand cmd = connection.CreateCommand(); db.Database.OpenConnection(); cmd.CommandText = sql; cmd.CommandType = type; if (sqlParams != null) { cmd.Parameters.AddRange(sqlParams); } DataTable dt = new DataTable(); using (DbDataReader reader = cmd.ExecuteReader()) { dt.Load(reader); } db.Database.CloseConnection(); return dt.ToCollection<T>(); } }
DataTable和集合的扩展
public static class ExtendDataTable { public static DataTable ToDataTable<T>(this IEnumerable<T> data) { PropertyDescriptorCollection properties = TypeDescriptor.GetProperties(typeof(T)); var table = new DataTable(); foreach (PropertyDescriptor prop in properties) table.Columns.Add(prop.Name, Nullable.GetUnderlyingType(prop.PropertyType) ?? prop.PropertyType); foreach (T item in data) { DataRow row = table.NewRow(); foreach (PropertyDescriptor prop in properties) row[prop.Name] = prop.GetValue(item) ?? DBNull.Value; table.Rows.Add(row); } return table; } public static T ToEntity<T>(this DataTable dt) where T : new() { IEnumerable<T> entities = dt.ToCollection<T>(); return entities.FirstOrDefault(); } public static IEnumerable<T> ToCollection<T>(this DataTable dt) where T : new() { if (dt == null || dt.Rows.Count == 0) { return Enumerable.Empty<T>(); } IList<T> ts = new List<T>(); // 获得此模型的类型 Type type = typeof(T); string tempName = string.Empty; foreach (DataRow dr in dt.Rows) { T t = new T(); PropertyInfo[] propertys = t.GetType().GetProperties(); foreach (PropertyInfo pi in propertys) { tempName = pi.Name; //检查DataTable是否包含此列(列名==对象的属性名) if (dt.Columns.Contains(tempName)) { // 判断此属性是否有Setter if (!pi.CanWrite) continue;//该属性不可写,直接跳出 object value = dr[tempName]; if (value != DBNull.Value) pi.SetValue(t, value, null); } } ts.Add(t); } return ts; } }
说明:上面的代码是通过datareader的方式获取数据集的,当然DbCommand 也支持异步的方式处理数据,我这边没有用到所以代码也就没有做扩展,我貌似没有找到可以通过dataadapter来填充dataset的方式获取数据集的相关函数,如果有小伙伴知道在如何在EF Core中用dataadapter来填充dataset的方式获取数据集,可以把代码贴评论区哦
付伤年华的技术分享