c# - 修改 IQueryable.Include() 的表达式树，为 join 添加条件

Question

基本上，我想实现一个存储库，它甚至可以通过导航属性过滤所有软删除的记录。所以我有一个基本实体，类似这样的东西:

public abstract class Entity
{
    public int Id { get; set; }

    public bool IsDeleted { get; set; }

    ...
}

还有一个存储库:

public class BaseStore<TEntity> : IStore<TEntity> where TEntity : Entity
{
    protected readonly ApplicationDbContext db;

    public IQueryable<TEntity> GetAll()
    {
        return db.Set<TEntity>().Where(e => !e.IsDeleted)
            .InterceptWith(new InjectConditionVisitor<Entity>(entity => !entity.IsDeleted));
    }

    public IQueryable<TEntity> GetAll(Expression<Func<TEntity, bool>> predicate)
    {
        return GetAll().Where(predicate);
    }

    public IQueryable<TEntity> GetAllWithDeleted()
    {
        return db.Set<TEntity>();
    }

    ...
}

InterceptWith 函数来自这个项目:https://github.com/davidfowl/QueryInterceptor和 https://github.com/StefH/QueryInterceptor (与异步实现相同)

IStore<Project> 的用法看起来像:

var project = await ProjectStore.GetAll()
          .Include(p => p.Versions).SingleOrDefaultAsync(p => p.Id == projectId);

我实现了一个 ExpressionVisitor:

internal class InjectConditionVisitor<T> : ExpressionVisitor
{
    private Expression<Func<T, bool>> queryCondition;

    public InjectConditionVisitor(Expression<Func<T, bool>> condition)
    {
        queryCondition = condition;
    }

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

但这就是我卡住的地方。我在 Visit 函数中放置了一个断点，以查看我得到了什么表达式，以及我什么时候应该做一些厚颜无耻的事情，但它永远不会到达我的树的 Include(p => p.Versions) 部分。

我看到了一些其他可能有效的解决方案，但那些是“永久的”，例如 EntityFramework.Filters似乎适用于大多数用例，但您必须在配置 DbContext 时添加过滤器 - 但是，您可以禁用过滤器，但我不想为每个查询禁用和重新启用过滤器。另一个类似的解决方案是订阅 ObjectContext 的 ObjectMaterialized 事件，但我也不喜欢它。

我的目标是“捕获”访问者中的包含项并修改表达式树以向连接添加另一个条件，该条件仅在您使用商店的 GetAll 函数之一时才检查记录的 IsDeleted 字段。任何帮助将不胜感激!

更新

我的存储库的目的是隐藏基础实体的一些基本行为——它还包含“创建/上次修改者”、“创建/上次修改日期”、时间戳等。我的 BLL 通过这个存储库获取所有数据所以它不需要担心这些，商店会处理所有的事情。也有可能从 BaseStore 继承。对于特定的类(然后我配置的 DI 会将继承的类注入(inject)到 IStore<Project> 如果它存在)，您可以在其中添加特定的行为。比如你修改了一个项目，你需要添加这些修改历史，那么你就把这个添加到继承store的update函数中即可。

当您查询具有导航属性的类(所以任何类 :D )时，问题就开始了。有两个具体实体:

  public class Project : Entity 
  {
      public string Name { get; set; }

      public string Description { get; set; }

      public virtual ICollection<Platform> Platforms { get; set; }

      //note: this version is not historical data, just the versions of the project, like: 1.0.0, 1.4.2, 2.1.0, etc.
      public virtual ICollection<ProjectVersion> Versions { get; set; }
  }

  public class Platform : Entity 
  {
      public string Name { get; set; }

      public virtual ICollection<Project> Projects { get; set; }

      public virtual ICollection<TestFunction> TestFunctions { get; set; }
  }

  public class ProjectVersion : Entity 
  {
      public string Code { get; set; }

      public virtual Project Project { get; set; }
  }

所以如果我想列出项目的版本，我调用商店:await ProjectStore.GetAll().Include(p => p.Versions).SingleOrDefaultAsync(p => p.Id == projectId) .我不会得到删除的项目，但如果项目存在，它会返回所有相关的版本，包括删除的版本。在这种特定情况下，我可以从另一侧开始并调用 ProjectVersionStore，但如果我想通过 2+ 个导航属性进行查询，那么游戏就结束了:)<​​/p>

预期的行为是:如果我将版本包含到项目中，它应该只查询未删除的版本 - 所以生成的 sql 连接应该包含 [Versions].[IsDeleted] = FALSE条件也。对于像 Include(project => project.Platforms.Select(platform => platform.TestFunctions)) 这样的复杂包含，它甚至更加复杂。 .

我尝试这样做的原因是我不想将 BLL 中的所有 Include 重构为其他内容。那是懒惰的部分:)另一个是我想要一个透明的解决方案，我不希望 BLL 知道所有这些。如果不是绝对必要，接口(interface)应该保持不变。我知道这只是一个扩展方法，但这种行为应该在商店层。

Answer 1

您使用的 include 方法调用方法 QueryableExtensions.Include(source, path1) 将表达式转换为字符串路径。这就是 include 方法的作用:

public static IQueryable<T> Include<T, TProperty>(this IQueryable<T> source, Expression<Func<T, TProperty>> path)
{
  Check.NotNull<IQueryable<T>>(source, "source");
  Check.NotNull<Expression<Func<T, TProperty>>>(path, "path");
  string path1;
  if (!DbHelpers.TryParsePath(path.Body, out path1) || path1 == null)
    throw new ArgumentException(Strings.DbExtensions_InvalidIncludePathExpression, "path");
  return QueryableExtensions.Include<T>(source, path1);
}

因此，您的表达式看起来像这样(检查表达式中的“Include”或“IncludeSpan”方法):

 value(System.Data.Entity.Core.Objects.ObjectQuery`1[TEntity]).MergeAs(AppendOnly)
   .IncludeSpan(value(System.Data.Entity.Core.Objects.Span))

您应该 Hook VisitMethodCall 来添加您的表达式:

internal class InjectConditionVisitor<T> : ExpressionVisitor
{
    private Expression<Func<T, bool>> queryCondition;

    protected override Expression VisitMethodCall(MethodCallExpression node)
    {
        Expression expression = node;
        if (node.Method.Name == "Include" || node.Method.Name == "IncludeSpan")
        {
            // DO something here! Let just add an OrderBy for fun

            // LAMBDA: x => x.[PropertyName]
            var parameter = Expression.Parameter(typeof(T), "x");
            Expression property = Expression.Property(parameter, "ColumnInt");
            var lambda = Expression.Lambda(property, parameter);

            // EXPRESSION: expression.[OrderMethod](x => x.[PropertyName])
            var orderByMethod = typeof(Queryable).GetMethods().First(x => x.Name == "OrderBy" && x.GetParameters().Length == 2);
            var orderByMethodGeneric = orderByMethod.MakeGenericMethod(typeof(T), property.Type);
            expression = Expression.Call(null, orderByMethodGeneric, new[] { expression, Expression.Quote(lambda) });
        }
        else
        {
            expression = base.VisitMethodCall(node);
        }

        return expression;
    }
}

David Fowl 的 QueryInterceptor 项目不支持“Include”。 Entity Framework 尝试使用反射查找“Include”方法，如果未找到(就是这种情况)则返回当前查询。

免责声明:我是项目的所有者EF+ .

我添加了一个支持“包含”的 QueryInterceptor 功能来回答您的问题。该功能尚不可用，因为尚未添加单元测试，但您可以下载并试用源代码:Query Interceptor Source

如果您有任何问题，请直接与我联系(电子邮件位于我的 GitHub 主页底部)，否则这将开始偏离主题。

请注意，“Include”方法通过隐藏一些先前的表达式来修改表达式。因此，有时很难理解引擎盖下到底发生了什么。

我的项目还包含一个查询过滤器功能，我认为它具有更大的灵 active 。

---

编辑:根据更新的要求添加工作示例

这是您可以用于您的要求的起始代码:

public IQueryable<TEntity> GetAll()
{
    var conditionVisitor = new InjectConditionVisitor<TEntity>("Versions", db.Set<TEntity>.Provider, x => x.Where(y => !y.IsDeleted));
    return db.Set<TEntity>().Where(e => !e.IsDeleted).InterceptWith(conditionVisitor);
}

var project = await ProjectStore.GetAll().Include(p => p.Versions).SingleOrDefaultAsync(p => p.Id == projectId);

internal class InjectConditionVisitor<T> : ExpressionVisitor
{
    private readonly string NavigationString;
    private readonly IQueryProvider Provider;
    private readonly Func<IQueryable<T>, IQueryable<T>> QueryCondition;

    public InjectConditionVisitor(string navigationString, IQueryProvider provder , Func<IQueryable<T>, IQueryable<T>> queryCondition)
    {
        NavigationString = navigationString;
        Provider = provder;
        QueryCondition = queryCondition;
    }

    protected override Expression VisitMethodCall(MethodCallExpression node)
    {
        Expression expression = node;

        bool isIncludeSpanValid = false;

        if (node.Method.Name == "IncludeSpan")
        {
            var spanValue = (node.Arguments[0] as ConstantExpression).Value;

            // The System.Data.Entity.Core.Objects.Span class and SpanList is internal, let play with reflection!
            var spanListProperty = spanValue.GetType().GetProperty("SpanList", BindingFlags.Public | BindingFlags.NonPublic | BindingFlags.Instance);
            var spanList = (IEnumerable)spanListProperty.GetValue(spanValue);

            foreach (var span in spanList)
            {
                var spanNavigationsField = span.GetType().GetField("Navigations", BindingFlags.Public | BindingFlags.NonPublic | BindingFlags.Instance);
                var spanNavigation = (List<string>)spanNavigationsField.GetValue(span);

                if (spanNavigation.Contains(NavigationString))
                {
                    isIncludeSpanValid = true;
                    break;
                }
            }
        }

        if ((node.Method.Name == "Include" && (node.Arguments[0] as ConstantExpression).Value.ToString() == NavigationString)
            || isIncludeSpanValid)
        {

            // CREATE a query from current expression
            var query = Provider.CreateQuery<T>(expression);

            // APPLY the query condition
            query = QueryCondition(query);

            // CHANGE the query expression
            expression = query.Expression;
        }
        else
        {
            expression = base.VisitMethodCall(node);
        }

        return expression;
    }
}

---

编辑:回答子问题

Include 和 IncludeSpan 的区别

据我了解

IncludeSpan:当原始查询尚未被 LINQ 方法修改时出现。

Include:当原始查询已被 LINQ 方法修改时出现(您不再看到以前的表达式)

-- Expression: {value(System.Data.Entity.Core.Objects.ObjectQuery`1[Z.Test.EntityFramework.Plus.Association_Multi_OneToMany_Left]).MergeAs(AppendOnly).IncludeSpan(value(System.Data.Entity.Core.Objects.Span))}
var q = ctx.Association_Multi_OneToMany_Lefts.Include(x => x.Right1s).Include(x => x.Right2s);


-- Expression: {value(System.Data.Entity.Core.Objects.ObjectQuery`1[Z.Test.EntityFramework.Plus.Association_Multi_OneToMany_Left]).Include("Right2s")}
var q = ctx.Association_Multi_OneToMany_Lefts.Include(x => x.Right1s).Where(x => x.ColumnInt > 10).Include(x => x.Right2s);

如何包含和过滤相关实体

Include 不允许您过滤相关实体。您可以在这篇文章中找到 2 个解决方案:EF. How to include only some sub results in a model?

• 一个涉及使用投影
• 一个涉及使用我的库中的 EF+ Query IncludeFilter