在iOS項(xiàng)目開發(fā)中，我們要收集用戶的行為信息以便對(duì)項(xiàng)目進(jìn)行分析統(tǒng)計(jì)，就需要在代碼中進(jìn)行埋點(diǎn)統(tǒng)計(jì)。
一、通常的埋點(diǎn)方式分為三種：
1.代碼埋點(diǎn)
在具體事件收集處手動(dòng)插入代碼，優(yōu)點(diǎn)是能準(zhǔn)確的收集到需要統(tǒng)計(jì)的信息，缺點(diǎn)是插入代碼工作量比較大，耦合度太高，后期維護(hù)和管理比較麻煩
2.可視化埋點(diǎn)
就是將埋點(diǎn)增加和修改的工作可視化了，提升了增加和維護(hù)埋點(diǎn)的體驗(yàn)?？梢暬顸c(diǎn)并非完全拋棄了代碼埋點(diǎn)，而是在代碼埋點(diǎn)的上層封裝的一套邏輯來代替手工埋點(diǎn)
3.無埋點(diǎn)
無埋點(diǎn)，并不是不需要進(jìn)行埋點(diǎn)，而是需要“全埋點(diǎn)”，而且埋點(diǎn)代碼不會(huì)出現(xiàn)在業(yè)務(wù)代碼中，容易管理和維護(hù)。它的缺點(diǎn)是方案成本比較高，而且后期解析也比較復(fù)雜
可視化埋點(diǎn)和無埋點(diǎn)都是屬于無侵入的埋點(diǎn)方案，因?yàn)樗鼈兌疾恍枰诖a中寫入埋點(diǎn)的代碼。所以采用無侵入式的埋點(diǎn)方案的優(yōu)點(diǎn)有：
1.埋點(diǎn)代碼與業(yè)務(wù)代碼剝離，降低耦合性
2.埋點(diǎn)方法集中統(tǒng)一管理，減少漏埋點(diǎn)的幾率
二、無侵入埋點(diǎn)方法的實(shí)現(xiàn)：
1.用運(yùn)行時(shí)方法替換方法進(jìn)行埋點(diǎn)
iOS常見的三種埋點(diǎn)就是：進(jìn)入頁面的次數(shù)、頁面停留時(shí)間、點(diǎn)擊事件統(tǒng)計(jì)，對(duì)于這幾種常見的埋點(diǎn)，我們可以運(yùn)用運(yùn)行時(shí)方法替換來進(jìn)行插入埋點(diǎn)代碼，以實(shí)現(xiàn)無侵入的埋點(diǎn)方法。
實(shí)現(xiàn)原理圖：
具體的實(shí)現(xiàn)方法是：先寫一個(gè)運(yùn)行時(shí)方法替換的類 SMHook，加上替換的方法
hookClass:fromSelector:toSelector,代碼如下：
#import "SMHook.h"
#import <objc/runtime.h>
@implementation SMHook
+ (void)hookClass:(Class)classObject fromSelector:(SEL)fromSelector toSelector:(SEL)toSelector {
Class class = classObject;
// 得到被替換類的實(shí)例方法
Method fromMethod = class_getInstanceMethod(class, fromSelector);
// 得到替換類的實(shí)例方法
Method toMethod = class_getInstanceMethod(class, toSelector);
// class_addMethod 返回成功表示被替換的方法沒實(shí)現(xiàn)，然后會(huì)通過 class_addMethod 方法先實(shí)現(xiàn)；返回失敗則表示被替換方法已存在，可以直接進(jìn)行 IMP 指針交換
if(class_addMethod(class, fromSelector, method_getImplementation(toMethod), method_getTypeEncoding(toMethod))) {
// 進(jìn)行方法的替換
class_replaceMethod(class, toSelector, method_getImplementation(fromMethod), method_getTypeEncoding(fromMethod));
} else {
// 交換 IMP 指針
method_exchangeImplementations(fromMethod, toMethod);
}
}
@end
這個(gè)方法利用運(yùn)行時(shí)method_exchangeImplementations進(jìn)行交換，當(dāng)原方法被調(diào)用時(shí)，就會(huì)hook到指定的新方法去執(zhí)行。
頁面進(jìn)入次數(shù)、頁面停留時(shí)間都需要對(duì)UIViewController 生命周期進(jìn)行埋點(diǎn)，你可以創(chuàng)建一個(gè) UIViewController 的 Category，代碼如下：
@implementation UIViewController (logger)
+ (void)load {
static dispatch_once_t onceToken;
dispatch_once(&onceToken, ^{
// 通過 @selector 獲得被替換和替換方法的 SEL，作為 SMHook:hookClass:fromeSelector:toSelector 的參數(shù)傳入
SEL fromSelectorAppear = @selector(viewWillAppear:);
SEL toSelectorAppear = @selector(hook_viewWillAppear:);
[SMHook hookClass:self fromSelector:fromSelectorAppear toSelector:toSelectorAppear];
SEL fromSelectorDisappear = @selector(viewWillDisappear:);
SEL toSelectorDisappear = @selector(hook_viewWillDisappear:);
[SMHook hookClass:self fromSelector:fromSelectorDisappear toSelector:toSelectorDisappear];
});
}
- (void)hook_viewWillAppear:(BOOL)animated {
// 先執(zhí)行插入代碼，再執(zhí)行原 viewWillAppear 方法
[self insertToViewWillAppear];
[self hook_viewWillAppear:animated];
}
- (void)hook_viewWillDisappear:(BOOL)animated {
// 執(zhí)行插入代碼，再執(zhí)行原 viewWillDisappear 方法
[self insertToViewWillDisappear];
[self hook_viewWillDisappear:animated];
}
- (void)insertToViewWillAppear {
// 在 ViewWillAppear 時(shí)進(jìn)行日志的埋點(diǎn)
[[[[SMLogger create]
message:[NSString stringWithFormat:@"%@ Appear",NSStringFromClass([self class])]]
classify:ProjectClassifyOperation]
save];
}
- (void)insertToViewWillDisappear {
// 在 ViewWillDisappear 時(shí)進(jìn)行日志的埋點(diǎn)
[[[[SMLogger create]
message:[NSString stringWithFormat:@"%@ Disappear",NSStringFromClass([self class])]]
classify:ProjectClassifyOperation]
save];
}
@end
可以看到，Category 在 +load() 方法里使用了SMHook 進(jìn)行方法替換，在替換的方法里執(zhí)行需要埋點(diǎn)的方法 [self insertToViewWillAppear]。這樣的話，每個(gè)UIViewController生命周期到了ViewWillAppear都會(huì)執(zhí)行insertToViewWillAppear方法。
在這里邊，我們是通過類名NSStringFromClass([self class])來區(qū)分不同的控制器的。
對(duì)于點(diǎn)擊事件來說，我們也可以通過運(yùn)行時(shí)替換方法的方式來進(jìn)行無侵入埋點(diǎn)。 找到點(diǎn)擊事件的方法sendAction:to:forEvent:，然后再+(void)load方法中使用SMHook替換新的方法。代碼如下：
+ (void)load {
static dispatch_once_t onceToken;
dispatch_once(&onceToken, ^{
// 通過 @selector 獲得被替換和替換方法的 SEL，作為 SMHook:hookClass:fromeSelector:toSelector 的參數(shù)傳入
SEL fromSelector = @selector(sendAction:to:forEvent:);
SEL toSelector = @selector(hook_sendAction:to:forEvent:);
[SMHook hookClass:self fromSelector:fromSelector toSelector:toSelector];
});
}
- (void)hook_sendAction:(SEL)action to:(id)target forEvent:(UIEvent *)event {
[self insertToSendAction:action to:target forEvent:event];
[self hook_sendAction:action to:target forEvent:event];
}
- (void)insertToSendAction:(SEL)action to:(id)target forEvent:(UIEvent *)event {
// 日志記錄
if ([[[event allTouches] anyObject] phase] == UITouchPhaseEnded) {
NSString *actionString = NSStringFromSelector(action);
NSString *targetName = NSStringFromClass([target class]);
[[[SMLogger create] message:[NSString stringWithFormat:@"%@ %@",targetName,actionString]] save];
}
}
和UIViewController生命周期埋點(diǎn)不同的是，一個(gè)類中可能有許多不同的UIButton子類，相同的UIButton子類在不同的視圖中的埋點(diǎn)也要區(qū)分出來，所以我們通過NSStringFromClass([target class]) + NSStringFromSelector(action) 來區(qū)別，即類名加方法名的格式作為唯一標(biāo)志。
除了UIViewController、UIButton控件外，Cocoa框架的其他控件都可以使用這種方法來進(jìn)行無侵入埋點(diǎn)。
2.事件唯一標(biāo)識(shí)
運(yùn)用運(yùn)行時(shí)替換方法的方式，我們能hook住所有的OC方法，能夠幫我們解決了絕大部分的埋點(diǎn)問題。
但是這種方案的精度還不夠高，僅僅通過“ 方法名+視圖類名”拼接的標(biāo)識(shí)還不能夠區(qū)分開。比如一個(gè)視圖下面有很多相同的按鈕，響應(yīng)的是同一個(gè)事件，如果僅僅是通過方法名+視圖類型來區(qū)分，顯然是不能區(qū)分到具體的事件，所以可以多添加一項(xiàng)目，比如“方法名+視圖類名+按鈕標(biāo)題/索引”，這樣就能通過這個(gè)標(biāo)識(shí)，精確的識(shí)別到某一個(gè)事件了。
3.上報(bào)機(jī)制
在收集到埋點(diǎn)信息之后，會(huì)有一個(gè)上報(bào)到服務(wù)器進(jìn)行統(tǒng)計(jì)分析的機(jī)制，比如實(shí)時(shí)發(fā)送、啟動(dòng)時(shí)發(fā)送、最小間隔時(shí)間發(fā)送等。服務(wù)器在接收到這些數(shù)據(jù)信息之后，按自己整理的計(jì)算統(tǒng)計(jì)規(guī)則得出最后的數(shù)據(jù)報(bào)表，提供給相關(guān)人員對(duì)項(xiàng)目進(jìn)行分析使用。
總結(jié)：
雖然使用運(yùn)行時(shí)方法的替換實(shí)現(xiàn)了無侵入埋點(diǎn)，但是該方案也存在著唯一標(biāo)志難以維護(hù)和準(zhǔn)確性難以保證的缺點(diǎn)。所以無侵入埋點(diǎn)還有比較長的路要走。
參考資料:
https://time.geekbang.org/column/article/87925
http://www.itdecent.cn/p/7cd80e8bf29b
