Entity Framework若干个扩展
声明
这里有此东西是参考各大神修改和补充而来，有些地方就找不到原文章的地址了，一参考地址如下：
http://www.cnblogs.com/ahui/archive/2011/08/04/2127282.html
寄语
本着取之于大神，还之于大众的精神，我把本人整理以及扩展的一些重要部分贴出来，希望你也积极把你觉得好的扩展回应到此贴中。
1、ExecuteSqlCommand和SqlQuery扩展
作用：扩展后省去写大堆的new SqlParameter了
#region 动态执行Sql语句扩展 /// <summary> /// 根据sql语句和参数的值动态生成Sqlparameter /// </summary> /// <param name="sql">sql语句</param> /// <param name="values">值</param> /// <exception cref="ArgumentNullException"></exception> /// <exception cref="ArgumentException"></exception> /// <returns></returns> private static SqlParameter[] MakeSqlParameter(string sql, object[] values) { var matches = Regex.Matches(sql, @"@\w+"); List<string> paramNameList = new List<string>(); foreach (Match m in matches) { if (paramNameList.Contains(m.Value) == false) { paramNameList.Add(m.Value); } } if (values.Length != paramNameList.Count) { throw new ArgumentException("values的元素数目和Sql语句不匹配"); } int i = 0; var parameters = new SqlParameter[values.Length]; foreach (var pName in paramNameList) { parameters[i] = new SqlParameter(pName, values[i]); i++; } return parameters; } /// <summary> /// 执行Sql命令 /// <example>ExecuteSqlCommandEx("delete from [Table] where ID=@0", Guid.Empty)</example> /// </summary> /// <param name="database">数据库</param> /// <param name="sql">sql语句</param> /// <param name="values">值</param> /// <exception cref="ArgumentNullException"></exception> /// <exception cref="ArgumentException"></exception> /// <returns></returns> public static int ExecuteSqlCommandEx(this Database database, string sql, params object[] values) { var param = DbSetExtended.MakeSqlParameter(sql, values); return database.ExecuteSqlCommand(sql, param); } /// <summary> /// 执行Sql查询 /// <example>SqlQueryEx("select * from [Table] where name=@0 and password=@1", "abc", "123456")</example> /// </summary> /// <param name="database">数据库</param> /// <param name="sql">sql语句</param> /// <param name="values">值</param> /// <exception cref="ArgumentNullException"></exception> /// <exception cref="ArgumentException"></exception> /// <returns></returns> public static IEnumerable<TElement> SqlQueryEx<TElement>(this Database database, string sql, params object[] values) { var param = DbSetExtended.MakeSqlParameter(sql, values); return database.SqlQuery<TElement>(sql, param); } #endregion
2、排序扩展
作用：支持用字符串直接描述排序，如：OrderBy("key1,key2,key3 desc,ke4")，方便和UI交互
#region 排序扩展 /// <summary> /// 排序公共方法 /// </summary> /// <typeparam name="T">实体类型</typeparam> /// <param name="source">数据源</param> /// <param name="orderByKey">排序键排序键(不分大小写)</param> /// <param name="orderByMethod">排序方法</param> /// <exception cref="ArgumentNullException"></exception> /// <exception cref="ArgumentException"></exception> /// <returns></returns> private static IOrderedQueryable<T> OrderByCommon<T>(IQueryable<T> source, string orderByKey, string orderByMethod) where T : class { if (string.IsNullOrEmpty(orderByKey)) { throw new ArgumentNullException("orderByKey"); } Type sourceTtype = typeof(T); PropertyInfo keyProperty = sourceTtype.GetProperties().FirstOrDefault(p => p.Name.ToLower().Equals(orderByKey.Trim().ToLower())); if (keyProperty == null) { throw new ArgumentException("orderByKey不存在..."); } var param = Expression.Parameter(sourceTtype, "item"); var body = Expression.MakeMemberAccess(param, keyProperty); var orderByLambda = Expression.Lambda(body, param); var resultExp = Expression.Call(typeof(Queryable), orderByMethod, new Type[] { sourceTtype, keyProperty.PropertyType }, source.Expression, Expression.Quote(orderByLambda)); var ordereQueryable = source.Provider.CreateQuery<T>(resultExp) as IOrderedQueryable<T>; return ordereQueryable; } /// <summary> /// 排序 /// 选择升序或降序 /// </summary> /// <typeparam name="T">实体类型</typeparam> /// <param name="source">数据源</param> /// <param name="orderByKey">排序键排序键(不分大小写)</param> /// <param name="ascending">是否升序</param> /// <exception cref="ArgumentNullException"></exception> /// <exception cref="ArgumentException"></exception> /// <returns></returns> public static IOrderedQueryable<T> OrderBy<T>(this IQueryable<T> source, string orderByKey, bool ascending) where T : class { var methodName = ascending ? "OrderBy" : "OrderByDescending"; return DbSetExtended.OrderByCommon(source, orderByKey, methodName); } /// <summary> /// 排序次项 /// 选择升序或降序 /// </summary> /// <typeparam name="T">实体类型</typeparam> /// <param name="source">数据源</param> /// <param name="orderByKey">排序键(不分大小写)</param> /// <param name="ascending">是否升序</param> /// <exception cref="ArgumentNullException"></exception> /// <exception cref="ArgumentException"></exception> /// <returns></returns> public static IOrderedQueryable<T> ThenBy<T>(this IOrderedQueryable<T> source, string orderByKey, bool ascending) where T : class { var methodName = ascending ? "ThenBy" : "ThenByDescending"; return DbSetExtended.OrderByCommon(source, orderByKey, methodName); } /// <summary> /// 多字段混合排序 /// </summary> /// <typeparam name="T">实体类型</typeparam> /// <param name="source">数据源</param> /// <param name="orderByString">排序字符串：例如CreateTime desc, ID asc 不区分大小写</param> /// <exception cref="ArgumentNullException">orderByString</exception> /// <returns></returns> public static IOrderedQueryable<T> OrderBy<T>(this IQueryable<T> source, string orderByString) where T : class { Func<string[], bool> descFun = (item) => item.Length > 1 && item[1].Trim().ToLower().Equals("desc"); var parameters = orderByString .Split(new string[] { "," }, StringSplitOptions.RemoveEmptyEntries) .Select(item => item.Split(new string[] { " " }, StringSplitOptions.RemoveEmptyEntries)) .Select(item => new { Key = item.FirstOrDefault(), Asc = !descFun(item) }) .ToList(); if (parameters.Count == 0) { throw new ArgumentNullException("orderByString"); } var firstP = parameters.FirstOrDefault(); var orderQuery = source.OrderBy(firstP.Key, firstP.Asc); parameters.Skip(1).ToList().ForEach(p => orderQuery = orderQuery.ThenBy(p.Key, p.Asc)); return orderQuery; } /// <summary> /// 排序 /// 选择升序或降序 /// </summary> /// <typeparam name="T">实体类型</typeparam> /// <typeparam name="TKey">排序键</typeparam> /// <param name="source">数据源</param> /// <param name="orderKeySelector">排序器</param> /// <param name="ascending">是否升序</param> /// <returns></returns> public static IOrderedQueryable<T> OrderBy<T, TKey>(this IQueryable<T> source, Expression<Func<T, TKey>> orderKeySelector, bool ascending) { if (ascending) { return source.OrderBy(orderKeySelector); } else { return source.OrderByDescending(orderKeySelector); } } /// <summary> /// 次项排序 /// 选择升序或降序 /// </summary> /// <typeparam name="T">实体类型</typeparam> /// <typeparam name="TKey">排序键</typeparam> /// <param name="source">数据源</param> /// <param name="orderKeySelector">排序器</param> /// <param name="ascending">是否升序</param> /// <returns></returns> public static IOrderedQueryable<T> ThenBy<T, TKey>(this IOrderedQueryable<T> source, Expression<Func<T, TKey>> orderKeySelector, bool ascending) { if (ascending) { return source.ThenBy(orderKeySelector); } else { return source.ThenByDescending(orderKeySelector); } } #endregion
3、单张表省略式Select的扩展
作用：扩展后省去写大堆的 item => new A(){A.key1 = item.key1....}
#region 查询方法的扩展 /// <summary> /// Select方法的补充 /// rpy.SelectEx(item =>new TNew(){})等同rpy.Select(item => new TNew(){f1 = item.f1, f2 = item.f2 ,...}) /// rpy.SelectEx(item =>new TNew(){f1 = "something"})等同rpy.Select(item => new TNew(){ f1 ="something", f2 = item.f2 ,...}) /// 其它选择方法和原始Select方法一致 /// </summary> /// <typeparam name="T">源实体类型</typeparam> /// <typeparam name="TNew">新的实体类型</typeparam> /// <param name="source">数据源</param> /// <param name="selector">新对象实例</param> /// <exception cref="ArgumentException"></exception> /// <returns></returns> public static IQueryable<TNew> SelectEx<T, TNew>(this IQueryable<T> source, Expression<Func<T, TNew>> selector) where T : class { if (selector == null) { throw new ArgumentNullException(); } var body = selector.Body as MemberInitExpression; if (body != null) { var targetType = typeof(TNew); var targetProperties = targetType.GetProperties().ToList(); var sourceProperties = typeof(T).GetProperties(); var parameter = selector.Parameters[0]; var bindedMembers = body.Bindings.Select(b => b.Member).ToList(); var needBindProroties = targetProperties.Where(p => bindedMembers.Exists(m => m.Name.Equals(p.Name)) == false); var allBindings = body.Bindings.ToList(); foreach (var property in needBindProroties) { var sourceProperty = sourceProperties.FirstOrDefault(item => item.Name.Equals(property.Name)); if (sourceProperty != null) { var memberExp = Expression.MakeMemberAccess(parameter, sourceProperty); var binding = Expression.Bind(property, memberExp); allBindings.Add(binding); } } var targetNew = Expression.New(targetType); var bodyNew = Expression.MemberInit(targetNew, allBindings); selector = (Expression<Func<T, TNew>>)Expression.Lambda(bodyNew, parameter); } return source.Select(selector); } #endregion
4、动态复杂的Where条件逻辑表达式生成的扩展
作用：生成复杂的过滤条件表达式，条件字段可以从UI上传过来再动态生成Func<T,boo>表达式
/// <summary> /// Where条件扩展 /// 用于分步实现不确定条件个数的逻辑运算组织 /// <remarks>作者：陈国伟 日期：2013/05/07</remarks> /// </summary> public static class Where { /// <summary> /// 逻辑枚举 /// </summary> public enum LogicEnum { /// <summary> /// 相等 /// </summary> Equal, /// <summary> /// 不等 /// </summary> NotEqual, /// <summary> /// 大于 /// </summary> GreaterThan, /// <summary> /// 大于等于 /// </summary> GreaterThanOrEqual, /// <summary> /// 小于 /// </summary> LessThan, /// <summary> /// 小于等于 /// </summary> LessThanOrEqual, /// <summary> /// 字条串的Contains /// </summary> Contains } /// <summary> /// 参数替换对象 /// </summary> private class ParameterReplacer : ExpressionVisitor { /// <summary> /// 表达式的参数 /// </summary> public ParameterExpression ParameterExpression { get; private set; } /// <summary> /// 参数替换对象 /// </summary> /// <param name="paramExp">表达式的参数</param> public ParameterReplacer(ParameterExpression paramExp) { this.ParameterExpression = paramExp; } /// <summary> /// 将表达式调度到此类中更专用的访问方法之一 /// </summary> /// <param name="exp">表达式</param> /// <returns></returns> public Expression Replace(Expression exp) { return this.Visit(exp); } /// <summary> /// 获取表达式的参数 /// </summary> /// <param name="p"></param> /// <returns></returns> protected override Expression VisitParameter(ParameterExpression p) { return this.ParameterExpression; } } /// <summary> /// 返回默认为True的条件 /// </summary> /// <typeparam name="T"></typeparam> /// <returns></returns> public static Expression<Func<T, bool>> True<T>() { return item => true; } /// <summary> /// 返回默认为False的条件 /// </summary> /// <typeparam name="T"></typeparam> /// <returns></returns> public static Expression<Func<T, bool>> False<T>() { return item => false; } /// <summary> /// 与逻辑运算 /// </summary> /// <typeparam name="T">实体类型</typeparam> /// <param name="expLeft">表达式1</param> /// <param name="expRight">表达式2</param> /// <returns></returns> public static Expression<Func<T, bool>> And<T>(this Expression<Func<T, bool>> expLeft, Expression<Func<T, bool>> expRight) { var candidateExpr = Expression.Parameter(typeof(T), "item"); var parameterReplacer = new ParameterReplacer(candidateExpr); var left = parameterReplacer.Replace(expLeft.Body); var right = parameterReplacer.Replace(expRight.Body); var body = Expression.And(left, right); return Expression.Lambda<Func<T, bool>>(body, candidateExpr); } /// <summary> /// 或逻辑运算 /// </summary> /// <typeparam name="T">实体类型</typeparam> /// <param name="expLeft">表达式1</param> /// <param name="expRight">表达式2</param> /// <returns></returns> public static Expression<Func<T, bool>> Or<T>(this Expression<Func<T, bool>> expLeft, Expression<Func<T, bool>> expRight) { var candidateExpr = Expression.Parameter(typeof(T), "item"); var parameterReplacer = new ParameterReplacer(candidateExpr); var left = parameterReplacer.Replace(expLeft.Body); var right = parameterReplacer.Replace(expRight.Body); var body = Expression.Or(left, right); return Expression.Lambda<Func<T, bool>>(body, candidateExpr); } /// <summary> /// 动态生成Where逻辑表达式 /// </summary> /// <typeparam name="T">实体类型</typeparam> /// <param name="member">实体的成员(不区分大小写)</param> /// <param name="logic">逻辑关系</param> /// <param name="matchValue">要匹配的值</param> /// <exception cref="ArgumentNullException"></exception> /// <exception cref="ArgumentException"></exception> /// <returns></returns> public static Expression<Func<T, bool>> Parse<T>(string member, LogicEnum logic, string matchValue) { if (string.IsNullOrEmpty(member)) { throw new ArgumentNullException("member"); } var keyProperty = typeof(T).GetProperties().FirstOrDefault(item => item.Name.ToLower().Equals(member.Trim().ToLower())); if (keyProperty == null) { throw new ArgumentException("member不存在"); } // item var pExp = Expression.Parameter(typeof(T), "item"); // item.CreateTime Expression memberExp = Expression.MakeMemberAccess(pExp, keyProperty); if (logic != LogicEnum.Contains) { // 是否是可空类型 bool memberIsNullableType = keyProperty.PropertyType.IsGenericType && keyProperty.PropertyType.GetGenericTypeDefinition().Equals(typeof(Nullable<>)); // 是可空类型则取类型的Value属性 if (memberIsNullableType == true) { // item.CreateTime.Value memberExp = Expression.MakeMemberAccess(memberExp, keyProperty.PropertyType.GetProperty("Value")); } // 目标值类型 Type valueType = keyProperty.PropertyType; if (memberIsNullableType == true) { valueType = valueType.GetGenericArguments().FirstOrDefault(); } object value = matchValue; if (valueType.Equals(typeof(string)) == false) { // value = DateTime.Parse(matchValue) value = valueType.GetMethod("Parse", new Type[] { typeof(string) }).Invoke(null, new object[] { value }); } var valueExp = Expression.Constant(value, valueType); // Expression.Equal var expMethod = typeof(Expression).GetMethod(logic.ToString(), new Type[] { typeof(Expression), typeof(Expression) }); // item.CreateTime.Value == value var body = expMethod.Invoke(null, new object[] { memberExp, valueExp }) as Expression; return Expression.Lambda(body, pExp) as Expression<Func<T, bool>>; } else { // item.Member.Contains("something") var body = Expression.Call(memberExp, typeof(string).GetMethod(logic.ToString()), Expression.Constant(matchValue, typeof(string))); return Expression.Lambda(body, pExp) as Expression<Func<T, bool>>; } } /// <summary> /// 动态生成和匹配参数数目相同的逻辑表达式并用Or关联起来 /// </summary> /// <typeparam name="T">实体类型</typeparam> /// <param name="member">实体成员</param> /// <param name="logic">逻辑关系</param> /// <param name="matchValues">匹配值</param> /// <returns></returns> public static Expression<Func<T, bool>> ParseOr<T>(string member, LogicEnum logic, params string[] matchValues) { var where = Where.Parse<T>(member, logic, matchValues.FirstOrDefault()); matchValues.Skip(1).ToList().ForEach(value => where = where.Or(Where.Parse<T>(member, logic, value))); return where; } /// <summary> /// 动态生成和成员目相同的逻辑表达式并用Or关联起来 /// </summary> /// <typeparam name="T">实体类型</typeparam> /// <param name="members">实体成员</param> /// <param name="logic">逻辑关系</param> /// <param name="matchValue">匹配值</param> /// <returns></returns> public static Expression<Func<T, bool>> ParseOr<T>(string[] members, LogicEnum logic, string matchValue) { var where = Where.Parse<T>(members.FirstOrDefault(), logic, matchValue); members.Skip(1).ToList().ForEach(member => where = where.Or(Where.Parse<T>(member, logic, matchValue))); return where; } /// <summary> /// 动态生成和匹配参数数目相同的逻辑表达式并用And关联起来 /// </summary> /// <typeparam name="T">实体类型</typeparam> /// <param name="member">实体成员</param> /// <param name="logic">逻辑关系</param> /// <param name="matchValues">匹配值</param> /// <returns></returns> public static Expression<Func<T, bool>> ParseAnd<T>(string member, LogicEnum logic, params string[] matchValues) { var where = Where.Parse<T>(member, logic, matchValues.FirstOrDefault()); matchValues.Skip(1).ToList().ForEach(value => where = where.And(Where.Parse<T>(member, logic, value))); return where; } /// <summary> /// 动态生成和成员目相同的逻辑表达式并用And关联起来 /// </summary> /// <typeparam name="T">实体类型</typeparam> /// <param name="members">实体成员</param> /// <param name="logic">逻辑关系</param> /// <param name="matchValue">匹配值</param> /// <returns></returns> public static Expression<Func<T, bool>> ParseAnd<T>(string[] members, LogicEnum logic, string matchValue) { var where = Where.Parse<T>(members.FirstOrDefault(), logic, matchValue); members.Skip(1).ToList().ForEach(member => where = where.And(Where.Parse<T>(member, logic, matchValue))); return where; } }