您现在的位置: IOS教程網 >> IOS系統 >  >> iOS 教學 >> iOS 相關教學

MKNetworkKit 框架解析:輕量、支援 ARC 的 iOS 網路層

編輯:iOS 相關教學

MKNetworkKit 是一款以 Objective-C 撰寫的網路框架,特色是極度輕量、完整支援 ARC,並且內建快取、離線佇列與縮圖快取。本文解析它的設計理念、安裝方式與常見用法。

一、它是什麼

MKNetworkKit 支持 block、支援 ARC,用法簡潔。它吸收了 ASIHTTPRequest 與 AFNetworking 兩個框架的優點,並在此之上加入了不少新功能,目標是讓開發者遠離繁瑣的網路程式碼。

二、核心設計:整個 App 只有一個佇列

整個框架只有兩個核心類別(MKNetworkOperation 與 MKNetworkEngine)加上一些類別(category),因此上手極快。

更關鍵的是併發數的控制。高度依賴網路的 App 必須仔細規劃網路執行緒的併發數,而多數框架在這件事上做得並不理想;一旦沒有控制好,很容易出錯。

為什麼這麼重要?因為多數行動網路對同一個 IP 的 HTTP 併發連線數有嚴格限制:

  • 3G 通常不允許超過 2 個併發連線
  • Edge 的情況更糟,大多數時候不能超過 1 個
  • Wi-Fi 相對寬鬆,約可到 6 個

真正的問題往往不是上傳慢,而是這種情況:你打開一個畫面想載入縮圖,此時背景還有大量上傳任務在跑。若沒有控制上傳佇列的執行緒數,縮圖就會紛紛逾時。正確做法是優化縮圖的載入線程,或讓它排在上傳之後——而這一切都需要整個 App 共用同一個佇列。

MKNetworkKit 的做法是在每個 engine 實例中使用單例來保證這件事。並不是說 MKNetworkKit 本身是單例,而是它的共享佇列是單例。

三、下載與安裝

專案位置:https://github.com/MugunthKumar/MKNetworkKit

注意:若要執行內附的 demo,務必打開 MKNetworkKit.xcworkspace,直接打開單一專案檔會在編譯時抱怨找不到 libMKNetworkKit-iOS.a。

安裝步驟:

  1. 把專案中的 MKNetworkKit 資料夾拖進自己的專案
  2. 加入必要的 framework

  1. 在專案中開啟 ARC

因為 MKNetworkKit 本身支援 ARC,專案沒開 ARC 會直接編譯失敗。開啟 ARC 後,專案中所有手動的 dealloc、release、autorelease 都要移除或註解。

使用時在需要的檔案引入標頭:#import "MKNetworkKit.h"

四、內建的實用特性

1. 自動顯示網路狀態指示器

許多第三方框架透過「連線數增加/減少」的回呼來控制網路指示器。MKNetworkKit 因為使用單例共享佇列,共享佇列中的一個線程會用 KVO 監看 operationCount,因此開發者通常完全不必操心這件事:

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

2. 依網路環境自動調整佇列大小

如前所述,多數行動網路不允許 2 個以上的併發連線。MKNetworkKit 會自動處理:偵測到 3G/EDGE/GPRS 時把併發數調為 2,在 Wi-Fi 下則調為 6。當你透過 3G 載入遠端縮圖時,這個機制的效果特別明顯。

3. 自動快取

MKNetworkKit 會自動快取所有 GET 請求。再次發出同樣的請求時,它會立刻把快取內容交給 handler 處理,同時也向伺服器送出請求;一旦拿到新資料,handler 會被再次呼叫。也就是說你完全不必手寫快取邏輯,只要在 engine 中開啟:

[[MKNetworkEngine sharedEngine] useCache];

需要時可以覆寫這個方法(子類化),自訂快取路徑與佔用的記憶體上限。

4. 凍結(Freeze)網路操作

這是最有趣的特性之一。當一個操作被標記為「可凍結」,一旦網路中斷,它會被自動序列化保存;等裝置重新連線後自動送出。行為類似 Twitter 客戶端的「草稿」。

例如你離線時點了收藏,MKNetworkKit 會自動把這個請求凍結並存起來,等恢復連線後再送出——整個過程不需要寫任何一行程式碼。同樣的技巧也能用在分享連結到 Instapaper 這類操作上。

5. 相同 URL 的請求只執行一次

載入 Twitter 動態的縮圖時,你可能會為每張圖建立一個請求,但實際上很多請求指向同一個 URL。MKNetworkKit 對佇列中的每個 GET 請求只會實際執行一次,完成後通知所有等待的 block。(POST 目前不在此列。)

6. 圖片與縮圖快取

內建縮圖快取。覆寫幾個方法即可設定記憶體中最多快取幾張圖、以及快取要寫到哪個目錄;不覆寫也能正常運作。

7. 效能

快取機制類似 NSCache,當系統發出記憶體警告時,記憶體中的快取資料會被寫入快取目錄,而不是直接丟掉。

8. 完全支援 ARC

新專案本來就會開 ARC。ARC 通常也比非 ARC 程式碼更快,而且不必再手動管理記憶體。

五、設計哲學:不要臃腫

Apple 已經提供了最底層的網路程式碼,第三方框架該做的是提供一個優雅的操作佇列,最多再加上快取。作者認為第三方框架的類別數量不該超過 10 個,否則就太臃腫——Three20、ShareKit 都是龐大的例子;而 ASIHTTPRequest、AFNetworking 比 RESTKit 輕,JSONKit 比 TouchJSON 輕。

框架臃腫帶來的問題是難以理解內部機制、也難以依需求定制。所以 MKNetworkKit 只暴露兩個核心類別:

  • MKNetworkOperation:NSOperation 的子類,封裝單一請求與回應,相當於 ASIHTTPRequest 中的 request 類別。每個網路操作建立一個實例。
  • MKNetworkEngine:偽單例類別,管理整個程式的網路佇列。之所以說「偽」單例,是因為簡單請求可以直接用它的類方法,而深度定制則應該子類化。每個 engine 子類有自己的 Reachability 物件;對不同的 REST 服務器,建議各建一個子類。

實務上可以在 AppDelegate 中 retain 這個 engine,就像 Core Data 的 managedObjectContext 一樣,並依服務來源把請求做邏輯分組(例如所有 Yahoo 相關方法放一個類別、所有 Facebook 相關方法放另一個)。

六、實例一:抓取匯率

步驟 1:建立 engine 子類

MKNetworkEngine 以主機名稱(與自訂標頭)初始化,標頭可以是 nil。若是自己的 REST 服務器,可以在標頭中帶上客戶端版本或識別資訊。

NSMutableDictionary *headerFields = [NSMutableDictionary dictionary];
[headerFields setValue:@"iOS" forKey:@"x-client-identifier"];

self.engine = [[YahooEngine alloc] initWithHostName:@"download.finance.yahoo.com"
                                 customHeaderFields:headerFields];

(Yahoo 並不認得這個自訂標頭,此處僅為示範。)由於使用 ARC,開發者需要強引用這個 engine 物件。

建立子類之後,Reachability 會自動生效。當主機不可達時,請求會自動被凍結。

步驟 2:關注分離的介面設計

設計 engine 方法時,不要把 URL 或 HTTP 標頭暴露給呼叫者。視圖不該知道 URL 或相關參數,只需傳入幣別即可。因為是異步操作,結果應該透過 block 回傳:

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

父類 MKNetworkEngine 已定義三種 block 型別:

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

YahooEngine 另外定義了一個回傳匯率的型別:

typedef void (^CurrencyResponseBlock)(double rate);

步驟 3:在 engine 中處理資料

把伺服器回傳的 JSON/XML/plist 轉型為模型物件,這件事應該在 engine 中完成,而不是在控制器中。engine 應回傳模型物件或模型陣列,視圖控制器不該知道任何解析 JSON 節點用的 key。多數網路框架不強制關注分離,MKNetworkKit 強制,是因為它把這件事替你考慮好了。

步驟 4:實作方法

從 Yahoo 抓匯率,最簡單的方式就是一個 GET 請求。用一個巨集來格式化 URL:

#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. 設定 completion 與 error block(在 completion 中處理回應並轉為模型)
  5. 視需要加上 progress block
  6. 若是下載,設定下載串流(通常是檔案)
  7. 完成後處理結果並呼叫回傳的 block
MKNetworkOperation *op =
    [self operationWithPath:YAHOO_URL(sourceCurrency, targetCurrency)
                     params:nil
                 httpMethod:@"GET"];

[op onCompletion:^(MKNetworkOperation *completedOperation) {
    DLog(@"%@", [completedOperation responseString]);
    // 在這裡做資料處理
    completionBlock(5.0f);
} onError:^(NSError *error) {
    errorBlock(error);
}];

[self enqueueOperation:op];
return op;

這段程式格式化 URL、建立 operation、設定兩個 block,然後透過父類的 enqueueOperation: 加入佇列,最後回傳 operation 的參照。

回傳參照的用意:如果你在 viewDidAppear 呼叫這個方法,就能在 viewWillDisappear 取消它。取消 operation 會釋放佇列名額給其他畫面使用——切記在行動網路上同時只能有 2 個 operation 進行,及早取消不再需要的請求能明顯提升 App 的反應速度。

在 view controller 中也可以加上 progress block 來更新 UI:

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

MKNetworkEngine 也提供只用 URL 建立 operation 的便捷方法,因此第一行可以簡化為:

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

請求的 URL 會自動補上 engine 初始化時指定的主機名稱。這類便捷方法還有很多,可查閱標頭檔。

七、實例二:上傳圖片

上傳需要 operation 能編碼 multipart 表單資料。MKNetworkKit 的作法與 ASIHTTPRequest 類似:

// 以檔案方式提交
[op addFile:filePath forKey:@"image"];

// 以 NSData 方式提交(例如直接從相機取得的圖片)
[op addData:imageData forKey:@"image"];

八、實例三:下載檔案到本機

只要設定 operation 的 outputStream:

[operation setDownloadStream:
    [NSOutputStream outputStreamToFileAtPath:@"/path/to/DownloadedFile.pdf"
                                      append:YES]];

可以對同一個 operation 設定多個 outputStream,把同一份檔案同時寫到幾個地方(例如一份放快取目錄、一份放工作目錄)。

九、實例四:縮圖快取

下載圖片時,你手上通常是完整的絕對 URL 而非路徑。這時改用:

operationWithURLString:params:httpMethod:

MKNetworkEngine 相當聰明:它會把同一個 URL 的多個 GET 請求合併成一個,完成後通知所有等待的 block,這對渲染串流縮圖的效果特別顯著。

想自訂快取目錄與容量就子類化 MKNetworkEngine 並覆寫相關方法;不想定制則直接呼叫現成方法即可,這也是多數情況的建議做法。

十、快取操作

MKNetworkKit 預設會快取所有請求,你只要在自己的 engine 中開啟。執行 GET 時,若上次的回應已快取,completion block 會先用快取資料呼叫一次(瞬間完成)。想知道資料來源,用 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);
}];

十一、凍結操作

只需設定一個屬性:

[op setFreezable:YES];

凍結的意思是:網路中斷時自動序列化保存,恢復後自動執行。此外,App 進入背景時,凍結的 operation 也會被持久化到磁碟,回到前景後自動恢復執行。

十二、MKNetworkOperation 的取用方法

operation 完成後,可用這些方法取得各種格式的回應:

responseData
responseString
responseJSON   // 僅 iOS 5 以上
responseImage
responseXML
error

若格式不符會回傳 nil。例如回應實際上是 HTML,用 responseImage 只會拿到 nil。只有 responseData 保證任何格式都正確,其餘方法都必須自行確保型別對應。

十三、關於 GCD 的取捨

作者選擇放棄 GCD,改用 NSOperation 實作。理由是網路操作可能需要被取消或調整優先權,GCD 效率雖高,但在這件事上做不到。因此建議在網路相關的程式碼中也避免使用純 GCD 佇列。

今日觀點補充

值得補充的是,MKNetworkKit 已多年未更新,範例中的 Yahoo 匯率介面也早已停止服務。它作為「輕量網路層設計」的教材仍有價值——單例佇列、併發數控制、自動快取、離線凍結這幾個思路,在今日的 URLSession 生態中依然適用,只是實作上會改用 URLSessionConfiguration 搭配自製的請求建構層與磁碟快取策略。新專案建議直接以 URLSession 出發,必要時再引入 Alamofire 這類較現代化的封装。

  1. 上一篇文章:
  2. 下一篇文章:
蘋果刷機越獄教程| IOS教程問題解答| IOS技巧綜合| IOS7技巧| IOS8教程
Copyright © IOS教程網 All Rights Reserved