iOS无侵入埋点方案

在iOS项目开发中,我们要收集用户的行为信息以便对项目进行分析统计,就需要在代码中进行埋点统计。

一、通常的埋点方式分为三种:

1.代码埋点
在具体事件收集处手动插入代码,优点是能准确的收集到需要统计的信息,缺点是插入代码工作量比较大,耦合度太高,后期维护和管理比较麻烦

2.可视化埋点
就是将埋点增加和修改的工作可视化了,提升了增加和维护埋点的体验。可视化埋点并非完全抛弃了代码埋点,而是在代码埋点的上层封装的一套逻辑来代替手工埋点

3.无埋点
无埋点,并不是不需要进行埋点,而是需要“全埋点”,而且埋点代码不会出现在业务代码中,容易管理和维护。它的缺点是方案成本比较高,而且后期解析也比较复杂

可视化埋点和无埋点都是属于无侵入的埋点方案,因为它们都不需要在代码中写入埋点的代码。所以采用无侵入式的埋点方案的优点有:
1.埋点代码与业务代码剥离,降低耦合性
2.埋点方法集中统一管理,减少漏埋点的几率

二、无侵入埋点方法的实现:

1.用运行时方法替换方法进行埋点

iOS常见的三种埋点就是:进入页面的次数、页面停留时间、点击事件统计,对于这几种常见的埋点,我们可以运用运行时方法替换来进行插入埋点代码,以实现无侵入的埋点方法。

实现原理图:


4349969-6fa084ae3aac0b1f.png

具体的实现方法是:先写一个运行时方法替换的类 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;
    // 得到被替换类的实例方法
    Method fromMethod = class_getInstanceMethod(class, fromSelector);
    // 得到替换类的实例方法
    Method toMethod = class_getInstanceMethod(class, toSelector);
    
    // class_addMethod 返回成功表示被替换的方法没实现,然后会通过 class_addMethod 方法先实现;返回失败则表示被替换方法已存在,可以直接进行 IMP 指针交换 
    if(class_addMethod(class, fromSelector, method_getImplementation(toMethod), method_getTypeEncoding(toMethod))) {
        // 进行方法的替换
        class_replaceMethod(class, toSelector, method_getImplementation(fromMethod), method_getTypeEncoding(fromMethod));
    } else {
        // 交换 IMP 指针
        method_exchangeImplementations(fromMethod, toMethod);
    }

}

@end

这个方法利用运行时method_exchangeImplementations进行交换,当原方法被调用时,就会hook到指定的新方法去执行。

页面进入次数、页面停留时间都需要对UIViewController 生命周期进行埋点,你可以创建一个 UIViewController 的 Category,代码如下:

@implementation UIViewController (logger)
+ (void)load {
    static dispatch_once_t onceToken;
    dispatch_once(&onceToken, ^{
        // 通过 @selector 获得被替换和替换方法的 SEL,作为 SMHook:hookClass:fromeSelector:toSelector 的参数传入 
        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 {
    // 先执行插入代码,再执行原 viewWillAppear 方法
    [self insertToViewWillAppear];
    [self hook_viewWillAppear:animated];
}
- (void)hook_viewWillDisappear:(BOOL)animated {
    // 执行插入代码,再执行原 viewWillDisappear 方法
    [self insertToViewWillDisappear];
    [self hook_viewWillDisappear:animated];
}

- (void)insertToViewWillAppear {
    // 在 ViewWillAppear 时进行日志的埋点
    [[[[SMLogger create]
       message:[NSString stringWithFormat:@"%@ Appear",NSStringFromClass([self class])]]
      classify:ProjectClassifyOperation]
     save];
}
- (void)insertToViewWillDisappear {
    // 在 ViewWillDisappear 时进行日志的埋点
    [[[[SMLogger create]
       message:[NSString stringWithFormat:@"%@ Disappear",NSStringFromClass([self class])]]
      classify:ProjectClassifyOperation]
     save];
}
@end

可以看到,Category 在 +load() 方法里使用了SMHook 进行方法替换,在替换的方法里执行需要埋点的方法 [self insertToViewWillAppear]。这样的话,每个UIViewController生命周期到了ViewWillAppear都会执行insertToViewWillAppear方法。

在这里边,我们是通过类名NSStringFromClass([self class])来区分不同的控制器的。

对于点击事件来说,我们也可以通过运行时替换方法的方式来进行无侵入埋点。 找到点击事件的方法sendAction:to:forEvent:,然后再+(void)load方法中使用SMHook替换新的方法。代码如下:

+ (void)load {
    static dispatch_once_t onceToken;
    dispatch_once(&onceToken, ^{
        // 通过 @selector 获得被替换和替换方法的 SEL,作为 SMHook:hookClass:fromeSelector:toSelector 的参数传入
        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生命周期埋点不同的是,一个类中可能有许多不同的UIButton子类,相同的UIButton子类在不同的视图中的埋点也要区分出来,所以我们通过NSStringFromClass([target class]) + NSStringFromSelector(action) 来区别,即类名加方法名的格式作为唯一标志。

除了UIViewController、UIButton控件外,Cocoa框架的其他控件都可以使用这种方法来进行无侵入埋点。

2.事件唯一标识

运用运行时替换方法的方式,我们能hook住所有的OC方法,能够帮我们解决了绝大部分的埋点问题。

但是这种方案的精度还不够高,仅仅通过“ 方法名+视图类名”拼接的标识还不能够区分开。比如一个视图下面有很多相同的按钮,响应的是同一个事件,如果仅仅是通过方法名+视图类型来区分,显然是不能区分到具体的事件,所以可以多添加一项目,比如“方法名+视图类名+按钮标题/索引”,这样就能通过这个标识,精确的识别到某一个事件了。

3.上报机制
在收集到埋点信息之后,会有一个上报到服务器进行统计分析的机制,比如实时发送、启动时发送、最小间隔时间发送等。服务器在接收到这些数据信息之后,按自己整理的计算统计规则得出最后的数据报表,提供给相关人员对项目进行分析使用。

总结:

虽然使用运行时方法的替换实现了无侵入埋点,但是该方案也存在着唯一标志难以维护和准确性难以保证的缺点。所以无侵入埋点还有比较长的路要走。

参考资料:
https://time.geekbang.org/column/article/87925
https://www.jianshu.com/p/7cd80e8bf29b

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,456评论 5 477
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,370评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,337评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,583评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,596评论 5 365
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,572评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,936评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,595评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,850评论 1 297
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,601评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,685评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,371评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,951评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,934评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,167评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 43,636评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,411评论 2 342

推荐阅读更多精彩内容

  • GitHub项目地址 前言 最近业务需要加入一大批埋点统计事件,这个页面添加一点代码那个页面添加一点代码,各个页面...
    青年别来无恙阅读 1,938评论 0 23
  • 原文链接:无侵入的埋点方案如何实现? 前言: 原文中介绍了iOS开发常见的埋点方式:代码埋点、可视化埋点和无埋点。...
    YYYYYY25阅读 1,632评论 3 16
  • Swift1> Swift和OC的区别1.1> Swift没有地址/指针的概念1.2> 泛型1.3> 类型严谨 对...
    cosWriter阅读 11,082评论 1 32
  • 大家是希望文昌快点出场,还是希望慢一点出场。
    知己伴一生阅读 313评论 3 1
  • 有些日子不曾打电话给她了。 上次打电话回去的时候,因为有些难过,想找她说一说,结果却是更难过。她不爱我么?她不能解...
    墨淡花已开阅读 146评论 0 0