将 lambda 表达式传递给 LINQ Include() (SharePoint CSOM)

Question

我尝试过搜索，但似乎没有找到任何相关的答案。也许是因为我不确定如何提出我的问题。

我正在编写一个类库来帮助使用 SharePoint 的客户端对象模型。执行查询时，可以指定应加载返回对象的哪些属性，以避免不必要的网络流量。这是通过 Lambda 表达式完成的。

这是一个有效的例子：

public ListItemCollection GetItems(
                params Expression<Func<ListItemCollection, object>>[] retrievals)
{
   var query = new CamlQuery {...};
   ListItemCollection queryResults = _list.GetItems(query);
   ReloadClientObject(queryResults, retrievals)
   return queryResults;
}

public void ReloadClientObject<T>(T clientObject,
          params Expression<Func<T, object>>[] retrievals)
          where T : ClientObject
{
   _context.Load(clientObject, retrievals);
   _context.ExecuteQuery();
}

调用示例：

var items = GetItems(items => items.Include(
                                         item => item.Id,
                                         item => item.DisplayName));

一切都会好的。但我宁愿返回IEnumerable<ListItem> 而不是ListItemCollection 并且我想传递Expression<Func<ListItem, object>> 类型的参数而不是Expression<Func<ListItemCollection, object>>...根本不向用户介绍ListItemCollection。 所以我想将 Include() 调用移动到我的方法主体...这就是我卡住的地方。

这是我目前所得到的：

public IEnumerable<ListItem> GetItems(
                          params Expression<Func<ListItem, object>>[] retrievals)
{
   var query = new CamlQuery {...};
   ListItemCollection queryResults = _list.GetItems(query);
   ReloadClientObject(queryResults, items => items.Include(retrievals))
   _context.ExecuteQuery();
   return queryResults.AsEnumerable();
}

示例调用（更简洁更好）：

var items = GetItems(item => item.Id, item => item.DisplayName));

但是，这会在调用 Load() 方法时抛出 OperationNotSupportedException。

如有任何指导，我将不胜感激。谢谢！

Answer 1

直接在查询本身上调用Include，然后只使用LoadQuery而不是Load，来加载查询：

public IEnumerable<ListItem> GetItems(this ClientContext context,
    string listName,
    params Expression<Func<ListItem, object>>[] retrievals)
{
    var query = new CamlQuery();

    var queryResults = context.Web.Lists.GetByTitle(listName)
        .GetItems(query)
        .Include(retrievals);
    context.LoadQuery(queryResults);
    context.ExecuteQuery();
    return queryResults;
}

---

由于这对您不起作用（根据 your comment 声明您需要利用分页功能），我们需要做更多的工作。

所以我们在这里要做的是创建一个Expression<Func<ListItemCollection, ItemSelector, object>>，它将接受一个集合、一个选择器，并将其映射到一个对象。这里ItemSelector 是通过using ItemSelector = Expression<Func<ListItem, object>>; 定义的（因为试图使用Expression<Func<ListItemCollection, Expression<Func<ListItem, object>>, object>> 只是残忍和不寻常的惩罚）。我们可以这样定义：

Expression<Func<ListItemCollection, ItemSelector, object>> includeSelector =
    (items, selector) => items.Include(selector);

现在我们可以做的是编写一个Apply 方法，它可以接受一个带有两个参数的函数的表达式，用常量替换第二个参数的所有实例，从而创建一个少一个参数的方法。这是Apply 方法的定义：

public static Expression<Func<T1, TResult>> Apply<T1, T2, TResult>(
    this Expression<Func<T1, T2, TResult>> expression,
    T2 value)
{
    return Expression.Lambda<Func<T1, TResult>>(
        expression.Body.Replace(expression.Parameters[1],
            Expression.Constant(value))
        , expression.Parameters[0]);
}

这使用这个辅助方法将一个表达式的所有实例替换为另一个：

public static Expression Replace(this Expression expression,
    Expression searchEx, Expression replaceEx)
{
    return new ReplaceVisitor(searchEx, replaceEx).Visit(expression);
}

internal class ReplaceVisitor : ExpressionVisitor
{
    private readonly Expression from, to;
    public ReplaceVisitor(Expression from, Expression to)
    {
        this.from = from;
        this.to = to;
    }
    public override Expression Visit(Expression node)
    {
        return node == from ? to : base.Visit(node);
    }
}

所以现在我们可以使用这个includeSelector 表达式，并且对于我们数组中的每个项目选择器，将该选择器应用到这个函数。获取这些结果并将它们放入一个数组中会给我们一个 Expression<Func<ListItemCollection, object>>[]，这正是我们需要传递给 Load 的内容。

哇。这是实际执行此操作的最终代码：

public static IEnumerable<ListItem> GetItems(this ClientContext context,
    string listName,
    params Expression<Func<ListItem, object>>[] retrievals)
{
    var query = new CamlQuery();

    var queryResults = context.Web.Lists.GetByTitle(listName)
        .GetItems(query);

    Expression<Func<ListItemCollection, ItemSelector, object>> includeSelector =
        (items, selector) => items.Include(selector);

    context.Load(queryResults, retrievals
        .Select(selector => includeSelector.Apply(selector))
        .ToArray());
    context.ExecuteQuery();
    return queryResults;
}