您现在的位置: IOS教程網 >> IOS系統 >  >> iOS 程式開發 >> iOS 開發基礎

可複用、低耦合的 iOS 使用者行為統計方案

編輯:iOS 開發基礎

本文為投稿文章,作者:編程小翁(簡書)

使用者行為統計

使用者行為統計(User Behavior Statistics,UBS)一直是行動產品的標配環節,也就是俗稱的「埋點」。只要不太拖累流量,PM 通常希望覆蓋面越廣越好。目前主流做法是把埋點邏輯封裝成工具類,凡是需要記錄的地方(點擊、頁面跳轉等)就插入一段呼叫。問題是專案一旦變大,這些程式碼會散落在各個角落,維護與複用都成了惡夢。

本文想探討的是:借助 iOS 的 Runtime 機制,做出一套可複用、可解耦、好維護的埋點方案。探討畢竟是探討,歡迎到簡書留言指教。文章略長,但保證是用心之作。

閱讀前需要具備一些 iOS Runtime 基礎,涉及的核心知識有:

  • Method Swizzling(Hook)

  • 單元測試

一、傳統埋點怎麼做

先回顧主流做法。粗淺地分,埋點有兩類:頁面統計(停留時間、進入次數)與互動事件統計(單擊、雙擊、手勢等)。

1)頁面統計

以統計進入次數為例,最直接的做法是在每個頁面的 viewDidAppear: 與 viewDidDisappear: 裡各自埋點,把 pageID 上報後端:

@implementation HomeViewController //...other methods - (void)viewDidAppear:(BOOL)animated {     [super viewWillAppear:animated];     [WUserStatistics sendEventToServer:@"PAGE_EVENT_HOME_ENTER"]; } - (void)viewDidDisappear:(BOOL)animated {     [super viewDidDisappear:animated];     [WUserStatistics sendEventToServer:@"PAGE_EVENT_HOME_LEAVE"]; } @end

+[WUserStatistics sendEventToServer:] 負責封裝網路請求。這種寫法的毛病很明顯:

一是複用性差,換個專案幾乎要重寫;二是工作量大,頁面一多,改動點就跟著暴增;三是引入了大量「髒程式碼」。所謂髒,是指行為分析這種邊緣業務跟主業務糾纏得太緊,反而干擾了核心邏輯的閱讀與維護。

2)互動事件埋點

常見做法是在事件回呼裡取事件 ID 上報:

- (IBAction)onFavBtnPressed:(id)sender {     [WUserStatistics sendEventToServer:@"CTRL_EVENT_HOME_FAV"];     //...do other things }

規模大一點的 App 用這種方式,結果就是這類程式碼遍地開花。缺點與前面相同,複用性幾乎為零。

小結一下:傳統做法直觀方便,但在複用性與可維護性上先天不足。而 Runtime 恰好能補上這些短板。

二、Method Swizzling、Hook 與程式碼注入

Runtime 不是本文重點,這裡只簡單帶過。

在 iOS 中,我們可以在執行期替換兩個方法的實作,藉此「勾住」目標方法並注入自己的程式碼。做法是在類的 +(void)load 裡,透過 method_exchangeImplementations 等介面交換方法(記為 M)的實作;之後只要 M 被呼叫,就會先跑進我們的方法裡。

這套技術就是 Method Swizzling,屬於面向切面編程(AOP)的一種落地方式。

@interface WHookUtility : NSObject + (void)swizzlingInClass:(Class)cls originalSelector:(SEL)originalSelector swizzledSelector:(SEL)swizzledSelector; @end @implementation WHookUtility + (void)swizzlingInClass:(Class)cls originalSelector:(SEL)originalSelector swizzledSelector:(SEL)swizzledSelector {     Class class = cls;     Method originalMethod = class_getInstanceMethod(class, originalSelector);     Method swizzledMethod = class_getInstanceMethod(class, swizzledSelector);     BOOL didAddMethod =     class_addMethod(class,     originalSelector,     method_getImplementation(swizzledMethod),     method_getTypeEncoding(swizzledMethod));     if (didAddMethod) {         class_replaceMethod(class,         swizzledSelector,         method_getImplementation(originalMethod),         method_getTypeEncoding(originalMethod));     } else {         method_exchangeImplementations(originalMethod, swizzledMethod);     } } @end

這個 WHookUtility 下文會用到。舉例來說,要勾住 UIViewController 的 viewWillAppear::

@implementation UIViewController (userStastistics) + (void)load {     static dispatch_once_t onceToken;     dispatch_once(&onceToken, ^{         SEL originalSelector = @selector(viewWillAppear:);         SEL swizzledSelector = @selector(swiz_viewWillAppear:);         [WHookUtility swizzlingInClass:[self class] originalSelector:originalSelector swizzledSelector:swizzledSelector]; }); } #pragma mark - Method Swizzling - (void)swiz_viewWillAppear:(BOOL)animated {     //插入需要執行的程式碼     NSLog(@"我在viewWillAppear執行前偷偷插入了一段程式碼");     //不能干擾原來的程式碼流程,插入程式碼結束後要讓本來該執行的程式碼繼續執行     [self swiz_viewWillAppear:animated]; } @end

更多關於 Runtime、Method Swizzling 與面向切面編程的說明,可參考延伸閱讀。

三、以 Runtime 為基礎的埋點方案

為了便於說明,先準備一個簡單專案:兩個頁面(HomeViewController、DetailViewController)。

需求是:統計兩個頁面的顯示與離開次數;統計收藏、分享單擊次數;對既有程式碼的侵入越小越好。

1)頁面顯示與離開次數

做法很直觀:不再逐頁埋點,而是替 UIViewController 加上 category,Hook 住 viewWillAppear: 與 viewWillDisappear:,在裡頭注入統計邏輯。

問題來了:每個頁面都有自己的 pageEventID,埋點程式碼怎麼知道該上報哪一個?最粗暴的答案是 if-else:

- (NSString *)pageEventID:(BOOL)bEnterPage {     NSString *selfClassName = NSStringFromClass([self class]);     NSString *pageEventID = nil;     if ([selfClassName isEqualToString:@"HomeViewController"]) {         pageEventID = bEnterPage ? @"EVENT_HOME_ENTER_PAGE" : @"EVENT_HOME_LEAVE_PAGE";     } else if ([selfClassName isEqualToString:@"DetailViewController"]) {         pageEventID = bEnterPage ? @"EVENT_DETAIL_ENTER_PAGE" : @"EVENT_DETAIL_LEAVE_PAGE";     }     //else if (<#expression#>)... }

顯然有更優雅的寫法:用一份配置表取代這一長串判斷,頁面再多,程式碼量也還是那幾行。我們建立 WGlobalUserStatisticsConfig.plist 存放各頁面的進出事件 ID:

於是取值的程式碼永遠是這幾句:

- (NSString *)pageEventID:(BOOL)bEnterPage {     NSDictionary *configDict = [self dictionaryFromUserStatisticsConfigPlist];     NSString *selfClassName = NSStringFromClass([self class]);     return configDict[selfClassName][@"PageEventIDs"][bEnterPage ? @"Enter" : @"Leave"]; } - (NSDictionary *)dictionaryFromUserStatisticsConfigPlist {     NSString *filePath = [[NSBundle mainBundle] pathForResource:@"WGlobalUserStatisticsConfig" ofType:@"plist"];     NSDictionary *dic = [NSDictionary dictionaryWithContentsOfFile:filePath];     return dic; }

效果如下:

頁面進出統計就此完成,第三點需求(對既有程式碼近乎零侵入)也達到了——透過 Method Swizzling,現有工程甚至不需要 import 任何檔案,後續變動只需維護 plist。

2)收藏、分享單擊次數

思路一致,同樣靠 category + hook 來解耦。Demo 中收藏與分享都是 UIButton,替 UIButton 加 category 可行,但更好的選擇是加在 UIControl 上,這樣所有子類(button、switch、segment 等)都能一網打盡,複用性更高。

要 hook 就得先確定 hook 哪個方法,理想情況下該方法應能提供 target、actionName 等資訊。這一步得靠嘗試。

UIControl 的方法列表如下:

看過方法名與參數,倒數第二個格外可疑,因為它攜帶的資訊看起來很有價值:

- (void)sendAction:(SEL)action to:(nullable id)target forEvent:(nullable UIEvent *)event;

寫段測試程式碼驗證看看:

@implementation UIControl (userStastistics) + (void)load {     static dispatch_once_t onceToken;     dispatch_once(&onceToken, ^{         SEL originalSelector = @selector(sendAction:to:forEvent:);         SEL swizzledSelector = @selector(swiz_sendAction:to:forEvent:);         [WHookUtility swizzlingInClass:[self class] originalSelector:originalSelector swizzledSelector:swizzledSelector];     }); } #pragma mark - Method Swizzling - (void)swiz_sendAction:(SEL)action to:(id)target forEvent:(UIEvent *)event; {     //插入埋點程式碼     [self performUserStastisticsAction:action to:target forEvent:event];     [self swiz_sendAction:action to:target forEvent:event]; } - (void)performUserStastisticsAction:(SEL)action to:(id)target forEvent:(UIEvent *)event; {     NSLog(@"\n***hook success.\n[1]action:%@\n[2]target:%@ \n[3]event:%ld", NSStringFromSelector(action), target, (long)event); } @end

Log 如下:

可以看到,在完全沒有改動既有工程的情況下,所有點擊事件都已被成功攔下來:target(也就是 ViewController)、回呼方法名、觸摸集合全都拿得到,埋點所需的資訊已經足夠。

與頁面統計同樣,用 plist 避免長串 if-else:

有了這張表,任一次單擊的 ControlEventID 就能輕易取出:

NSString *actionString = NSStringFromSelector(action);//獲取SEL string NSString *targetName = NSStringFromClass([target class]);//viewController name NSDictionary *configDict = [self dictionaryFromUserStatisticsConfigPlist]; eventID = configDict[targetName][@"ControlEventIDs"][actionString];

我把單一頁面的事件 ID 分成兩類:頁面事件 ID(PageEventIDs,進出等)與互動事件 ID(ControlEventIDs,單擊、雙擊、手勢等)。這個分類是後面寫單元測試的基礎。

埋點效果:

階段性小結,這套思路的優勢是:

  • 與工程程式碼近乎解耦,不再引入「髒程式碼」

  • 後續重構時,只需修改 plist 配置表

  • 維護一份配置表,遠比維護散落在各處的程式碼輕鬆

四、用單元測試做後期維護

創業難,守業更難。前面的方案能跑通初步需求,但真實專案的重構頻率很高。多人協作下,回呼方法名甚至頁面名稱都可能被改名,一旦配置表沒同步,事件 ID 取不到,埋點就靜靜失效了。

以下只討論回呼方法變動的情況。

1、回呼方法改名或刪除

例如 onFavBtnPressed: 被改成 onFavouriteBtnPressed:,而 plist 忘了同步。趕進度時這種疏漏機率不低,結果就是 eventID 變成 nil。單元測試在這裡價值就體現出來了:完善的測試用例能在發版前把這種不匹配揪出來。

做法是先讀取 plist,遍歷所有頁面,再遍歷頁面的 ControlEventIDs,對每個方法名做 respondsToSelector: 檢查:

測試程式碼:

- (void)testIfUserStatisticsConfigPlistValid {     NSDictionary *configDict = [self dictionaryFromUserStatisticsConfigPlist];     XCTAssertNotNil(configDict, @"WGlobalUserStatisticsConfig.plist加載失敗");     [configDict enumerateKeysAndObjectsUsingBlock:^(NSString *  _Nonnull key, id  _Nonnull obj, BOOL * _Nonnull stop) {     XCTAssert([obj isKindOfClass:[NSDictionary class]], @"plist檔案結構可能已經改變,請確認");     NSString *targetPageName = key;     Class pageClass = NSClassFromString(targetPageName);     id pageInstance = [[pageClass alloc] init];     //一個pageDict對應一個頁面,存放pageID,所有的action及對應的eventID     NSDictionary *pageDict = (NSDictionary *)obj;     //頁面配置資訊     NSDictionary *pageEventIDDict = pageDict[@"PageEventIDs"];     //互動配置資訊     NSDictionary *controlEventIDDict = pageDict[@"ControlEventIDs"];     XCTAssert(pageEventIDDict, @"plist檔案未包含PageID欄位或者該欄位值為空");     XCTAssert(controlEventIDDict, @"plist檔案未包含EventIDs欄位或者該欄位值為空");     [pageEventIDDict enumerateKeysAndObjectsUsingBlock:^(NSString *  _Nonnull key, id  _Nonnull value, BOOL * _Nonnull stop) {     XCTAssert([value isKindOfClass:[NSString class]], @"plist檔案結構可能已經改變,請確認");     XCTAssertNotNil(value, @"EVENT_ID為空,請確認");     }];     [controlEventIDDict enumerateKeysAndObjectsUsingBlock:^(NSString *  _Nonnull key, id  _Nonnull value, BOOL * _Nonnull stop) {     XCTAssert([value isKindOfClass:[NSString class]], @"plist檔案結構可能已經改變,請確認");     NSString *actionName = key;     SEL actionSel = NSSelectorFromString(actionName);     XCTAssert([pageInstance respondsToSelector:actionSel], @"程式碼與plist檔案函數不匹配,請確認:-[%@ %@]", targetPageName, actionName);     //EVENT_ID不能為空     XCTAssertNotNil(value, @"EVENT_ID為空,請確認");     }];     }]; }

試著把 HomeViewController 的 onFavBtnPressed: 改成 onMyFavBtnPressed:,測試結果是:

改動被輕鬆抓到,只要 XCTAssert 的訊息寫得夠清楚,維護起來其實相當省事。上圖的 log 已經明確指出 -[HomeViewController onFavBtnPressed:] 出了問題。

2、程式碼中新增了回呼事件

這種情況多見於新版本帶來新的埋點需求。若新增的回呼確實在 PM 要求的清單上,但 plist 漏了,這種失誤比較棘手。上一種情況是「用 plist 驗證程式碼」,這裡得反過來「用程式碼驗證 plist」。難點在於:專案裡的回呼函數動輒上百,並非每個都要埋點,而需要埋點的那些在語法層面毫無特徵。

一種辦法是加強 code review(這基本上是廢話);另一種辦法是約定命名規則:需要埋點的回呼方法名帶上固定後綴,例如收藏事件寫成 onFavBtnPressed_UA:,然後在測試中用執行期 API class_copyMethodList 取出所有標記了 _UA 的方法,逐一回查 plist 是否存在,缺漏就讓測試失敗並提示開發者補上。

程式碼從略。不熟悉單元測試的讀者可另行參考相關資料。

小結:合理的單元測試能大幅減輕後期維護負擔,關鍵在於測試用例是否完備、是否想清楚了各種邊界。

五、結語

以上就是結合 Runtime 設計出的埋點方案。它在複用性與解耦度上表現都不錯,新專案能直接用,老專案也能逐步導入。內容看似繁多,收斂下來其實只有三件事:plist 配置表 + Hook + 單元測試。用 Method Swizzling 把埋點程式碼集中管理,也便於交由專人維護與追蹤。

當然,這套思路只涵蓋了簡單情境,更複雜的場景仍需變通,但大方向就是如此。

思路未必完美,作為一次嘗試倒也值得。路,都是走出來的。

本文 demo 地址,記得給個 star!

  1. 上一篇文章:
  2. 下一篇文章:
蘋果刷機越獄教程| IOS教程問題解答| IOS技巧綜合| IOS7技巧| IOS8教程
Copyright © IOS教程網 All Rights Reserved