Entity Framework使用自定义Func实现灵活字符串过滤报错如何解决

LINQ to Entities 执行查询时需要将Where子句的内容翻译成SQL语句在数据库端执行，你传入的Func<string, bool>是编译完成的托管委托，EF 无法解析委托内部的逻辑生成对应的SQL，因此抛出不支持 Invoke 节点的错误。

将原方法的返回值从委托Func<>改为表达式树Expression<Func<>>，表达式树存储的是逻辑的结构化描述，EF 可以直接解析生成对应SQL。同时为了支持多字段复用，我们补充简单的表达式拼接逻辑即可。

1. 修正过滤规则生成方法，返回表达式树 #

注意原代码中处理*后缀的EndsWith逻辑存在错误，示例中已修复该问题：

using System.Linq.Expressions;

public static Tuple<Expression<Func<string,bool>>, bool> PrepareFilterFieldFunc(string filter)
{
    bool valid = false;
    Expression<Func<string, bool>> retFunc = query_val => true;
    string filter_string = "";

    if (filter.Contains("*")) 
    {
        var f_strs = filter.Split("*");
        if (f_strs.Length == 3)   // 包含匹配 *xxx*
        {
            if (f_strs[0] == "" && f_strs[2] == "")
            {
                filter_string = f_strs[1];
                retFunc = query_val => query_val.Contains(filter_string);
                valid = true;
            }
            else
            {
                filter_string = filter;
                retFunc = query_val => query_val.Equals(filter_string);
                valid = true;
            }
        }
        else if (f_strs.Length == 2)   // 前缀匹配xxx* 或后缀匹配*xxx
        {
            if (f_strs[0] == "")   // 后缀匹配 *xxx
            {
                filter_string = f_strs[1];
                retFunc = query_val => query_val.StartsWith(filter_string);
                valid = true;
            }
            else if (f_strs[1] == "")  // 前缀匹配 xxx*，原代码此处取f_strs[1]为bug，已修正为取f_strs[0]
            {
                filter_string = f_strs[0];
                retFunc = query_val => query_val.EndsWith(filter_string);
                valid = true;
            }
            else
            {
                filter_string = filter;
                retFunc = query_val => query_val.Equals(filter_string);
                valid = true;
            }
        }
        else
        {
            filter_string = filter;
            retFunc = query_val => query_val.Equals(filter_string);
            valid = true;
        }
    }
    else
    {
        filter_string = filter;
        retFunc = query_val => query_val.Equals(filter_string);
        valid = true;
    }

    return Tuple.Create(retFunc, valid);
}

2. 新增表达式拼接辅助逻辑 #

用于将针对字符串的过滤表达式绑定到实体类的任意字符串字段上：

using System.Linq.Expressions;

// 参数替换访问器，用于拼接表达式
internal class ParameterReplaceVisitor : ExpressionVisitor
{
    private readonly ParameterExpression _oldParameter;
    private readonly Expression _newExpression;

    public ParameterReplaceVisitor(ParameterExpression oldParameter, Expression newExpression)
    {
        _oldParameter = oldParameter;
        _newExpression = newExpression;
    }

    protected override Expression VisitParameter(ParameterExpression node)
    {
        return node == _oldParameter ? _newExpression : base.VisitParameter(node);
    }
}

// IQueryable扩展方法，直接应用过滤到指定字段
public static class QueryableExtensions
{
    public static IQueryable<T> ApplyStringFilter<T>(this IQueryable<T> query, 
        Expression<Func<T, string>> propertySelector, 
        Expression<Func<string, bool>> filterExpression)
    {
        if (filterExpression == null) return query;
        // 替换过滤表达式的参数为实体属性访问逻辑
        var visitor = new ParameterReplaceVisitor(filterExpression.Parameters[0], propertySelector.Body);
        var newFilterBody = visitor.Visit(filterExpression.Body);
        var filterLambda = Expression.Lambda<Func<T, bool>>(newFilterBody, propertySelector.Parameters[0]);
        return query.Where(filterLambda);
    }
}

3. 调用方式 #

修改你原有的查询构造代码即可：

(var countryFilter, var executeCountryFilter) = SHARED.PrepareFilterFieldFunc(SHQ.filter_countryCode);
if (executeCountryFilter)
{
    type_query = type_query.ApplyStringFilter(sh => sh.bill_to_country_region_code, countryFilter);
}

// 复用其他字段示例：
(var nameFilter, var executeNameFilter) = SHARED.PrepareFilterFieldFunc(SHQ.filter_name);
if (executeNameFilter)
{
    type_query = type_query.ApplyStringFilter(sh => sh.customer_name, nameFilter);
}

内容的提问来源于stack exchange，提问作者WouldBeNerd