MKNetworkKit 的介绍

ASIHTTPRequest (做者：BenCopsey) 是一个使用简单，可用于各类从简单到复杂的 HTTP 请求，或者可用于处理 Amazon S三、Rackspace 等REST 服务的强大框架。

不幸的是，Ben 早在 2011 年 9 月 21 日就已经声明中止开发和支持该框架（见http://allseeing-i.com/%5Brequest_release%5D; ）。

Ben 推荐了许多可替代的框架（好比AFNetworking, RestKit 或 LRResty）。但最有潜力的莫过于Mugunth Kumar 的 MKNetworkKit 。Mugunth 曾发布了许多高质量的开源的 iOS/Mac 代码（好比 MKStoreKit），其中值得推荐一个就是 ASHTTPRequest 的替代者： MKNetworkKit。它支持 ARC 和块，易于使用且极为高效。

如下内容摘自 Mugunth本身的博客。原文位于：http://blog.mugunthkumar.com/products/ios-framework-introducing-mknetworkkit。

 

假设有一个网络框架，它能自动为你缓存 respones,能在你离线时自动记忆你的操做，你以为怎样？

当你离线时，你能够收藏某个 tweet 页或者标记某个 feed 为已读，当你再次上线时，网络框架会自动执行你的这些操做，这一切都不须要你额外编写代码。请看我对于MKNetworkKit 框架的介绍。

 

什么是MKNetworkKit?

MKNetworkKit是一个 O-C 编写的网络框架，支持块，ARC 且用法简单。

MKNetworkKit 集 ASIHTTPRequest 和 AFNetworking 两个框架于一体。在集成两者的优秀特性以外，还增长了一堆新的功能。尤为是，相比起其它框架，它能让你更轻松地编写代码。它让你完全远离那些恶心的网络代码。

特色

超轻量级框架

整个框架只有 2 个类和一些类别方法。所以，它的使用极其简单。

在整个程序中只有一个全局队列

高度依赖互联网链接的 app 应该优先考虑网络线程的并发数。不幸的是，没有任何网络框架在这方面作得够好。所以，一旦你在程序中没有控制好网络线程的并发数，就极易致使出错。

假设你要上传一堆图片到服务器上。绝大多数移动网络（3G）不会容许你对同一个IP 地址的 HTTP 并发链接数超过 2 个。换句话说，在设备上，你不能从 3G 网络中得到 2 个以上的 HTTP 并发链接。对于 Edge 则更糟，大多数状况不能超过1 个。相比较家用宽带网络（Wifi），则这个限制要宽得多（6 个）。可是，你不可能老是使用 wifi，你必须也考虑到有限网络（窄带）的连通性。更多的时候，iDevice设备几乎都能链接到 3G 网络，所以，你同时只能上传 2 张图片。可是，真正的问题不是缓慢的上传速度，而是另外一种状况。在你打开一个 view 试图加载缩略图（不一样的view）时，上传线程被运行到后台。若是你没有控制好上传队列中的线程数，你的缩略图会加载超时。这是不正常的。正确的方式是优化缩略图加载线程，或者让线程等待直到上传完成再加载缩略图。这须要你在整个程序中只拥有一个queue 队列。

MKNetworkKit 在它的每一个实例中使用单例来保证这一点。并非说MKNetworkKit 是单例的，而是说它的共享队列是单例的。

正确显示网络状态指示

许多第 3 方框架都经过一个“网络链接数增长/减小”的方法回调来显示网络状态，MKNetworkKit则因为使用了单例的共享队列，能自动显示网络状态。在共享队列中有一个线程经过 KVO 方式会随时观察 operationCount 属性。所以对于开发者，通常状况下根本不须要操心网络状态的显示。

if (object == _sharedNetworkQueue && [keyPath isEqualToString:@"operationCount"]) {      [UIApplication sharedApplication].networkActivityIndicatorVisible =        ([_sharedNetworkQueue.operations count] < 0);      }

自动改变队列大小

如前所述，绝大部分移动网络不容许 2 个以上的并发链接，所以你的队列大小在3G 网络下应当设置为 2。 MKNetworkKit 会自动为你处理好这个。当网络出于3G/EDGE/GPRS 时，它会将并发数调整到 2。当网络处于 Wifi 网络时，则自动调整到 6。当你经过 3G 网络中从远程服务器加载缩略图时，这种调整能带来极大的好处。

自动缓存

MKNetworkKit 能自动缓存你全部的 GET 请求。当你再次发起一样的请求时，MKNetworkKit 随即就能调用 response缓存（若是可用的话）传递给 handler 进行处理。固然，它同时也向服务器发出请求。一旦得到服务器数据，handler 被再次要求处理新获取的数据。也就是说，你不用手动缓存。你只须要使用：

[[MKNetworkEngine sharedEngine] useCache];

固然，你能够覆盖这个方法（子类化），定制你的缓存路径和缓存占用的内存开销。

冻结网络操做

MKNetworkKit 可以“冻结”网络操做。在一个网络操做被“冻结”的状况下，一旦网络连断开，它们将自动序列化并在设备再次连线时自动被提交一次。相似 twitter 客户端的“drafts”。

当你提交一篇 tweet 时，若是网络被标记为“可冻结”，MKNetworkKit 会自动执行冻结并储存这些请求。所以会在未来推迟发送这篇 tweet。整个过程不须要你写一行代码。这个特性你能够用于其余操做，诸如收藏一篇 tweet 或者从 Goolge reader 客户端共享一个帖子，加一个连接到Instapaper 中，等等。

相似的请求只执行一个操做

当你加载缩略图（针对 twitter stream）时，你最终得为每一个实际的图片建立一个新的请求。实际上你所进行的多个请求都是同一个URL。MKNetworkKit 对于队列中的每一个 GET 请求都只会执行一次。它还不能到缓存 POST 请求。

图片缓存

MKNetworkKit 内置了缩略图缓存。只要覆盖几个方法，就能够设置内存中最大能缓存的图片数量，以及缓存要保存到目录。固然，你也能够不覆盖这些方法。

性能

即速度。MKNetworkKit 缓存是内置的，就如 NSCache,当发现有内存警告，缓存到内存中的数据将被写入缓存目录。

彻底支持 ARC

通常你只会在新项目中使用新的网络框架。MKNetworkKit并不意味着要放弃已有的框架（固然你也能够放弃，这会是个乏味的工做）。对于新的项目，你老是想使用 ARC。当你看到本文的时候，极可能 MKNetworkKit  会是仅有的彻底支持 ARC 的网络框架。ARC 一般比非 ARC 代码更快。

用法

Ok，我就不“自卖自诩”了。让咱们当即了解若是使用这个框架。

添加MKNetworkKit

1. 将 MKNetworkKit 目录拖到项目中
2. 添加下列框架： CFNetwork.Framework, SystemConfiguration.framework, Security.framework and ImageIO.Framework.
3. 将 MKNetworkKit.h 头文件包含到 PCH 文件中
4. 对于 iOS，删除 NSAlert+MKNetworkKitAdditions.h
5. 对于 Mac，删除 UIAlertView+MKNetworkKitAdditions.h

总共只须要 5 个核心文件，真是一个强大的网络开发包

MKNetworkKit 的类

1. MKNetworkOperation
2. MKNetworkEngine
3. 一些工具类 (Apple 的 Reachability) 以及类别

我喜欢简单。苹果已经写了最基本最核心的网络代码。第 3 方框架须要的是提供一个优雅的网络队列最多再加上缓存。我认为第3 方框架不该该超过 10 个类（不管它是网络的仍是 UIKit 仍是别的什么）。超过这个数就太臃肿了。Three20 就是一个例子。如今 ShareKit 又是这样。尽管它们是优秀的，但仍然是庞大和臃肿的。ASIHttpRequest or AFNetworking 比 RESTKit 更轻，JSONKit比TouchJSON (或者任何 TouchCode 库)更轻。这只是我本身的见解，但当一个第三方库的代码超过程序源代码1/3，我就不会使用它。

框架臃肿带来的问题是很难理解它的内部工做机制，以及很难根据本身的需求定制它（当你须要时）。我曾经写过的一些框架（例如MKStoreKit ，用于应用程序内购的 ）老是易于使用，我认为MKNetworkKit 也应该是这样。对于 MKNetworkKit ，你所须要了解的就是暴露在两个类MKNetworkOperation 和 MKNetworkEngine 中的方法。MKNetworkOperation 就比如ASIHttpRequest类。它是一个NSOperation 子类，封装了你的 request 和 response 类。对于每一个网络操做，你须要建立一个MKNetworkOperation 。

MKNetworkEngine 是一个伪单例类，管理程序中的网络队列。它是伪单例的，也就是说，对于简单请求，你能够直接用MKNetworkEngine 中的方法。要进行深度的定制，你应该进行子类化。每一个 MKNetworkEngine 子类有它本身的Reachability 对象，用于通知它来自服务器的reachability 通知。对于不一样的 REST 服务器，你能够考虑建立单独的 MKNetworkEngine子类。

它是伪单例，它的子类的每一个请求都共用惟一的一个队列。你能够在应用程序委托中retain 这个 MKNetworkEngine ，就像CoreData 的 managedObjectContext 类同样。在使用MKNetworkKit 时，建立一个 MKNetworkEngine 子类将你的网络请求进行逻辑上的分组。例如，将全部关于 Yahoo 的方法放在一个类，全部 Facebook 有关的方法放进另外一个类。来看 3 个实际使用的例子。

例1:

建立一个  “YahooEngine” 从 Yahoo 财经服务器抓取货币汇率。

步骤 1:建立YahooEngine 类继承于MKNetworkEngine。MKNetworkEngine 使用主机名和指定的头（若是有的话）进行初始化。头信息能够是nil。若是你是在本身的 REST 服务器上，你能够考虑加一个客户端 app 的版本或者其余信息（好比客户端的标识）。

NSMutableDictionary *headerFields = [NSMutableDictionary dictionary];     [headerFields setValue:@"iOS"forKey:@"x-client-identifier"]; self.engine = [[YahooEngine alloc] initWithHostName:@"download.finance.yahoo.com"                        customHeaderFields:headerFields];

 

注意，yahoo 并不识别你在头中发送x-client-identifier 给它，这个示例仅仅是演示这个特性而

因为使用了 ARC 代码，做为开发者你须要拥有（强引用）Engine对象。

一旦你建立了一个 MKNetworkEngine子类, Reachability 即自动实现。当你的服务器因为某些状况挂了，主机名不可访问，你的请求会自动被冻结。关于“冻结”，请参考后面的“冻结操做”小节。

步骤 2:设计Engine 类 (关注分离)

如今，开始编写 Yahoo Engine 中的方法，以抓取汇率。这些方法将在ViewController 中被调用。良好的设计体验是确保不要将 engine 类中的 URL/HTTPHeaders 暴露给调用者。你的视图不该该知道URL 或者相关的参数。也就是，只须要向 engine 方法传递货币种类和货币单位就能够了。方法的返回值多是 double，即汇率，以及获取汇率的时间。因为是异步操做，你应当在块中返回这些值。例如：

-(MKNetworkOperation*) currencyRateFor:(NSString*) sourceCurrency                                inCurrency:(NSString*) targetCurrency             onCompletion:(CurrencyResponseBlock) completion         onError:(ErrorBlock) error;

在父类 MKNetworkEngine 中，定义了3 个块类型：

typedef void (^ProgressBlock)(double progress); typedef void (^ResponseBlock)(MKNetworkOperation* operation); typedef void (^ErrorBlock)(NSError* error);

在 YahooEngine中，咱们使用了一个新的块类型：CurrencyResponseBlock，用以返回汇率。其定义以下：

typedef void (^CurrencyResponseBlock)(double rate);

在其余正式的 app 中，你应该定义本身的块相似于CurrencyResponseBlock ，用以向 ViewController 返回数据。

步骤 3:处理数据
处理数据，包括将从服务器抓来的数据（例如 JSON/XML/plists）进行数据类型转换。这应当在 Engine 中完成。注意，不要在控制器中完成。你的 Engine 应当将数据以适当的模型对象或模型对象的数组返回。在engine 中转换 JSON/XML 为模型——注意，适当保持关注分离，view controller 不该当知道任何用于访问 JSON 节点的 key。这种思想主导了engine 的设计。许多网络框架并不强制要求你服从关注分离，咱们这样作，是由于咱们为你考虑到了。

步骤 4:实现方法
如今，咱们来讨论方法实现细节。要从 Yahoo 得到汇率信息，最简单的是发起一个 GET 请求。下列宏用一对指定的货币格式化 URL 字串：

We will now discuss the implementationdetails of the method that calculates your currency exchange.

Getting currency information from Yahoo,is as simple as making a GET request.
I wrote a macro to format this URL for a given currency pair.

#define YAHOO_URL(__C1__, __C2__) [NSString stringWithFormat:@"d/quotes.csv?e=.csv&f=sl1d1t1&s=%@%@=X", __C1__, __C2__]

按以下顺序编写 engine类方法：

1. 根据参数准备 URL
2. 建立一个 MKNetworkOperation 对象
3. 设置方法参数
4. 设置 operation 的 completion 块和 error 块（在 completation 块中处理 response 并转换为模型）
5. 可选地，添加一个 progress 块（或者在 view controller 中作这个）
6. 若是 operation 是下载，设置下载流（一般是文件）。这步也是可选的
7. 当 operation 完成，处理结果并调用方法块，并将数据返回给调用者。

示例代码以下：

MKNetworkOperation *op = [selfoperationWithPath:YAHOO_URL(sourceCurrency, targetCurrency)

params:nil

httpMethod:@"GET"];

 

    [op onCompletion:^(MKNetworkOperation*completedOperation)

     {

        DLog(@"%@", [completedOperation responseString]);

 

 //do your processing here

         completionBlock(5.0f);

 

     }onError:^(NSError* error) {

 

         errorBlock(error);

     }];

 

    [self enqueueOperation:op];

 

    return op;

上述代码格式化 URL 并建立了 MKNetworkOperation。设置完 completion 和 error 块以后，将 operation 加入到队列（经过父类的 enqueueOperation 方法），而后返回一个 operation 的引用。所以，若是你在 viewDidAppear 中调用这个方法，则在 viewWillDisappear 方法中取消operation。取消 operation 将释放 operation 以便执行 queue 中用于其余view 的 operation（牢记，在移动网络中只有2 个 operation 能被同时进行，当 operation 再也不须要时取消它们能提高 app 的性能和速度）。

在 viewcontroller 中也能够添加一个 progress 块用以刷新UI。例如：

[self.uploadOperation onUploadProgressChanged:^(double progress) {          DLog(@"%.2f", progress*100.0);                     self.uploadProgessBar.progress = progress;     }];

MKNetworkEngine 也有一个只用 URL 建立 operation 的有用方法。所以第1行代码也能够写成：

MKNetworkOperation *op = [self operationWithPath:YAHOO_URL(sourceCurrency, targetCurrency)];

注意，请求的 URL将自动添加上主机名（在 engine 实例化时指定的）。

 

像这样的实用方法 MKNetworkEngine还有许多，你能够查看头文件。

例2:

上传图片到服务器 (例如 TwitPic)。
如今让咱们看一个上传图片到服务器的例子。要上传图片，显然要 operation 能编码 multi-part 表单数据。 MKNetworkKit 使用相似 ASIHttpRequest 的方式。
你能够很是简单地经过MKNetworkOperation 的 addFile:forKey:方法将一个文件做为请求中的 multi-part 表单数据提交。

MKNetworkOperation 也有一个方法，能够将图片以 NSData 的方式提交。即 addData:forKey: 方法，它能够将图片以NSData 的方法上传到服务器。 (例如直接从相机中捕获的图片).

例3:

下载文件到本地目录 (缓存)
使用MKNetworkKit 从服务器下载文件并保存到 iPhone 的本地目录很是简单。

只须要设置 MKNetworkOperation的 outputStream 。

[operation setDownloadStream:[NSOutputStream         outputStreamToFileAtPath:@"/Users/mugunth/Desktop/DownloadedFile.pdf"                         append:YES]];

你能够设置多个 outputStream 到一个 operation，将同一文件保存到几个地方（例如其中一个是你的缓存目录，另外一个用作你的工做目录）。

例4:

缓存图片的缩略图

对于下载图片，你可能须要提供一个绝对 URL 地址而不是一个路径。
MKNetworkEngine 的operationWithURLString:params:httpMethod: 方法根据绝对 URL地址来建立网络线程。

MKNetworkEngine 至关聪明。它会将同一个 URL 的屡次 GET 请求合并成一个，当 operation 完成时它会通知全部的块。这显著提高了抓取图片 URL 以渲染缩略图的速度.

子类化 MKNetworkEngine而后覆盖图片的缓存目录及缓存的大小。若是你不想定制这两者，你能够直接调用 MKNetworkEngine中的方法来下载图片。这是我极力推荐的。

缓存operation

MKNetworkKit 默认会缓存全部请求。你所须要的仅仅是在你本身的 engine 中打开它。当执行一个 GET 请求时，若是上次的 response 已缓存，相应的 completion 块将用缓存的response 进行调用（瞬间）。要想知道 response 是否缓存，能够调用 isCachedResponse 方法，以下所示：

[op onCompletion:^(MKNetworkOperation *completedOperation) {           if([completedOperation isCachedResponse]) {               DLog(@"Data from cache");           }else {               DLog(@"Data from server");           }             DLog(@"%@", [completedOperation responseString]);       } onError:^(NSError* error) {             errorBlock(error); }];

冻结operation

MKNetworkKit 的一个最有趣的特性是它内置的冻结 operation 特性。你只须要设置 operation 的 freeesable 属性就能够。几乎什么也不用作！

[op setFreezable:YES];

冻结是指 operation 在网络被断开时自动序列化并在网络恢复后自动执行。例如当你离线时也可以进行收藏tweet 的操做，而后在你再次上线时 operation 自动恢复执行。

在应用程序进入后台时，冻结的 operation 也会被持久化到磁盘。而后在应用程序回到前台后自动恢复执行。

MKNetworkOperation 中的有用方法

以下所示，MKNetworkOperation 公开了一些有用的方法，你可从中获取各类格式的 response 数据：

1. responseData
2. responseString
3. responseJSON (Only on iOS 5)
4. responseImage
5. responseXML
6. error

当 operation 执行完时，这些方法被用于获取响应数据。若是格式不正确，方法会返回nil。例如，响应的数据明明是一个 HTML 格式，你用 responseImage 方法只会获得 nil。只有 responseData 能保证不管什么格式都返回正确，而其余方法你必须确保和相应的repsone 类型匹配。

有用的宏

DLog 和 ALog 宏被无耻地从 Stackoverflow 剽窃来了，我找不到源做者。若是是你写的，请告诉我。

关于GCD 的一点说明

由于网络线程有可能会能被中止或优先处理，我果断放弃了 GCD——GCD 的效率是比NSOperation 高，但它作不到这一点。我建议在你的网络线程中也不要使用基于 GCD 的队列。