iOS大数据埋点SDK快速集成文档

使用说明

该文档提供给iOS开发团队使用,便于在应用中快速集成埋点SDK。目前为方便扩展,提供源码使用。

SVN地址https://172.16.3.100/svn/ios/xxxx/JJSAnalytics/trunk/JJSAnalytics


快速集成

第 1 步:集成埋点SDK

  • 方式一
    结合现有应用架构, 推荐使用 CocoaPods 集成,在 Podfile 文件加入:
pod 'JJSAnalytics', :svn => "https://172.16.3.100/svn/ios/xxxx/JJSAnalytics/trunk/JJSAnalytics"

然后在终端进入项目所在目录,执行:

pod install
  • 方式二
    从 SVN 上 Check out 源码加入到项目中使用:
埋点SDK项目.png

注意 :使用方式二需要添加依赖,该 SDK 依赖了第三方类库。

s.dependency 'AFNetworking', '~> 3.0'
s.dependency 'FMDB'

第 2 步:初始化埋点SDK

导入头文件:

#import <JJSAnalytics/JJSAnalyticsApi.h>

初始化设置:

AnalysisSetting *setting = [[AnalysisSetting alloc] init];
setting.clearTime = 3600 * 24;
setting.autoUploadInterval = 3600;
[JJSAnalyticsApi sharedInstance].analysisSetting = setting;
[JJSAnalyticsApi sharedInstance].host = HOST;

启动:

[JJSAnalyticsApi startWithParams:@{@"appid":@"JJSApp"}];

下面我们给一个完整的示例:

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
    // 大数据埋点
    AnalysisSetting *setting = [[AnalysisSetting alloc] init];
    setting.clearTime = 3600 * 24;
    setting.autoUploadInterval = 3600;
    [JJSAnalyticsApi sharedInstance].analysisSetting = setting;
    [JJSAnalyticsApi sharedInstance].host = HOST;
    // Base info
    NSMutableDictionary *baseInfo = [@{} mutableCopy];
    [baseInfo setObject:[JJSHttpUtils getNetworkType] forKey:@"networktype"]; // 联网模式
    [baseInfo setObject:[JJSHttpUtils netPriovider] forKey:@"networkprovider"]; // 网络提供商
    [baseInfo setObject:[GetForIPMac getIPAddress] ? : @"" forKey:@"ip"]; // IP
    NSString *adId = [[[ASIdentifierManager sharedManager] advertisingIdentifier] UUIDString];
    [baseInfo setObject:adId forKey:@"idfa"]; // 广告标识符
    [baseInfo setObject:[NSString stringWithFormat:@"%f",[JJSBaiduLocationManager sharedInstance].userLocation.location.coordinate.longitude] forKey:@"lng"]; // 经度
    [baseInfo setObject:[NSString stringWithFormat:@"%f",[JJSBaiduLocationManager sharedInstance].userLocation.location.coordinate.latitude] forKey:@"lat"];// 纬度
    [JJSAnalyticsApi additionalParams:baseInfo];
    // 启动事件
    [JJSAnalyticsApi beginEvent:@{@"id":@"ST0001",@"et":[JJSUtil timeDateFormatter:[NSDate date] type:11]} andParams:nil];
    [JJSAnalyticsApi startWithParams:@{@"appid":@"JJSApp"}];
}

第 3 步:事件埋点

针对某些特性的操作,比如:用户点了某个拨号按钮,需要对这个行为进行埋点采集,那么我们可以记录一个事件,我们可以在拨号按钮的点击事件中插入如下代码:

[JJSAnalyticsApi beginEvent:@{@"id":@"CALL0001",@"time":[JJSUtil timeDateFormatter:[NSDate date] type:11]} andParams:headerExtension];

说明 :[JJSAnalyticsApi beginEvent:@{} andParams:@{}] 中第一个参数是事件的主要信息,例如:Event id,time等,第二个参数是一些具体的参数,可以根据业务需要进行采集。参数均以 NSDictionary 形式给出。

第 4 步:页面埋点

针对页面的访问路径,SDK提供了页面进出采集功能,比如:用户进入了 Homepage 页面,我们可以在 viewWillAppear 方法中插入如下代码:

[JJSAnalyticsApi beginLogPageView:@{@"id":@"Homepage"} andParams:nil];

用户离开了 Homepage 页面,我们可以在 viewWillDisappear 方法中插入如下代码:

[JJSAnalyticsApi endLogPageView:@{@"id":@"Homepage"} andParams:nil];

下面是一个完整的示例:

- (void)viewWillAppear:(BOOL)animated {
    [super viewWillAppear:animated];
    [JJSAnalyticsApi beginLogPageView:@{@"id":@"LocationViewController"} andParams:nil];
}

- (void)viewWillDisappear:(BOOL)animated {
    [super viewWillDisappear:animated];
    [JJSAnalyticsApi endLogPageView:@{@"id":@"LocationViewController"} andParams:nil];
}

说明:为了更大程度地减少代码侵入性,提高可维护性,这里建议这种页面访问路径地统计,可以采用 AOP 来实现:

[UIViewController aspect_hookSelector:@selector(viewWillAppear:)
                          withOptions:AspectPositionBefore
                           usingBlock:^(id<AspectInfo> info){
                               // 统计代码写在此处
                               Class instance = (Class)[info instance];
                               if ([[instance class] isSubclassOfClass:[JJSViewController class]]) {
                               [JJSAnalyticsApi beginLogPageView:@{@"id":NSStringFromClass([instance class])} andParams:nil];
                               }
                           }
                                error:NULL];
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 159,569评论 4 363
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 67,499评论 1 294
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 109,271评论 0 244
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 44,087评论 0 209
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,474评论 3 287
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,670评论 1 222
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,911评论 2 313
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,636评论 0 202
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,397评论 1 246
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,607评论 2 246
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,093评论 1 261
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,418评论 2 254
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,074评论 3 237
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,092评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,865评论 0 196
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,726评论 2 276
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,627评论 2 270

推荐阅读更多精彩内容