iOS 全埋点-页面浏览事件（2）

小知识，大挑战！本文正在参与“程序员必备小知识”创作活动。

写在前面

传送门： iOS 全埋点-应用程序退出和启动（1）
本章节主要是介绍 iOS全埋点序列文章（2）页面浏览事件的埋点分析

UIViewController生命周期

UIViewController在不同的显示状态时会回调不同的方法。如下图所示：

通过UIViewController的整个生命周期可知， 当执行到-viewDidAppear:方法时，表示视图已经 在屏幕上渲染完成，即页面已经显示出来，正等 待用户进行下一步操作。因此，执行到- viewDidAppear:方法的时间点是触发页面浏览事件的最佳时机。如果想要实现页面浏览事件的全埋点，就需要使用 iOS的“黑魔法”——Method Swizzling分析的相关技术

定义一个NSObject的分类Swizzler如下所示：

#import "NSObject+Swizzler.h"
#import <objc/runtime.h>
@implementation NSObject (Swizzler)

+ (BOOL)sensorsdata_swizzleMethod:(SEL)originalSEL withMethod:(SEL)alternateSEL {
   
    //获取原始的方法
    Method originalMethod = class_getInstanceMethod(self, originalSEL);
    if (!originalMethod) {
        return NO;
    }
    //获取将要交换的方法
    Method alternateMethod = class_getInstanceMethod(self, alternateSEL);
    if (!alternateMethod) {
        return NO;
    }
    //交互两个方法的实现
    method_exchangeImplementations(originalMethod, alternateMethod);
    //返回yes，方法交换成功
    return YES;
}

@end

复制代码

新建一个UIViewController的类别 CountData

+ (void)load {
    
    [UIViewController sensorsdata_swizzleMethod:@selector(viewDidAppear:) withMethod:@selector(CountData_viewDidAppear:)];
    
}

//触发$AppViewScreen事件
- (void)CountData_viewDidAppear:(BOOL)animated {
    
    [self CountData_viewDidAppear:animated];
    //首先去判断当前的黑名单设置中是否包含有（特别需求就是可能某一个页面不需要统计的情况）
    if ([self shouldTrackAppViewScreen]) {
        
        NSMutableDictionary *prams = [[NSMutableDictionary alloc]init];
        [prams setValue:NSStringFromClass([self class]) forKey:@"$screen_name"];      
        //navigationItem.titleView的优先级高于navigationItem.title
        NSString *title = [self contentTiltleFromView:self.navigationItem.titleView];
        if (title.length == 0) {
            title = self.navigationItem.title;
        }
        [prams setValue:title forKey:@"$title"];
        [[SensorsAnalyticsSDK sharedInstance]track:@"$AppViewScreen" properties:prams];
    }
}
复制代码

屏蔽采集页面

针对特别需求就是可能某一个页面不需要统计的情况，这个时候可以配置一个黑名单的plist文件

#pragma mark - 检查黑名单中是否包含目前UIViewController

-(BOOL)shouldTrackAppViewScreen {
   
    static NSSet *blackList = nil;
    static dispatch_once_t onceToken;
    dispatch_once(&onceToken, ^{
        //获取文件的路径
        NSString *path = [[NSBundle bundleForClass:SensorsAnalyticsSDK.class] pathForResource:KdataBlackListFileName ofType:nil];
        NSArray *classNames = [NSArray arrayWithContentsOfFile:path];
        NSMutableSet *set = [NSMutableSet setWithCapacity:classNames.count];
        for (NSString *str in classNames) {
            if (NSClassFromString(str)) {
                [set addObject:NSClassFromString(str)];
            }   
        }
        blackList = [set copy];
    });
    
    for (Class cla in blackList) {
        //判断当前控制器是否为黑名单中类或子类
        if ([self isKindOfClass:cla]) {
            return NO;
        }
    }
    return YES;
    
}
复制代码

捕获页面标题

一般设置页面title的方式

• 方式1: self.title = @"title";
• 方式2: self.navigationItem.title = @"navigationItem.title";
• 方式3: self.navigationItem.titleView = customTitleView;（customTitleView 自定义的View）

注意：navigationItem.titleView的优先级要高于 navigationItem.title。

匹配页面标题方法如下：

-(NSString *)contentTiltleFromView:(UIView *) view {
    
    if (view.isHidden) {
        return nil;
    }
    NSMutableString *elementContent = [NSMutableString string];
    if ([view isKindOfClass:[UIButton class]]) {
        UIButton *button = (UIButton *)view;
        NSString *title = button.titleLabel.text;
        if (title.length > 0) {
            [elementContent appendString:title];
        }
    }
    else if ([view isKindOfClass:[UILabel class]]) {
        UILabel *label = (UILabel *)view;
        NSString *title = label.text;
        if (title.length > 0) {
            [elementContent appendString:title];   
        }
    }
    else if ([view isKindOfClass:[UITextView class]]) {
        UITextView *textView = (UITextView *)view;
        NSString *title = textView.text;
        if (title.length > 0) {
            [elementContent appendString:title];   
        }
    }
    else {
        NSMutableArray<NSString *> *elementContentArray = [NSMutableArray array];
        for (UIView *subview in view.subviews) {
            NSString *temp = [self contentTiltleFromView:subview];
            if (temp.length > 0) {
                [elementContentArray addObject:temp];
            }
        }
        if (elementContentArray.count > 0) {
            [elementContent appendString:[elementContentArray componentsJoinedByString: @"-"]];
        }
    }
    return [elementContent copy];
}

复制代码

存在的问题

• 应用程序热启动时（从后台恢复），第一个页面没有触发$AppViewScreen事件。原因是这个 页面没有再次执行-viewDidAppear:方法。
• 要求UIViewController的子类不重写- viewDidAppear:方法，一旦重写必须调用[super viewDidAppear:animated]，否则不会触发 $AppViewScreen事件。原因是直接交换了 UIViewController的-viewDidAppear:方法。