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

iOS 無埋點數據 SDK 實踐:viewPath 與 KVC 的組合技

編輯:iOS 開發基礎

本文整理自網易樂得無埋點數據 SDK 的開發經驗。負責這套 SDK 已有一段時間,這次把整體思路與關鍵技術點拿出來和同行交流。

這套 SDK 已經做到不需要寫埋點程式碼,就能自動、可動態配置、全面且正確地收集使用者操作 App 時的所有事件。另外還搭配開發了圈選 SDK,能在 App 端完成介面元素的圈選與 KVC 配置上傳,而圈選工作完全可以交由用研與產品人員執行,替開發者省下可觀工時。

能力分成兩塊

基本事件收集:包含冷啟動、頁面事件、點擊事件、ScrollView 滑動等,全部自動完成。
業務層數據收集:例如使用者點擊「提交訂單」時,一併帶出購買品項與訂單總金額。過去這類需求多靠代碼埋點,本 SDK 則真正做到無埋點取得。

整體實現思路:AOP + Method Swizzling

SDK 採用 AOP(Aspect-Oriented Programming)面向切面程式設計的思想,在函數呼叫的前後動態插入數據收集程式碼。在 Objective-C 中的落地方式,就是基於 Runtime 特性的 Method Swizzling。

被 hook 的方法大致分三類:

系統類的方法——例如 UIApplication、UIViewController。做頁面事件收集時,主要 hook 了 UIViewController 的 viewDidLoad、viewDidAppear、viewDidDisappear、dealloc。

系統類的 Delegate 方法——例如 UIScrollViewDelegate、UITableViewDelegate、UIWebViewDelegate。SDK 多數功能都靠 hook 這些協議方法完成,例如列表點擊事件就是 hook UITableViewDelegate 的 tableView:didSelectRowAtIndexPath:。

自定義類的方法——開發者在工程中自行定義的類別。例如手勢事件收集需要 hook 手勢物件指定的 target 中的 action 方法,而 target 通常就是自定義類別。(其實 hook 系統的 delegate 方法也可以視為 hook 自定義方法,因為它們大多得在自定義類別中實作。)

聽起來只是靠 AOP 插程式碼,實際做起來細節不少:如何把導覽列與系統彈窗的點擊歸屬到正確頁面、如何區分 UIControlEventValueChanged、如何解決 hook 手勢帶來的效能問題等等。這些之後再獨立成文。

關鍵技術一:viewPath 與 viewId

要對某頁面的某個 view 做統計,首先得能唯一標識並定位它,這是整個數據 SDK 的前提。

1. viewPath 的組成

整個 App 的視圖結構可以看作一棵樹(viewTree):根節點是 UIWindow,枝幹由 UIViewController 與 UIView 組成,葉節點都是 UIView。

要標示樹上任一節點的位置,最直覺的做法是用「目標 view 到根節點之間,每個節點的深度(在父節點中的 index)」組成路徑。這確實能唯一標示,缺點是可讀性太差。因此又加上每個節點的名稱,也就是該 view 的類名。

另外,由於統計都是以頁面為單位,SDK 產生 viewPath 時只到 view 所屬的 UIViewController 層級,而非根部的 UIWindow,這也順帶縮短了長度。

2. Cell 的深度怎麼表示

UITableView 與 UICollectionView 是最常用也最重要的控件,裡面包含數量不定的可重複使用 Cell。答案是 indexPath:雖然 Cell 會被重複使用,但每個 Cell 都對應一個唯一的 indexPath,完全可以拿它來表示深度。

3. 表示形式與示例

節點類名:

HYGHallSlideViewController-UIScrollView-HYGHallProductTableView-UITableViewWrapperView-HYGHallProductCell-UITableViewCellContentView-HYGHallProductView

節點深度:0-0-0-0-0:2-0-1

組合成 viewPath:

viewPath:HYGHallSlideViewController-UIScrollView-HYGHallProductTableView-UITableViewWrapperView-HYGHallProductCell-UITableViewCellContentView-HYGHallProductView && 0-0-1-0-0:2-0-1

用 & 連接兩段資訊,方便後續的組合與拆分匹配。網路上也有類似 xPath 的寫法:

HYGHallSlideViewController[0]/UIScrollView[0]/HYGHallProductTableView[1]/UITableViewWrapperView[0]/HYGHallProductCell[0:2]/UITableViewCellContentView[0]/HYGHallProductView[1]

個人覺得 xPath 稍嫌繁瑣,但形式其實是次要的,挑自己順手的就好。

4. 針對 viewPath 的三項優化

4.1 改用「同類型子 view」的 index 計算深度。原本用「所有子 view 中的 index」,問題是 viewTree 會隨使用者操作變動。舉例:某 UIView 依序加入 label、button1、button2,深度為 0、1、2;使用者觸發某操作後 label 被移除,button1、button2 的深度就變成 0、1——仅仅移除一個子 view,其他 view 的深度全變了。

調整後改成計算「所有同類型子 view 中的 index」:最初 label、button1、button2 為 0、0、1;label 移除後,button1、button2 仍是 0、1,完全不受影響。這明顯增強了 viewPath 的抗干擾能力。

要注意的是,這種算法依賴節點型別,所以類名已經不只是為了可讀性,而是必須放進 viewPath。

4.2 針對 Swift 的處理。Swift 檔案取得類名時會自動加上所在 Module 的前綴:主工程加工程名,元件庫(開啟 use frameworks!)加元件名。這導致三種情況下 viewPath 會改變:OC 檔被 Swift 重寫、Swift 檔在主工程與元件庫之間搬移、以及在開啟/關閉 use frameworks! 之間切換。

對於老舊 OC 專案經常用 Swift 重寫的現實情況,解法很乾脆:產生 viewPath 時直接剝掉所有 Swift 的 ModuleName 前綴。

那不同元件庫中有兩個同名視圖或控制器怎麼辦?仔細想就會發現這擔憂多餘:即使類名相同,它們內部的視圖結構不同,深度也就不同,viewPath 不會完全撞在一起。

4.3 含子 VC 時,VC 深度固定為 0。viewPath 只表示到離 view 最近的那層 VC,而 VC 的深度原本取自其 view 在父 view 中的 index。實務上常用 addChildViewController: 組出複雜頁面,這時問題就來了:假設 containerVC 有四個子 VC,各子 VC 首次顯示時才會被 add 進來、view 才掛到 scrollView 上,於是使用者查看的先後順序會決定它們的深度。順序是 VC1→VC2→VC3→VC4 時深度為 0、1、2、3;順序變成 VC3→VC1→VC4→VC2 時,深度就變成 VC1(1)、VC2(3)、VC3(0)、VC4(2)。這讓 viewPath 不可靠且無法保證唯一。

解法是:VC 的深度一律固定為 0,反正 VC 已經是 viewPath 的根層級,深度資訊不重要了。

但這又衍生一個小問題:若 VC1 與 VC2 是同一個類的不同實例,內部視圖結構完全相同,固定深度 0 就無法區分是哪個子 VC 的 view。針對這種情況,SDK 另用頁面別名來處理。

5. viewId 的產生

viewPath 已能唯一標識 view,為何還要 viewId?因為 viewPath 長度不固定、通常偏長,後台拿它當唯一鍵不方便。SDK 將 viewPath 做 MD5 後得到固定長度的 viewId。

6. viewPath 重複時怎麼辦

即使做了優化,仍有些情況單靠 viewPath 無法區分事件:

  • 同一個按鈕在不同狀態顯示不同文字(未加商品時顯示「加入」,加了之後變成「清除」)。
  • 同一個 view 上有多個點擊點,例如 UISegmentedControl、UISwitch、UIStepper。

解法是 viewPath + 「其它資訊」。第一種情況的「其它資訊」是 button 的 title;第二種是 selectedIndex 或 isOn 的值。SDK 收集時會把這些一併上傳,搭配圈選 SDK,後台就能區分出不同事件。

另外還有一類「其它資訊」是業務數據。例如商品列表頁每行一個商品,若後台想統計的不是「每一行」而是「每個商品」的點擊,那「其它資訊」就該是 productId。

關鍵技術二:無埋點的業務數據收集

傳統代碼埋點的缺點很明顯:

  • 埋點程式碼與業務邏輯混在一起,維護成本高;
  • 埋點得跟著 App 版本一起發布,拖慢數據收集與統計;
  • 容易錯埋、漏埋,且無法動態更新。

SDK 依靠 viewPath + KVC 真正做到無埋點取得業務數據。KVC 讓我們能用 key 或 keyPath 直接存取屬性,不必呼叫明確的存取方法。

整體分三步:上傳 KVC 配置 → 請求 KVC 配置 → 業務數據的收集與上報。

什麼是 KVC 配置

它就是描述「App 應該在什麼時機、收集什麼數據」的資訊,包含:

  • appKey:標識哪個應用
  • appVersion:標識版本號
  • viewEvent:事件類型/收集時機,如 ButtonClick、ListItemClick、ViewTap
  • viewPath:目標 view 在 viewTree 中的位置資訊
  • keyPath:目標 view 與要收集數據之間的關聯路徑,用於 KVC 取值
  • keyName:為收集到的數據定義 key,最終以 key-value 形式上報,用於區分多筆數據

配置的上傳與下發

透過圈選 SDK 上傳 KVC 配置的動作對使用者透明,主要由開發或數據人員執行,任何時候都能做,達到「按需動態配置」的效果。SDK 初始化時會主動拉取當前版本對應的所有 KVC 配置並快取起來。

收集與上報流程

這一步的核心是基於 viewPath 的 view 匹配:循環遍歷 viewPath 的每個節點,與當前 view 及其父 view 逐層比對。這會帶來時間與效能消耗,因此 SDK 做了幾層優化。

4.1 快取上一次匹配成功的 view

快取的資訊包括 targetView(上次匹配成功的 view 物件)與 indexPath(該 view 的 indexPath,沒有則為 nil)。匹配依序進行:

① viewEvent 匹配:先比對事件類型。若配置指定 ButtonClick,就能直接濾掉 ListItemClick、ViewTap 等,過濾掉大部分事件。

② targetView 匹配:把快取的 targetView 與當前 view 比對,指向同一物件就進入下一步,否則跳到第 ④ 步。

③ indexPath 匹配:這一步是對第 ② 步的補充,專門處理 Cell 重複使用的情況。舉例:某 Cell 內有個 button,點第 1 行時匹配成功並快取了該 button;往下滑動後第 1 行滾出畫面、第 10 行滾入並重複使用了第 1 行的 Cell,這時再點 button,targetView 與當前 button 必然指向同一物件,卻不是我們真正想匹配的那個。因此若快取的 indexPath 不為 nil 且與當前 view 的 indexPath 不同,就跳到第 ④ 步;否則可跳過 viewPath 匹配直接進第 ⑤ 步。

④ viewPath 匹配:將當前 view 及其父 view 與配置中的 viewPath 逐節點比對。進入循環前先做三道快速判斷——view 類名是否相等、所屬 viewController 類名是否相等、所屬 window 類名是否相等。這三關能濾掉大量不必要的匹配。

⑤ KVC 取值與上報:時機驗證通過後,用 keyPath 呼叫 valueForKeyPath: 取值。值不為 nil 就與 keyName 組成鍵值對,併入當前事件一起上報,後台即可用 key 找到對應的業務數據。

實作上還會處理 cell 的 indexPath 通配情況,篇幅關係這裡不展開。

5. KVC 的異常防護

KVC 很方便,但也很危險:一旦 key 或 keyPath 對應的屬性不存在,會立刻拋出 NSUndefinedKeyException,沒攔住就是 crash。SDK 的做法是給 NSObject 加一個 category,覆寫 valueForUndefinedKey: 並回傳 nil:

@implementation NSObject (KVCExceptionHandler)

- (nullable id)valueForUndefinedKey:(NSString *)key {
    return nil;
}

@end

Q & A

Q1:都用 KVC 配置取數據,維護成本會不會很高?

確實需要維護。由於不同 App 版本的 keyPath 可能不同,配置需與版本對應;新版本發布時,舊配置要逐一驗證是否適用,適用就把新版本號加進去,不適用就重新上傳一份。隨版本迭代,配置只會越來越多。

SDK 用三招解決這個痛點:上傳時可指定版本區間、或不綁定具體版本(套用至所有版本);SDK 取值失敗時記錄錯誤日誌並上報,內容含 appKey、appVersion、keyPath;用腳本監控這類日誌,發現異常就發郵件通知相關人員。這樣一來,管理工作就簡化成一句話:依日誌快速找到對應配置,並為新版本上傳一份新配置。

Q2:內容與位置會隨時間變動時,怎麼統計?

這在實務中很常見,比如首頁內容多由後台配置。問題可拆成兩類:同一位置顯示不同內容、同一內容顯示在不同位置。

情況 A:同一位置顯示不同內容(例如首頁有一個活動位,先是活動 1 的圖,後來換成活動 2)。方案是「關心位置 + 關心內容」:viewPath 不含任何通配符,只鎖定該位置;圈選 SDK 上傳帶有活動 url 之 keyPath 的配置,數據 SDK 在點擊時收集當前活動的 url 隨事件上報;最後再上傳一份「關心位置 + 關心內容(指定要統計的 url)」的圈選配置。

情況 B:同一內容顯示在不同位置(例如首頁四個固定入口,「熱門推薦」依後台排序可能落在任一位置)。方案是「不關心位置 + 關心內容」:viewPath 中放入通配符以涵蓋多個位置(例如把 indexPath 換成通配符);數據 SDK 在任何一個入口被點擊時都收集入口的 title 隨事件上報;最後上傳「不關心位置 + 關心內容(指定為『熱門推薦』)」的圈選配置。

兩種情況在後台統計時沒有差別:拿到圈選配置後,依 viewPath 與「關心的內容」生成正則表達式,再從數據 SDK 上報的原始資料中做正則比對,即可統計出結果。

結語

本文主要在講兩個關鍵技術:viewPath 的定位能力,以及 viewPath 搭配 KVC 的無埋點業務數據收集。此外 SDK 還有對 RN 頁面的數據收集、頁面別名方案、Method Swizzling 與 Aspects 的相容處理等課題,篇幅有限留待後續。

特別感謝同事王佳樂協助本文的排版與校對,也感謝組內同事在開發過程中的諸多幫助。若對方案有更好的建議,歡迎一起討論。

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