[ios 站在巨人的肩膀上開發 之]ASIHttpRequest 使用指南(二)


本文來源: http://www.cocoachina.com/bbs/read.php?tid-51242.html


另外也可以參考:  [ios 站在巨人的肩膀上開發 之]ASIHttpRequest 使用指南(一) 


ASIHTTPRequest 是一款極其強勁的 HTTP 訪問開源項目。讓簡單的 API 完成複雜的功能,如:異步請求,隊列請求,GZIP 壓縮,緩存,斷點續傳,進度跟蹤,上傳文件,HTTP 認證。在新的版本中,還加入了 Objective-C 閉包 Block 的支持,讓我們的代碼加輕簡靈活。

下面就舉例說明它的 API 用法。

發起一個同步請求

同步意爲着線程阻塞,在主線程中使用此方法會使應用Hang住而不響應任何用戶事件。所以,在應用程序設計時,大多被用在專門的子線程增加用戶體驗,或用異步請求代替(下面會講到)。

- (IBAction)grabURL:(id)sender
{
NSURL *url = [NSURL URLWithString:@"http://allseeing-i.com"];
ASIHTTPRequest *request = [ASIHTTPRequest requestWithURL:url];
[request startSynchronous];
NSError *error = [request error];
if (!error) {
NSString *response = [request responseString];
}
}

  • 用 requestWithURL 快捷方法獲取 ASIHTTPRequest 的一個實例
  • startSynchronous 方法啓動同步訪問
  • 由於是同步請求,沒有基於事件的回調方法,所以從 request的error 屬性獲取錯誤信息
  • responseString,爲請求的返回 NSString 信息

創建一個異步請求

異步請求的好處是不阻塞當前線程,但相對於同步請求略爲複雜,至少要添加兩個回調方法來獲取異步事件。下面異步請求代碼完成上面同樣的一件事情:

- (IBAction)grabURLInBackground:(id)sender
{
NSURL *url = [NSURL URLWithString:@"http://allseeing-i.com"];
ASIHTTPRequest *request = [ASIHTTPRequest requestWithURL:url];
[request setDelegate:self];
[request startAsynchronous];
}
- (void)requestFinished:(ASIHTTPRequest *)request
{
// Use when fetching text data
NSString *responseString = [request responseString];
// Use when fetching binary data
NSData *responseData = [request responseData];
}
- (void)requestFailed:(ASIHTTPRequest *)request
{
NSError *error = [request error];
}

  • 與上面不同的地方是指定了一個 “delegate”,並用 startAsynchronous 來啓動網絡請求
  • 在這裏實現了兩個 delegate 的方法,當數據請求成功時會調用 requestFinished,請求失敗時(如網絡問題或服務器內部錯誤)會調用 requestFailed。

隊列請求

提供了一個對異步請求更加精準豐富的控制。如:可以設置在隊列中同步請求的連接數。往隊列裏添加的請求實例數大於 maxConcurrentOperationCount 時,請求實例將被置爲等待,直到前面至少有一個請求完成並出列才被放到隊列裏執行。這也適用於當我們有多個請求需求按順序執行的時候(可能是業務上的需要,也可能是軟件上的調優),僅僅需要把 maxConcurrentOperationCount 設爲“1”。

- (IBAction)grabURLInTheBackground:(id)sender
{
if (![self queue]) {
[self setQueue:[[[NSOperationQueue alloc] init] autorelease]];
}
NSURL *url = [NSURL URLWithString:@"http://allseeing-i.com"];
ASIHTTPRequest *request = [ASIHTTPRequest requestWithURL:url];
[request setDelegate:self];
[request setDidFinishSelector:@selector(requestDone:)];
[request setDidFailSelector:@selector(requestWentWrong:)];
[[self queue] addOperation:request]; //queue is an NSOperationQueue
}
- (void)requestDone:(ASIHTTPRequest *)request
{
NSString *response = [request responseString];
}
- (void)requestWentWrong:(ASIHTTPRequest *)request
{
NSError *error = [request error];
}

創建 NSOperationQueue,這個 Cocoa 架構的執行任務(NSOperation)的任務隊列。我們通過 ASIHTTPRequest.h 的源碼可以看到,此類本身就是一個 NSOperation 的子類。也就是說它可以直接被放到”任務隊列”中並被執行。上面的代碼除了隊列的創建與添加操作外,其它代碼與上一例一樣。

隊列異步請求中中獲取或識別不同request小技巧

  • 可以設置一個上下文(userInfo)到 request 對象中,當請求響應完後可以通過訪問 request 對象的 userInfo 獲取裏面的信息
  • 爲每一個請求實例設置不同的 setDidFinishSelector / setDidFailSelector 的回調方法
  • 子類化 ASIHTTPRequest,重寫 requestFinished: 與 failWithProblem: 方法

ASINetworkQueues, 它的delegate提供更爲豐富的功能

提供的更多的回調方法如下:

  • requestDidStartSelector,請求發起時會調此方法,你可以在此方法中跟據業務選擇性的設置 request 對象的 deleaget
  • requestDidReceiveResponseHeadersSelector,當接受完響應的 Header 後設計此方法,這個對下載大數據的時候相當有用,你可以在方法裏做更多業務上的處理
  • requestDidFinishSelector,請求並響應成功完成時調用此方法
  • requestDidFailSelector,請求失敗
  • queueDidFinishSelector,整個隊列裏的所有請求都結束時調用此方法

它是 NSOperationQueues 的擴展,小而強大。但也與它的父類略有區別。如,僅添加到隊列中其實並不能執行請求,只有調用[  queue g o ]纔會執行;一個正在運行中的隊列,並不需要重複調用[  queue go  ]。默認情況下,隊列中的一個請求如果失敗,它會取消所有未完成的請求。可以設置[  queue setShouldCancelAllRequestsOnFailure:NO  ]來修正。

取消異步請求

首先,同步請求是不能取消的。

其次,不管是隊列請求,還是簡單的異步請求,全部調用[ request cancel ]來取消請求。取消的請求默認都會按請求失敗處理,並調用請求失敗delegate。
如果不想調用delegate方法,則設置:[ request clearDelegatesAndCancel];

隊列請求中需要注意的是,如果你取消了一個請求,隊列會自動取消其它所有請求。如果只想取消一個請求,可以設置隊列:[ queue setShouldCancelAllRequestsOnFailure:NO ]; 如果想明確取消所有請求:[ queue cancelAllOperations ];

安全的內存回收建議

request並沒有retain你的delegate,所以在沒有請求完的時候釋放了此delegate,需要在dealloc方法裏先取消所有請求,再釋放請求實例,如:

- (void)dealloc
{
[request clearDelegatesAndCancel];
[request release];
...
[super dealloc];
}

向服務器端上傳數據

ASIFormDataRequest ,模擬 Form 表單提交,其提交格式與 Header 會自動識別。

  • 沒有文件:application/x-www-form-urlencoded
  • 有文件:multipart/form-data
ASIFormDataRequest *request = [ASIFormDataRequest requestWithURL:url];
[request setPostValue:@"Ben" forKey:@"first_name"];
[request setPostValue:@"Copsey" forKey:@"last_name"];
[request setFile:@"/Users/ben/Desktop/ben.jpg" forKey:@"photo"];
[request addData:imageData withFileName:@"george.jpg" andContentType:@"image/jpeg" forKey:@"photos"];

如果要發送自定義數據:
ASIHTTPRequest *request = [ASIHTTPRequest requestWithURL:url];
[request appendPostData:[@"This is my data" dataUsingEncoding:NSUTF8StringEncoding]];
// Default becomes POST when you use appendPostData: / appendPostDataFromFile: / setPostBody:
[request setRequestMethod:@"PUT"];

下載文件

通過設置request的setDownloadDestinationPath,可以設置下載文件用的下載目標目錄。

首先,下載過程文件會保存在temporaryFileDownloadPath目錄下。如果下載完成會做以下事情:

  • 如果數據是壓縮的,進行解壓,並把文件放在 downloadDestinationPath 目錄中,臨時文件被刪除
  • 如果下載失敗,臨時文件被直接移到 downloadDestinationPath 目錄,並替換同名文件

如果你想獲取下載中的所有數據,可以實現 delegate 中的 request:didReceiveData:方法。但如果你實現了這個方法,request 在下載完後,request 並不把文件放在 downloadDestinationPath 中,需要手工處理。

獲取響應信息

信息:status , header, responseEncoding

[request responseStatusCode];
[[request responseHeaders] objectForKey:@"X-Powered-By"];
[request responseEncoding];

獲取請求進度

 

有兩個回調方法可以獲取請求進度:

  • downloadProgressDelegate,可以獲取下載進度
  • uploadProgressDelegate,可以獲取上傳進度

cookie的支持

如果 Cookie 存在的話,會把這些信息放在 NSHTTPCookieStorage 容器中共享,並供下次使用。你可以用 [ ASIHTTPRequest setSessionCookies:nil ] ; 清空所有 Cookies。當然,你也可以取消默認的Cookie策略,而使自定義的Cookie:

//Create a cookie
NSDictionary *properties = [[[NSMutableDictionary alloc] init] autorelease];
[properties setValue:[@"Test Value" encodedCookieValue] forKey:NSHTTPCookieValue];
[properties setValue:@"ASIHTTPRequestTestCookie" forKey:NSHTTPCookieName];
[properties setValue:@".allseeing-i.com" forKey:NSHTTPCookieDomain];
[properties setValue:[NSDate dateWithTimeIntervalSinceNow:60*60] forKey:NSHTTPCookieExpires];
[properties setValue:@"/asi-http-request/tests" forKey:NSHTTPCookiePath];
NSHTTPCookie *cookie = [[[NSHTTPCookie alloc] initWithProperties:properties] autorelease];
//This url will return the value of the 'ASIHTTPRequestTestCookie' cookie
url = [NSURL URLWithString:@"http://allseeing-i.com/ASIHTTPRequest/tests/read_cookie"];
request = [ASIHTTPRequest requestWithURL:url];
[request setUseCookiePersistence:NO];
[request setRequestCookies:[NSMutableArray arrayWithObject:cookie]];
[request startSynchronous];
//Should be: I have 'Test Value' as the value of 'ASIHTTPRequestTestCookie'
NSLog(@"%@",[request responseString]);

大文件斷點續傳

0.94 以後支持大文件的斷點下載,只需要設置

[ request setAllowResumeForFileDownloads:YES ];
 
[ request setDownloadDestinationPath:downloadPath ];

就可以了。

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章