有一種常見現象:App 設計者覺得理所當然的操作方式,卻常常被用戶忽略。為了避免這種情況,就要為 App 設計一套引導。一種低成本的方案是把幫助文檔寫成 HTML 展示給用戶,但效果往往不理想;更好的方式則是高亮用戶應該點擊的區域,對其他部分進行遮蓋,並配上說明文字來提醒用戶,如下圖所示。

框架 SGUserGuide 已經上傳到 GitHub,歡迎前往下載,也歡迎 Star!
要實現這樣的引導,關鍵問題有兩個:一是如何拿到允許交互的控件,二是如何處理引導步驟的推進關係。
對於第一個問題,可以通過 keyPath 解決。keyPath 的強大之處在於,它能用點語法拿到更深層的私有屬性。例如我們的 ViewController 有一個私有屬性 topView,而 topView 又有私有屬性 topButton,那麼我們使用 topView.topButton 就能從 ViewController 中拿到控件 topButton,而絲毫不破壞其封裝性。
對於第二個問題,可以通過 AOP(面向切面編程)來解決。我們知道大部分交互都涉及頁面切換,例如上圖點擊按鈕後進入編輯頁面,因此頁面的切換就可以作為一個「切面」,我們通過這個切面來處理大部分的引導步驟推進。具體做法是通過 Method Swizzling 攔截所有的 viewWillAppear: 方法,在其中處理引導步驟的判斷與推進。需要注意的是,還有一些不涉及頁面切換的引導步驟,則需要在合適的地方手動推進。
為了描述一個引導步驟,首先要判斷當前頁面是否應該被引導,這通過 ViewController 的類型來判斷;其次需要可交互控件,通過 keyPath 來尋找;此外還需要對用戶的提示信息。這個類的具體設計如下:
@interface SGGuideNode : NSObject @property (nonatomic, assign) Class controllerClass; @property (nonatomic, strong) NSString *permitViewPath; @property (nonatomic, copy) NSString *message; @property (nonatomic, assign) BOOL reverse; + (instancetype)nodeWithController:(Class)controller permitViewPath:(NSString *)permitViewPath message:(NSString *)message reverse:(BOOL)reverse; + (instancetype)endNodeWithController:(Class)controller; @end
其中 reverse 是一個用於反轉「遮蓋」與「可交互控件」的屬性,適用於類似「進行一項除退出以外的操作」的情景。通過兩個類方法可以快速創建一個步驟結點,endNode 作為結束結點,用於判斷用戶引導是否結束。
遮蓋層視圖需要蓋住界面,並且在可交互區域「挖洞」。要實現這種功能,可以通過 pointInside:withEvent: 方法處理點擊事件:對於落在洞外的點交給遮蓋層處理,即返回 YES,這樣就保證了原來的交互事件被攔截。其中 permitRect 為允許交互的視圖區域。
- (BOOL)pointInside:(CGPoint)point withEvent:(UIEvent *)event { BOOL ret = !CGRectContainsPoint(self.permitRect, point); if (self.node.reverse) { ret = !ret; } return ret; }
處理完點擊事件後,我們只需通過 drawRect: 在遮蓋區繪製半透明灰色、在允許交互區域繪製透明色,就能做出預想的效果。首先要定義出 maskColor 和 holeColor,然後先對整個遮蓋層填充 maskColor,再對允許交互區填充 holeColor。
- (void)drawRect:(CGRect)rect { // 省略maskColor、holeColor的定義與賦值代碼 [maskColor setFill]; UIRectFill(rect); // 省略允許點擊區域permitRect的計算代碼 [holeColor setFill]; UIRectFill(self.permitRect); }
接下來一個問題是提示文字的位置。提示文字應該緊貼可交互區域,並且盡可能佔有更多空間,因此我們需要計算可交互區域四周的面積,從中選擇面積最大的那一塊。
最關鍵的問題是:遮蓋層應該添加到誰的 view 上?由於在觸發一個引導步驟時已經拿到了當前顯示的視圖控制器(引導步驟的觸發是通過攔截 viewWillAppear: 實現的,因此可以拿到視圖控制器對象),添加起來就十分簡單。
不要簡單地認為把遮蓋層添加到視圖控制器的 view 上即可,因為視圖控制器可能被 NavigationController 或 TabbarController 包裹,如果只是添加到視圖控制器的 view,就無法蓋住頂部和底部區域。
基於這個考慮,我們按照 tabBarController.view > navigationController.view > viewController.view 的優先級來添加遮蓋層。
- (void)showInViewController:(UIViewController *)viewController { // 每次顯示前,保證顯示中的遮蓋層已經被移除,通過removeFromSuperview移除。 [self hide]; self.permitView = [viewController valueForKeyPath:self.node.permitViewPath]; self.messageLabel.text = self.node.message; if (viewController.tabBarController) { [viewController.tabBarController.view addSubview:self]; }else if (viewController.navigationController) { [viewController.navigationController.view addSubview:self]; } else { [viewController.view addSubview:self]; } self.frame = self.superview.frame; [self setNeedsDisplay]; }
這段代碼包含了對步驟結點的解析。注意遮蓋的尺寸要與要蓋住的視圖大小一致,最後一句會觸發 drawRect:,根據最新的結點解析數據繪製遮蓋層與允許交互層。
移除遮蓋層只需調用 removeFromSuperview 即可。
- (void)hide { [self removeFromSuperview]; }
要實現步驟的切換,需要一個全局調度器,它接收切面通知或用戶的手動通知來對步驟進行判斷與切換。所有步驟結點都以數組形式保存到調度器中,調度器通過游標 cur 來判斷當前進行到哪一步。為了使用方便,編程者只需把結點數組傳給調度器,調度器就會自動開始處理步驟的判斷與切換,例如下面的代碼:
- (void)setupGuide { SGGuideDispatcher *dp = [SGGuideDispatcher sharedDispatcher]; dp.nodes = @[ [SGGuideNode nodeWithController:[FirstViewController class] permitViewPath:@"addBtn" message:@"Please Click The Add Button And Choose Yes From the Alert." reverse:NO], [SGGuideNode nodeWithController:[FirstViewController class] permitViewPath:@"wrap.innerView" message:@"Please Click the Info Button" reverse:NO], [SGGuideNode nodeWithController:[SecondViewController class] permitViewPath:@"tabBarController.tabBar" message:@"Please Change To Third Page" reverse:NO], [SGGuideNode endNodeWithController:[ThirdViewController class]] ]; }
要實現這樣的效果,需要把調度器設計成單例,並通過 nodes 數組屬性接收步驟結點。前面提到,不涉及頁面切換的步驟完成無法被捕獲,需要用戶手動推進,因此調度器還需要一個 next 方法來進行手動推進。綜上所述,調度器的設計如下:
@interface SGGuideDispatcher : NSObject @property (nonatomic, strong) NSArray *nodes; + (instancetype)sharedDispatcher; - (void)next; // 重置引導步驟,用於調試 - (void)reset; @end
上文提到,我們通過攔截 viewWillAppear: 方法來觸發步驟的判斷與切換,這可以通過為 UIViewController 添加分類來實現,在攔截後發出通知,以供調度器接收,如下:
@implementation UIViewController (Tracking) + (void)load { method_exchangeImplementations(class_getInstanceMethod([self class], @selector(viewWillAppear:)), class_getInstanceMethod([self class], @selector(track_viewWillAppear:))); } - (void)track_viewWillAppear:(BOOL)animated { [self track_viewWillAppear:animated]; [[NSNotificationCenter defaultCenter] postNotificationName:SGGuideTrigNotification object:@{@"viewController":self}]; } @end
上文提到,調度器開始工作的時機是接收到步驟結點之後,因此通過重寫結點數組的 setter 來註冊對攔截器通知的監聽即可。
- (void)setNodes:(NSArray *)nodes { _nodes = nodes; // 重置游標 self.cur = 0; // 防止重復注冊 [[NSNotificationCenter defaultCenter] removeObserver:self]; [[NSNotificationCenter defaultCenter] addObserver:self selector:@selector(trig:) name:SGGuideTrigNotification object:nil]; }
這樣的設計十分明了,但不利於「引導結束後再次啟動 App 時不再開啟調度」的場景,因此改良如下:通過 Preference 記錄引導步驟游標 cur 的值,對於已結束的引導 cur 為 -1,如果 cur 是 -1,則不接收步驟結點,防止浪費內存。
- (void)setNodes:(NSArray *)nodes { if ([[NSUserDefaults standardUserDefaults] integerForKey:kSGGuideDispatcherCur] == -1) { return; } _nodes = nodes; if (self.cur < nodes.count) { [[NSNotificationCenter defaultCenter] removeObserver:self]; [[NSNotificationCenter defaultCenter] addObserver:self selector:@selector(trig:) name:SGGuideTrigNotification object:nil]; } }
通過上文我們知道,攔截器的通知觸發了調度器的 trig: 方法,trig: 方法用於處理調度器的觸發邏輯;此外,還有手動觸發調度器的方式,也通過發送通知實現。
- (void)next { if (!self.currentViewController) return; [[NSNotificationCenter defaultCenter] postNotificationName:SGGuideTrigNotification object:@{@"viewController":self.currentViewController}]; }
這裡的 currentViewController 為當前展示的視圖控制器,這個值在每次調度器觸發時根據通知中的視圖控制器來賦值。由於 next 之前還沒有進行頁面切換,因此當前的視圖控制器不變,依然是 currentViewController。
調度器每次觸發時,首先根據游標拿出當前步驟結點,並判斷當前顯示的視圖控制器是否與步驟結點要求相匹配。如果匹配,則添加遮蓋,並把游標後移。上文提到,最後一個步驟結點是 endNode,用於判斷調度的結束;endNode 與其他步驟結點的區別是允許交互視圖的 keyPath 為空,一旦發現 keyPath 為空,就認為調度結束,清空 nodes 釋放內存並移除通知,同時記錄游標的值為 -1,以防止下次打開 App 時重複啟動調度。
- (void)trig:(NSNotification *)nof { if (self.cur >= self.nodes.count) return; SGGuideMaskView *maskView = [SGGuideMaskView sharedMask]; UIViewController *topVc = nof.object[@"viewController"]; SGGuideNode *node = self.nodes[self.cur]; if ([topVc isKindOfClass:node.controllerClass]) { self.currentViewController = topVc; [maskView hide]; self.cur++; if (node.permitViewPath == nil) { self.nodes = nil; [[NSNotificationCenter defaultCenter] removeObserver:self]; [[NSUserDefaults standardUserDefaults] setInteger:-1 forKey:kSGGuideDispatcherCur]; [[NSUserDefaults standardUserDefaults] synchronize]; return; } maskView.node = node; [maskView showInViewController:topVc]; } }
實現用戶引導有三個關鍵類:引導結點 SGGuideNode、遮蓋層 SGGuideMaskView 和調度器 SGGuideDispatcher。把引導結點的數組傳給調度器即可開始調度,調度的觸發分為手動和自動兩種方式:攔截器(UIViewController 的分類)對頁面切換進行攔截並觸發調度,而不涉及頁面切換的調度則需要編程者通過調度器的 next 方法實現。每次觸發調度時先判斷是否與引導結點相符,相符則添加遮蓋層並向後推進。
通過這樣的設計,實現了幾乎無侵入的用戶引導——它不會破壞工程結構,同時能提供良好的引導效果。