MGJRequestManager 是一款基于 AFNetwokring 2.0+ 的 iOS 網(wǎng)絡(luò)庫。

一般在做項(xiàng)目時(shí)，我們都會(huì)在 AFNetworking 的基礎(chǔ)上再封裝一層，加入一些業(yè)務(wù)邏輯，然后作為統(tǒng)一的 API 層。細(xì)分下來的話，功能點(diǎn)其實(shí)不多，且相對(duì)固定和通用，就索性把這些常用的功能統(tǒng)一處理，并提供靈活的使用方式，于是就有了 MGJRequestManager。

MGJRequestManager 目前被用在「蘑菇街」，「小店」等 App 中，已穩(wěn)定運(yùn)行了一段時(shí)間。

強(qiáng)大

以「蘑菇街」為例，統(tǒng)計(jì)這塊會(huì)計(jì)算請(qǐng)求消耗的時(shí)間、每次請(qǐng)求都要發(fā)送的參數(shù)、據(jù)請(qǐng)求參數(shù)的值計(jì)算 token、緩存請(qǐng)求以便快速呈現(xiàn)等等，MGJRequestManager 都可以比較方便地搞定。

主要功能

• 緩存GET請(qǐng)求（可以方便地開啟/關(guān)閉）

• 設(shè)置 Builtin 參數(shù)（每次請(qǐng)求都會(huì)帶上的參數(shù)，如設(shè)備型號(hào)等）

• 符合某種（自定義）條件時(shí)，可以不發(fā)送請(qǐng)求（比如用戶多次點(diǎn)擊「喜歡」按鈕）

• 對(duì)請(qǐng)求結(jié)果做預(yù)處理（比如將服務(wù)端返回的數(shù)據(jù)包裝成統(tǒng)一的格式）

• 串行發(fā)送多個(gè)請(qǐng)求（比如 token 過期后，可以將請(qǐng)求新 token 和當(dāng)前請(qǐng)求串起來）

• 并行發(fā)送多個(gè)請(qǐng)求，可以告知請(qǐng)求完成數(shù)，以及全部請(qǐng)求完成后調(diào)用某個(gè) callback

• 發(fā)送請(qǐng)求時(shí)顯示 loading，發(fā)送完成后隱藏 loading

• 上傳圖片

• 取消正在發(fā)送的請(qǐng)求

靈活

因?yàn)樾枨蠼?jīng)常會(huì)變，所以架構(gòu)需要非常靈活才能方便應(yīng)對(duì)新功能，比如「發(fā)送請(qǐng)求時(shí)顯示 loading，發(fā)送完成后隱藏 loading」這個(gè)只是利用了現(xiàn)成的接口實(shí)現(xiàn)的一個(gè)特性。一些常見的需求都可以通過對(duì) MGJRequestManager 進(jìn)行配置來實(shí)現(xiàn)。

思想

本著「everything should be as simple as possible, but not simpler」的原則，設(shè)計(jì)這個(gè)類庫時(shí)，希望使用起來和理解起來盡量方便，同時(shí)又足夠靈活，可以應(yīng)付大多數(shù)的場(chǎng)景。

主要分為兩部分 MGJRequestManagerConfiguration 和 MGJRequestManager，前者做一些自定義配置，比如請(qǐng)求發(fā)送前/后的預(yù)處理，baseURL，userInfo等。后者記錄下這些信息，在適當(dāng)?shù)臅r(shí)候消費(fèi)它們，同時(shí)支持針對(duì)某些特殊請(qǐng)求做自定義配置。

安裝

pod?'MGJRequestManager'

gif 演示

使用

以「發(fā)送請(qǐng)求時(shí)顯示 loading，發(fā)送完成后隱藏 loading」為例

//?1
MGJRequestManagerConfiguration?*configuration?=?[[MGJRequestManagerConfiguration?alloc]?init];

UIActivityIndicatorView?*indicatorView?=?[[UIActivityIndicatorView?alloc]?initWithActivityIndicatorStyle:UIActivityIndicatorViewStyleGray];
indicatorView.frame?=?CGRectMake(self.view.frame.size.width?/?2?-?8,?self.view.frame.size.height?/?2?-?8,?16,?16);
[self.view?addSubview:indicatorView];

//?2
configuration.requestHandler?=?^(AFHTTPRequestOperation?*operation,?id?userInfo,?BOOL?*shouldStopProcessing)?{
????if?(userInfo[@"showLoading"])?{
????????[indicatorView?startAnimating];
????}
};

//?3
configuration.responseHandler?=?^(AFHTTPRequestOperation?*operation,?id?userInfo,?MGJResponse?*response,?BOOL?*shouldStopProcessing)?{
????if?(userInfo[@"showLoading"])?{
????????[indicatorView?stopAnimating];
????}
};

[MGJRequestManager?sharedInstance].configuration?=?configuration;

//?4
[[MGJRequestManager?sharedInstance]?GET:@"http://httpbin.org/delay/2"
?????????????????????????????parameters:nil
???????????????????????startImmediately:YES?//?5
???????????????????configurationHandler:^(MGJRequestManagerConfiguration?*configuration){
???????????????????????configuration.userInfo?=?@{@"showLoading":?@YES};?//?6
???????????????????}?completionHandler:^(NSError?*error,?id?result,?BOOL?isFromCache,?AFHTTPRequestOperation?*operation)?{
???????????????????????[self?appendLog:result.description];?//?7
???????????????????}];

1. MGJRequestManager 要配合 MGJRequestManagerConfiguration 才能發(fā)揮出威力。這個(gè) configuration 可以配置 baseURL, requestHandler, responseHandler 等信息，可變部分一般是通過對(duì) MGJRequestManagerConfiguration 進(jìn)行配置來實(shí)現(xiàn)的。可以全局設(shè)置一個(gè) configuration，然后單獨(dú)發(fā)送請(qǐng)求時(shí)還可以覆蓋默認(rèn)設(shè)置。

2. requestHandler 這個(gè) block 會(huì)在請(qǐng)求發(fā)送前被觸發(fā)，userInfo 這個(gè)參數(shù)時(shí) configuration 這個(gè)實(shí)例的一個(gè)屬性，方便起見，作為參數(shù)傳給了 requestHandler。還有一個(gè)重要的參數(shù)時(shí) *shouldStopProcessing，如果在這個(gè) block 里，它被設(shè)置為了 YES，那么這個(gè)請(qǐng)求將不會(huì)被發(fā)送。

3. responseHandler 這個(gè) block 會(huì)在收到服務(wù)端的響應(yīng)后被觸發(fā)，response 參數(shù)有 error 和 result 兩個(gè)屬性，服務(wù)端返回的數(shù)據(jù)都被放到了 result 屬性里，在這里可以對(duì)它進(jìn)行解析，然后重新設(shè)置 response。如果 *shouldStopProcessing 被設(shè)置為了 YES，那么 completionHandler 就不會(huì)被觸發(fā)。

4. POST/PUT/DELETE 只需把 GET 換成對(duì)應(yīng)的 HTTP Method 即可。

5. startImmediately 如果設(shè)為 NO，那么這個(gè)請(qǐng)求不會(huì)被發(fā)送，可以將來通過調(diào)用 -[MGJRequestManager startOperation:] 來發(fā)送，或者也可以放到隊(duì)列里。

6. 這里會(huì)傳入默認(rèn)的 configuration，如果需要在這個(gè)請(qǐng)求做一些個(gè)性化設(shè)置，可以修改 configuration 里相應(yīng)地配置。

7. 這里的 result 就是 -[MGJResponse result], error 是 -[MGJResponse error], isFromCache 表示這個(gè)結(jié)果是否來自緩存。