|
| 1 | +# TreeHelper 树形数据辅助类 |
| 2 | + |
| 3 | +`TreeHelper` 是一个功能强大的树形数据操作工具类,提供了平面数据与树形数据之间的相互转换功能,以及树形数据的遍历操作。**无需实现特定接口,完全兼容现有代码**。 |
| 4 | + |
| 5 | +## 功能特性 |
| 6 | + |
| 7 | +- ✅ **平面数据转树形数据** - 将扁平的父子关系数据转换为树形结构 |
| 8 | +- ✅ **树形数据转平面数据** - 将树形结构数据转换为扁平列表 |
| 9 | +- ✅ **树形数据遍历** - 非递归的前序遍历算法 |
| 10 | +- ✅ **泛型支持** - 支持 int、string、Guid 等各种类型的节点ID |
| 11 | +- ✅ **高性能** - 使用字典查找,时间复杂度 O(n) |
| 12 | +- ✅ **非递归实现** - 避免栈溢出,适合深层树结构 |
| 13 | +- ✅ **完全兼容** - 无需实现接口,适配任何现有类 |
| 14 | +- ✅ **完整测试** - 100% 单元测试覆盖 |
| 15 | + |
| 16 | +## 核心方法 |
| 17 | + |
| 18 | +### 1. ToTree<T, TKey> - 平面数据转树形数据 |
| 19 | + |
| 20 | +将具有父子关系的平面数据转换为树形结构。 |
| 21 | + |
| 22 | +```csharp |
| 23 | +public static IList<T> ToTree<T, TKey>( |
| 24 | + IEnumerable<T> flatData, |
| 25 | + Func<T, TKey> getId, |
| 26 | + Func<T, TKey> getParentId, |
| 27 | + Func<T, IList<T>> getChildren, |
| 28 | + Action<T, IList<T>> setChildren, |
| 29 | + TKey rootId = default(TKey)) |
| 30 | +``` |
| 31 | + |
| 32 | +**参数说明:** |
| 33 | +- `flatData`: 平面数据列表 |
| 34 | +- `getId`: 获取节点ID的委托函数 |
| 35 | +- `getParentId`: 获取父节点ID的委托函数 |
| 36 | +- `getChildren`: 获取子节点集合的委托函数 |
| 37 | +- `setChildren`: 设置子节点集合的委托函数 |
| 38 | +- `rootId`: 根节点ID,默认为 `default(TKey)` |
| 39 | + |
| 40 | +**返回值:** |
| 41 | +- 树形数据列表(根节点集合) |
| 42 | + |
| 43 | +### 2. ToFlat<T> - 树形数据转平面数据 |
| 44 | + |
| 45 | +将树形结构数据转换为扁平列表,支持深度优先遍历。 |
| 46 | + |
| 47 | +```csharp |
| 48 | +public static IList<T> ToFlat<T>( |
| 49 | + IEnumerable<T> treeData, |
| 50 | + Func<T, IEnumerable<T>> getChildren, |
| 51 | + Func<T, T> createFlatNode) |
| 52 | +``` |
| 53 | + |
| 54 | +**参数说明:** |
| 55 | +- `treeData`: 树形数据列表 |
| 56 | +- `getChildren`: 获取子节点集合的委托函数 |
| 57 | +- `createFlatNode`: 创建平面节点的委托函数 |
| 58 | + |
| 59 | +**返回值:** |
| 60 | +- 平面数据列表 |
| 61 | + |
| 62 | +### 3. TraverseWithStack<T> - 树形数据遍历 |
| 63 | + |
| 64 | +使用堆栈实现树的前序遍历(非递归)。 |
| 65 | + |
| 66 | +```csharp |
| 67 | +public static void TraverseWithStack<T>( |
| 68 | + T root, |
| 69 | + Func<T, IEnumerable<T>> getChildNodes, |
| 70 | + Action<T> processNode) |
| 71 | +``` |
| 72 | + |
| 73 | +**参数说明:** |
| 74 | +- `root`: 根节点 |
| 75 | +- `getChildNodes`: 获取节点子节点的委托函数 |
| 76 | +- `processNode`: 处理节点的委托函数 |
| 77 | + |
| 78 | +## 使用示例 |
| 79 | + |
| 80 | +### 基本用法 |
| 81 | + |
| 82 | +```csharp |
| 83 | +// 1. 定义树节点类(无需实现任何接口) |
| 84 | +public class TreeNode |
| 85 | +{ |
| 86 | + public int Id { get; set; } |
| 87 | + public int ParentId { get; set; } |
| 88 | + public string Name { get; set; } |
| 89 | + public IList<TreeNode> Children { get; set; } = new List<TreeNode>(); |
| 90 | +} |
| 91 | + |
| 92 | +// 2. 创建平面数据 |
| 93 | +var flatData = new List<TreeNode> |
| 94 | +{ |
| 95 | + new TreeNode { Id = 1, ParentId = 0, Name = "根节点1" }, |
| 96 | + new TreeNode { Id = 2, ParentId = 0, Name = "根节点2" }, |
| 97 | + new TreeNode { Id = 3, ParentId = 1, Name = "子节点1-1" }, |
| 98 | + new TreeNode { Id = 4, ParentId = 1, Name = "子节点1-2" }, |
| 99 | + new TreeNode { Id = 5, ParentId = 2, Name = "子节点2-1" } |
| 100 | +}; |
| 101 | + |
| 102 | +// 3. 平面数据转树形数据 |
| 103 | +var treeData = TreeHelper.ToTree( |
| 104 | + flatData, |
| 105 | + x => x.Id, // 获取ID |
| 106 | + x => x.ParentId, // 获取父ID |
| 107 | + x => x.Children, // 获取子节点集合 |
| 108 | + (x, children) => x.Children = children, // 设置子节点集合 |
| 109 | + 0 // 根节点ID |
| 110 | +); |
| 111 | + |
| 112 | +// 4. 树形数据转平面数据 |
| 113 | +var flatResult = TreeHelper.ToFlat( |
| 114 | + treeData, |
| 115 | + x => x.Children, // 获取子节点集合 |
| 116 | + x => new TreeNode // 创建平面节点 |
| 117 | + { |
| 118 | + Id = x.Id, |
| 119 | + ParentId = x.ParentId, |
| 120 | + Name = x.Name, |
| 121 | + Children = null |
| 122 | + } |
| 123 | +); |
| 124 | + |
| 125 | +// 5. 树形数据遍历 |
| 126 | +TreeHelper.TraverseWithStack( |
| 127 | + treeData.First(), |
| 128 | + x => x.Children, |
| 129 | + x => Console.WriteLine($"处理节点: {x.Name}") |
| 130 | +); |
| 131 | +``` |
| 132 | + |
| 133 | +### 高级用法 |
| 134 | + |
| 135 | +#### 支持不同属性名 |
| 136 | + |
| 137 | +```csharp |
| 138 | +public class MenuItem |
| 139 | +{ |
| 140 | + public string MenuId { get; set; } |
| 141 | + public string ParentMenuId { get; set; } |
| 142 | + public string MenuName { get; set; } |
| 143 | + public List<MenuItem> SubMenus { get; set; } = new List<MenuItem>(); |
| 144 | +} |
| 145 | + |
| 146 | +// 使用自定义属性名 |
| 147 | +var menuTree = TreeHelper.ToTree( |
| 148 | + flatMenus, |
| 149 | + x => x.MenuId, // 自定义ID属性 |
| 150 | + x => x.ParentMenuId, // 自定义父ID属性 |
| 151 | + x => x.SubMenus, // 自定义子节点属性 |
| 152 | + (x, children) => x.SubMenus = children, |
| 153 | + "0" // 字符串类型的根ID |
| 154 | +); |
| 155 | +``` |
| 156 | + |
| 157 | +#### 支持不同数据类型 |
| 158 | + |
| 159 | +```csharp |
| 160 | +public class Category |
| 161 | +{ |
| 162 | + public Guid CategoryId { get; set; } |
| 163 | + public Guid? ParentCategoryId { get; set; } |
| 164 | + public string CategoryName { get; set; } |
| 165 | + public IList<Category> SubCategories { get; set; } = new List<Category>(); |
| 166 | +} |
| 167 | + |
| 168 | +// 使用Guid类型 |
| 169 | +var categoryTree = TreeHelper.ToTree( |
| 170 | + flatCategories, |
| 171 | + x => x.CategoryId, |
| 172 | + x => x.ParentCategoryId ?? Guid.Empty, |
| 173 | + x => x.SubCategories, |
| 174 | + (x, children) => x.SubCategories = children, |
| 175 | + Guid.Empty |
| 176 | +); |
| 177 | +``` |
| 178 | + |
| 179 | +## 性能特点 |
| 180 | + |
| 181 | +- **时间复杂度**: O(n) - 使用字典进行快速查找 |
| 182 | +- **空间复杂度**: O(n) - 需要额外的字典存储空间 |
| 183 | +- **非递归实现**: 避免栈溢出,适合深层树结构 |
| 184 | +- **深度优先遍历**: 保证数据顺序的一致性 |
| 185 | + |
| 186 | +## 支持的数据类型 |
| 187 | + |
| 188 | +| 类型 | 示例 | 说明 | |
| 189 | +|------|------|------| |
| 190 | +| `int` | `1, 2, 3` | 整数ID,最常用 | |
| 191 | +| `string` | `"1", "2", "3"` | 字符串ID,支持复杂格式 | |
| 192 | +| `Guid` | `Guid.NewGuid()` | GUID ID,全局唯一 | |
| 193 | +| `long` | `1L, 2L, 3L` | 长整型ID | |
| 194 | +| 其他 | 任何实现了相等比较的类型 | 自定义类型 | |
| 195 | + |
| 196 | +## 最佳实践 |
| 197 | + |
| 198 | +### 1. 数据完整性检查 |
| 199 | + |
| 200 | +```csharp |
| 201 | +// 转换前检查数据完整性 |
| 202 | +var orphanNodes = flatData.Where(x => |
| 203 | + !Equals(x.ParentId, rootId) && |
| 204 | + !flatData.Any(p => Equals(p.Id, x.ParentId)) |
| 205 | +).ToList(); |
| 206 | + |
| 207 | +if (orphanNodes.Any()) |
| 208 | +{ |
| 209 | + Console.WriteLine($"发现孤立节点: {string.Join(", ", orphanNodes.Select(x => x.Id))}"); |
| 210 | +} |
| 211 | +``` |
| 212 | + |
| 213 | +### 2. 性能优化 |
| 214 | + |
| 215 | +```csharp |
| 216 | +// 对于大数据集,考虑分批处理 |
| 217 | +var batchSize = 1000; |
| 218 | +var batches = flatData.Chunk(batchSize); |
| 219 | +var allTrees = new List<TreeNode>(); |
| 220 | + |
| 221 | +foreach (var batch in batches) |
| 222 | +{ |
| 223 | + var batchTree = TreeHelper.ToTree(batch, ...); |
| 224 | + allTrees.AddRange(batchTree); |
| 225 | +} |
| 226 | +``` |
| 227 | + |
| 228 | +### 3. 错误处理 |
| 229 | + |
| 230 | +```csharp |
| 231 | +try |
| 232 | +{ |
| 233 | + var treeData = TreeHelper.ToTree(flatData, ...); |
| 234 | +} |
| 235 | +catch (Exception ex) |
| 236 | +{ |
| 237 | + // 处理转换异常 |
| 238 | + Console.WriteLine($"树形数据转换失败: {ex.Message}"); |
| 239 | +} |
| 240 | +``` |
| 241 | + |
| 242 | +## 注意事项 |
| 243 | + |
| 244 | +1. **无需实现接口**: 完全兼容现有代码,无需修改任何类定义 |
| 245 | +2. **数据一致性**: 确保 `ParentId` 与某个节点的 `Id` 对应,或为根节点ID |
| 246 | +3. **内存管理**: 转换过程会创建新对象,注意内存使用 |
| 247 | +4. **空值处理**: 委托函数必须正确处理 null 值情况 |
| 248 | +5. **循环引用**: 避免数据中存在循环引用,可能导致无限递归 |
| 249 | + |
| 250 | +## 相关文件 |
| 251 | + |
| 252 | +- `TreeHelper.cs` - 核心实现类 |
| 253 | +- `TreeExample.cs` - 详细使用示例 |
| 254 | +- `TreeHelperTests.cs` - 完整单元测试 |
| 255 | +- `TreeHelper.README.md` - 本文档 |
| 256 | + |
| 257 | +## 更新日志 |
| 258 | + |
| 259 | +- **v1.0.0** - 初始版本,支持基本的树形数据转换 |
| 260 | +- **v1.1.0** - 移除接口依赖,使用委托函数方式,提高兼容性 |
| 261 | +- **v1.2.0** - 添加树形数据遍历功能,完善文档和测试 |
0 commit comments