您现在的位置: IOS教程網 >> IOS系統 >  >> iOS 程式開發 >> iOS 開發基礎

iOS 網絡請求實戰:NSURLSession 的 GET、POST 與代理用法

編輯:iOS 開發基礎

NSURLConnection 在 iOS 9 中被宣布棄用,本文不再使用它進行網絡編程,有興趣的讀者可以參考《iOS 開發 GET、POST 請求方法(NSURLConnection 篇)》。

NSURLSession 是 iOS 7 引入的新網絡接口,在 2013 年的 WWDC 上由 Apple 作為 NSURLConnection 的繼任者提出。

它與 NSURLConnection 並列,支持後台網絡任務等新特性。結構上,NSURLSession 把原來的一整套換成了三個角色:NSURLSession、NSURLSessionConfiguration、NSURLSessionTask。

使用 NSURLSession 通常分兩步:先通過實例創建 task,再執行 task。而 NSURLSessionTask 就是所謂的「任務」,它是抽象類,有三個可直接使用的子類:

  • NSURLSessionDataTask:獲取數據
  • NSURLSessionUploadTask:上傳文件
  • NSURLSessionDownloadTask:下載文件

由於 DataTask 也能勝任上傳下載,實戰中使用頻率最高。

一、GET 請求

// 1. 創建網絡路徑
NSURL *url = [NSURL URLWithString:[NSString stringWithFormat:
    @"https://172.16.2.254/php/phonelogin?yourname=%@&yourpas=%@&btn=login", yourname, yourpass]];

// 2. 創建網絡請求
NSURLRequest *request = [NSURLRequest requestWithURL:url];

// 3. 獲得會話對象
NSURLSession *session = [NSURLSession sharedSession];

// 4. 根據會話創建 Task
NSURLSessionDataTask *sessionDataTask =
    [session dataTaskWithRequest:request
               completionHandler:^(NSData * _Nullable data,
                                   NSURLResponse * _Nullable response,
                                   NSError * _Nullable error) {
        NSLog(@"從服務器獲取到數據");

        NSDictionary *dict = [NSJSONSerialization JSONObjectWithData:data
                                                             options:(NSJSONReadingMutableLeaves)
                                                               error:nil];
    }];

// 5. 執行任務
[sessionDataTask resume];

二、POST 請求

// 1. 創建網絡路徑
NSURL *url = [NSURL URLWithString:@"https://172.16.2.254/php/phonelogin"];

// 2. 創建請求並設置方法與請求體
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:url];
request.HTTPMethod = @"POST";

NSString *args = [NSString stringWithFormat:@"yourname=%@&yourpass=%@&btn=login", yourname, yourpass];
request.HTTPBody = [args dataUsingEncoding:NSUTF8StringEncoding];

// 3. 獲得會話對象
NSURLSession *session = [NSURLSession sharedSession];

// 4. 創建 Task
NSURLSessionDataTask *sessionDataTask =
    [session dataTaskWithRequest:request
               completionHandler:^(NSData * _Nullable data,
                                   NSURLResponse * _Nullable response,
                                   NSError * _Nullable error) {
        NSLog(@"從服務器獲取到數據");
        NSDictionary *dict = [NSJSONSerialization JSONObjectWithData:data
                                                             options:(NSJSONReadingMutableLeaves)
                                                               error:nil];
    }];

// 5. 執行任務
[sessionDataTask resume];

三、使用 NSURLSessionDataDelegate 代理

從上面兩種方式可以看出,相比 NSURLConnection,NSURLSession 提供了 block 回調的簡便寫法。但如果需要在請求過程中做更細粒度的處理(例如分塊解析、實時進度),就得改用代理方法。

通常設置代理需要一個可寫的 delegate 屬性,但查閱 NSURLSessionDataDelegate 文檔會發現,session 的 delegate 是只讀的:

@property (nullable, readonly, retain) id delegate;

因此必須通過另一個入口來指定代理:

// 1. delegateQueue 表示協議方法將在該 NSOperationQueue 中執行
//    session 的 delegate 只讀,只能用這種方式設置代理
NSURLSession *session =
    [NSURLSession sessionWithConfiguration:[NSURLSessionConfiguration defaultSessionConfiguration]
                                 delegate:self
                            delegateQueue:[[NSOperationQueue alloc] init]];

// 2. 創建任務(使用代理後不再需要 block 版本)
NSURL *url = [NSURL URLWithString:[NSString stringWithFormat:
    @"https://172.16.2.254/php/phonelogin?yourname=%@&yourpass=%@&btn=login", yourname, yourpass]];

NSURLSessionDataTask *task = [session dataTaskWithRequest:[NSURLRequest requestWithURL:url]];

// 3. 執行任務
[task resume];

類的開頭記得聲明遵循協議:

#import <UIKit/UIKit.h>

@interface ViewController : UIViewController <NSURLSessionDataDelegate>
@end

三個關鍵代理方法:

#pragma mark - NSURLSessionDataDelegate

// 1. 接收到服務器的響應
- (void)URLSession:(NSURLSession *)session
          dataTask:(NSURLSessionDataTask *)dataTask
didReceiveResponse:(NSURLResponse *)response
 completionHandler:(void (^)(NSURLSessionResponseDisposition))completionHandler {
    // 注意:必須調用 completionHandler 允許繼續,否則不會加載後續數據。
    // 若需要處理響應頭等信息,應寫在這行之前。
    completionHandler(NSURLSessionResponseAllow);
}

// 2. 接收到數據(此方法會被多次調用)
- (void)URLSession:(NSURLSession *)session
          dataTask:(NSURLSessionDataTask *)dataTask
    didReceiveData:(NSData *)data {
    // 追加每次接收到的數據
    [self.receiveData appendData:data];
}

// 3. 任務完成時調用(成功時 error 為 nil)
- (void)URLSession:(NSURLSession *)session
              task:(NSURLSessionTask *)task
didCompleteWithError:(NSError *)error {
    if (error == nil) {
        // 請求完成,在這裡統一解析 self.receiveData
    } else {
        NSLog(@"請求失敗:%@", error);
    }
}

四、NSURLSessionDownloadTask:文件下載

// 1. 創建網絡路徑
NSURL *url = [NSURL URLWithString:@"https://172.16.2.254/php/phonelogin/image.png"];

// 2. 獲取會話
NSURLSession *session = [NSURLSession sharedSession];

// 3. 創建下載任務
NSURLSessionDownloadTask *task =
    [session downloadTaskWithURL:url
               completionHandler:^(NSURL *location, NSURLResponse *response, NSError *error) {
        // location 是沙盒 tmp 下的臨時路徑,tmp 隨時可能被清理,
        // 因此需要把文件移動到 Caches 等持久目錄
        // response.suggestedFilename 即服務器上的文件名,此處為 image.png
        NSString *path = [[NSSearchPathForDirectoriesInDomains(NSCachesDirectory, NSUserDomainMask, YES) lastObject]
                          stringByAppendingPathComponent:response.suggestedFilename];
        NSURL *pathUrl = [NSURL fileURLWithPath:path];

        [[NSFileManager defaultManager] moveItemAtURL:location toURL:pathUrl error:nil];
    }];

// 4. 啟動任務
[task resume];

若需要展示下載進度,則改用 NSURLSessionDownloadDelegate:

// 1. 每次寫入調用(會多次觸發)
- (void)URLSession:(NSURLSession *)session
      downloadTask:(NSURLSessionDownloadTask *)downloadTask
      didWriteData:(int64_t)bytesWritten
 totalBytesWritten:(int64_t)totalBytesWritten
totalBytesExpectedToWrite:(int64_t)totalBytesExpectedToWrite {
    CGFloat progress = 1.0 * totalBytesWritten / totalBytesExpectedToWrite;
    NSLog(@"%f", progress);
}

// 2. 下載完成時調用
- (void)URLSession:(NSURLSession *)session
      downloadTask:(NSURLSessionDownloadTask *)downloadTask
didFinishDownloadingToURL:(NSURL *)location {
    // location 同樣是臨時路徑,需要自己移動到 Caches
    NSString *filePath = [[NSSearchPathForDirectoriesInDomains(NSCachesDirectory, NSUserDomainMask, YES) lastObject]
                          stringByAppendingPathComponent:downloadTask.response.suggestedFilename];
    [[NSFileManager defaultManager] moveItemAtURL:location
                                             toURL:[NSURL fileURLWithPath:filePath]
                                             error:nil];
}

// 3. 請求結束(成功時 error 為 nil)
- (void)URLSession:(NSURLSession *)session
              task:(NSURLSessionTask *)task
didCompleteWithError:(NSError *)error {
    if (error == nil) {
        // 成功處理
    } else {
        NSLog(@"請求失敗:%@", error);
    }
}

五、NSURLSessionUploadTask:文件上傳

上傳有兩種形式。從文件上傳:

NSURLSessionUploadTask *task =
    [[NSURLSession sharedSession] uploadTaskWithRequest:request
                                               fromFile:fileName
                                      completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
    }];

從二進制數據上傳(POST 方式):

[[NSURLSession sharedSession] uploadTaskWithRequest:request
                                           fromData:body
                                  completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
    NSLog(@"-------%@", [NSJSONSerialization JSONObjectWithData:data options:kNilOptions error:nil]);
}];

差別在於:POST 方式需要構造請求體 body。實際開發中上傳一般走 POST,更可控也更安全。

小結

NSURLSession 的用法遠不止這些,比如可配置的 NSURLSessionConfiguration(超時、緩存策略、允許 Cellular 訪問)、後台 session 的完成通知機制等,都需要在日常開發中慢慢積累。AFNetworking 2.0 之後正是基於 NSURLSession 做了封裝,感興趣的讀者可以去 GitHub 上對照源碼閱讀。

本文作者:伯樂在線 - 啊左~

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