在Entity Framework中使用OR条件进行动态查询

时间:2013-11-18 18:10:43

标签: c# sql-server entity-framework linq linq-to-entities

我正在创建一个创建一个搜索数据库的应用程序,并允许用户动态添加任何标准(大约50种可能),就像下面的SO问题一样:Creating dynamic queries with entity framework。我目前正在进行搜索,检查每个条件,如果它不是空白,则将其添加到查询中。

C#

var query = Db.Names.AsQueryable();
  if (!string.IsNullOrWhiteSpace(first))
      query = query.Where(q => q.first.Contains(first));
  if (!string.IsNullOrWhiteSpace(last))
      query = query.Where(q => q.last.Contains(last));
  //.. around 50 additional criteria
  return query.ToList();

此代码在sql server中生成类似于以下内容的东西(为了便于理解,我进行了简化)

SQL

SELECT
    [Id],
    [FirstName],
    [LastName],
    ...etc
FROM [dbo].[Names]
WHERE [FirstName] LIKE '%first%'
  AND [LastName] LIKE '%last%'

我现在正尝试添加一种方法,通过实体框架使用C#生成以下SQL,但使用 OR 而不是 AND ,同时仍然保持能力动态添加标准。

SQL

SELECT
    [Id],
    [FirstName],
    [LastName],
    ...etc
  FROM [dbo].[Names]
WHERE [FirstName] LIKE '%first%'
  OR [LastName] LIKE '%last%' <-- NOTICE THE "OR"

通常条件不会大于查询的两个或三个项目,但将它们组合成一个巨大的查询不是一种选择。我尝试了concat,union和intersect,他们只是复制查询并将它们与UNION连接。

是否有一种简单而干净的方法可以使用实体框架向动态生成的查询添加“OR”条件?

使用我的解决方案进行编辑 - 2015年9月29日

自发布此消息后,我注意到这已经引起了一些关注,所以我决定发布我的解决方案

// Make sure to add required nuget
// PM> Install-Package LinqKit

var searchCriteria = new 
{
    FirstName = "sha",
    LastName = "hill",
    Address = string.Empty,
    Dob = (DateTime?)new DateTime(1970, 1, 1),
    MaritalStatus = "S",
    HireDate = (DateTime?)null,
    LoginId = string.Empty,
};

var predicate = PredicateBuilder.False<Person>();
if (!string.IsNullOrWhiteSpace(searchCriteria.FirstName))
{
    predicate = predicate.Or(p => p.FirstName.Contains(searchCriteria.FirstName));
}

if (!string.IsNullOrWhiteSpace(searchCriteria.LastName))
{
    predicate = predicate.Or(p => p.LastName.Contains(searchCriteria.LastName));
}

// Quite a few more conditions...

foreach(var person in this.Persons.Where(predicate.Compile()))
{
    Console.WriteLine("First: {0} Last: {1}", person.FirstName, person.LastName);
}

3 个答案:

答案 0 :(得分:18)

你可能正在寻找类似Predicate Builder的东西,它允许你更容易地控制where语句的AND和OR。

还有Dynamic Linq允许您像SQL字符串一样提交WHERE子句,它会将其解析为WHERE的正确谓词。

答案 1 :(得分:5)

虽然LINQKit及其PredicateBuilder相当通用,但可以通过一些简单的实用程序(每个实用程序都可以作为其他表达式操作操作的基础)直接执行此操作:

首先,通用表达式替换器:

public class ExpressionReplacer : ExpressionVisitor
{
    private readonly Func<Expression, Expression> replacer;

    public ExpressionReplacer(Func<Expression, Expression> replacer)
    {
        this.replacer = replacer;
    }

    public override Expression Visit(Expression node)
    {
        return base.Visit(replacer(node));
    }
}

接下来,一个简单的实用方法,用于将一个参数的用法替换为给定表达式中的另一个参数:

public static T ReplaceParameter<T>(T expr, ParameterExpression toReplace, ParameterExpression replacement)
    where T : Expression
{
    var replacer = new ExpressionReplacer(e => e == toReplace ? replacement : e);
    return (T)replacer.Visit(expr);
}

这是必要的,因为两个不同表达式中的lambda参数实际上是不同的参数,即使它们具有相同的名称。例如,如果您希望以q => q.first.Contains(first) || q.last.Contains(last)结尾,则q中的q.last.Contains(last)必须与完全相同 q lambda表达式的开头。

接下来,我们需要一个通用的Join方法,它能够将Func<T, TReturn>样式的Lambda表达式与给定的二进制表达式生成器结合在一起。

public static Expression<Func<T, TReturn>> Join<T, TReturn>(Func<Expression, Expression, BinaryExpression> joiner, IReadOnlyCollection<Expression<Func<T, TReturn>>> expressions)
{
    if (!expressions.Any())
    {
        throw new ArgumentException("No expressions were provided");
    }
    var firstExpression = expressions.First();
    var otherExpressions = expressions.Skip(1);
    var firstParameter = firstExpression.Parameters.Single();
    var otherExpressionsWithParameterReplaced = otherExpressions.Select(e => ReplaceParameter(e.Body, e.Parameters.Single(), firstParameter));
    var bodies = new[] { firstExpression.Body }.Concat(otherExpressionsWithParameterReplaced);
    var joinedBodies = bodies.Aggregate(joiner);
    return Expression.Lambda<Func<T, TReturn>>(joinedBodies, firstParameter);
}

我们会在Expression.Or中使用此功能,但您可以将相同的方法用于各种目的,例如将数字表达式与Expression.Add结合使用。

最后,把它们放在一起,你可以得到这样的东西:

var searchCriteria = new List<Expression<Func<Name, bool>>();

  if (!string.IsNullOrWhiteSpace(first))
      searchCriteria.Add(q => q.first.Contains(first));
  if (!string.IsNullOrWhiteSpace(last))
      searchCriteria.Add(q => q.last.Contains(last));
  //.. around 50 additional criteria
var query = Db.Names.AsQueryable();
if(searchCriteria.Any())
{
    var joinedSearchCriteria = Join(Expression.Or, searchCriteria);
    query = query.Where(joinedSearchCriteria);
}
  return query.ToList();

答案 2 :(得分:1)

  

是否存在一种简单明了的方法来使用实体框架向动态生成的查询添加“ OR”条件?

是的,您可以通过简单地依赖包含单个布尔表达式的单个where子句来实现此目标,布尔表达式的OR部分在运行时会动态“禁用”或“启用”,从而避免了安装LINQKit或编写自定义谓词生成器。

参考您的示例:

var isFirstValid = !string.IsNullOrWhiteSpace(first);
var isLastValid = !string.IsNullOrWhiteSpace(last);

var query = db.Names
  .AsQueryable()
  .Where(name =>
    (isFirstValid && name.first.Contains(first)) ||
    (isLastValid && name.last.Contains(last))
  )
  .ToList();

如您在上面的示例中所见,我们正在根据先前评估的前提(例如where)动态地“打开”或“关闭” isFirstValid过滤器表达式的OR部分。 。

例如,如果isFirstValid不是true,则name.first.Contains(first)short-circuited,既不会执行也不会影响结果集。此外,EF Core的DefaultQuerySqlGenerator将在执行where之前进一步optimize and reduce内部的布尔表达式(例如,false && x || true && y || false && z可以通过简单的静态分析简化为y

请注意:如果所有前提都不是true,那么结果集将为空-我认为这是您所期望的行为。但是,如果您出于某种原因宁愿从IQueryable源中选择所有元素,则可以在表达式中添加一个最终变量,求值为true(例如,{{1}中的.Where( ... || shouldReturnAll) }}或类似的内容。

最后一点:该技术的缺点是它迫使您构建一个“集中式”布尔表达式,该表达式位于查询所位于的同一方法主体中(更确切地说,查询的var shouldReturnAll = !(isFirstValid || isLastValid)部分)。如果出于某种原因,您希望分散谓词的构建过程并将其作为参数注入或通过查询构建器将它们链接起来,那么您最好按照其他答案中的建议继续使用谓词构建器。否则,请享受这种简单的技术:)