美文网首页
iOS调试篇(三)——无侵入埋点实践

iOS调试篇(三)——无侵入埋点实践

作者: Claire_wu | 来源:发表于2019-05-09 17:01 被阅读0次

    0 背景

    在iOS开发中,埋点可以解决两类问题:一是了解用户使用App的行为,二是降低分析线上问题的难度。常用埋点方式包括:

    • 代码埋点:在需要埋点的地方加入代码,可以很精确的在需要埋点的代码上加入埋点代码逻辑,方便的记录当前环境的变量值,方便调试,并跟踪埋点内容。但存在开发工作量大,并且埋点代码到处都是,后期难以维护
    • 可视化埋点:根据标识来识别每一个事件, 针对指定的事件进行取参埋点。而事件的标识与参数信息都写在配置表中,通过动态下发配置表来实现埋点统计。
    • 全埋点:也叫无埋点,埋点代码不会出现在业务代码中,易于管理和维护。但缺点自傲与埋点成本高,后期解析也复杂,尤其是view_path的不确定性,对于大量通用的埋点需求来说,全埋点的形式可以节省大量的开发和维护成本。

    1 运行时方法替换方式进行埋点

    iOS开发最常见的三种埋点,就是对页面进入次数、页面停留时间、点击事件上报。对于这三种情况,我们都可以通过运行时方法替换技术来插入埋点代码。具体实现如下:

    1. 先写一个运行时方法替换类WYEHook,加上替换的方法hookClass:fromSelector:toSelector,代码如下:
    #import "WYEHook.h"
    #import <objc/runtime.h>
    @implementation WYEHook
    + (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
    

    1.1 页面进入次数、页面停留时间埋点

    1. 页面进入次数、页面停留时间都需要对UIViewController生命周期进行埋点,可以创建UIViewController的category:
    #import "UIViewController+Logger.h"
    #import "WYEHook.h"
    @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:);
            [WYEHook hookClass:self fromSelector:fromSelectorAppear toSelector:toSelectorAppear];
            
            SEL fromSelectorDisappear = @selector(viewWillDisappear:);
            SEL toSelectorDisappear = @selector(hook_viewWillDisappear:);
            
            [WYEHook hookClass:self fromSelector:fromSelectorDisappear toSelector:toSelectorDisappear];
        });
    }
    
    - (void)hook_viewWillAppear:(BOOL)animated {
        // 先执行插入代码,再执行原 viewWillAppear 方法
        [self insertToViewWillAppear];
        
        /**
        //乍一看,这里容易理解成循环递归调用。但其实要正确理解这个方法交换的过程:
         1、程序首先调用viewWillAppear方法,但其实已经被替换成hook_viewWillAppear了。所以执行到hook_viewWillAppear
         2、执行完insertToViewWillAppear这个方法后,调用hook_viewWillAppear,但这个方法其实已经被替换成viewWillAppear了。
        */
        [self hook_viewWillAppear:animated];
    }
    - (void)hook_viewWillDisappear:(BOOL)animated {
        // 执行插入代码,再执行原 viewWillDisappear 方法
        [self insertToViewWillDisappear];
        [self hook_viewWillDisappear:animated];
    }
    
    - (void)insertToViewWillAppear {
        // 在 ViewWillAppear 时进行日志的埋点
        NSLog(@"hook到  %@ will appear",NSStringFromClass([self class]));
    }
    - (void)insertToViewWillDisappear {
        // 在 ViewWillDisappear 时进行日志的埋点
        // 在 ViewWillAppear 时进行日志的埋点
        NSLog(@"hook到  %@ will disappear",NSStringFromClass([self class]));
    }
    

    1.2 UIButton点击事件埋点

    点击事件可以对sendAction:to:forEvent:方法埋点:

    #import "UIButton+Logger.h"
    #import "WYEHook.h"
    @implementation UIButton (Logger)
    + (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:);
            [WYEHook 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]);
            NSLog(@"hook到button事件啦: %@",[NSString stringWithFormat:@"%@ %@",targetName,actionString]);
        }
    }
    
    @end
    

    2 demo

    WuyineiOSDemo,还包含了作者整理的其他的知识点,持续更新,欢迎Star

    相关文章

      网友评论

          本文标题:iOS调试篇(三)——无侵入埋点实践

          本文链接:https://www.haomeiwen.com/subject/jpxgoqtx.html