使用说明
该文档提供给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 依赖了第三方类库。
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];