自定义 SDK

SDK结构介绍
SDK 可以通过拆分成 模块、服务实现模块化，在 GrowingIO 的 SDK 中，已经有多个模块功能已经从代码中分离出来，后续将会独立出更多的模块， GrowingAnalytics.podspec 文件中包含了所有的相关信息。
 模块 
具有单独业务功能的模块，例如圈选，Mobile Debugger。模块遵循 模块协议 且需要进行初始化操作，并可能使用服务。Module 可以去除。
名称
说明
是否可选
MobileDebugger
数据调试Mobile Debugger，默认集成在埋点SDK中
是
WebCircle
基于无埋点的圈选插件，默认集成在无埋点SDK中
是
Hybrid
混合开发模式，默认集成在无埋点SDK中（无埋点中自动注入），埋点SDK需要手动导入
是
更多开发中...
​
​
 服务 
具有单个逻辑处理的单元，供Module使用，可替换，可去除。例如 网络发送服务、加密服务。对应的 Service Protocol 协议可以去 Services 下查看。
可以创建自己的Service服务并替换原有Service服务，例如选用自己的加密服务。不应该去除任意Service，除非您的模块和核心库都没有使用该Service。
名称
说明
是否可选
Database
数据库服务，处理事件数据
是
Network
网络发送服务
是
WebSocket
websocket服务，用于圈选以及Mobile Debugger
是
Compression
压缩服务，用于网络发送时的数据压缩
是
Encryption
加密服务，用于网络发送时的数据加密
是
更多开发中...
​
​
 核心库 
名称
说明
是否可选
TrackerCore
埋点核心库，包含最基本的埋点逻辑，以及service协议，是最基础的模块
否
AutotrackerCore
无埋点核心库，依赖于埋点核心库，包含无埋点的注入逻辑
否（埋点SDK无需集成此库）
 外壳 
GrowingTracker 和 GrowingAutotracker 属于外壳部分，相当于一个菜篮，里面装了从市场中选购的 Module以及Service ，外壳一般只要一个对外接口类，可以自行定义接口开放程度。
如果需要高度定制化SDK，可以创建自己的外壳类，并在spec配置中选择需要依赖的Module以及Service。
名称
说明
依赖
Tracker
埋点SDK
TrackerCore、MobileDebugger、Database、Network、Encryption、Compression
Autotracker
无埋点SDK
AutotrackerCore、Hybrid、MobileDebugger、WebCircle、Database、Network、Encryption、Compression
 配置项 
对于常用的可选配置，增加了配置项，通过Pod引入可以实现
名称
说明
DISABLE_IDFA
禁用IDFA，且SDK中不会再有相关的IDFA代码逻辑
ENABLE_ENCRYPTION
禁用数据加密，使用明文
如果仅需要禁用idfa，则在pod文件中添加 pod 'GrowingAnalytics/DISABLE_IDFA' 即可，而无需自定义SDK。
接下来，介绍如何自定义您的专属SDK
二次开发
1. 创建一个外壳
因为外壳固定配置了 Module 以及 Service，所以我们需要自定义我们的外壳，才能自定义配置Module以及Service ,使用 Cocoapods 配置最为方便，这里以修改SDK的Autotracker 配置为例：
首先自定义开发就不能使用 Cocoapods 库上的 Autotracker 版本，可以从 Github仓库 上下载最新的 Release包 （版本大于或等于3.2.1）
解压到本地，然后在原工程的 podfile 文件中修改依赖关系为路径依赖：
原来：
pod 'GrowingAnalytics/Autotracker'
修改后：
pod 'GrowingAnalytics/Autotracker', :path => './../growingio-sdk-ios-autotracker'
路径请设置为相对路径，例如 ./../growingio-sdk-ios-autotracker
3. 修改 GrowingAnalytics.podspec 文件中 Autotracker 的配置：
s.subspec 'Autotracker' do |autotracker|
      autotracker.source_files = 'GrowingAutotracker/**/*{.h,.m,.c,.cpp,.mm}'
      autotracker.dependency 'GrowingAnalytics/AutotrackerCore'
      autotracker.dependency 'GrowingAnalytics/MobileDebugger'
      autotracker.dependency 'GrowingAnalytics/WebCircle'
      
      autotracker.dependency 'GrowingAnalytics/Network'
      autotracker.dependency 'GrowingAnalytics/Encryption'
      autotracker.dependency 'GrowingAnalytics/Compression'
  end
例如需要去掉 WebCirle 和 MobileDebugger ，则修改为：
s.subspec 'Autotracker' do |autotracker|
      autotracker.source_files = 'GrowingAutotracker/**/*{.h,.m,.c,.cpp,.mm}'
      autotracker.dependency 'GrowingAnalytics/AutotrackerCore'
      
      autotracker.dependency 'GrowingAnalytics/Network'
      autotracker.dependency 'GrowingAnalytics/Encryption'
      autotracker.dependency 'GrowingAnalytics/Compression'
  end
对于AutoTracker中的 Service ，不建议去除，建议替换，例如Network 负责网络，如果去除将无法进行网络数据发送，用户可以自定义一个网络Service来进行替换原来固有的 Network ，这点后续会进行说明。
4. 执行 pod install ，所修改的 Autotracker 配置即可生效。
Autotracker中只包含了一个GrowingAutotracker类（Tracker同理），如果用户想在其基础上修改扩展，请参考或使用这个类
2. 替换Service
替换 Service 适用于想替换某个逻辑单元的代码，例如 网络服务，加密 想使用自己的。
2.1 制作Service
Service必定继承其对应的Protocol，例如 加密Service 对应协议为 GrowingEncryptionService：
@protocol GrowingEncryptionService <GrowingBaseService>
​
@optional
​
/// event相关数据在上传之前的加密处理
/// @param data 将要加密的NSData对象
/// @param hint 盐值
- (NSData *_Nonnull)encryptEventData:(NSData *_Nonnull)data factor:(unsigned char)hint;
​
/// 本地数据存储加密（如当天已使用数据网络上传的数据量等）
/// @param data 将要加密的NSData对象
- (NSData *_Nonnull)encryptLocalData:(NSData *_Nonnull)data;
​
/// 本地数据存储解密（如当天已使用数据网络上传的数据量等）
/// @param data 将要解密的NSData对象
- (NSData *_Nonnull)decryptLocalData:(NSData *_Nonnull)data;
​
@end
可以创建一个类，遵循 GrowingEncryptionService 协议，在对应的方法中写自己的逻辑，例如这里在CustomEncryptionClass中实现：
- (NSData *_Nonnull)encryptEventData:(NSData *_Nonnull)data factor:(unsigned char)hint {
    NSMutableData *dataM = [[NSMutableData alloc] initWithLength:data.length];
    // 加密逻辑处理您的数据
    return dataM;
}
然后需要将 GrowingEncryptionService 对应的实现类implclass 修改为自己创建的类，例如上述的 CustomEncryptionClass ，替换方案有：
注解 (推荐)
@GrowingService(GrowingEncryptionService, CustomEncryptionClass)
2. 代码
初始化SDK前调用
[[GrowingServiceManager sharedInstance] registerService:NSProtocolFromString(GrowingEncryptionService)
                                                                 implClass:NSClassFromString(@"CustomEncryptionClass")];
这样，加密服务就使用自己的了，下面我们需要将代码导入。
2.2 替换Sevice
参考 Encryption 的配置，新增一个
  s.subspec 'Encryption' do |service|
      service.source_files = 'Services/Encryption/**/*{.h,.m,.c,.cpp,.mm}'
      service.dependency 'GrowingAnalytics/TrackerCore'
  end
并将 2.1 创建的代码放置对应的 CustomEncryption 目录下
  s.subspec 'CustomEncryption' do |service|
      service.source_files = 'Services/CustomEncryption/**/*{.h,.m,.c,.cpp,.mm}'
      service.dependency 'GrowingAnalytics/TrackerCore'
  end
修改 spec 文件进行配置：
  s.subspec 'Autotracker' do |autotracker|
      autotracker.source_files = 'GrowingAutotracker/**/*{.h,.m,.c,.cpp,.mm}'
      autotracker.dependency 'GrowingAnalytics/AutotrackerCore'
      autotracker.dependency 'GrowingAnalytics/MobileDebugger'
      autotracker.dependency 'GrowingAnalytics/WebCircle'
      
      autotracker.dependency 'GrowingAnalytics/Network'
      autotracker.dependency 'GrowingAnalytics/CustomEncryption' #原为Encryption
      autotracker.dependency 'GrowingAnalytics/Compression'
  end
这样Autotracker就替换了 Encryption 的服务。
3. 扩展 Module
扩展 Module 适用于 用户有额外的业务需求的场景，这里举例了几种，都可以作为扩展 Module 进行，例如：
SDK运行的同时，还想将事件写入自己的数据库中做额外操作
SDK中事件少了，想添加自己的额外事件
但需要注意是单独的业务场景，需要将逻辑全部封装在 Module 中，Module 可是使用 TrackerCore中的类，但 TrackerCore 不应该依赖 Module 中的类。
3.1 示例 1
SDK运行的同时，还想将事件写入自己的数据库中做额外操作
找到GrowingEventManager事件发送的入口 postEventBuidler: ，可以添加拦截者来处理事件信息
//拦截者做额外处理
@protocol GrowingEventInterceptor <NSObject>
@optional
- (void)growingEventManagerChannels:(NSMutableArray<GrowingEventChannel *> *)channels;
//事件被触发
- (void)growingEventManagerEventTriggered:(NSString * _Nullable)eventType;
//在未完成构造event前，返回builder
- (void)growingEventManagerEventWillBuild:(GrowingBaseBuilder* _Nullable)builder;
//在完成构造event之后，返回event
- (void)growingEventManagerEventDidBuild:(GrowingBaseEvent* _Nullable)event;
//频段事件的网络请求request对象
- (id<GrowingRequestProtocol>_Nullable)growingEventManagerRequestWithChannel:(GrowingEventChannel* _Nullable)channel;
@end
那么我们只需要创建一个类，添加到GrowingEventManager拦截者中
/// 添加拦截者 - 执行顺序不保证有序
/// @param interceptor 拦截者
- (void)addInterceptor:(NSObject<GrowingEventInterceptor>* _Nonnull)interceptor;
即可以通过代理回调获得事件信息，然后做自己的逻辑处理。
2. Module的处理
module需要继承 GrowingModuleProtocol 协议
#import <Foundation/Foundation.h>
#import "GrowingModuleProtocol.h"
​
NS_ASSUME_NONNULL_BEGIN
​
@interface CustomEventModule : NSObject <GrowingModuleProtocol>
​
@end
​
NS_ASSUME_NONNULL_END
同时使用 @GrowingMod 注册Module到SDK中，并实现growingModInit 方法，在方法中将自己添加到GrowingEventManager拦截者中
#import "CustomEventModule.h"
#import "GrowingEventManager.h"
​
​
@GrowingMod(CustomEventModule)
​
@implementation CustomEventModule
​
- (void)growingModInit:(GrowingContext *)context {
    [[GrowingEventManager sharedInstance] addInterceptor:self];
}
​
- (void)growingEventManagerEventDidBuild:(GrowingBaseEvent* _Nullable)event {
    // do your work
}
​
@end
这样Module就实现了功能。
3.2 示例 2
SDK中事件少了，想添加自己的额外事件，这部分可以参考 https://github.com/growingio/growingio-sdk-ios-advertising​
首先SDK中的事件均继承自 GrowingBaseEvent , 可以继承该类或者其子类，例如 GrowingActivateEvent
#import "GrowingReengageEvent.h"
​
NS_ASSUME_NONNULL_BEGIN
@class GrowingActivateBuilder;
​
@interface GrowingActivateEvent : GrowingReengageEvent
​
+ (GrowingActivateBuilder *_Nonnull)builder;
​
@end
​
@interface GrowingActivateBuilder : GrowingReengageBuilder
​
- (GrowingActivateBuilder *_Nonnull (^)(NSDictionary *_Nonnull))setExtraParams;
​
@end
​
NS_ASSUME_NONNULL_END
2. 发送时机由用户自定，再者就是事件如何发送，均使用 Builder 方式传入
GrowingReengageBuilder *builder = GrowingReengageEvent.builder.setExtraParams(params);
[self postEventBuidler:builder];
3. 如果事件发送地址需要自定义，可以参考 https://github.com/growingio/growingio-sdk-ios-advertising 中的处理
/// 由于vst 以及 reenage activate，发送地址和3.0不一致，需要另创建2个channel来发送
- (void)growingEventManagerChannels:(NSMutableArray<GrowingEventChannel *> *)channels {
    [channels addObject:[GrowingEventChannel eventChannelWithEventTypes:@[@"vst"]
                                                            urlTemplate:@"v3/%@/ios/pv?stm=%llu"
                                                          isCustomEvent:NO]];
    [channels addObject:[GrowingEventChannel eventChannelWithEventTypes:@[@"reengage",@"activate"]
                                                             urlTemplate:@"app/%@/ios/ctvt"
                                                           isCustomEvent:NO]];
}
以前
前言
下一个
常见问题
最近更新 2 weeks ago
名称	说明	是否可选
MobileDebugger	数据调试Mobile Debugger，默认集成在埋点SDK中	是
WebCircle	基于无埋点的圈选插件，默认集成在无埋点SDK中	是
Hybrid	混合开发模式，默认集成在无埋点SDK中（无埋点中自动注入），埋点SDK需要手动导入	是
更多开发中...
名称	说明	依赖
Tracker	埋点SDK	TrackerCore、MobileDebugger、Database、Network、Encryption、Compression
Autotracker	无埋点SDK	AutotrackerCore、Hybrid、MobileDebugger、WebCircle、Database、Network、Encryption、Compression
名称	说明
DISABLE_IDFA	禁用IDFA，且SDK中不会再有相关的IDFA代码逻辑
ENABLE_ENCRYPTION	禁用数据加密，使用明文