簡括
?? NSURLSession是2013年iOS 7發布的用于替代NSURLConnection的,iOS 9之后NSURLConnection徹底推出歷史舞臺。
NSURLSession一般分別兩部操作:
?? 第一步:通過NSURLSession的實例創建task;
?? 第二步:執行task;
對于NSURLSessionTask,也就是task,可以把它當作所謂的任務。
?? NSURLSessionTask是一個抽象子類,它有三個具體的子類是可以直接使用分別是:NSURLSessionDataTask
,NSURLSessionUploadTask
和NSURLSessionDownloadTask
。這三個類應用的三個基本網絡任務分別是:獲取數據、上傳文件、下載文件。與數據有關的NSURLSessionDataTask也可以勝任上傳下載的任務,所以經常使用到。
Request 請求對象
1)首先構造一個NSURL請求資源地址
// 構造URL資源地址
NSURL *url = [NSURL URLWithString:@"http://api.nohttp.net/method?name=yanzhenjie&pwd=123"];
2)創建一個NSRequest請求對象
// 創建Request請求
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:url];
// 配置Request請求
// 設置請求方法
[request setHTTPMethod:@"GET"];
// 設置請求超時 默認超時時間60s
[request setTimeoutInterval:10.0];
// 設置頭部參數
[request addValue:@"gzip" forHTTPHeaderField:@"Content-Encoding"];
//或者下面這種方式 添加所有請求頭信息
request.allHTTPHeaderFields=@{@"Content-Encoding":@"gzip"};
//設置緩存策略
[request setCachePolicy:NSURLRequestReloadIgnoringLocalCacheData];
根據需求添加不用的設置,比如請求方式、超時時間、請求頭信息,這里重點介紹下緩存策略:
NSURLRequestUseProtocolCachePolicy = 0
//默認的緩存策略, 如果緩存不存在,直接從服務端獲取。如果緩存存在,會根據response中的Cache-Control字段判斷下一步操作,如: Cache-Control字段為must-revalidata, 則詢問服務端該數據是否有更新,無更新的話直接返回給用戶緩存數據,若已更新,則請求服務端.
NSURLRequestReloadIgnoringLocalCacheData = 1
//忽略本地緩存數據,直接請求服務端.
NSURLRequestIgnoringLocalAndRemoteCacheData = 4
//忽略本地緩存,代理服務器以及其他中介,直接請求源服務端.
NSURLRequestReloadIgnoringCacheData = NSURLRequestReloadIgnoringLocalCacheData
NSURLRequestReturnCacheDataElseLoad = 2
//有緩存就使用,不管其有效性(即忽略Cache-Control字段), 無則請求服務端.
NSURLRequestReturnCacheDataDontLoad = 3
//只加載本地緩存. 沒有就失敗. (確定當前無網絡時使用)
NSURLRequestReloadRevalidatingCacheData = 5
//緩存數據必須得得到服務端確認有效才使用
創建會話對象方式
第一種方式
// 采用蘋果提供的共享session
NSURLSession *sharedSession = [NSURLSession sharedSession];
第二種方式
#通過NSURLSessionConfiguration方式配置不同的NSURLSession
// 構造NSURLSessionConfiguration
NSURLSessionConfiguration *configuration = [NSURLSessionConfiguration defaultSessionConfiguration];
// 構造NSURLSession,網絡會話;
NSURLSession *session = [NSURLSession sessionWithConfiguration:configuration];
通過NSURLSessionConfiguration提供了三種創建NSURLSession的方式
defaultSessionConfiguration
//默認配置使用的是持久化的硬盤緩存,存儲證書到用戶鑰匙鏈。存儲cookie到shareCookie。
ephemeralSessionConfiguration
//不使用永久持存cookie、證書、緩存的配置,最佳優化數據傳輸。
backgroundSessionConfigurationWithIdentifier
//可以上傳下載HTTP和HTTPS的后臺任務(程序在后臺運行)。在后臺時,將網絡傳輸交給系統的單獨的一個進程,即使app掛起、推出甚至崩潰照樣在后臺執行。
可以通過NSURLSessionConfiguration統一設置超時時間、請求頭等信息
// 構造NSURLSessionConfiguration
NSURLSessionConfiguration *configuration = [NSURLSessionConfiguration defaultSessionConfiguration];
//設置請求超時為10秒鐘
configuration.timeoutIntervalForRequest = 10;
//在蜂窩網絡情況下是否繼續請求(上傳或下載)
configuration.allowsCellularAccess = NO;
//配置請求頭
configuration.HTTPAdditionalHeaders =@{@"Content-Encoding":@"gzip"};
Get請求
// 1.創建一個網絡路徑
NSURL *url = [NSURL URLWithString:[NSString stringWithFormat:@"http://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(@"從服務器獲取到數據");
/*
對從服務器獲取到的數據data進行相應的處理:
*/
//請求失敗,打印錯誤信息
if (error) {
NSLog(@"get error :%@",error.localizedDescription);
}else {
// JSON數據格式解析
NSDictionary *object = [NSJSONSerialization JSONObjectWithData:data options:NSJSONReadingMutableLeaves error:&error];
// 判斷是否解析成功
if (error) {
NSLog(@"get error :%@",error.localizedDescription);
}else {
NSLog(@"get success :%@",object);
// 解析成功,處理數據,通過GCD獲取主隊列,在主線程中刷新界面。
dispatch_async(dispatch_get_main_queue(), ^{
// 刷新界面....
});
}
}
}];
// 5.最后一步,執行任務(resume也是繼續執行):
[sessionDataTask resume];
Post 請求
// 1.創建一個網絡路徑
NSURL *url = [NSURL URLWithString:[NSString stringWithFormat:@"http://172.16.2.254/php/phonelogin"]];
// 2.創建一個網絡請求,分別設置請求方法、請求參數
NSMutableURLRequest *request =[NSMutableURLRequest requestWithURL:url];
request.HTTPMethod = @"POST";
//設置請求超時
[request setTimeoutInterval:10.0f]
// 設置頭部參數
[request addValue:@"gzip" forHTTPHeaderField:@"Content-Encoding"];
NSString *args = [NSString stringWithFormat:@"yourname=%@&yourpass=%@&btn=login",yourname,yourpass];
//NSString轉成NSData數據類型。
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(@"從服務器獲取到數據");
/*
對從服務器獲取到的數據data進行相應的處理.
*/
NSDictionary *dict = [NSJSONSerialization JSONObjectWithData:data options:(NSJSONReadingMutableLeaves) error:nil];
}];
//5.最后一步,執行任務,(resume也是繼續執行)。
[sessionDataTask resume];
NSURLSessionDataDelegate代理方法
?? 相比NSURLConnection,NSURLSession提供了block方式處理返回數據的簡便方式,但是,如果項目需要在網絡請求數據的過程中,要做進一步的處理的話,需要調用NSURLSession的代理方法。
?? 通常,使用代理方法需要先設置代理對象,但是通過查看NSURLSessionDataDelegate文檔,我們可以看到如下,代理屬性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:@"http://172.16.2.254/php/phonelogin?yourname=%@&yourpass=%@&btn=login",yourname,yourpass]];
NSURLSessionDataTask *task = [session dataTaskWithRequest:[NSURLRequest requestWithURL:url]];
// 3.執行任務
[task resume];
代理方法
#pragma mark -- NSURLSessionDataDelegate
// 1.接收到服務器的響應
- (void)URLSession:(NSURLSession *)session dataTask:(NSURLSessionDataTask *)dataTask didReceiveResponse:(NSURLResponse *)response completionHandler:(void (^)(NSURLSessionResponseDisposition))completionHandler {
//此處需要允許處理服務器的響應,才會繼續加載服務器的數據。 若在接收響應時需要對返回的參數進行處理(如獲取響應頭信息等),那么這些處理應該放在這個允許操作的前面
completionHandler(NSURLSessionResponseAllow);
}
// 2.接收到服務器的數據(此方法在接收數據過程會多次調用)
- (void)URLSession:(NSURLSession *)session dataTask:(NSURLSessionDataTask *)dataTask didReceiveData:(NSData *)data {
// 處理每次接收的數據,例如每次拼接到自己創建的數據receiveData
[self.receiveData appendData:data];
}
// 3.3.任務完成時調用(如果成功,error == nil)
- (void)URLSession:(NSURLSession *)session task:(NSURLSessionTask *)task didCompleteWithError:(NSError *)error {
if(error == nil){
/*
請求完成,成功或者失敗的處理
*/
}else{
NSLog(@"請求失敗:%@",error);
}
}
NSURLSessionDownloadTask 文件下載
// 1.創建網路路徑
NSURL *url = [NSURL URLWithString:@"http://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) {
/*
a.location是沙盒中tmp文件夾下的一個臨時url,文件下載后會存到這個位置,由于tmp中的文件隨時可能被刪除,所以我們需要自己需要把下載的文件移動到其他地方:pathUrl.
b.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 上傳文件
Get 方法
NSURLSessionUploadTask *task = [NSURLSession sharedSession] uploadTaskWithRequest:request fromFile:fileName completionHandler:^(NSData * _Nullable data, NSURLResponse * _Nullable response, NSError * _Nullable error) {
//數據處理
};
Post 方法
[[NSURLSession sharedSession] uploadTaskWithRequest:request fromData:body completionHandler:^(NSData * _Nullable data, NSURLResponse * _Nullable response, NSError * _Nullable error) {
NSLog(@"-------%@", [NSJSONSerialization JSONObjectWithData:data options:kNilOptions error:nil]);
}];
?? 對于Get和Post的不同點在于,用post方法需要添加網絡路徑的請求體body,而在實際開發中,上傳文件一般使用post方式,更加安全可靠。
參考資料: