Shiply iOS 远程资源 SDK 集成
一、隐私安全说明
Shiply 资源发布 iOS SDK
版本：1.10.21
更新时间：2025年2月14日
SDK介绍：为移动开发者提供专业的资源分发能力，帮助开发者动态下载远程资源文件。
服务提供方：深圳市腾讯计算机系统有限公司
隐私保护规则：《Shiply资源发布SDK个人信息保护规则》
合规使用指南：《Shiply资源SDK合规使用指南》
二、接入SDK
通过 Cocoapods 的 Podfile 集成 ShiplyResHub.xcframework
# 添加镜像源
source 'https://cdn.cocoapods.org/'
pod 'ShiplyResHub', '1.10.21'
# 或
pod 'ShiplyResHub', :git => 'https://e.coding.net/tencent-tds/shiply/ShiplyResHub.git', :tag => '1.10.21'
建议：
ShiplyResHub.podspec 声明了以下依赖，您可根据 App 实际情况锁定依赖库的版本，以避免自动升级 SDK 带来的风险
pod 'ShiplyRDelivery', '1.3.5.1'
pod 'MMKV', '1.2.16'
pod 'YYModel', '1.0.4'
pod 'RaftInterface', '0.0.20'
2.1. SDK初始化示例
可参考 Demo 工程（公开仓库 ）进行体验和接入。
// 1. 构建初始化参数
ResHubParam *param = [[ResHubParam alloc] init];
param.appVersion = @"1.0.0"; // 应用版本号，用于匹配资源
// 请在 qimei 填写你的设备唯一标识符（用于条件下发，测试任务加体验名单）
param.qimei = @"your_device_unique_id";
struct utsname systemInfo;
uname(&systemInfo);
NSString *deviceType = [NSString stringWithCString:systemInfo.machine encoding:NSUTF8StringEncoding];
param.deviceType = deviceType; // 设备型号，数据上报使用
param.systemVersion = [UIDevice currentDevice].systemVersion; // 系统版本号，拉取配置及数据上报使用
param.localPresetResPath = [[[NSBundle mainBundle] resourcePath] stringByAppendingPathComponent:@"res_hub"]; // 内置资源路径，如无内置资源，可不填
param.callbackOnMainThread = YES; // progress回调是否要求在主线程进行，默认为NO
// 2. 注入必选的功能模块
// 必须实现包括：网络请求、文件下载、KV存储、上报、文件处理
ResHubDependImpl *depends = [[ResHubDependImpl alloc] init];
// 网络请求和kv存储，可集成RDelivery的DefaultNetworkImpl和DefaultStorageImpl模块
depends.netImpl = [RDNetworkImpl sharedInstance];
depends.kvFactoryImpl = [RDMMKVFactoryImpl sharedInstance];
// 文件下载、上报、文件处理，可集成ResHub的Download、Beacon和File模块
depends.downloadImpl = [ResHubDownloadImpl sharedInstance];
depends.fileImpl = [ResHubFileImpl sharedInstance];
depends.yymodelImpl = [RDeliveryJsonModelImpl sharedInstance];
depends.jsonModelImpl = [RDeliveryJsonModelImpl sharedInstance];
param.depends = depends;
[[ResHubCenter sharedInstance] initSDK:param];
// 3. 创建一个hub实例
ResHub *hub = [[ResHubCenter sharedInstance] resHubWithAppId:@"xxxxxxx"
appKey:@"xxxxxxx-xxxxxxx-xxxxxxx-xxxxxxx-xxxxxxx"
env:@"online"]; // 正式环境"online"，默认测试环境"test"，其他环境填写环境ID
2.2 资源拉取示例
以下所有示例可在 Demo 中体验
2.2.1 同步获取资源（仅获取，不会下载资源）
// 1. 同步获取最新资源（首选）
ResHubModel *model = [[self resHub] latestResWithId:[self resId]];
// 2. 同步获取本地资源（特殊场景使用，App 生命周期锁定返回一个版本）
ResHubModel *model = [[self resHub] resWithId:[self resId]];
2.2.2 异步获取资源（会下载资源）
// 1. 异步拉取最新资源（首选）
[[self resHub] loadLatestWithId:resId
progress:^(CGFloat progress) {
} completed:^(BOOL success, NSError * _Nullable error, ResHubModel * _Nullable resModel) {
}];
// 2. 异步拉取指定资源并加锁（特殊场景使用，App 生命周期锁定返回一个版本），优先返回本地资源，同时会自动进行网络请求更新资源
[[self resHub] loadWithId:resId
progress:^(CGFloat progress) {
} completed:^(BOOL success, NSError * _Nullable error, ResHubModel * _Nullable resModel) {
}];
2.2.3 批量拉取资源（会下载资源）
// 1. 批量异步拉取最新资源(首选)，一定会进行网络请求尝试获取最新包
[[self resHub] batchLoadLatestWithIds:resIds
progress:^(NSUInteger completedCount, NSUInteger totalCount, CGFloat progress) {
} completed:^(BOOL allSuccess, NSDictionary<NSString *,NSError *> * _Nullable errorMap, NSDictionary<NSString *,ResHubModel *> * _Nullable resModelMap) {
}];
// 2. 批量异步拉取资源，优先返回本地资源，同时会自动进行网络请求更新资源
[[self resHub] batchLoadWithIds:resIds
progress:^(NSUInteger completedCount, NSUInteger totalCount, CGFloat progress) {
} completed:^(BOOL allSuccess, NSDictionary<NSString *,NSError *> * _Nullable errorMap, NSDictionary<NSString *,ResHubModel *> * _Nullable resModelMap) {
}];
2.2.4 按场景拉取资源（会下载资源）
// 1. 通过场景(Scene)ID异步拉取多个远程最新资源(首选)
[[self resHub] batchLoadLatestWithSceneId:sceneId progress:^(NSUInteger completedCount, NSUInteger totalCount, CGFloat progress) {
} completed:^(BOOL allSuccess, NSDictionary<NSString *,NSError *> * _Nullable errorMap, NSDictionary<NSString *,ResHubModel *> * _Nullable resModelMap) {
}];
// // 通过场景(Scene)异步拉取多个资源（特殊场景使用，App 生命周期锁定返回一个版本）
[[self resHub] batchLoadWithSceneId:sceneId progress:^(NSUInteger completedCount, NSUInteger totalCount, CGFloat progress) {
} completed:^(BOOL allSuccess, NSDictionary<NSString *,NSError *> * _Nullable errorMap, NSDictionary<NSString *,ResHubModel *> * _Nullable resModelMap) {
}];
2.2.5 删除资源
// 1. 删除某个资源的指定版本
ResHubConfigItem *resConfig = [[ResHubConfigItem alloc] init];
resConfig.resId = resId;
resConfig.version = [resVer integerValue];
[[self resHub] deleteWithModel:resConfig];
// 2. 删除某个资源
[[self resHub] deleteWithId:resId];
// 3. 删除所有
[[self resHub] deleteAll];
2.2.6 获取所有配置信息（不会下载资源）
// 1. 获取所有配置信息
- (nullable NSDictionary<NSString *, ResHubConfigItem *> *)allReshubConfigDict;
// 2. 获取某个资源的配置信息
- (nullable ResHubModel *)fetchedResConfigWithId:(NSString *)resId;