本文記錄一個可展開/收合的多層級樹形菜單實作。做法參考了他人的分享,但因為自己的資料欄位與範例不同,所以重新整理了一份更通用的版本,希望對需要類似功能的讀者有所幫助。
後端回傳的清單,每一筆至少要有三個欄位:父節點 ID、自身 ID、自身名稱。此外我們自己再加一個 expand 旗標,用來記錄該節點目前是展開還是收合。
@property (nonatomic, strong) NSString *itemParentId; // 父節點 id @property (nonatomic, strong) NSString *itemId; // 本節點 id @property (nonatomic, strong) NSString *itemName; // 本節點名稱 @property (nonatomic, assign) BOOL expand; // 是否處於展開狀態
讓 Node 繼承自 NSObject,並提供一個便利初始化器。這裡刻意把商業欄位(例如索引值、額外識別碼)也保留下來,實務上只要照自己的需求增減即可。
// Node.h
@interface Node : NSObject
@property (nonatomic, strong) NSString *itemParentId;
@property (nonatomic, strong) NSString *itemId;
@property (nonatomic, strong) NSString *itemName;
@property (nonatomic, strong) NSString *itemIndex; // 該節點在同層菜單中的索引
@property (nonatomic, assign) BOOL expand;
@property (nonatomic, strong) NSString *siteSSCID; // 業務專用欄位
- (instancetype)initWithParentId:(NSString *)itemParentId
nodeId:(NSString *)itemId
name:(NSString *)itemName
index:(NSString *)itemIndex
siteSSCID:(NSString *)itemSiteSSCID
expand:(BOOL)expand;
@end
// Node.m
- (instancetype)initWithParentId:(NSString *)itemParentId
nodeId:(NSString *)itemId
name:(NSString *)itemName
index:(NSString *)itemIndex
siteSSCID:(NSString *)itemSiteSSCID
expand:(BOOL)expand {
self = [self init];
if (self) {
self.itemParentId = itemParentId;
self.itemId = itemId;
self.itemName = itemName;
self.itemIndex = itemIndex;
self.siteSSCID = itemSiteSSCID;
self.expand = expand;
}
return self;
}
UITableView 只認一維陣列,所以核心工作就是「如何把樹狀結構攤平」。TreeTableView 對外提供三個成員:全量資料 dataS、目前顯示用的 tempData,以及點擊末端節點時的回呼 selectBlock。
// TreeTableView.h @interface TreeTableView : UITableView @property (nonatomic, strong) NSArray *dataS; // 已組織好的全量資料 @property (nonatomic, strong) NSMutableArray *tempData; // 目前實際顯示的資料 @property (nonatomic, strong) void (^selectBlock)(NSString *); // 點擊葉節點時回傳名稱 - (NSMutableArray *)createTempData:(NSArray *)data; // 初始化最上層菜單 @end
內部用一個字典 _dic 去重,並以 _depth 記錄遞迴深度。初始化的邏輯很直接:遍歷全量資料,凡是父節點 ID 為 "0" 的就是根節點,把它們放進 tempData 並預設展開。
- (NSMutableArray *)createTempData:(NSArray *)data {
NSMutableArray *tempArray = [NSMutableArray array];
NSMutableArray *keys = [NSMutableArray array];
for (Node *node in self.dataS) {
if ([node.itemParentId isEqualToString:@"0"]) {
node.expand = YES;
[tempArray addObject:node];
[keys addObject:node.itemId];
}
}
return tempArray;
}
每個 cell 要顯示時,必須知道它在整棵樹中的第幾層,才能決定前面要留多少縮排。這裡的做法是沿著父節點一路往上找,每找上一層就把深度加一,直到抵達根節點。
- (NSInteger)findDepthOfNode:(Node *)node {
_depth = 0;
Node *nextNode = nil;
if (![node.itemParentId isEqualToString:@"0"]) {
_depth++;
for (NSInteger i = 0; i < self.tempData.count; i++) {
nextNode = [self.tempData objectAtIndex:i];
if ([node.itemParentId isEqualToString:nextNode.itemId]) { break; }
}
[self findDepthOfNode:nextNode]; // 遞迴往上
}
return _depth;
}
取得深度後,只要在文字前面補上等量的空格(或改用自訂 cell,加上層級用的 imageView)就能呈現視覺上的層次感。
- (UITableViewCell *)tableView:(UITableView *)tableView cellForRowAtIndexPath:(NSIndexPath *)indexPath {
static NSString *NODE_CELL_ID = @"node_cell_id";
UITableViewCell *cell = [tableView dequeueReusableCellWithIdentifier:NODE_CELL_ID];
if (!cell) {
cell = [[UITableViewCell alloc] initWithStyle:UITableViewCellStyleDefault
reuseIdentifier:NODE_CELL_ID];
}
Node *node = [self.tempData objectAtIndex:indexPath.row];
NSInteger depth = [self findDepthOfNode:node];
NSMutableString *name = [NSMutableString string];
for (int i = 0; i < depth; i++) { [name appendString:@" "]; }
[name appendString:node.itemName];
cell.textLabel.font = [UIFont systemFontOfSize:15.0];
cell.textLabel.text = name;
return cell;
}
這段是整個元件最關鍵的部分。點擊某一列時,先在全量資料中找出所有「父節點等於該列節點」的子節點:若目前是收合狀態就把它插入 tempData 的後續位置,若目前是展開狀態就把它移出。最後依插入或刪除的範圍,批次呼叫 insertRows 或 deleteRows,讓動畫平順。
- (void)tableView:(UITableView *)tableView didSelectRowAtIndexPath:(NSIndexPath *)indexPath {
NSUInteger startPosition = indexPath.row + 1;
NSUInteger endPosition = startPosition;
Node *parentNode = [self.tempData objectAtIndex:indexPath.row];
if (self.selectBlock) { self.selectBlock(parentNode.itemName); } // 可在此判斷是否為葉節點
for (Node *node in self.dataS) {
Node *node2 = (startPosition < self.tempData.count)
? [self.tempData objectAtIndex:startPosition] : nil;
if ([node.itemParentId isEqualToString:parentNode.itemId]
&& ![node2.itemId isEqualToString:node.itemId]) {
node.expand = !node.expand;
if (node.expand) {
[self.tempData insertObject:node atIndex:endPosition++];
} else {
endPosition = [self removeAllNodesAtParentNode:parentNode];
break;
}
}
}
NSMutableArray *indexPathArray = [NSMutableArray array];
for (NSUInteger i = startPosition; i < endPosition; i++) {
[indexPathArray addObject:[NSIndexPath indexPathForRow:i inSection:0]];
}
if (indexPathArray.count == 0) { return; }
BOOL isInsert = parentNode.expand;
if (isInsert) {
[tableView insertRowsAtIndexPaths:indexPathArray withRowAnimation:UITableViewRowAnimationFade];
} else {
[tableView deleteRowsAtIndexPaths:indexPathArray withRowAnimation:UITableViewRowAnimationFade];
}
}
// 移除某父節點底下所有後代節點
- (NSUInteger)removeAllNodesAtParentNode:(Node *)parentNode {
NSUInteger startPosition = [self.tempData indexOfObject:parentNode];
NSUInteger endPosition = startPosition + 1;
for (NSUInteger i = startPosition + 1; i < self.tempData.count; i++) {
Node *node = [self.tempData objectAtIndex:i];
if ([node.itemParentId isEqualToString:parentNode.itemId]) {
node.expand = NO;
endPosition++;
}
}
if (endPosition > startPosition) {
[self.tempData removeObjectsInRange:NSMakeRange(startPosition + 1,
endPosition - startPosition - 1)];
}
return endPosition;
}
使用端只需要餵入全量資料、呼叫 createTempData 取得初始顯示清單,再掛上視圖即可。以下用「國家 → 省份 → 城市 → 區域」的四層結構示範。
- (void)viewDidLoad {
[super viewDidLoad];
self.treeTableView.dataS = [self LoadDataForTableView];
self.treeTableView.tempData = [self.treeTableView createTempData:self.treeTableView.dataS];
[self.view addSubview:self.treeTableView];
}
- (NSArray *)LoadDataForTableView {
// 以 "0" 作為虛擬根節點;若改用其他約定,記得同步修改 createTempData
Node *node = [[Node alloc] initWithParentId:@"0" nodeId:@"國家1" name:@"中國"
index:@"-" siteSSCID:@"-" expand:NO];
Node *node2 = [[Node alloc] initWithParentId:@"國家1" nodeId:@"省份1" name:@"四川"
index:@"-" siteSSCID:@"-" expand:NO];
Node *node5 = [[Node alloc] initWithParentId:@"省份1" nodeId:@"城市1" name:@"成都"
index:@"-" siteSSCID:@"-" expand:NO];
Node *node12 = [[Node alloc] initWithParentId:@"城市1" nodeId:@"區域1" name:@"青羊區"
index:@"-" siteSSCID:@"-" expand:NO];
// 其餘節點依同樣規則建立…
return @[node, node2, node5, node12];
}
- (TreeTableView *)treeTableView {
if (!_treeTableView) {
_treeTableView = [[TreeTableView alloc] initWithFrame:
CGRectMake(0, 20, self.view.bounds.size.width,
self.view.bounds.size.height)];
}
return _treeTableView;
}

整體來說,樹形菜單的難點不在 UI,而在「攤平」與「局部增刪」這兩件事。只要把父子關係的判斷寫對,後續要改成無限層級、要加箭頭圖示或要換成 CollectionView,都只是替換呈現層而已。