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