Winform中Treeview实现按需加载的方法

一、Winform中Treeview实现按需加载的方法

Winform中的Treeview控件非常适合用于显示树形结构的数据，但如果树的层次比较多或者数据比较庞大，一次性将所有数据全部加载到TreeView中显然不太现实，这时就需要实现按需加载的功能，即当需要展开树节点时，才动态地加载该节点下的子节点。

实现按需加载需要以下几个步骤：

1.设置TreeView的属性“VirtualMode”为True。这样TreeView就会触发虚拟模式的事件，我们可以在这些事件中实现按需加载的逻辑。

2.处理TreeView的BeforeExpand事件。在这个事件中需要判断当前的节点是否需要加载子节点，并将该节点的HasChildren属性设置为true或false。如果需要加载子节点，则需要在这个事件中调用TreeView的方法Nodes.Add，为当前节点添加子节点。

3.处理TreeView的RetrieveVirtualItem事件。在这个事件中需要返回虚拟项，也就是当前节点的数据对象，这个对象必须实现TreeView控件的IHierarchicalData接口。在实现这个接口的GetChildren()方法中可以返回当前节点的子节点数据。

下面我们来看一个具体的实现示例。

二、示例1：从本地数据源加载节点数据

假设我们有一个本地的XML文件，其中包含了一些树形结构的数据。我们需要从这个XML文件中动态地加载数据，并实现TreeView的按需加载功能。

首先，在Form的构造函数中加载XML数据，将其存储到一个List集合中：

public partial class MainForm : Form
{
    // 存储从XML中加载的树节点数据
    private List<TreeNodeData> dataList;

    public MainForm()
    {
        InitializeComponent();

        // 加载XML数据
        dataList = LoadDataFromXml();
    }

    // 从XML文件中加载树节点数据
    private List<TreeNodeData> LoadDataFromXml()
    {
        List<TreeNodeData> dataList = new List<TreeNodeData>();

        XmlDocument xmlDoc = new XmlDocument();
        xmlDoc.Load("data.xml");

        foreach (XmlNode node in xmlDoc.SelectNodes("//node"))
        {
            TreeNodeData data = new TreeNodeData();
            data.Name = node.Attributes["name"].Value;
            data.ParentName = node.Attributes["parent"].Value;
            dataList.Add(data);
        }

        return dataList;
    }
}

接下来，在TreeView的BeforeExpand事件中添加按需加载的逻辑：

private void treeView1_BeforeExpand(object sender, TreeViewCancelEventArgs e)
{
    TreeNodeData parentData = e.Node.Tag as TreeNodeData;
    if (parentData == null) return;

    if (!parentData.HasLoadedChildren)
    {
        // 加载该节点的子节点
        LoadChildren(e.Node);
        parentData.HasLoadedChildren = true;
    }
}

// 加载指定节点的子节点
private void LoadChildren(TreeNode parentNode)
{
    TreeNodeData parentData = parentNode.Tag as TreeNodeData;
    if (parentData == null) return;

    foreach (TreeNodeData childData in dataList.Where(d => d.ParentName == parentData.Name))
    {
        TreeNode childNode = new TreeNode(childData.Name);
        childNode.Tag = childData;
        // 设置子节点是否包含子节点
        childNode.Nodes.Add(new TreeNode());
        parentNode.Nodes.Add(childNode);
    }
}

在LoadChildren方法中，我们根据父节点的名称从数据集合中查找所有子节点数据，然后依次将子节点添加到TreeView中。值得注意的是，每个子节点先用一个空的TreeNode表示，这是由于在下一步实现的RetrieveVirtualItem事件中会对这个节点进行数据绑定。

最后，在TreeView的RetrieveVirtualItem事件中添加数据绑定的逻辑：

private void treeView1_RetrieveVirtualItem(object sender, RetrieveVirtualItemEventArgs e)
{
    TreeNodeData data = dataList[e.ItemIndex];
    e.Item = new TreeNode(data.Name);
    e.Item.Tag = data;

    if (!data.HasLoadedChildren)
    {
        // 设置节点是否包含子节点
        e.Item.Nodes.Add(new TreeNode());
    }
}

在RetrieveVirtualItem事件中，我们根据节点的索引值，获取对应的数据项，然后创建一个新的TreeNode对象，并将其与数据对象关联起来。

在这个示例中，我们实现了按需加载功能，并且将树节点数据存储在本地的XML文件中。但如果数据量比较大，每次加载数据都要扫描整个XML文件，这样的效率显然是低下的。因此，我们需要寻找一种更高效的数据加载方案。

三、示例2：从远程数据源异步加载节点数据

在实际应用中，数据往往存储在分布式的服务器中，我们需要通过网络获取节点数据。以下是一个示例，演示了如何从远程数据源中异步加载节点数据，并实现TreeView的按需加载功能。

首先，我们需要在TreeView的BeforeExpand事件中添加异步加载节点数据的逻辑：

private async void treeView1_BeforeExpand(object sender, TreeViewCancelEventArgs e)
{
    TreeNodeData parentData = e.Node.Tag as TreeNodeData;
    if (parentData == null) return;

    if (!parentData.HasLoadedChildren)
    {
        // 加载该节点的子节点
        await LoadChildrenAsync(e.Node);
        parentData.HasLoadedChildren = true;
    }
}

在这个示例中，我们使用了C# 5.0引入的async和await关键字来实现异步加载数据。在LoadChildrenAsync方法中，我们使用HttpClient类从远程服务器获取数据：

private async Task LoadChildrenAsync(TreeNode parentNode)
{
    TreeNodeData parentData = parentNode.Tag as TreeNodeData;
    if (parentData == null) return;

    using (HttpClient client = new HttpClient())
    {
        var response = await client.GetAsync($"http://localhost:8080/findChildren?name={parentData.Name}");
        if (response.IsSuccessStatusCode)
        {
            var json = await response.Content.ReadAsStringAsync();
            var children = JsonConvert.DeserializeObject<List<TreeNodeData>>(json);

            foreach (TreeNodeData childData in children)
            {
                TreeNode childNode = new TreeNode(childData.Name);
                childNode.Tag = childData;
                // 设置子节点是否包含子节点
                childNode.Nodes.Add(new TreeNode());
                parentNode.Nodes.Add(childNode);
            }
        }
    }
}

在这个方法中，我们使用了HttpClient类向远程服务器发送HTTP请求，获取当前节点的子节点数据。当数据返回时，我们使用Json.NET将字符串数据转换为TreeNodeData类型，然后根据数据创建子节点，并将这些节点添加到TreeView中。

最后，在TreeView的RetrieveVirtualItem事件中添加数据绑定的逻辑：

private void treeView1_RetrieveVirtualItem(object sender, RetrieveVirtualItemEventArgs e)
{
    TreeNodeData data = dataList[e.ItemIndex];
    e.Item = new TreeNode(data.Name);
    e.Item.Tag = data;

    if (!data.HasLoadedChildren)
    {
        // 加载该节点的子节点
        LoadChildrenAsync(e.Item);
        data.HasLoadedChildren = true;
        // 设置节点是否包含子节点
        e.Item.Nodes.Add(new TreeNode());
    }
}

在这个示例中，我们将LoadChildrenAsync方法在RetrieveVirtualItem事件中调用。当调用这个方法时，我们同时将当前节点的HasLoadedChildren属性设为true，并在TreeView中添加一个空的子节点。这样，在TreeView中展开这个节点时，就不会再次触发LoadChildrenAsync方法了，而是直接通过TreeView的BeforeExpand事件获取已有的子节点数据。

通过以上两个示例，我们可以看到如何实现TreeView的按需加载功能。无论是从本地数据源加载节点数据还是从远程服务器异步加载节点数据，我们都可以通过TreeView的虚拟模式机制，实现高效的树形结构显示。