如何使用Predicate Builder创建动态LINQ查询

一、引言

在日常开发过程中，我们经常需要处理动态条件下的数据库查询。这些查询的条件往往是由用户输入决定的，这就要求我们的应用程序能够灵活地根据不同的输入来构建 SQL 查询语句。LINQ 提供了一种简洁的方式来处理这样的需求，但当查询条件变得复杂时，手动构建这样的查询可能会非常繁琐且容易出错。这时候，Predicate Builder 就可以派上用场了。

1.1 什么是 Predicate Builder？

Predicate Builder 是一个帮助类，用于在 LINQ 查询中构建复杂的谓词表达式。它可以帮助我们轻松地添加、删除或组合多个查询条件，而无需担心逻辑错误。

1.2 为什么使用 Predicate Builder？

• 可读性：使用 Predicate Builder 可以让代码更加清晰易懂。
• 灵活性：可以方便地添加或移除查询条件。
• 复用性：构建好的条件可以方便地复用在多个查询中。

二、准备工作

为了更好地理解如何使用 Predicate Builder，我们需要准备一个简单的例子。假设我们有一个 Employee 类，以及一个包含员工信息的列表。我们将尝试根据不同的过滤条件来查询这个列表。

// 定义 Employee 类
public class Employee
{
    public int Id { get; set; }
    public string Name { get; set; }
    public int Age { get; set; }
    public bool IsActive { get; set; }
}

2.1 创建 Employee 列表

// 创建 Employee 列表
var employees = new List<Employee>
{
    new Employee { Id = 1, Name = "张三", Age = 28, IsActive = true },
    new Employee { Id = 2, Name = "李四", Age = 35, IsActive = false },
    // 更多员工...
};

三、Predicate Builder 的实现

接下来，我们将创建一个 Predicate Builder 类，用于构建查询条件。

3.1 实现 PredicateBuilder 类

public static class PredicateBuilder
{
    // 创建一个空的谓词
    public static Expression<Func<T, bool>> True<T>() => x => true;

    // 创建一个永远返回 false 的谓词
    public static Expression<Func<T, bool>> False<T>() => x => false;

    // 将两个谓词合并为一个新的谓词
    public static Expression<Func<T, bool>> Combine<T>(this Expression<Func<T, bool>> expr1,
                                                        Expression<Func<T, bool>> expr2,
                                                        Func<Expression, Expression, Expression> combiner)
    {
        var invokedExpr = Expression.Invoke(expr2, expr1.Parameters.Cast<Expression>());
        return Expression.Lambda<Func<T, bool>>(combiner(expr1.Body, invokedExpr), expr1.Parameters);
    }

    // 逻辑与
    public static Expression<Func<T, bool>> And<T>(this Expression<Func<T, bool>> expr1,
                                                   Expression<Func<T, bool>> expr2) =>
        Combine(expr1, expr2, Expression.AndAlso);

    // 逻辑或
    public static Expression<Func<T, bool>> Or<T>(this Expression<Func<T, bool>> expr1,
                                                  Expression<Func<T, bool>> expr2) =>
        Combine(expr1, expr2, Expression.OrElse);
}

3.2 构建查询条件

// 定义查询条件
bool? isActiveFilter = true;
int? ageFilter = 30;

// 创建初始谓词
Expression<Func<Employee, bool>> predicate = PredicateBuilder.True<Employee>();

// 如果 isActiveFilter 不为 null，则添加到谓词中
if (isActiveFilter.HasValue)
{
    predicate = predicate.And(employee => employee.IsActive == isActiveFilter.Value);
}

// 如果 ageFilter 不为 null，则添加到谓词中
if (ageFilter.HasValue)
{
    predicate = predicate.And(employee => employee.Age >= ageFilter.Value);
}

// 应用谓词到查询中
var filteredEmployees = employees.Where(predicate).ToList();

四、总结

通过使用 Predicate Builder，我们可以更加方便地管理和构建动态查询。这不仅提高了代码的可维护性，还使得业务逻辑更加清晰。希望本文能帮助你在实际项目中应用这一技巧，提升开发效率。