在博客開始之前肴敛，先說說目前多數(shù)開發(fā)者使用的幾種埋點方案
- 代碼復(fù)制黏貼到需要統(tǒng)計的類和方法中墨辛，工作量大，不利維護
- 使用Method Swizzling機制進行方法替換，將埋點代碼統(tǒng)一管理(全局)
- AOP-利用Aspect框架對需要進行統(tǒng)計的方法進行掛鉤（hook）研底，并注入包含了統(tǒng)計邏輯的代碼塊（block）
- 目前本項目中使用的埋點方案
一：使用Method Swizzling機制進行方法替換，將埋點代碼統(tǒng)一管理(全局)
使用場景：需要監(jiān)聽全局的某一類的同一方法
這種方案被監(jiān)聽的方法單一奏瞬，但會影響全局的所有的類的該方法
#import "SXSwizzleTool.h"
#import <objc/runtime.h>
@implementation SXSwizzleTool
+ (void)SXSwizzleWithClass:(Class)processedClass originalSelector:(SEL)originSelector swizzleSelector:(SEL)swizzlSelector
{
Method originalMethod = class_getInstanceMethod(processedClass, originSelector);
Method swizzleMethod = class_getInstanceMethod(processedClass, swizzlSelector);
BOOL didAddMethod = class_addMethod(processedClass, originSelector, method_getImplementation(swizzleMethod), method_getTypeEncoding(swizzleMethod));
if (didAddMethod) {
class_replaceMethod(processedClass, swizzlSelector, method_getImplementation(originalMethod), method_getTypeEncoding(originalMethod));
}else{
method_exchangeImplementations(originalMethod, swizzleMethod);
}
}
@end
在VC分類中交換viewDidAppear:和viewDidDisappear:方法
@implementation UIViewController (SX)
+ (void) load
{
static dispatch_once_t onceToken;
dispatch_once(&onceToken, ^{
SEL originalAppearSelector = @selector(viewDidAppear:);
SEL swizzleAppearSelector = @selector(swizzleViewDidAppear:);
[SXSwizzleTool sxSwizzleToolWithClass:[self class] originalSelector:originalAppearSelector swizzleSelector:swizzleAppearSelector];
SEL originalDisAppearSelector = @selector(viewDidDisappear:);
SEL swizzleDisAppearSelector = @selector(swizzleViewDidDisappear:);
[SXSwizzleTool sxSwizzleToolWithClass:[self class] originalSelector:originalDisAppearSelector swizzleSelector:swizzleDisAppearSelector];
});
}
- (void) swizzleViewDidAppear:(BOOL)animated
{
[self swizzleViewDidAppear:animated];
if (!self.isNeedMD) {
return;
}
self.mdModel.entry_time = [self getNowTimeString];
// 獲取位置信息
[self getLocation];
}
- (void) swizzleViewDidDisappear:(BOOL)animated
{
[self swizzleViewDidDisappear:animated];
if (!self.isNeedMD) {
return;
}
// 上傳
[self uploadMDdata];
}
涉及到點擊事件時交換sendAction:to:forEvent:方法
@implementation UIControl (SX)
+ (void) load
{
static dispatch_once_t onceToken;
dispatch_once(&onceToken, ^{
SEL originSEL = @selector(sendAction:to:forEvent:);
SEL swizzleSEL = @selector(swizzleSendAction:to:forEvent:);
[SXSwizzleTool SXSwizzleWithClass:[self class] originalSelector:originSEL swizzleSelector:swizzleSEL];
});
}
- (void)swizzleSendAction:(SEL)action to:(id)target forEvent:(UIEvent *)event{
[self swizzleSendAction:action to:target forEvent:event];
if (!self.isNeedSwizzle) {
return;
}
NSString *pathString = [[NSBundle mainBundle]pathForResource:@"MaidianVCList" ofType:@"plist"];
NSDictionary *plistDic = [NSDictionary dictionaryWithContentsOfFile:pathString];
// 獲取當(dāng)前SEL string
NSString *selectorName = NSStringFromSelector(action);
// 獲取當(dāng)前類名
NSString *targetName = NSStringFromClass([target class]);
// 獲取當(dāng)前vc 對應(yīng)的 dic
NSDictionary *controllerDic = plistDic[targetName];
// 之后對此dic做相應(yīng)的處理
}
Plist根據(jù)實際需求配置
屏幕快照 2018-08-24 下午3.35.47.png
當(dāng)然侄刽，同樣的效果，你也可直接使用AOP方案來實現(xiàn)
// VC分類中
+ (void)load{
[UIViewController aspect_hookSelector:@selector(viewDidAppear:)
withOptions:AspectPositionAfter
usingBlock:^(id<AspectInfo>aspectInfo){
NSString *className = NSStringFromClass([[aspectInfo instance] class]);;
// 執(zhí)行埋點操作
} error:nil];
}
// UIControl分類中
+ (void)load{
[UIViewController aspect_hookSelector:@selector(sendAction:to:forEvent:)
withOptions:AspectPositionAfter
usingBlock:^(id<AspectInfo>aspectInfo){
NSString *className = NSStringFromClass([[aspectInfo instance] class]);;
// 執(zhí)行埋點操作
} error:nil];
}
Aspects是iOS平臺一個輕量級的面向切面編程(AOP)框架鹊汛，只包括兩個方法：一個類方法蒲赂，一個實例方法
+ (id<AspectToken>)aspect_hookSelector:(SEL)selector
withOptions:(AspectOptions)options
usingBlock:(id)block
error:(NSError **)error;
- (id<AspectToken>)aspect_hookSelector:(SEL)selector
withOptions:(AspectOptions)options
usingBlock:(id)block
error:(NSError **)error;
函數(shù)使用方式簡單易懂，掛鉤的方式為三種：
typedef NS_OPTIONS(NSUInteger, AspectOptions) {
AspectPositionAfter = 0, /// 在原始方法后調(diào)用（默認）
AspectPositionInstead = 1, /// 替換原始方法
AspectPositionBefore = 2, /// 在原始方法前調(diào)用
AspectOptionAutomaticRemoval = 1 << 3 /// 在執(zhí)行1次后自動移除
};
調(diào)用示例代碼：
[UIViewController aspect_hookSelector:@selector(viewWillAppear:) withOptions:AspectPositionAfter usingBlock:^(id<AspectInfo> aspectInfo, BOOL animated) {
//
} error:NULL];
二：在AppDelegate的類方法中根據(jù)Plist監(jiān)聽清單進行HOOK
場景需求：需要監(jiān)聽不同類柒昏，不同按鈕凳宙，系統(tǒng)方法，及表單元點擊事件
需要手動創(chuàng)建并管理埋點類的Plist文件
AspectMananer.m
#pragma mark --- 監(jiān)控button的點擊事件
+ (void)trackBttonEvent{
__weak typeof(self) ws = self;
//設(shè)置事件統(tǒng)計
//放到異步線程去執(zhí)行
dispatch_async(dispatch_get_global_queue(DISPATCH_QUEUE_PRIORITY_DEFAULT, 0), ^{
//讀取配置文件职祷，獲取需要統(tǒng)計的事件列表
NSString *path = [[NSBundle mainBundle] pathForResource:@"EventList" ofType:@"plist"];
NSDictionary *eventStatisticsDict = [[NSDictionary alloc] initWithContentsOfFile:path];
for (NSString *classNameString in eventStatisticsDict.allKeys) {
//使用運行時創(chuàng)建類對象
const char * className = [classNameString UTF8String];
//從一個字串返回一個類
Class newClass = objc_getClass(className);
NSArray *pageEventList = [eventStatisticsDict objectForKey:classNameString];
for (NSDictionary *eventDict in pageEventList) {
//事件方法名稱
NSString *eventMethodName = eventDict[@"MethodName"];
SEL seletor = NSSelectorFromString(eventMethodName);
NSString *eventId = eventDict[@"EventId"];
[ws trackEventWithClass:newClass selector:seletor eventID:eventId];
[ws trackTableViewEventWithClass:newClass selector:seletor eventID:eventId];
[ws trackParameterEventWithClass:newClass selector:seletor eventID:eventId];
}
}
});
}
#pragma mark -- 1.監(jiān)控button和tap點擊事件(不帶參數(shù))
+ (void)trackEventWithClass:(Class)klass selector:(SEL)selector eventID:(NSString*)eventID{
[klass aspect_hookSelector:selector withOptions:AspectPositionAfter usingBlock:^(id<AspectInfo> aspectInfo) {
NSString *className = NSStringFromClass([aspectInfo.instance class]);
NSLog(@"className--->%@",className);
NSLog(@"event----->%@",eventID);
if ([eventID isEqualToString:@"xxx"]) {
// [EJServiceUserInfo isLogin]?[MobClick event:eventID]:[MobClick event:@"???"];
}else{
// [MobClick event:eventID];
}
} error:NULL];
}
#pragma mark -- 2.監(jiān)控button和tap點擊事件（帶參數(shù)）
+ (void)trackParameterEventWithClass:(Class)klass selector:(SEL)selector eventID:(NSString*)eventID{
[klass aspect_hookSelector:selector withOptions:AspectPositionAfter usingBlock:^(id<AspectInfo> aspectInfo,UIButton *button) {
NSLog(@"button---->%@",button);
NSString *className = NSStringFromClass([aspectInfo.instance class]);
NSLog(@"className--->%@",className);
NSLog(@"event----->%@",eventID);
} error:NULL];
}
#pragma mark -- 3.監(jiān)控tableView的點擊事件
+ (void)trackTableViewEventWithClass:(Class)klass selector:(SEL)selector eventID:(NSString*)eventID{
[klass aspect_hookSelector:selector withOptions:AspectPositionAfter usingBlock:^(id<AspectInfo> aspectInfo,NSSet *touches, UIEvent *event) {
NSString *className = NSStringFromClass([aspectInfo.instance class]);
NSLog(@"className--->%@",className);
NSLog(@"event----->%@",eventID);
NSLog(@"section---->%@",[event valueForKeyPath:@"section"]);
NSLog(@"row---->%@",[event valueForKeyPath:@"row"]);
NSInteger section = [[event valueForKeyPath:@"section"]integerValue];
NSInteger row = [[event valueForKeyPath:@"row"]integerValue];
//統(tǒng)計事件
if (section == 0 && row == 1) {
// [MobClick event:eventID];
}
} error:NULL];
}
Appdelegate.m調(diào)用
[AspectMananer trackBttonEvent];
看不明白的來這里 : 運行時Method Swizzling機制與AOP編程
事實上上述方案是直接從上述鏈接中復(fù)制過來的氏涩，因為通俗易懂，就沒做自己的處理
三. 項目使用方案
作為貸款類app有梆，我們對申請借款的幾個流程界面進行了埋點處理是尖，但現(xiàn)行的埋點方案并沒做到完全解耦，有更好的方案可私信我泥耀，在此謝過!
我們的需求是每一個頁面都要進行定位并獲取用戶的部分信息（包含進出頁面時間饺汹、手機型號、網(wǎng)絡(luò)ip痰催、當(dāng)前頁面部分數(shù)據(jù)等）上傳服務(wù)端
分類VC.h
#import <UIKit/UIKit.h>
#import "SXNavigationController.h"
#import <CoreLocation/CoreLocation.h>
#import "SXMDModel.h"
@interface UIViewController (SX)<CLLocationManagerDelegate>
/* 自定義導(dǎo)航控制器相關(guān) */
@property (nonatomic, assign) BOOL enablePopGestureRecognizer;
@property (nonatomic, strong) SXNavigationController *sx_navigationController;
/* 埋點相關(guān) */
@property (nonatomic, assign) BOOL isNeedMD;//是否需要埋點
@property (nonatomic, strong) SXMDModel *mdModel;//埋點model
@property (nonatomic, strong) CLLocationManager *locationmanager;
/*
* requestId @param 訂單id
* pageTag @param 類似于EventID
* isNeedMD @param 當(dāng)前頁面是否需要埋點
*/
- (void) transferRequestId:(NSString *)requestId pageTag:(NSString *)pageTag isNeedMD:(BOOL)isNeedMD;
@end
分類VC.m
#import "UIViewController+SX.h"
#import <objc/runtime.h>
#import "SXSwizzleTool.h"
#import "SXPersonalParam.h"
#import "SXUserModel.h"
#import "SXLogTool.h"
#import "SXCommonTool.h"
static char const * const ISNEEDMD = "isNeedMD";
@implementation UIViewController (SX)
- (BOOL)enablePopGestureRecognizer {
return [objc_getAssociatedObject(self, _cmd) boolValue];
}
- (void)setEnablePopGestureRecognizer:(BOOL)enablePopGestureRecognizer {
objc_setAssociatedObject(self, @selector(enablePopGestureRecognizer), @(enablePopGestureRecognizer), OBJC_ASSOCIATION_RETAIN);
}
- (SXNavigationController *)sx_navigationController {
return objc_getAssociatedObject(self, _cmd);
}
- (void)setSx_navigationController:(SXNavigationController *)sx_navigationController {
objc_setAssociatedObject(self, @selector(sx_navigationController), sx_navigationController, OBJC_ASSOCIATION_RETAIN);
}
/***********************埋點相關(guān)*************************/
- (BOOL) isNeedMD
{
NSNumber *number = objc_getAssociatedObject(self, ISNEEDMD);
return [number boolValue];
}
- (void) setIsNeedMD:(BOOL)isNeedMD
{
NSNumber *number = [NSNumber numberWithBool:isNeedMD];
objc_setAssociatedObject(self, ISNEEDMD, number, OBJC_ASSOCIATION_RETAIN);
}
- (SXMDModel *) mdModel
{
return objc_getAssociatedObject(self, _cmd);
}
- (void) setMdModel:(SXMDModel *)mdModel
{
objc_setAssociatedObject(self, @selector(mdModel), mdModel, OBJC_ASSOCIATION_RETAIN);
}
- (CLLocationManager *) locationmanager
{
return objc_getAssociatedObject(self, _cmd);
}
- (void) setLocationmanager:(CLLocationManager *)locationmanager
{
objc_setAssociatedObject(self, @selector(locationmanager), locationmanager, OBJC_ASSOCIATION_RETAIN);
}
+ (void) load
{
static dispatch_once_t onceToken;
dispatch_once(&onceToken, ^{
SEL originalAppearSelector = @selector(viewDidAppear:);
SEL swizzleAppearSelector = @selector(swizzleViewDidAppear:);
[SXSwizzleTool sxSwizzleToolWithClass:[self class] originalSelector:originalAppearSelector swizzleSelector:swizzleAppearSelector];
SEL originalDisAppearSelector = @selector(viewDidDisappear:);
SEL swizzleDisAppearSelector = @selector(swizzleViewDidDisappear:);
[SXSwizzleTool sxSwizzleToolWithClass:[self class] originalSelector:originalDisAppearSelector swizzleSelector:swizzleDisAppearSelector];
});
}
- (void) swizzleViewDidAppear:(BOOL)animated
{
[self swizzleViewDidAppear:animated];
if (!self.isNeedMD) {
return;
}
self.mdModel.entry_time = [self getNowTimeString];
// 獲取位置信息
[self getLocation];
}
- (void) swizzleViewDidDisappear:(BOOL)animated
{
[self swizzleViewDidDisappear:animated];
if (!self.isNeedMD) {
return;
}
// 上傳(這里本人提出過數(shù)據(jù)存儲兜辞，按時間段或者數(shù)據(jù)條數(shù)上傳，未被采納夸溶，說是后期再作考慮逸吵，然而......)
[self uploadMDdata];
}
-(void)getLocation
{
//判斷定位功能是否打開
if ([CLLocationManager locationServicesEnabled]) {
self.locationmanager = [[CLLocationManager alloc]init];
self.locationmanager.delegate = self;
[self.locationmanager requestWhenInUseAuthorization];
//設(shè)置尋址精度
self.locationmanager.desiredAccuracy = kCLLocationAccuracyBest;
self.locationmanager.distanceFilter = 5.0;
[self.locationmanager startUpdatingLocation];
}
}
#pragma mark CoreLocation delegate (定位失敗)
-(void)locationManager:(CLLocationManager *)manager didFailWithError:(NSError *)error
{
self.mdModel.latitude = @"";
self.mdModel.longitude = @"";
}
#pragma mark 定位成功后則執(zhí)行此代理方法
-(void)locationManager:(CLLocationManager *)manager didUpdateLocations:(NSArray<CLLocation *> *)locations
{
[self.locationmanager stopUpdatingHeading];
CLLocation *currentLocation = [locations lastObject];
self.mdModel.latitude = [NSString stringWithFormat:@"%.5f",currentLocation.coordinate.latitude];
self.mdModel.longitude = [NSString stringWithFormat:@"%.5f",currentLocation.coordinate.longitude];
}
#pragma mark - 上傳埋點信息
- (void) uploadMDdata
{
self.mdModel.submit_time = [self getNowTimeString];
/* 添加埋點 */
SXUserModel *model = [SXLogTool getLoginUser];
CafintechSecurityForiOS *cafintechSecurity = [[CafintechSecurityForiOS alloc] init];
NSString *deviceJson = [cafintechSecurity getPhoneInfoWithJsonStringLongitude:self.mdModel.longitude Latitude:self.mdModel.latitude];
NSDictionary *deviceDic = [deviceJson jsonStringToDictionary];
[deviceDic setValue:model.mobile forKey:@"mobile"];
[deviceDic setValue:model.token forKey:@"token"];
[deviceDic setValue:self.mdModel.requestId forKey:@"requestId"];
[deviceDic setValue:self.mdModel.page_tag forKey:@"page_tag"];
[deviceDic setValue:self.mdModel.entry_time forKey:@"entry_time"];
[deviceDic setValue:self.mdModel.submit_time forKey:@"submit_time"];
SXPersonalParam *param = [SXPersonalParam personalParamWithData:deviceDic serviceId:@"JUNCAI0055"];
[SXCommonTool commonToolWithParam:param success:^(SXCommonResult *result) {
} failure:^(NSError *error) {
}];
}
- (void) transferRequestId:(NSString *)requestId pageTag:(NSString *)pageTag isNeedMD:(BOOL)isNeedMD
{
self.mdModel = [[SXMDModel alloc]init];
self.isNeedMD = isNeedMD;//也可嵌入mdModel
self.mdModel.requestId = requestId;
self.mdModel.page_tag = pageTag;
}
- (NSString *) getNowTimeString
{
NSDate *date = [NSDate date];
NSDateFormatter *formatter = [[NSDateFormatter alloc]init];
formatter.dateFormat = @"yyyy-MM-dd HH:mm:ss";
return [formatter stringFromDate:date];
}
@end
之所以說未完全從頁面中分離出來，是因為需要在當(dāng)前需要埋點的vc中做以下配置
- (void) viewWillAppear:(BOOL)animated
{
[super viewWillAppear:animated];
// requestId：訂單號 pagTag：頁面標志 isNeedMD：是否需要埋點
[self transferRequestId:self.caseNumModel.requestId pageTag:@"2" isNeedMD:YES];
}
事實上從技術(shù)上是可以做到完全解耦缝裁，就是為每個頁面生成一個model用于存儲requestId扫皱、pageTag、isNeedMD等信息捷绑，在分類中取出即可韩脑，但是這樣并沒有比現(xiàn)有方案簡單，所以暫不采納粹污！
運行時Method Swizzling機制與AOP編程
可復(fù)用而且高度解耦的用戶統(tǒng)計埋點實現(xiàn)
關(guān)于埋點的思考
無侵入埋點
最后段多，有任何疑問或者建議，歡迎敲門騷擾壮吩！
