RavenDB递归Include查询：如何加载多层级树形结构节点？

嗨，我明白你遇到的问题——RavenDB的Include默认只能处理一级关联，要加载多层树形结构确实需要点技巧。不过别担心，我们可以通过递归Map-Reduce索引来实现从顶层节点一次性加载所有关联的子节点，下面一步步来给你讲清楚：

第一步：创建递归索引捕获层级关系 #

首先我们需要定义一个索引，用来递归遍历你的Node树形结构，记录每个顶层节点对应的所有后代节点ID。这样查询时就能一次性拿到所有需要加载的文档ID，再结合Include批量加载。

以下是C#的索引示例：

public class Nodes_RecursiveHierarchy : AbstractIndexCreationTask<Node>
{
    public class Result
    {
        public string AncestorId { get; set; }
        public string NodeId { get; set; }
    }

    public Nodes_RecursiveHierarchy()
    {
        // Map阶段：处理每个节点，输出自身和直接子节点的关联
        Map = nodes => from node in nodes
                       select new 
                       {
                           AncestorId = node.Id,
                           NodeId = node.Id
                       }
                       // 递归处理子节点，将子节点关联到当前节点作为祖先
                       .Concat(from node in nodes
                               from childId in node.ChildrenIds
                               select new 
                               {
                                   AncestorId = node.Id,
                                   NodeId = childId
                               });

        // Reduce阶段：聚合所有祖先对应的后代节点，去重
        Reduce = results => from result in results
                            group result by result.AncestorId into g
                            select new 
                            {
                                AncestorId = g.Key,
                                NodeId = g.Select(x => x.NodeId).Distinct()
                            };

        // 存储NodeId的集合，方便后续查询
        StoreAllFields(FieldStorage.Yes);
    }
}

这个索引的逻辑是：

• Map阶段：每个节点先输出自身（祖先ID=自身ID，节点ID=自身ID），然后再输出自身作为祖先，每个子节点作为关联节点。
• Reduce阶段：将同一个祖先下的所有节点ID聚合起来，去重后得到该祖先对应的所有后代（包括自身）ID集合。

第二步：使用索引查询并加载整个树形结构 #

有了索引之后，我们可以先查询顶层节点对应的所有关联节点ID，然后用Include的等效方式一次性加载所有文档：

using (var session = store.OpenSession())
{
    // 假设顶层节点ID是"nodes/1"
    var topLevelNodeId = "nodes/1";

    // 第一步：通过索引获取该顶层节点对应的所有关联节点ID
    var allNodeIds = session.Query<Nodes_RecursiveHierarchy.Result, Nodes_RecursiveHierarchy>()
        .Where(x => x.AncestorId == topLevelNodeId)
        .SelectMany(x => x.NodeId)
        .ToList();

    // 第二步：加载所有节点，一次性获取所有文档，避免N+1查询
    var allNodes = session.Load<Node>(allNodeIds).Values.ToList();

    // 现在allNodes包含了顶层节点和所有层级的子节点，你可以自行构建树形结构
}

关于“基于索引属性执行Include”的说明 #

你问到能不能直接基于索引属性做Include——很遗憾，RavenDB的Include只能针对文档ID引用，而索引里存储的是计算后的字段（比如我们索引里的NodeId集合），并不是直接的文档引用。所以我们需要先通过索引拿到所有需要的文档ID，再用Load结合ID列表来批量加载，这样效果和Include一致，都是一次请求获取所有文档。

另一种简化方法：使用LoadStartingWith（可选） #

如果你的Node文档ID是有层级前缀的（比如nodes/1、nodes/1/child1、nodes/1/child1/grandchild1），那可以直接用LoadStartingWith来加载所有子节点：

var allNodes = session.LoadStartingWith<Node>("nodes/1/")
    .Include("nodes/1") // 别忘了包含顶层节点本身
    .ToList();

但这种方法依赖ID的命名规则，如果你的ID是随机生成的（比如nodes/abc123），那还是递归索引的方法更可靠。

注意事项 #

• 确保索引已经部署到RavenDB服务器上，可以通过IndexCreation.CreateIndexes(typeof(Nodes_RecursiveHierarchy).Assembly, store)来创建索引。
• 当节点的ChildrenIds发生变化时，RavenDB会自动更新索引，所以不需要手动维护索引数据。
• 如果树形结构非常大，建议考虑分页或者按需加载，但对于大多数场景，上面的方法已经足够高效。

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