接着上次Swizzle部分继续。上次已经讲到通过Swizzle方法hook住NSURLConnection和NSURLSession的代理。那么Hook住之后就需要插入自定义代码。今天主要讲的就是FLEXNetworkRecorder。
FLEXNetworkTransaction
FLEXNetworkTransaction起得作用类似于一个模型类。包含的都是数据。里面的内容也比较简单。不过也有一些地方值得学些的。
枚举的命名方式及习惯
命名对于写代码来说非常重要。比较正规的枚举命名应该是如下这样：
typedef NS_ENUM(NSInteger, FLEXNetworkTransactionState) {
FLEXNetworkTransactionStateUnstarted,
FLEXNetworkTransactionStateAwaitingResponse,
FLEXNetworkTransactionStateReceivingData,
FLEXNetworkTransactionStateFinished,
FLEXNetworkTransactionStateFailed
};
枚举类型名+不同状态来表示具体的枚举值。
通常情况下应该为枚举值返回不同的描述。所以最好在额外定义一个类方法。比如：+ (NSString *)readableStringFromTransactionState:(FLEXNetworkTransactionState)state;。根据不同的枚举值返回不同的字符串描述。这样可读性比较好。
+ (NSString *)readableStringFromTransactionState:(FLEXNetworkTransactionState)state
{
NSString *readableString = nil;
switch (state) {
case FLEXNetworkTransactionStateUnstarted:
readableString = @"Unstarted";
break;
case FLEXNetworkTransactionStateAwaitingResponse:
readableString = @"Awaiting Response";
break;
case FLEXNetworkTransactionStateReceivingData:
readableString = @"Receiving Data";
break;
case FLEXNetworkTransactionStateFinished:
readableString = @"Finished";
break;
case FLEXNetworkTransactionStateFailed:
readableString = @"Failed";
break;
}
return readableString;
}
尽量重写方法- (NSString *)description
这条原则最先是在《Effective Objective-C 》这本书看到的。之后学习在《Effective Java 》同样看到了这个原则。这样在打印类信息的时候能够提供更为全面的信息。
- (NSString *)description
{
NSString *description = [super description];
description = [description stringByAppendingFormat:@" id = %@;", self.requestID];
description = [description stringByAppendingFormat:@" url = %@;", self.request.URL];
description = [description stringByAppendingFormat:@" duration = %f;", self.duration];
description = [description stringByAppendingFormat:@" receivedDataLength = %lld", self.receivedDataLength];
return description;
}
FLEXNetworkRecorder
全局只有一个FLEXNetworkRecorder用于记录请求过程。
唯一标示符
因为请求的数量很多，为了区分每一个请求的话，必须做到对每一个请求进行标识。在FLEX中使用[[NSUUID UUID] UUIDString]标识每一个请求。关于iOS中的唯一标示相关知识，可以参考这篇文章。
NSUUID在iOS 6中才出现，这个值系统也不会存储，每次调用的时候都会获得一个新的唯一标示符。如果要存储的话，你需要自己存储。形如"E621E1F8-C36C-495A-93FC-0C247A3E6E5F"。
在swillze替换的block中进行创建requestID。之后在请求准备发出的时候会把requestID加入到FLEXNetworkRecorder的字典networkTransactionsForRequestIdentifiers中，用于保存所有请求。由于字典是无序存储的，所以额外定义了一个orderedTransactions来安装请求的顺序保存transaction。
缓存响应结果
缓存所有网络请求的响应是通过NSCache保存的。平时开发中用NSCache的地方也比较多。它的好处是可以直接设置缓存大小限制，并且在内存紧张的时候自动释放掉。
定义属性@property (nonatomic, strong) NSCache *responseCache;使用如下：
if (responseCacheLimit) {
[self.responseCache setTotalCostLimit:responseCacheLimit];
} else {
// Default to 25 MB max. The cache will purge earlier if there is memory pressure.
[self.responseCache setTotalCostLimit:25 * 1024 * 1024];
}
什么时候将请求缓存呢？在网络请求成功之后通过- (void)setObject:(ObjectType)obj forKey:(KeyType)key cost:(NSUInteger)g;缓存
if (shouldCache) {
[self.responseCache setObject:responseBody forKey:requestID cost:[responseBody length]];
}
线程安全
关于Object-c的线程安全，Objc.Io有一篇经典的文章Thread-Safe Class Design，中文版线程安全类的设计
如果对多线程安全问题不是很清楚建议看看iOS多线程到底不安全在哪里？。讲得比较通俗易懂。
说了这么多其实就是想说NSMutableArray和NSMutableDictionary都是线程不安全的，因为他们可变。但是这样用了两者来缓存请求的数据。在FLEXNetworkRecorder的init方法有如下这段：
// Serial queue used because we use mutable objects that are not thread safe
self.queue = dispatch_queue_create("com.flex.FLEXNetworkRecorder", DISPATCH_QUEUE_SERIAL);
创建了一个串行队列，然后在这个串行队列里面对NSMutableArray和NSMutableDictionary操作，就是线程安全的了。
使用方式：
dispatch_async(self.queue, ^{
FLEXNetworkTransaction *transaction = [[FLEXNetworkTransaction alloc] init];
transaction.requestID = requestID;
transaction.request = request;
transaction.startTime = startDate;
// 串行队列里面执行，保证同步，也就到达线程安全
[self.orderedTransactions insertObject:transaction atIndex:0];
[self.networkTransactionsForRequestIdentifiers setObject:transaction forKey:requestID];
transaction.transactionState = FLEXNetworkTransactionStateAwaitingResponse;
[self postNewTransactionNotificationWithTransaction:transaction];
});
注意所谓异步执行和同步执行区分很多同学理解有偏差，正确的应该是：是否阻塞当前线程，如果阻塞则是同步，不阻塞就是异步。
为了达到可变容器的线程安全，除了创建一个串行的队列之外，还有通过加锁，将容器的操作切换到同一个线程。或者继承可变数组，自己实现一套线程安全的方法。已经有前辈实现过类似的思路，这里贴个地址，有兴趣的同学可以具体实现。SafeContainer
发送通知
这里为什么会把发送通知列出来了，因为曾经因为发送通知犯过错。
大家需要知道，默认情况下，如果在哪一个线程发送通知，则接受处理方法就会在哪个线程执行。大部分情况下都会涉及到UI的操作，而UI操作应该是在主线程中执行的。所以如果通知涉及到UI操作的应该用如下的方式：
；
dispatch_async(dispatch_get_main_queue(), ^{
NSDictionary *userInfo = @{ kFLEXNetworkRecorderUserInfoTransactionKey : transaction };
[[NSNotificationCenter defaultCenter] postNotificationName:kFLEXNetworkRecorderNewTransactionNotification object:self userInfo:userInfo];
});
在控制器FLEXNetworkHistoryTableViewController中注册通知[[NSNotificationCenter defaultCenter] addObserver:self selector:@selector(handleTransactionsClearedNotification:) name:kFLEXNetworkRecorderTransactionsClearedNotification object:nil];，收到通知之后刷新界面
- (void)handleTransactionsClearedNotification:(NSNotification *)notification
{
[self updateTransactions];
[self.tableView reloadData];
}
思路总结
记录网络请求的关键部分如下：
- Swizzle住NSURLConnection和NSURLSession的代理方法，将定义的Block替换为原有执行。在Block里面注入监测代码。
- 将需要显示的信息，model化，定义数据模型。比如FLEXNetworkTransaction
- 定义可变数组，以及可变字典用于记录的请求状态以及内容，注意线程安全问题。比如networkTransactionsForRequestIdentifiers
- 监测过程，为每一个请求分配唯一标示，加入到缓存中。下次直接从缓存中取。
- 在监测中Block回调中，更新transaction的状态，比如在发出请求的时候，设置requestID、request，startTime。在接收到相应的Block回调中，设置transaction的response、latency。
- 把更新后的transaction通过发送通知的方式，告诉给控制器，更新界面。注意发送会更新UI的通知应该放在主线程中发送。
THE END
这部分不是很难理解，到这里，基本上关于网络这块就写完了。下篇准备介绍一些FLEX里面有关系统日志以及文件浏览的具体实现。
扩展阅读
iOS中的唯一标示
NSUUID /CFUUIDRef /UIDevice -uniqueIdentifier /-identifierForVendor
线程安全的可变容器类
