由於我們的業務越來越重，並且對於資料的要求也越來越高，所以在業務程式碼中需要嵌入大量的資料上報程式碼，而且大部分還都是膠水程式碼。
所以為了提高人效，降低耦合，精簡業務程式碼等目的，終於！我重構了這部分程式碼。
一、基礎框架
- YGTracking，為基礎類。主要功能為，初始化第三方SDK，傳送事件，封裝第三方方法
- YGTrackingEnum，為列舉定義類，主要功能即定義列舉
- YGTrackingBaseModel，為資料定義基礎類，所有其他的資料定義model都繼承自它。主要功能，即定義上報所需引數，通過外部引數的不同，定義事件名稱，格式化資料，區分上報平臺（目前我們有Talking和神策兩個平臺）
二、使用方法
而外部使用方法十分簡單，則可以總結為如下：
- 建立model
- model賦值資料（業務所需上報引數）
- 定義上報平臺
- 定義上報事件
- 定義上報引數
- 開始上報
例如：
//使用巨集初始化model
YGTrackingModel(YGTrackingPlayActionModel)
//給model賦值業務需要的資料
ygTrackingModel.plan = self.plan;
ygTrackingModel.course = self.course;
ygTrackingModel.playTime = self.actualPlayingTime;
ygTrackingModel.actionType = YGTrackingPlayActionTypeFinish;
//傳送事件
YGTrackingGo
複製程式碼外部呼叫只需要關心和業務有關的引數即可，其他事情都被封裝在model中進行
三、程式碼實現
YGTracking.h
#import <Foundation/Foundation.h>
#import "SensorsAnalyticsSDK.h"
#import <ShareSDK/ShareSDK.h>
#import "YGTrackingEnum.h"
#import "TalkingData.h"
#pragma mark - model.h
#import "YGTrackingClickSearchResultModel.h"
#import "YGTrackingShareEndActionModel.h"
#import "YGTrackingEvaluateActionModel.h"
#import "YGTrackingDownloadActionModel.h"
#import "YGTrackingClickGeneralModel.h"
#import "YGTrackingWatchActionModel.h"
#import "YGTrackingShareActionModel.h"
#import "YGTrackingPageGeneralModel.h"
#import "YGTrackingPlayActionModel.h"
#import "YGTrackingShareModel.h"
#import "YGTrackingOldAdModel.h"
#import "YGTrackVideoAdModel.h"
#import "YGTrackingDealModel.h"
#import "YGTrackingBaseModel.h"
#import "YGTrackingPostModel.h"
#import "YGTrackingAdModel.h"
/// 初始化model的巨集
#define YGTrackingModel(A) A *ygTrackingModel = [[A alloc]init];
/// 傳送model事件的巨集
#define YGTrackingGo [YGTracking trackModel:ygTrackingModel];
@interface YGTracking : NSObject
/**
初始化上報SDK
*/
+ (void)registTrackSDK;
/**
神策聯通webview中的上報
*/
+ (BOOL)showUpWebView:(id)webView WithRequest:(NSURLRequest *)request;
/**
傳送model事件
*/
+ (void)trackModel:(YGTrackingBaseModel *)model;
/**
傳送普通事件
*/
+ (void)trackEvent:(NSString *)event property:(NSDictionary *)property supportPlatform:(YGAdTrackingPlatform)supportPlatform;
@end
複製程式碼YGTracking.m
#import "YGTracking.h"
#import "NSString+YGAddition.h"
@implementation YGTracking
/**
初始化上報SDK
*/
+ (void)registTrackSDK {
// TalkingData
[TalkingData backgroundSessionEnabled];
[TalkingData sessionStarted:kYGTalkingDataKey withChannelId:@"AppStore"];
[TalkingData setLogEnabled:NO];
// 神策SDK初始化
[SensorsAnalyticsSDK sharedInstanceWithServerURL:kYGSensorsReportURL
andDebugMode:SensorsAnalyticsDebugOff];
//神策註冊公共屬性
[[SensorsAnalyticsSDK sharedInstance] registerSuperProperties:@
{
@"PlatformType": @"iOS"
}];
// 神策 開啟自動採集, 並指定追蹤哪些 AutoTrack 事件
[[SensorsAnalyticsSDK sharedInstance] enableAutoTrack:SensorsAnalyticsEventTypeAppStart];
[[SensorsAnalyticsSDK sharedInstance]trackInstallation:@"AppInstall"];
//神策 打通H5
[[SensorsAnalyticsSDK sharedInstance] enableLog:NO];
NSLog(@"神策版本:%@", [[SensorsAnalyticsSDK sharedInstance]libVersion]);
}
/**
神策聯通webview中的上報
*/
+ (BOOL)showUpWebView:(id)webView WithRequest:(NSURLRequest *)request {
return [[SensorsAnalyticsSDK sharedInstance]showUpWebView:webView WithRequest:request];
}
/**
傳送model事件
*/
+ (void)trackModel:(YGTrackingBaseModel *)model {
dispatch_async(dispatch_get_global_queue(DISPATCH_QUEUE_PRIORITY_DEFAULT, 0), ^{
NSString *event = [model enventName];
NSDictionary *property = [model trackParam];
if (![event formatNull]
|| !IS_DICTIONARY(property)) {
return;
}
if ([model supportPlatform] & YGAdTrackingPlatformSensor) {
[[SensorsAnalyticsSDK sharedInstance]track:event withProperties:property];
}
if ([model supportPlatform] & YGAdTrackingPlatformTD) {
[TalkingData trackEvent:event label:@"" parameters:property];
}
});
}
/**
傳送普通事件
*/
+ (void)trackEvent:(NSString *)event property:(NSDictionary *)property supportPlatform:(YGAdTrackingPlatform)supportPlatform {
if (![event formatNull]
|| !IS_DICTIONARY(property)) {
return;
}
dispatch_async(dispatch_get_global_queue(DISPATCH_QUEUE_PRIORITY_DEFAULT, 0), ^{
if (supportPlatform & YGAdTrackingPlatformSensor) {
[[SensorsAnalyticsSDK sharedInstance]track:event withProperties:property];
}
if (supportPlatform & YGAdTrackingPlatformTD) {
[TalkingData trackEvent:event label:@"" parameters:property];
}
});
}
@end
複製程式碼YGTrackingBaseModel.h
#import <Foundation/Foundation.h>
@interface YGTrackingBaseModel : NSObject
/**
支援上報平臺的型別
*/
- (YGAdTrackingPlatform)supportPlatform;
/**
返回事件名
*/
- (NSString *)enventName;
/**
返回事件所需引數dic
*/
- (NSDictionary *)trackParam;
@end
複製程式碼YGTrackingBaseModel.m
#import "YGTrackingBaseModel.h"
@implementation YGTrackingBaseModel
/**
支援上報平臺的型別
*/
- (YGAdTrackingPlatform)supportPlatform {
return 0;
}
/**
返回事件名
*/
- (NSString *)enventName {
return @"";
}
/**
返回事件所需引數dic
*/
- (NSDictionary *)trackParam {
return nil;
}
@end
複製程式碼目前此基類*YGTrackingBaseModel*只是為了實現一些虛擬函式而存在，函式實現主要在子類中，下面貼一個子類作為例子：
YGTrackingAdModel.h
#import "YGTrackingBaseModel.h"
@interface YGTrackingAdModel : YGTrackingBaseModel
/// 表現型別 YGAdTrackingModelType 彈框/開屏。。。
@property(nonatomic, assign)YGAdTrackingModelType modelType;
/// 行為型別 YGAdTrackingType 點選/展示/關閉
@property(nonatomic, assign)YGAdTrackingType trackingType;
/// 廣告位id
@property(nonatomic, copy)NSString *adID;
/// 廣告物料型別（跳轉到哪裡)
@property(nonatomic, assign)YGOpenLinkType adType;
/// 廣告來源型別（美數/億動。。。）
@property(nonatomic, assign)YGAdResourceType adResourceType;
/// 推薦廣告所在頁面
@property(nonatomic, assign)NSInteger pageID;
/// 到達該頁面的訓練id/產品id
@property(nonatomic, copy)NSString *referID;
/// 廣告位中的廣告id
@property(nonatomic, copy)NSString *contentID;
/// 位置
@property(nonatomic, assign)NSInteger index;
@end
複製程式碼YGTrackingAdModel.m
#import "YGTrackingAdModel.h"
@implementation YGTrackingAdModel
/**
支援上報平臺的型別
*/
- (YGAdTrackingPlatform)supportPlatform {
if (self.trackingType == YGAdTrackingTypeClick) {
return YGAdTrackingPlatformSensor | YGAdTrackingPlatformTD;
}
return YGAdTrackingPlatformTD;
}
/**
返回事件名
*/
- (NSString *)enventName {
if (self.modelType == YGAdTrackingTypeRecommend) {
if (self.trackingType == YGAdTrackingTypeDisplay) {
return @"view_operation_recommend";
}
if (self.trackingType == YGAdTrackingTypeClick) {
return @"click_operation_recommend";
}
if (self.trackingType == YGAdTrackingTypeClose) {
return @"close_operation_recommend";
}
}
if (self.modelType == YGAdTrackingTypeOpenScreen) {
if (self.trackingType == YGAdTrackingTypeDisplay) {
return @"view_operation_open_screen";
}
if (self.trackingType == YGAdTrackingTypeClick) {
return @"click_operation_open_screen";
}
}
if (self.modelType == YGAdTrackingTypeTips) {
if (self.trackingType == YGAdTrackingTypeDisplay) {
return @"view_operation_tips";
}
if (self.trackingType == YGAdTrackingTypeClick) {
return @"click_operation_tips";
}
if (self.trackingType == YGAdTrackingTypeClose) {
return @"close_operation_tips";
}
}
if (self.modelType == YGAdTrackingTypeTips) {
if (self.trackingType == YGAdTrackingTypeDisplay) {
return @"view_operation_banner";
}
if (self.trackingType == YGAdTrackingTypeClick) {
return @"click_operation_banner";
}
if (self.trackingType == YGAdTrackingTypeClose) {
return @"close_operation_banner";
}
}
return @"";
}
/**
返回事件所需引數dic
*/
- (NSDictionary *)trackParam {
NSMutableDictionary *params = [NSMutableDictionary dictionary];
[params setValue:self.adID forKey:@"ad_id"];
[params setValue:@(self.adType) forKey:@"ad_type"];
[params setValue:@(self.adResourceType) forKey:@"ad_resource_type"];
[params setValue:@(self.pageID) forKey:@"page_id"];
[params setValue:[NSString stringWithFormat:@"%@_%@", @(self.pageID), self.referID] forKey:@"refer_id"];
[params setValue:self.contentID forKey:@"contentid"];
[params setValue:@(self.index) forKey:@"frame"];
return params;
}
@end
複製程式碼後續，無論是時間增改欄位，還是事件名替換，或者同一源行為增加事件，都直接修改相應的model即可，對業務程式碼的修改較少，尤其是像課程或者廣告的相關事件，本身資料上報model接收的引數就是課程model或者廣告自身model，業務程式碼幾乎不需要更改。
並且，無論是增改執行緒，更換資料上報平臺等等操作，都可以集中進行。
相信，後面我們資料上報工作會越來越高效清晰，為我們資料驅動作為業務行為的同時，也大大提升了此部分的開發效率