分享动态拼接Expression表达式组件及原理

时间：2022-02-12 04:32:34

前言

LINQ大家都知道，用起来也还不错，但有一个问题，当你用Linq进行搜索的时候，你是这样写的

  1. var query = from user in db.Set<User>()
  2.                         where user.Username == "xxxx"
  3.                         select user;

OK，看起来很好，不过····如果你要进行动态搜索的话··呵呵！其实方法还是挺多，只不过绕大弯

动态搜索是什么？顺便介绍下，假如你做了一个表格页面，有用户名、注册时间、等级三列，你希望实现动态组合搜索，只有当用户指定了要以用户名搜索的时候才把用户名这一列加入搜索条件，传统的sql是这么干的

  1. string sql="select * from user ";
  2. if(userName!="")
  3. {
  4.     sql+=" Where Username="+userName
  5. }

声明：只做示例，能不能运行不重要！（上面的代码一般情况下必须是有问题的）

那你用linq能不能这么干呢？呃····向下面这样

  1. var query = from user in db.Set<User>()
  2.                         select user;
  3.             var userName = string.Empty;
  4.             if(!string.IsNullOrWhiteSpace(userName))
  5.             {
  6.                 query = query.Where(x => x.Username == userName);
  7.             }

对，是可以这样，但在实际项目中一般是不会直接返回IQueryable接口的，也就没办法这么做。

所以，动态拼接linq就应运而生了，而linq的实质是表达式树，大家可以看IQueryable的Where扩展方法的签名，是以Expression开头的。

组件介绍及使用

封装的最初目的，也是给自己用。我是懒人，所以我会把组件搞得越简单越好，下面是一个完整的使用示例

  1. TestDataContext db = new TestDataContext();
  2.            var builder = new ExpressionBuilder<User>();//实例化组件，User是什么下面说
  3.            var filters = new List<SqlFilter>();
  4.            filters.Add(SqlFilter.Create("Id", Operation.Equal, 1)); //添加User的Id属性值等于1的搜索条件
  5.            filters.Add(SqlFilter.Create("LastLoginDate", Operation.GreaterThan, DateTime.Now));//添加User的LastLoginDate属性值大于现在的搜索条件
  6.            filters.Add(SqlFilter.Create("Username", Operation.Like, "aaaa"));//添加User的Username属性值like "aaaaa"的搜索条件
  7.            filters.Add(SqlFilter.Create("Id", Operation.In, new int[] { 1, 2, 3 }));//添加User的Id属性值在1、2、3之中的搜索条件，当Operation为In的时候，最后一个参数必须为集合
  8.            filters.Add(SqlFilter.Create(""));
  9.            filters.Add(SqlFilter.Create("Status", Operation.In, new int[] { 1 }));
  10.            var where = builder.Build(filters, new Dictionary<string, string>());//根据上面的条件，拼接出表达式树
  11.            var results = db.Set<User>().Where(where).ToList();//地球人都知道

上面的代码拼接出来表达式树是这样的

  1. var ids=new int[]{1,2,3};
  2.             var status=new int[]{1};
  3.             db.Set<User>().Where(x => x.Id == 1 && x.LastLoginDate > DateTime.Now && ids.Contains(x.Id) && x.Username.Contains("" && status.Contains(x.Status));

注释已经说得比较清楚了，但第2行和第10行需要特别解释一下，第10行的Build方法原型如下

  1. public Expression<Func<TParameter, bool>> Build(IList<SqlFilter> filters, Dictionary<string, string> filterNameMap)

返回值是一个Expression<Func<TParameter,bool>>类型的，其中有一个泛型参数，这个参数就是第2行实例化的时候传的User，在使用的时候，必须保证添加的每一个搜索条件的属性在User类里面有。

为什么要这样设计呢？这个感觉一下子说不清楚，等下讲原理的时候说

另外还可以看到有个filterNameMap的参数，这个主要是用来进行属性名的转换的，一般用于外键。简单说一下我当时的设计意图。

例如，有一个列表，展示的是权限系统中的角色信息，有角色名、描述、拥有的功能三列，其中第三列内容是来自功能表中的，其他是来自角色表的。

一般情况下可能会将第三列的属性名设置为Privileges，然后类型是string型，但如果说用户要按角色拥有的功能进行搜索，你不可能按字符串过滤吧？一般是按照功能Id也就是PrivilegeId过滤。

因为我用的是ExtJs（没用过这个的直接跳过这一段吧），所以问题来了，extjs传给我的参数名是Privileges，值是一个集合，因为我的Model类属性名是这个，但我后台用于过滤的真正属性是PrivilegeId，所以我需要将Privileges映射到PrivilegeId，告诉ExpressionBuilder，如果遇到了Privileges属性名的搜索条件，就将属性名换成PrivilegeId进行拼接

为了方便理解，下面是SqlFilter的源码，很简单

  1. public class SqlFilter
  2.     {
  3.         public static SqlFilter Create(string propertyName, Operation operation, object value)
  4.         {
  5.             return new SqlFilter()
  6.             {
  7.                 Name = propertyName,
  8.                 Operation = operation,
  9.                 Value = value
  10.             };
  11.         }
  12.  
  13.         /// <summary>
  14.         /// 字段名
  15.         /// </summary>
  16.         public string Name { get; set; }
  17.  
  18.         /// <summary>
  19.         /// 搜索操作，大于小于等于
  20.         /// </summary>
  21.         public Xinchen.DbUtils.Operation Operation { get; set; }
  22.  
  23.         /// <summary>
  24.         /// 搜索参数值
  25.         /// </summary>
  26.         public object Value { get; set; }
  27.     }

下面是Operation的

  1. public enum Operation
  2.     {
  3.         GreaterThan,
  4.         LessThan,
  5.         GreaterThanOrEqual,
  6.         LessThanOrEqual,
  7.         NotEqual,
  8.         Equal,
  9.         Like,
  10.         In
  11.     }

组件原理

还真没把握能说清楚···

其实就是拼接表达式树的原理

  1. //假如我们要拼接x=>x.Id==1，假如x的类型为User
  2.             var parameterExp = Expression.Parameter(typeof(User), "x");
  3.             //结果是这样：x=>，x是变量名
  4.             var propertyExp = Expression.Property(parameterExp, "Id");
  5.             //结果是这样：x=>x.Id，这句是为了构建访问属性的表达式
  6.             //上面这句第一个参数是你要取属性的对象表达式。我们要拼的表达式是x=>x.Id==1，==1这块先不管，其实就是x=>x.Id，那么其实我们就是对x进行取属性值，而x是parameterExp，所以第一个参数是parameterExp，第二个参数好说，就是属性名
  7.             var constExp = Expression.Constant(1);
  8.             //结果是··没有结果，构建一个常量表达式，值为1（LINQ的世界，一切皆表达式树）
  9.             //马上就是关键的一步了
  10.             var body = Expression.Equal(propertyExp, constExp);
  11.             //结果是：x=>x.Id==1，这个··还需要解释么，很简单，不是么。创建一个相等的表达式，然后传入左边和右边的表达式
  12.             //当然到这儿还不能用，还需要继续
  13.             var lambda = Expression.Lambda<Func<User, bool>>(body, parameterExp);
  14.             //这句和第二句是我学的时候最难理解的两个地方。这句是将我们的成果封装成能用的，第一个参数就是我们的成果，第二个参数是实现这个成果所需要的参数，那当然是parameterExp，然后泛型参数Func<User,bool>就是我们想把这个表达式封装成什么样的东西，此时,lambda的类型就是Expression<Fun<User,bool>>，这个时候就能用了

这是一个相当简单的表达式树，注释写得很清楚，下面来个复杂的

  1. //假如我们要拼接x=>x.Username.Contains("aaa")，假如x的类型为User
  2.             var parameterExp = Expression.Parameter(typeof(User), "x");
  3.             var propertyExp = Expression.Property(parameterExp, "Username");
  4.             //上面两句不再介绍
  5.             var containsMethod = typeof(string).GetMethod("Contains", new Type[] { typeof(string) });
  6.             //因为我们要拼接的表达式中调用了string类型的Username的Contains方法，所以反射获取string类型的Contains方法
  7.             var constExp = Expression.Constant("aaa");
  8.             //不再解释
  9.             var containsExp = Expression.Call(propertyExp, containsMethod, constExp);
  10.             //结果是：x=>x.Username.Contains("aaa")，第一个参数，是要调用哪个实例的方法，这里是propertyExp，第二个是调用哪个方法，第三个是参数，理解了上一个示例，这个应该不难理解
  11.             var lambda = Expression.Lambda<Func<User, bool>>(containsExp, parameterExp);
  12.             //不再解释

可以看到，第一句都是取了User的类型，所以我在设计ExpressionBuilder的使用了泛型，以供传入这个参数

相关文章