概念
代码埋点:
通过手写代码的方式进行埋点。代码埋点存在高度耦合、依赖发版、无法动态更新、容易误删、重复埋点等问题。
无埋点:
其实所谓无埋点就是开发者无需再对追踪点进行埋码,而是脱离代码,只需面对应用界面圈圈点点即可追加随时生效的事件数据点。无埋点的基础是圈选,圈选的基础是元素。无埋点的说法并不准确,与其说无埋点不如说成可视化埋点更为简单,易理解。
不懂代码的人也可以通过后台配置锚点并实时下发到客户端生效
解决代码埋点本身成本过高,可视化操作,更容易上手;把核心代码和配置进行分离
避免代码写死,需要更新版本才能生效的笨拙方式;变得更为主动灵活高效
Codeless: 开发人员只需要集成几行初始化代码即可热更新:修改、添加方便,无需重新编译打包,效率高,成本低可视化:可视化埋点操作,运营和实施人员就可以完成配置即代码:灵活、可扩展埋点功能由配置控制
无埋点SDK的整体实现思路以及关键的技术点
具备不需要代码埋点就能 自动的、动态可配的、全面且正确 的收集用户在使用 App 时的所有事件数据,配合圈选SDK,能够在 App 端完成对界面元素的圈配以及 KVC 配置的上传。而界面元素圈配的工作完全可以交给用研与产品人员来做,减轻了开发人员的工作量。
从上图可以看出,在实现 SDK 的无埋点数据收集时,主要分为3步:上传KVC配置、请求KVC配置、业务数据的收集与上报。
原理
- 第一步:通过可视化工具配置采集的 View。例如使用已经嵌入了SDK的App连接管理界面,当手机App与后台同步时,后台管理界面上会显示和手机App一样的界面,用户可以在管理界面上用鼠标选择需要监测的元素,设置事件名称,保存这个配置。(也有一些SDK,比如GrowingIO的SDK圈选操作是在手机悬浮了一个原点,拖动圆点到需要监测的元素上来设置埋点位置的,不管是什么方式本质上是一样的,需要保存一份配置到后台)。
- 第二步:App解析配置,找到View,Hook它的事件并上报数据。 例如嵌入了SDK的App启动时,会从服务器获取到一份配置,再根据这份配置去检测App中的界面及其元素,满足配置的条件时向服务器上报事件。
技术实现思路
SDK 整体采用了 AOP(Aspect-Oriented-Programming)即面向切面编程的思想,就是动态的在函数调用的前后插入数据收集的代码。在 Objective-C 中的实现是基于 Runtime 特性的 Method Swizzling 黑魔法。
- 获取时机:
核心技术是利用苹果的 runtime机制,把系统事件、点击事件的指针替换成我们自己的函数来监测用户的操作,我们在自己的函数中采集并发送需要的数据
(1)UIControl类型的控件hook – (void)sendAction:(SEL) to:(id)target forEvent:(UIEvent *)event
(2)UIScrollView,UITextView,UITableView,UICollectionView 类型的控件,先hook -(void)setDelegate:(id)delegate 方法,然后再hook想要采集事件的代理方法,例如textViewDidBeginEditing 、tableview:(UITableView *)tableview didSelectRowAtIndexPath:(NSIndexPath *)indexPath 等。(3)带手势事件的视图 hook -(void)addGestureRecognizer方法,并在方法实现中给手势对象添加新的target和action ,- (void)addTarget:(id)target action:(SEL)action。
定义工具类
@interface HookUtility : NSObject
+ (void)swizzlingInClass:(Class)cls originalSelector:(SEL)originalSelector swizzledSelector:(SEL)swizzledSelector;
@end
#import
+ (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);
}
}
例子一、页面呈现耗时主要是hook所有的 viewcontroller 的 viewDidAppear 函数,利用 iOS的运行时使用 method swizzling 技术拦截系统函数,替换为自己的函数实现UIViewController的类别
#import "UIViewController+userStatics.h"
#import "HookUtility.h"
@implementation UIViewController (userStatics)
+ (void)load {
static dispatch_once_t onceToken;
dispatch_once(&onceToken, ^{
SEL originalSelector = @selector(viewWillAppear:);
SEL swizzledSelector = @selector(swiz_viewWillAppear:);
[HookUtility swizzlingInClass:[self class] originalSelector:originalSelector swizzledSelector:swizzledSelector];
SEL originalSelectorDis = @selector(viewWillDisappear:);
SEL swizzledSelectorDis = @selector(swiz_viewWillDisappear:);
[HookUtility swizzlingInClass:[self class] originalSelector:originalSelectorDis swizzledSelector:swizzledSelectorDis];
});
}
- (void)swiz_viewWillAppear:(BOOL)animated {
//插入需要执行的代码
NSLog(@"我在viewWillAppear执行前偷偷插入了一段代码%@",[self class]);
//不能干扰原来的代码流程,插入代码结束后要让本来该执行的代码继续执行
[self swiz_viewWillAppear:animated];
}
- (void)swiz_viewWillDisappear:(BOOL)animated {
//插入需要执行的代码
NSString *pageName=NSStringFromClass([self class]);
NSLog(@"结束监听%@",pageName);
//不能干扰原来的代码流程,插入代码结束后要让本来该执行的代码继续执行
[self swiz_viewWillDisappear:animated];
}
例子二、可以用在其它的类比如监听整个app的按钮点击:UIControl类别
#import "UIViewController+userStatics.h"
#import "HookUtility.h"
@implementation UIViewController (userStatics)
+ (void)load {
static dispatch_once_t onceToken;
dispatch_once(&onceToken, ^{
SEL originalSelector = @selector(viewWillAppear:);
SEL swizzledSelector = @selector(swiz_viewWillAppear:);
[HookUtility swizzlingInClass:[self class] originalSelector:originalSelector swizzledSelector:swizzledSelector];
SEL originalSelectorDis = @selector(viewWillDisappear:);
SEL swizzledSelectorDis = @selector(swiz_viewWillDisappear:);
[HookUtility swizzlingInClass:[self class] originalSelector:originalSelectorDis swizzledSelector:swizzledSelectorDis];
});
}
- (void)swiz_viewWillAppear:(BOOL)animated
{
//插入需要执行的代码
NSLog(@"我在viewWillAppear执行前偷偷插入了一段代码%@",[self class]);
//不能干扰原来的代码流程,插入代码结束后要让本来该执行的代码继续执行
[self swiz_viewWillAppear:animated];
}
- (void)swiz_viewWillDisappear:(BOOL)animated
{
//插入需要执行的代码
NSString *pageName=NSStringFromClass([self class]);
NSLog(@"结束监听%@",pageName);
//不能干扰原来的代码流程,插入代码结束后要让本来该执行的代码继续执行
[self swiz_viewWillDisappear:animated];
}
例子二、可以用在其它的类比如监听整个app的按钮点击:UIControl类别
import "UIControl+userStatics.h"
#import "HookUtility.h"
@implementation UIControl (userStatics)
+ (void)load {
static dispatch_once_t onceToken;
dispatch_once(&onceToken, ^{
SEL originalSelector = @selector(sendAction:to:forEvent:);
SEL swizzledSelector = @selector(swiz_sendAction:to:forEvent:);
[HookUtility swizzlingInClass:[self class] originalSelector:originalSelector swizzledSelector:swizzledSelector];
});
}
#pragma mark - Method Swizzling
- (void)swiz_sendAction:(SEL)action to:(id)target forEvent:(UIEvent *)event{
//插入埋点代码
[self performUserStastisticsAction:action to:target forEvent:event];
[self swiz_sendAction:action to:target forEvent:event];
}
- (void)performUserStastisticsAction:(SEL)action to:(id)target forEvent:(UIEvent *)event; {
NSLog(@"\n***hook success.\n[1]action:%@\n[2]target:%@ \n[3]event:%ld", NSStringFromSelector(action), target, (long)event);
}
2.控件的viewPath及 viewId 的生成:为了对 APP 中某个页面的某个 view 进行数据收集、统计与分析,首先就需要能够唯一的标识与定位这个视图,这可以说是数据收集 SDK 的一个重要前提。那么怎样去唯一的标识 APP 中的某个 view 呢?SDK 中使用了 viewPath 与 viewId 来完成。
其实整个 APP 的视图结构可以看成是一颗树(viewTree),树的根节点就是 UIWindow,树的枝干由UIViewController及UIView组成,树的叶节点都是由UIView组成。
②viewId 的生成
viewPath 的长度不固定,而且一般都会比较长,不便于后台使用它作为 view 的唯一标识。因此 SDK 使用viewPath信息通过MD5加密生成一个固定长度的值作为viewId。
总结
无码埋点的关键技术,就是以上分析的几点,首先通过可视化圈选拿到需要绑定事件视图,并生成唯一标识viewPath,通过hook系统控件的方法,拿到用户触发的视图,生成视图的viewPath与本地的事件列表比对,比对成功则上传viewPath对应的事件。