IOS用戶統(tǒng)計實現(xiàn)
用戶統(tǒng)計
用戶行為統(tǒng)計(User Behavior Statistics, UBS)一直是移動互聯(lián)網(wǎng)產(chǎn)品中必不可少的環(huán)節(jié)姊舵，也俗稱埋點。在保證移動端流量不會受較大影響的前提下彼硫，PM們總是希望埋點覆蓋面越廣越好。目前常規(guī)的做法是將埋點代碼封裝成工具類凌箕，但凡工程中需要埋點(如點擊事件拧篮、頁面跳轉(zhuǎn))的地方都插入埋點代碼。一旦項目越來越復(fù)雜牵舱，你會發(fā)現(xiàn)埋點的代碼散落在程序的各個角落串绩，不利于維護(hù)以及復(fù)用。
常規(guī)埋點做法
接著開頭的話題仆葡，我們先回顧一下主流的埋點是怎么做的。我粗糙地將埋點分為兩種：
1、頁面統(tǒng)計沿盅，包括頁面停留時間把篓、頁面進(jìn)入次數(shù)；
2腰涧、交互事件統(tǒng)計韧掩，包括單擊、雙擊窖铡、手勢交互等疗锐。
常規(guī)頁面統(tǒng)計埋點
以統(tǒng)計頁面進(jìn)入次數(shù)為例，最簡單粗暴的做法是在所有頁面的viewDidAppear:以及viewDidDisappear:中分別埋點费彼，將自己對應(yīng)的pageID上傳給服務(wù)端滑臊。代碼大概長醬紫：
@implementation HomeViewController
- (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:]封裝網(wǎng)絡(luò)請求，將ID上傳給服務(wù)器箍铲。上述方案有以下弊端：
1.復(fù)用性差雇卷。這部分埋點代碼很難給其他項目復(fù)用。
2.工作量大颠猴。尤其當(dāng)頁面較多時关划，需要修改的代碼較多。
3.引入“臟代碼”翘瓮，不易維護(hù)贮折。
第3點提到的“臟代碼”意思是用戶行為分析這種業(yè)務(wù)其實跟主業(yè)務(wù)沒太大關(guān)系，不應(yīng)該保持如此高的耦合度资盅，因為這些代碼會干擾我們對項目主業(yè)務(wù)的維護(hù)调榄。
常規(guī)交互事件埋點
常規(guī)做法一般在交互事件的selector中獲取該事件的ID并上傳給服務(wù)端，代碼大概長醬紫：
- (IBAction)onFavBtnPressed:(id)sender{
[WUserStatistics sendEventToServer:@"CTRL_EVENT_HOME_FAV"];
//...do other things }
稍微大一點的APP如果采用這種方式律姨，那諸如此類的埋點代碼將遍地都是振峻。它的缺點參考頁面統(tǒng)計埋點部分，其復(fù)用性基本為零择份，也就是在新項目中根本無法復(fù)用埋點代碼扣孟。 小總結(jié)一下，采用常規(guī)的做法雖然直觀方便荣赶，但在可復(fù)用性凤价、可維護(hù)性等方面有所欠缺。在我看來拔创，借助運(yùn)行時可以很好地避開這些缺點利诺。
Method Swizzling、Hook與代碼注入
在iOS中剩燥，我們可以在運(yùn)行時替換兩個方法的實現(xiàn)慢逾，達(dá)到“勾住”某個方法并注入代碼的目的立倍。具體做法是: 重載類的“+(void)load”方法，在程序加載到內(nèi)存時利用Runtime的method_exchangeImplementations等接口將方法(設(shè)為M)的實現(xiàn)互相交換侣滩。當(dāng)方法M被調(diào)用時就會被勾住(Hook)口注，執(zhí)行我們的方法。 這種技術(shù)也稱為Method Swizzling君珠，屬于面向切面編程(Aspect-Oriented Programming)的一種實現(xiàn)寝志。 替換兩個方法的實現(xiàn)，代碼一般長醬紫:
@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工具類下文會用到策添。比如現(xiàn)在我們要勾住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];
});
}
- (void)swiz_viewWillAppear:(BOOL)animated{
//插入需要執(zhí)行的代碼
NSLog(@"我在viewWillAppear執(zhí)行前偷偷插入了一段代碼");
[self swiz_viewWillAppear:animated];
}
@end
基于運(yùn)行時的埋點方案
為了便于下文敘述，先引入一個簡單的項目唯竹，共有兩個頁面(HomeViewController乐导，DetailViewController) 需求是：
- 統(tǒng)計兩個頁面的展示與離開次數(shù)
- 統(tǒng)計收藏、分享單擊事件的次數(shù)
- 對現(xiàn)有工程代碼影響越小越好
統(tǒng)計兩個頁面的展示與離開次數(shù)
這部分應(yīng)該比較直觀了摩窃，摒棄掉在每個controller中埋點的方式兽叮，我們對UIViewController添加category從而Hook到viewWillAppear:與viewWillDisappear:。在這兩個方法中注入埋點代碼：
@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];
SEL originalSelector2 = @selector(viewWillDisappear:);
SEL swizzledSelector2 = @selector(swiz_viewWillDisappear:);
[WHookUtility swizzlingInClass:[self class] originalSelector:originalSelector2 swizzledSelector:swizzledSelector2];
});
}
pragma mark - Method Swizzling
- (void)swiz_viewWillAppear:(BOOL)animated{
//插入需要執(zhí)行的代碼
[self inject_viewWillAppear];
[self swiz_viewWillAppear:animated];
}
- (void)swiz_viewWillDisappear:(BOOL)animated{
[self inject_viewWillDisappear];
[self swiz_viewWillDisappear:animated];
}
//利用hook 統(tǒng)計所有頁面的停留時長
- (void)inject_viewWillAppear{
NSString *pageID = [self pageEventID:YES];
if (pageID) {
[WUserStatistics sendEventToServer:pageID];
}
}
- (void)inject_viewWillDisappear{
NSString *pageID = [self pageEventID:NO];
if (pageID) {
[WUserStatistics sendEventToServer:pageID];
}
}
這時候問題來了猾愿，項目中每個頁面都會有自己的頁面事件編號(pageEventID)鹦聪，此處的埋點代碼如何知道要發(fā)送什么pageEventID給服務(wù)端呢？輕松祭出if-else神器： 為了便于下文敘述蒂秘，先引入一個簡單的項目泽本，共有兩個頁面(HomeViewController，DetailViewController)姻僧，如下：
- (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#>)...
}
當(dāng)然规丽，我們可以有更優(yōu)雅的方式，比如用一個配置表替代上面一長串的if判斷撇贺，這樣無論頁面數(shù)怎么增加赌莺，代碼始終是那么一小段。我們新建一個WGlobalUserStatisticsConfig.plist的配置表來存放每個頁面在進(jìn)入以及離開時的pageEventID松嘶，結(jié)構(gòu)如下：
- (上效果圖可見用戶統(tǒng)計實現(xiàn)圖片文件夾中的PageEventID.png)
因此艘狭，頁面進(jìn)出統(tǒng)計中獲取pageEventID的代碼始終是以下這幾句：
- (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;
}
效果如下：
- (上效果圖可見用戶統(tǒng)計實現(xiàn)圖片文件夾中的Jietu.png)
以上就是完成了頁面進(jìn)出統(tǒng)計的埋點，并且達(dá)到了我們的第三點預(yù)期：對現(xiàn)有代碼基本無影響翠订。通過Method Swizzling的方式現(xiàn)有的工程甚至不需要import任何文件巢音！后期代碼變動時需要維護(hù)的僅僅是plist配置表。
統(tǒng)計收藏尽超、分享單擊事件的次數(shù)
與上一節(jié)思路一致官撼，要做到解耦顯然需要通過category+hook來實現(xiàn)。本文demo中收藏跟分享都是UIButton類型似谁，可以考慮添加UIButton的catogory傲绣。但更好的方式是添加UIControl的category掠哥，這樣可以讓埋點代碼覆蓋到所有UIControl的子類中去，比如button秃诵、switch龙致、segment等，提高復(fù)用性顷链。 既然要hook，那就要清楚到底要hookUIControl的哪(幾)個方法屈梁，只有部分方法是滿足埋點需求的嗤练，最好是所hook的方法能提供target、actionName等信息在讶。這是個嘗試的過程煞抬。代碼如下：
@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如下圖：
- (上效果圖可見用戶統(tǒng)計實現(xiàn)圖片文件夾中的Log.png)
可以看到，通過category+method swizzling的方式在沒有修改現(xiàn)有工程任何代碼的情況下已經(jīng)成功Hook到所有點擊事件构哺，在Hook代碼中我們知道了一個點擊事件的target也就是ViewController革答，也知道了點擊事件的響應(yīng)函數(shù)名，知道了點擊的TouchSet曙强。這些信息已經(jīng)能滿足埋點需求了残拐。 與頁面統(tǒng)計埋點類似，我們同樣采用plist配置表的方式避免一大長串的if-else判斷： 有了這張配置表就很容易得到某次單擊事件的事件ID(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溪食，頁面的進(jìn)出等)、交互事件ID(ControlEventIDs娜扇，單擊错沃、雙擊、手勢等)雀瓢。分類有助于下文使用單元測試(Unit Test)進(jìn)行自動化后期維護(hù)枢析。 到這里先做了階段性的總結(jié)，本文提出的思路有以下優(yōu)越性：
- 與工程代碼基本解耦刃麸，避免引入“臟代碼”
- 即使后期工程代碼發(fā)生重構(gòu)醒叁，需要修改的僅僅是plist配置表
- 維護(hù)配置表比維護(hù)散落在工程各個角落的代碼簡單
小總結(jié)：
合理的單元測試可以為本文方案的后期維護(hù)減輕相當(dāng)大的負(fù)擔(dān)，測試用例的完備性很重要嫌蚤，需要用心設(shè)計考慮周全辐益。
結(jié)語
以上就是結(jié)合運(yùn)行時所設(shè)計出的用戶統(tǒng)計思路全部內(nèi)容。應(yīng)該說該方案的可復(fù)用性與解耦程度都是不錯的脱吱，既適合于新建的工程智政，也適合于已經(jīng)創(chuàng)建的工程∠潋穑看起來內(nèi)容多续捂，其實總結(jié)起來無非幾個步驟：plist配置表+Hook+單元測試垦垂。利用Method Swizzling把埋點代碼集中管理其實也是合理的，有利于專人開發(fā)牙瓢、跟蹤及維護(hù)劫拗。當(dāng)然以上思路只考慮簡單的情形，更復(fù)雜的情況就需要變通了矾克，但總體思路就是如此页慷。
- 本文demo地址
