網路上有個公開的天氣接口,點進其中的 getSupportCityDataset,就能查詢某區域支援的城市列表。以下用它當例子,說明 iOS 上 GET、POST 以及同步、非同步請求的寫法。該接口同時提供了 GET 與 POST 兩種呼叫形式。
NSString *URLString = @"https://webservice.webxml.com.cn/WebServices/WeatherWS.asmx/getSupportCityDataset?theRegionCode=廣東";
NSURL *URL = [NSURL URLWithString:[URLString stringByAddingPercentEscapesUsingEncoding:NSUTF8StringEncoding]];
NSURLRequest *request = [[NSURLRequest alloc] initWithURL:URL];
NSURLResponse *response = nil;
NSError *error = nil;
NSData *data = [NSURLConnection sendSynchronousRequest:request returningResponse:&response error:&error];
if (error) {
NSLog(@"error: %@", [error localizedDescription]);
} else {
NSLog(@"response : %@", response);
NSLog(@"backData : %@", [[NSString alloc] initWithData:data encoding:NSUTF8StringEncoding]);
}
GET 的請求參數放在那串長長的 URL 裡。這裡只需要一個參數,也就是地區編號或名稱,伺服器會回傳該區域內支援查詢的城市清單。若有更多參數,同樣接在 URL 後面,實際的組織方式要看伺服器端的要求。
用字串建立 NSURL 時,最好先做一次 UTF-8 轉碼。原因是 URL 中含中文等非 ASCII 字元時,直接傳入會導致 NSURL 為 nil,後續請求自然失敗。接著由 NSURL 建立 NSURLRequest,再用 NSURLConnection 的同步方法發送即可。
這裡傳入了 NSError 的地址做錯誤判斷。網路的實際狀況多變,一定要考慮請求失敗的情況,否則後續強制解包或假設資料不為空都可能讓程式崩潰。
NSString *URLString = @"https://webservice.webxml.com.cn/WebServices/WeatherWS.asmx/getSupportCityString";
NSURL *URL = [NSURL URLWithString:[URLString stringByAddingPercentEscapesUsingEncoding:NSUTF8StringEncoding]];
NSString *postString = @"theRegionCode=廣東";
NSData *postData = [postString dataUsingEncoding:NSUTF8StringEncoding]; // 參數字串轉成 NSData
NSMutableURLRequest *request = [[NSMutableURLRequest alloc] init];
[request setHTTPMethod:@"POST"]; // 指定請求方式
[request setURL:URL]; // 設定位址
[request setHTTPBody:postData]; // 設定請求參數
NSURLResponse *response;
NSError *error;
NSData *backData = [NSURLConnection sendSynchronousRequest:request returningResponse:&response error:&error];
if (error) {
NSLog(@"error : %@", [error localizedDescription]);
} else {
NSLog(@"response : %@", response);
NSLog(@"backData : %@", [[NSString alloc] initWithData:backData encoding:NSUTF8StringEncoding]);
}
POST 的參數放在 HTTP Body 裡,而且需要轉成對應的 NSData。編碼方式在接口文檔中通常會標明,必須按指定方式處理 —— 這裡是 UTF-8,也有服務使用 gb2312。request 建立好之後,發送方式與 GET 相同。
一般網路請求都需要一段時間,而且很多時候必須考慮網路不佳時 App 的狀態。
同步請求只要安心等待資料回來即可,不需額外處理,上面兩個例子都是同步的 —— connection 呼叫後直接回傳結果。但同步會阻塞執行緒:如果透過點擊 button 發起請求,按鈕會一直停留在 highlight 狀態直到請求結束,給人一種 App 卡死、當機的觀感,體驗很差。
非同步 GET:
NSString *URLString = @"https://webservice.webxml.com.cn/WebServices/WeatherWS.asmx/getSupportCityDataset?theRegionCode=廣東"; NSURL *URL = [NSURL URLWithString:[URLString stringByAddingPercentEscapesUsingEncoding:NSUTF8StringEncoding]]; NSURLRequest *request = [[NSURLRequest alloc] initWithURL:URL]; _connection = [[NSURLConnection alloc] initWithRequest:request delegate:self]; // (1)
非同步 POST 類似,差別只在於不再用 NSURLConnection 的類方法直接取回資料,而是用 (1) 這個位置的初始化方法建立一個 NSURLConnection 物件,該方法會自動開始請求。接下來的關鍵就在 delegate:因為請求完成時間未知,所以用回調的方式在資料回來時通知我們。POST 與 GET 在 delegate 的處理上完全一樣。
要注意這裡有兩個 delegate:NSURLConnectionDataDelegate 與 NSURLConnectionDelegate,前者繼承自後者,而取得資料的方法定義在前者裡面,所以只要遵循 NSURLConnectionDataDelegate 即可。
一般會用到四個回調:
// 收到 response,其中包含狀態碼與資料標頭(長度、編碼等)
- (void)connection:(NSURLConnection *)connection didReceiveResponse:(NSURLResponse *)response {
NSLog(@"response = %@", response);
_backData = [[NSMutableData alloc] init];
}
// 收到資料時呼叫。完整資料可能拆成多個封包,每次都會回呼,因此需要一個全域
// 的 NSData 用來拼接
- (void)connection:(NSURLConnection *)connection didReceiveData:(NSData *)data {
[_backData appendData:data];
}
// 資料接收完畢,此時才是完整資料
- (void)connectionDidFinishLoading:(NSURLConnection *)connection {
NSLog(@"%@", [[NSString alloc] initWithData:_backData encoding:NSUTF8StringEncoding]);
}
// 請求失敗時呼叫,錯誤處理不可忽略
- (void)connection:(NSURLConnection *)connection didFailWithError:(NSError *)error {
if (error.code == NSURLErrorTimedOut) {
NSLog(@"請求超時");
}
NSLog(@"%@", [error localizedDescription]);
}
didReceiveData 那一段特別容易出錯:如果直接在回調中把 data 轉成字串,遇到較大的回應就會得到截斷或亂碼,因為 TCP 本來就不保證一次送完。必須用一個成員變量持續 append,直到 connectionDidFinishLoading 才做解析。
NSURLRequest *request = [[NSURLRequest alloc] initWithURL:URL cachePolicy:0 timeoutInterval:8.0];
或者:
NSMutableURLRequest *request = [[NSMutableURLRequest alloc] initWithURL:URL]; [request setTimeoutInterval:8.0];
請求時間超過設定值,系統會自動呼叫:
- (void)connection:(NSURLConnection *)connection didFailWithError:(NSError *)error
至於如何判斷是「超時」導致的失敗,上面例子已經示範了:根據回傳 error 的 code 判斷。了解不同情境的請求失敗,才能給使用者更精準的提示。
補充一句:NSURLConnection 在後續的 iOS 版本中已被標記為不建議使用,新專案請改用 NSURLSession。整體概念是相通的 —— 一樣有 request 建構、一樣有 delegate 或 completion handler 兩種回調風格,只是 API 更清晰,也原生支援背景傳輸。