从IQueryable生成缓存键以缓存EF代码优先查询的结果

HOC*_*OCA 7 caching entity-framework iqueryable repository ef-code-first

我正在尝试为我的EF存储库实现一个缓存方案,类似于此处的博客.正如作者和评论者所报告的那样,限制是密钥生成方法无法生成随给定查询的参数而变化的缓存键.这是缓存密钥生成方法:

private static string GetKey<T>(IQueryable<T> query)
{
    string key = string.Concat(query.ToString(), "\n\r",
        typeof(T).AssemblyQualifiedName);
    return key;
}
Run Code Online (Sandbox Code Playgroud)

因此,以下查询将生成相同的缓存键:

var isActive = true;
var query = context.Products
.OrderBy(one => one.ProductNumber)
.Where(one => one.IsActive == isActive).AsCacheable();
Run Code Online (Sandbox Code Playgroud)

var isActive = false;
var query = context.Products
.OrderBy(one => one.ProductNumber)
.Where(one => one.IsActive == isActive).AsCacheable();
Run Code Online (Sandbox Code Playgroud)

请注意,唯一的区别在于isActive = true第一个查询和isActive = false第二个查询.

任何有效生成因IQueryable参数而异的缓存键的建议/见解都将得到真正的体会.

感谢Sergey Barskiy分享EF CodeFirst缓存方案.

更新

我采用了遍历IQueryable表达式树的方法,目的是解析查询中使用的参数值.根据maxlego的建议,我扩展了System.Linq.Expressions.ExpressionVisitor类来访问我们感兴趣的表达式节点 - 在本例中是MemberExpression.更新的GetKey方法如下所示:

public static string GetKey<T>(IQueryable<T> query)
{
    var keyBuilder = new StringBuilder(query.ToString());
    var queryParamVisitor = new QueryParameterVisitor(keyBuilder);
    queryParamVisitor.GetQueryParameters(query.Expression);
    keyBuilder.Append("\n\r");
    keyBuilder.Append(typeof (T).AssemblyQualifiedName);

    return keyBuilder.ToString();
}
Run Code Online (Sandbox Code Playgroud)

这个QueryParameterVisitor课程的灵感来自Bryan WattsMarc Gravell对这个问题的答案,看起来像这样:

/// <summary>
/// <see cref="ExpressionVisitor"/> subclass which encapsulates logic to 
/// traverse an expression tree and resolve all the query parameter values
/// </summary>
internal class QueryParameterVisitor : ExpressionVisitor
{
    public QueryParameterVisitor(StringBuilder sb)
    {
        QueryParamBuilder = sb;
        Visited = new Dictionary<int, bool>();
    }

    protected StringBuilder QueryParamBuilder { get; set; }
    protected Dictionary<int, bool> Visited { get; set; }

    public StringBuilder GetQueryParameters(Expression expression)
    {
        Visit(expression);
        return QueryParamBuilder;
    }

    private static object GetMemberValue(MemberExpression memberExpression, Dictionary<int, bool> visited)
    {
        object value;
        if (!TryGetMemberValue(memberExpression, out value, visited))
        {
            UnaryExpression objectMember = Expression.Convert(memberExpression, typeof (object));
            Expression<Func<object>> getterLambda = Expression.Lambda<Func<object>>(objectMember);
            Func<object> getter = null;
            try
            {
                getter = getterLambda.Compile();
            }
            catch (InvalidOperationException)
            {
            }
            if (getter != null) value = getter();
        }
        return value;
    }

    private static bool TryGetMemberValue(Expression expression, out object value, Dictionary<int, bool> visited)
    {
        if (expression == null)
        {
            // used for static fields, etc
            value = null;
            return true;
        }
        // Mark this node as visited (processed)
        int expressionHash = expression.GetHashCode();
        if (!visited.ContainsKey(expressionHash))
        {
            visited.Add(expressionHash, true);
        }
        // Get Member Value, recurse if necessary
        switch (expression.NodeType)
        {
            case ExpressionType.Constant:
                value = ((ConstantExpression) expression).Value;
                return true;
            case ExpressionType.MemberAccess:
                var me = (MemberExpression) expression;
                object target;
                if (TryGetMemberValue(me.Expression, out target, visited))
                {
                    // instance target
                    switch (me.Member.MemberType)
                    {
                        case MemberTypes.Field:
                            value = ((FieldInfo) me.Member).GetValue(target);
                            return true;
                        case MemberTypes.Property:
                            value = ((PropertyInfo) me.Member).GetValue(target, null);
                            return true;
                    }
                }
                break;
        }
        // Could not retrieve value
        value = null;
        return false;
    }

    protected override Expression VisitMember(MemberExpression node)
    {
        // Only process nodes that haven't been processed before, this could happen because our traversal
        // is depth-first and will "visit" the nodes in the subtree before this method (VisitMember) does
        if (!Visited.ContainsKey(node.GetHashCode()))
        {
            object value = GetMemberValue(node, Visited);
            if (value != null)
            {
                QueryParamBuilder.Append("\n\r");
                QueryParamBuilder.Append(value.ToString());
            }
        }

        return base.VisitMember(node);
    }
}
Run Code Online (Sandbox Code Playgroud)

我仍在对缓存密钥生成进行一些性能分析,并希望它不是太昂贵(一旦我拥有它们,我将用结果更新问题).如果有人建议如何优化此过程,或者建议使用更有效的方法来生成随查询参数而变化的缓存键,我将保持打开问题.虽然这种方法产生了所需的输出,但它绝不是最佳的.