iOS | 小收获：自动埋点

海贼王.jpeg

用户行为统计，俗称埋点，是一个成熟项目中必不可少的环节。埋点的常规做法是在项目中所有需要埋点的地方插入埋点，但随着项目不断壮大，埋点的地方越来越多，埋点代码散落在项目中不同角落，不易于管理和后期维护，出于简化埋点开发的目的，针对自动埋点做了小小的总结。

小豆暂且把埋点分为两种：
1>页面统计，即在进入页面和离开页面的时候埋点，统计停留页面时长
2>交互事件统计
本文暂且以按钮点击事件埋点为例来简单地讲述自动埋点的思路。

常规埋点

常规的点击事件埋点，大概是酱紫：

- (void)totalBillAction:(UIButton *)sender
{
    [Agent useCustomizeEvent:@"loan114" extra:nil];
}

常规埋点简单直接，哪里需要埋哪里，so easy！但如此一来，代码的复用性几乎为0，维护性也并不理想。那么，我们来借助一下“黑魔法”来实现简易的自动埋点。

自动埋点

1.技术原理：Method-Swizzling

Method-Swizzling，俗称RunTime的“黑魔法”，属于面向切面编程的一种实现。具体操作是在重载类的load方法中，通过method_exchangeImplementations等接口实现方法交换，让程序执行我们的方法。

方法交换的代码，大概是酱紫：

+ (void)swizzlingInClass:(Class)cls originalSelector:(SEL)originalSelector swizzledSelector:(SEL)swizzledSelector
{
    Class class = cls;
    Method originalMethod = class_getInstanceMethod(class, originalSelector);
    Method swizzledMethod = class_getInstanceMethod(class, swizzledSelector);
    
    BOOL didAddMethod =
    class_addMethod(class,
                    originalSelector,
                    method_getImplementation(swizzledMethod),
                    method_getTypeEncoding(swizzledMethod));
    
    if (didAddMethod)
    {
        class_replaceMethod(class,
                            swizzledSelector,
                            method_getImplementation(originalMethod),
                            method_getTypeEncoding(originalMethod));
    }
    else
    {
        method_exchangeImplementations(originalMethod, swizzledMethod);
    }
}

2.实现思路

对于一个给定的事件，UIControl会调用sendAction:to:forEvent:来将行为消息转发到UIApplication对象，再由UIApplication对象调用其sendAction:to:fromSender:forEvent:方法来将消息分发到指定的target上，那么，我们写一个UIControl的类别，通过替换它的sendAction:to:forEvent:方法，结合本地配置的埋点json或者plist文件(若埋点需要额外的参数，需要给UIControl的类别通过Runtime添加属性)，便可以实现自动埋点的功能。

具体实现如下：

@implementation UIControl (UserStastistics)
static char *extraKey = "stastisticExtraKey";

+ (void)load
{
    static dispatch_once_t onceToken;
    dispatch_once(&onceToken, ^
    {
        //原方法
        SEL originalSelector = @selector(sendAction:to:forEvent:);
        //我们要实现的方法
        SEL swizzledSelector = @selector(swiz_sendAction:to:forEvent:);
        //方法交换（具体实现在上面）
        [CommonUtility swizzlingInClass:[self class] originalSelector:originalSelector swizzledSelector:swizzledSelector];
    });
}

#pragma mark - Runtime增加属性
- (void)setStastisticExtraDic:(NSMutableDictionary *)stastisticExtraDic
{
    objc_setAssociatedObject(self, &extraKey,stastisticExtraDic,OBJC_ASSOCIATION_RETAIN_NONATOMIC);
}

- (NSMutableDictionary *)stastisticExtraDic
{
    return objc_getAssociatedObject(self, &extraKey);
}

#pragma mark - Method Swizzling
- (void)swiz_sendAction:(SEL)action to:(id)target forEvent:(UIEvent *)event
{
    [self swiz_sendAction:action to:target forEvent:event];
    //插入埋点代码
    [self performUserStastisticsAction:action to:target forEvent:event];
}

- (void)performUserStastisticsAction:(SEL)action to:(id)target forEvent:(UIEvent *)event
{
    NSString *actionStr = NSStringFromSelector(action);
    actionStr = [actionStr hasPrefix:@"_"]?[actionStr substringFromIndex:1]:actionStr;
    
    //我以NSStringFromClass([target class])_actionStr_self.tag作为key来配置埋点文件
    NSString *controlName = self.tag>0?[NSString stringWithFormat:@"%@_%@_%ld", NSStringFromClass([target class]), actionStr,self.tag]:[NSString stringWithFormat:@"%@_%@", NSStringFromClass([target class]), actionStr];
    
    //埋点具体实现
    [StastisticsUtility stastisticEventData:controlName extraDic:self.stastisticExtraDic];
}

埋点的配置文件，大概是酱紫：

{
    "eventStastistics":
    {
        "RegistrationView_nextBtnClick:":
        {
            "eventId":"sxj_01_004",
            "eventName":"登录/注册-点击【下一步】按钮"
        },
        "VerificationCodeView_voiceSmsButtonClick:":
        {
            "eventId":"sxj_01_008",
            "eventName":"登录/注册-点击【收不到短信，试试语音验证码】按钮"
        },
        "manual_LoginView_popUp":
        {
            "eventId":"sxj_01_009",
            "eventName":"登录/注册-进入弹窗"
        },
    }
}

为了集中管理，我的所有埋点配置都写在了这个json文件中，不方便写自动埋点的，我会以manual为开头命名它的key，在该埋点的地方如下实现：

- (void)totalBillAction:(UIButton *)sender
{
     [StastisticsUtility stastisticEventData:@"manual_LoginView_popUp" extraDic:nil];
}

到这里，简易的自动埋点功能已经实现，页面进出的埋点思路类似，Demo是木有的，因为懒啊！