YTKNetwork 2.0 迁移指南：从基础到实践-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00572/article/details/148467487

YTKNetwork 2.0 迁移指南：从基础到实践

YTKNetwork 项目地址: https://gitcode.com/gh_mirrors/ytk/YTKNetwork

前言

YTKNetwork 是一个优秀的 iOS 网络请求框架，在 2.0 版本中进行了重大更新。本文将深入解析 YTKNetwork 2.0 的核心变化，帮助开发者顺利完成从 1.X 到 2.0 版本的迁移工作。

核心架构变化

1. 底层网络引擎升级

YTKNetwork 2.0 最显著的变化是从基于 AFNetworking 2.X 升级到 3.X 版本。这一变化带来了底层网络实现机制的转变：

从 NSOperation 到 NSURLSession：1.X 版本使用 AFHTTPRequestOperation 作为请求载体，而 2.0 版本改为使用 NSURLSessionTask
线程模型优化：新的实现更好地利用了 NSURLSession 的异步特性

2. 请求对象属性变更

迁移时需要特别注意以下属性的变化：

| 1.X 版本属性 | 2.0 版本属性 | 说明 | |-------------|-------------|------| | requestOperation | requestTask | 请求任务对象变更 | | requestOperationError | error | 错误对象简化命名 | | requestOperation.response | response | 直接访问响应对象 |

重要提示：currentRequest 和 originalRequest 属性必须在请求启动后才能获取，这与 1.X 版本的行为不同。

响应处理机制优化

1. 响应序列化控制

YTKNetwork 2.0 引入了明确的响应序列化控制：

typedef NS_ENUM(NSInteger, YTKResponseSerializerType) {
    YTKResponseSerializerTypeHTTP,  // 原始NSData数据
    YTKResponseSerializerTypeJSON,  // JSON对象(默认)
    YTKResponseSerializerTypeXMLParser  // XML解析器
};

迁移注意点：

1.X 版本默认强制尝试JSON解析，即使响应内容不是JSON
2.0 版本会严格检查响应内容类型，可能导致部分请求失败
如果遇到解析错误，请检查服务器返回的实际内容类型

2. 缓存接口重构

缓存相关API进行了重大调整：

废弃接口：

cacheJson
isCacheVersionExpired

新接口：

- (BOOL)loadCacheWithError:(NSError **)error;

使用示例：

NSError *error = nil;
if ([request loadCacheWithError:&error]) {
    id response = request.responseObject;
    // 使用缓存数据
} else {
    NSLog(@"加载缓存失败: %@", error);
}

缓存写入优化：

新增异步写入控制：writeCacheAsynchronously 方法
默认启用异步写入提升性能
需要同步写入时可重写该方法返回NO

下载功能升级

1. 下载实现变更

| 特性 | 1.X 版本 | 2.0 版本 | |------|---------|---------| | 实现方式 | AFDownloadRequestOperation | NSURLSessionDownloadTask | | 文件存储 | 手动保存responseData | 自动保存到指定路径 | | 进度回调 | 自定义block | NSProgress对象 |

2. 下载使用指南

// 设置下载路径
request.resumableDownloadPath = @"path/to/save/file";

// 获取下载进度
[request setDownloadProgressBlock:^(NSProgress *progress) {
    CGFloat percent = progress.completedUnitCount * 1.0 / progress.totalUnitCount;
    NSLog(@"下载进度: %.2f%%", percent * 100);
}];

注意：使用下载功能时，responseData 和 responseString 将不可用，成功回调中的 responseObject 会是文件本地路径的NSURL对象。

URL拼接规则调整

2.0 版本改用 NSURL 的标准拼接方式，这可能导致与1.X版本不同的拼接结果：

关键规则：

当requestUrl以/开头时，会忽略baseUrl中的path部分
建议baseUrl只包含host部分，path部分放在requestUrl中

正确示例：

// baseUrl: http://api.example.com/v1
// requestUrl: user/profile
// 结果: http://api.example.com/v1/user/profile

错误示例：

// baseUrl: http://api.example.com/v1/
// requestUrl: /user/profile
// 结果: http://api.example.com/user/profile (v1被忽略)

预处理与后处理

2.0 版本增强了请求生命周期管理：

新增预处理方法：
- requestCompletePreprocessor：响应完成但未回到主线程
- requestFailedPreprocessor：响应失败但未回到主线程
原有过滤方法：
- requestCompleteFilter：主线程中响应成功后调用
- requestFailedFilter：主线程中响应失败后调用