KVAutoCancelHttpTool GitHub地址
在App运行期间总会频繁地发生网络请求，如何管理好这些零散的网络请求一定是App架构设计中必须考虑的问题。
使用工具类来封装通用网络框架（AFNetworking）以提高代码可重用性，可维护性是一个必须做的工作，另外，由于App是多页面的，不同的页面需要开启不同的网络请求，并且大多数时候一个网络请求仅能在一个页面运行，这时候就要求当用户退出该页面时需要停止正在进行的网络请求，减少用户的流量花费和某些不可预测的问题出现（例如，该页面销毁了，但是网络请求还在继续，当请求结束调用了该页面的资源，获取不到可能会出现问题）。
为了解决这个问题，最蠢的办法当然是在控制器销毁时手动取消掉该请求任务（我不能忍，我总想找出一个一劳永逸的方法），然而，作为程序员，我们总能写出一段程序来帮我们干这些重复的工作，让整个App变得高效，开发也变得省事，KVAutoCancelHttpTool就是为了应付这种情况而产出的。
1 KVAutoCancelHttpTool
首先声明一点，KVAutoCancelHttpTool并不是一个完整的网络请求工具，仅包含常见的GET,POST,PUT请求，开源出来的目的仅为了给大家提供一种自动取消网络任务的解决方案，如果你们觉得KVAutoCancelHttpTool已经适用于你们的项目，可以直接在项目中引入，如果觉得不满意，可以在KVAutoCancelHttpTool的基础上进行功能完善或者只借鉴其中自动取消网络任务的方法。
1.1 原理实现
我们都知道在Object-C（包含Swift，原理都相通的）中，一个对象在被销毁的时候会调用dealloc方法，
- (void)dealloc {
}
KVAutoCancelHttpTool也是在此原理上实现的自动取消功能。
看图识原理：
1.2 实现步骤
- 创建一个持有可变数组的类，目的在于保存网络请求任务，以及监听释放对象的释放。
.h
#import <Foundation/Foundation.h>
@interface KVHttpResponseObject : NSObject
@property (nonatomic, strong) NSMutableArray * httpTasks;
@end
.m
#import "KVHttpResponseObject.h"
@implementation KVHttpResponseObject
- (instancetype)init {
if (self = [super init]) {
self.httpTasks = [NSMutableArray array];
}
return self;
}
- (void)dealloc {
//当该对象被释放时取消掉所有任务
if (self.httpTasks.count) {
for (id object in self.httpTasks) {
if ([object isKindOfClass:[NSURLSessionDataTask class]]) {
[((NSURLSessionDataTask*)object) cancel]; //取消任务
}
}
}
}
@end
- 使用分类以及runtime给NSObject加上一个监听对象，该监听对象就是步骤一创建的类，由于是强引用关系，所以当该对象释放时相应地监听对象也会调用dealloc方法。
.h
#import <Foundation/Foundation.h>
#import "KVHttpResponseObject.h"
@interface NSObject (KVHttp)
//释放监听对象
@property (nonatomic, strong) KVHttpResponseObject * kvHttpObject;
@end
.m
#import "NSObject+KVHttp.h"
#import <objc/runtime.h>
@implementation NSObject (KVHttp)
- (KVHttpResponseObject*)kvHttpObject {
KVHttpResponseObject * object = objc_getAssociatedObject(self, "kvHttpObject");
return object;
}
- (void)setKvHttpObject:(KVHttpResponseObject *)kvHttpObject {
objc_setAssociatedObject(self, "kvHttpObject", kvHttpObject, OBJC_ASSOCIATION_RETAIN_NONATOMIC);
}
@end
- 封装网络请求工具类，将释放对象传入，给释放对象添加一个监听对象，以及请求结束时移除的处理。
+ (NSURLSessionDataTask*)getWithUrl:(NSString*)url params:(NSDictionary*)params object:(NSObject*)object handler:(KVHTTPResponseHandle)handler {
[UIApplication sharedApplication].networkActivityIndicatorVisible = YES;
KV_WO(object, wobject); //弱引用释放对象
if (!wobject.kvHttpObject) {
//为该释放对象添加一个监听释放过程的监听对象
wobject.kvHttpObject = [[KVHttpResponseObject alloc] init];
}
NSURLSessionDataTask * task = [[KVHttpTool sharedHttpTool].manager GET:url parameters:params progress:nil success:^(NSURLSessionDataTask * _Nonnull task, id _Nullable responseObject) {
//成功处理
[wobject.kvHttpObject.httpTasks removeObject:task]; //监听对象移除该请求任务
[UIApplication sharedApplication].networkActivityIndicatorVisible = NO;
//处理回调结果
[self handleHttpResponse:YES task:task responseObject:responseObject error:nil handler:handler];
} failure:^(NSURLSessionDataTask * _Nullable task, NSError * _Nonnull error) {
//失败处理
[wobject.kvHttpObject.httpTasks removeObject:task]; //监听对象移除该请求任务
[UIApplication sharedApplication].networkActivityIndicatorVisible = NO;
//处理回调结果
[self handleHttpResponse:NO task:task responseObject:nil error:error handler:handler];
}];
[wobject.kvHttpObject.httpTasks addObject:task]; //监听对象添加该请求任务，如果释放对象释放了，那么监听对象会自动取消掉所持有的所有未完成请求任务
return task;
}
原理其实很简单，只不过使用了比较巧妙的手法来达到此功能。
2 视频演示
由于简书MarkDown不支持iframe嵌入视频，所以只能让你们跳转优酷去看咯。
- 不使用自动取消功能的演示
视频一地址
由于我在网络请求时给系统状态栏加了小菊花，所以可以很明显地看到，当退出页面时，请求还在继续，并且结束后还在回调打印出了结果。
- 使用了自动取消功能的演示
视频二地址
这次同样可以很明显地看到，当退出页面时，小菊花马上停止转动，并且控制台打印出了任务被取消的文字（封装的网络请求回调会告诉你是不是被取消的）
3 使用方法
集成方法就不赘述了，上GitHub上clone就是了。
3.1 GET
NSMutableDictionary * param = nil;
//添加参数
//param = [NSMutableDictionary dictionary];
//[param setObject:@"1" forKey:@"version"];
KV_WS(weakSelf);
[KVHttpTool getWithUrl:@"自己的接口请求地址" params:param object:self handler:^(KVHttpResponseCode code, NSInteger statusCode, NSDictionary *responseHeaderFields, id responseObject) {
if (code == KVHttpResponseCode_Success) {
NSLog(@"成功");
}else if (code == KVHttpResponseCode_Cancelled) {
NSLog(@"被取消");
}else {
NSLog(@"失败");
}
NSLog(@"%ld %@ %@", statusCode, responseHeaderFields, NSStringFromClass([responseObject class]));
[weakSelf hahaha]; //必须得做好内存管理，这是做好程序的前提，不然自动取消也不好使
// [self hahaha];
}];
3.2 POST
同3.1。
3.3 PUT
同3.1.
4 注意事项
由于使用的是监听释放对象的释放来实现的自动取消，所以必须得做好释放对象的内存管理，保证释放对象能够被正常释放，一般释放对象传入当前控制器即可，也可以根据需要传入其他对象，只要保证释放对象能够被正常释放即可，而且做好内存管理也是我们身为iOS程序员的责任，我想不到任何理由让你不去做好内存管理。
另外，我们也可以利用KVAutoCancelHttpTool去判断当前控制器的生命周期是否正常，如果发现当你退出页面时，小菊花还在转，那么就去检查一遍是否哪里内存泄漏了吧。
