寫此文時(shí)突發(fā)靈感作詩一首, 而后置頂, 歡迎品鑒.
有的程序員老了,還沒聽過NSURLSession
有的程序員還嫩,沒用過NSURLConnection
有的程序員很單純,他只知道AFN.
NSURLConnection在iOS9被宣布棄用,NSURLSession從13年發(fā)展到現(xiàn)在,終于迎來了它獨(dú)步江湖的時(shí)代.NSURLSession是蘋果在iOS7后為HTTP數(shù)據(jù)傳輸提供的一系列接口,比NSURLConnection強(qiáng)大,坑少,好用.今天從使用的角度介紹下.
除了NSURLSession,文中還會(huì)頻繁地出現(xiàn)NSURLSessionConfiguration和NSURLSessionTask兩個(gè)類.先認(rèn)識(shí)一下,混個(gè)臉熟吧.
使用NSURLSession,攏共分兩步:
- 第一步 通過NSURLSession的實(shí)例創(chuàng)建task
- 第二部 執(zhí)行task
既然兩步里面都出現(xiàn)了task,就先說說它吧.
NSURLSessionTask可以簡(jiǎn)單理解為任務(wù):如數(shù)據(jù)請(qǐng)求任務(wù),下載任務(wù),上傳任務(wù)and so on.我們使用的是他的子類們:
- NSURLSessionTask(抽象類)
- NSURLSessionDataTask
- NSURLSessionUploadTask
- NSURLSessionDownloadTask
- NSURLSessionDataTask
從這幾個(gè)子類的名字就可以大概猜出他們的作用了.接下來我們就從不同類型的任務(wù)出發(fā),來使用session.
NSURLSessionDataTask
字面上看是和數(shù)據(jù)相關(guān)的任務(wù),但其實(shí)dataTask完全可以勝任downloadTask和uploadTask的工作.這可能也是我們使用最多的task種類.
簡(jiǎn)單GET請(qǐng)求
如果請(qǐng)求的數(shù)據(jù)比較簡(jiǎn)單,也不需要對(duì)返回的數(shù)據(jù)做一些復(fù)雜的操作.那么我們可以使用帶block
// 快捷方式獲得session對(duì)象
NSURLSession *session = [NSURLSession sharedSession];
NSURL *url = [NSURL URLWithString:@"http://www.daka.com/login?username=daka&pwd=123"];
// 通過URL初始化task,在block內(nèi)部可以直接對(duì)返回的數(shù)據(jù)進(jìn)行處理
NSURLSessionTask *task = [session dataTaskWithURL:url
completionHandler:^(NSData *data, NSURLResponse *response, NSError error) {
NSLog(@"%@", [NSJSONSerialization JSONObjectWithData:data options:kNilOptions error:nil]);
}];
// 啟動(dòng)任務(wù)
[task resume];
Tips:
- 所有類型的task都要調(diào)用resume方法才會(huì)開始進(jìn)行請(qǐng)求.
簡(jiǎn)單POST請(qǐng)求
POST和GET的區(qū)別就在于request,所以使用session的POST請(qǐng)求和GET過程是一樣的,區(qū)別就在于對(duì)request的處理.
NSURL *url = [NSURL URLWithString:@"http://www.daka.com/login"];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:url];
request.HTTPMethod = @"POST";
request.HTTPBody = [@"username=daka&pwd=123" dataUsingEncoding:NSUTF8StringEncoding];
NSURLSession *session = [NSURLSession sharedSession];
// 由于要先對(duì)request先行處理,我們通過request初始化task
NSURLSessionTask *task = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) { NSLog(@"%@", [NSJSONSerialization JSONObjectWithData:data options:kNilOptions error:nil]); }];
[task resume];
NSURLSessionDataDelegate代理方法
NSURLSession提供了block方式處理返回?cái)?shù)據(jù)的簡(jiǎn)便方式,但如果想要在接收數(shù)據(jù)過程中做進(jìn)一步的處理,仍然可以調(diào)用相關(guān)的協(xié)議方法.NSURLSession的代理方法和NSURLConnection有些類似,都是分為接收響應(yīng)府蛇、接收數(shù)據(jù)两入、請(qǐng)求完成幾個(gè)階段.
// 使用代理方法需要設(shè)置代理,但是session的delegate屬性是只讀的,要想設(shè)置代理只能通過這種方式創(chuàng)建session
NSURLSession *session = [NSURLSession sessionWithConfiguration:[NSURLSessionConfiguration defaultSessionConfiguration]
delegate:self
delegateQueue:[[NSOperationQueue alloc] init]];
// 創(chuàng)建任務(wù)(因?yàn)橐褂么矸椒?就不需要block方式的初始化了)
NSURLSessionDataTask *task = [session dataTaskWithRequest:[NSURLRequest requestWithURL:[NSURL URLWithString:@"http://www.daka.com/login?userName=daka&pwd=123"]]];
// 啟動(dòng)任務(wù)
[task resume];
//對(duì)應(yīng)的代理方法如下:
// 1.接收到服務(wù)器的響應(yīng)
- (void)URLSession:(NSURLSession *)session dataTask:(NSURLSessionDataTask *)dataTask didReceiveResponse:(NSURLResponse *)response completionHandler:(void (^)(NSURLSessionResponseDisposition))completionHandler {
// 允許處理服務(wù)器的響應(yīng)，才會(huì)繼續(xù)接收服務(wù)器返回的數(shù)據(jù)
completionHandler(NSURLSessionResponseAllow);
}
// 2.接收到服務(wù)器的數(shù)據(jù)（可能調(diào)用多次）
- (void)URLSession:(NSURLSession *)session dataTask:(NSURLSessionDataTask *)dataTask didReceiveData:(NSData *)data {
// 處理每次接收的數(shù)據(jù)
}
// 3.請(qǐng)求成功或者失敻然（如果失敗，error有值）
- (void)URLSession:(NSURLSession *)session task:(NSURLSessionTask *)task didCompleteWithError:(NSError *)error {
// 請(qǐng)求完成,成功或者失敗的處理
}
Tips:
關(guān)鍵點(diǎn)在代碼注釋里面都有提及,重要的地方再強(qiáng)調(diào)一下:
- 如果要使用代理方法,需要設(shè)置代理,但從NSURLSession的頭文件發(fā)現(xiàn)session的delegate屬性是只讀的.因此設(shè)置代理要通過session的初始化方法賦值:
sessionWithConfiguration:delegate:delegateQueue:其中:- configuration參數(shù)(文章開始提到的)需要傳遞一個(gè)配置,我們暫且使用默認(rèn)的配置
[NSURLSessionConfiguration defaultSessionConfiguration]就好(后面會(huì)說下這個(gè)配置是干嘛用的); - delegateQueue參數(shù)表示協(xié)議方法將會(huì)在哪個(gè)隊(duì)列(NSOperationQueue)里面執(zhí)行.
- configuration參數(shù)(文章開始提到的)需要傳遞一個(gè)配置,我們暫且使用默認(rèn)的配置
- NSURLSession在接收到響應(yīng)的時(shí)候要先對(duì)響應(yīng)做允許處理:
completionHandler(NSURLSessionResponseAllow);,才會(huì)繼續(xù)接收服務(wù)器返回的數(shù)據(jù),進(jìn)入后面的代理方法.值得一提的是,如果在接收響應(yīng)的時(shí)候需要對(duì)返回的參數(shù)進(jìn)行處理(如獲取響應(yīng)頭信息等),那么這些處理應(yīng)該放在前面允許操作的前面.
NSURLSessionDownloadTask
文件下載可以使用NSURLSessionDownloadTask這個(gè)子類.
簡(jiǎn)單下載
NSURLSessionDownloadTask同樣提供了通過NSURL和NSURLRequest兩種方式來初始化并通過block進(jìn)行回調(diào)的方法.下面以NSURL初始化為例:
SURLSession *session = [NSURLSession sharedSession];
NSURL *url = [NSURL URLWithString:@"http://www.daka.com/resources/image/icon.png"] ;
NSURLSessionDownloadTask *task = [session downloadTaskWithURL:url completionHandler:^(NSURL *location, NSURLResponse *response, NSError *error) {
// location是沙盒中tmp文件夾下的一個(gè)臨時(shí)url,文件下載后會(huì)存到這個(gè)位置,由于tmp中的文件隨時(shí)可能被刪除,所以我們需要自己需要把下載的文件挪到需要的地方
NSString *path = [[NSSearchPathForDirectoriesInDomains(NSCachesDirectory, NSUserDomainMask, YES) lastObject] stringByAppendingPathComponent:response.suggestedFilename];
// 剪切文件
[[NSFileManager defaultManager] moveItemAtURL:location toURL:[NSURL fileURLWithPath:path] error:nil];
}];
// 啟動(dòng)任務(wù)
[task resume];
Tips:
- 需要注意的就是需要將下載到tmp文件夾的文件轉(zhuǎn)移到需要的目錄.原因在代碼中已經(jīng)貼出.
-
response.suggestedFilename是從相應(yīng)中取出文件在服務(wù)器上存儲(chǔ)路徑的最后部分,如數(shù)據(jù)在服務(wù)器的url為http://www.daka.com/resources/image/icon.png, 那么其suggestedFilename就是icon.png.
NSURLSessionDownloadDelegate代理方法
同樣的,downloadTask也提供了配套的代理方法
// 每次寫入調(diào)用(會(huì)調(diào)用多次)
- (void)URLSession:(NSURLSession *)session downloadTask:(NSURLSessionDownloadTask *)downloadTask didWriteData:(int64_t)bytesWritten totalBytesWritten:(int64_t)totalBytesWritten totalBytesExpectedToWrite:(int64_t)totalBytesExpectedToWrite {
// 可在這里通過已寫入的長度和總長度算出下載進(jìn)度
CGFloat progress = 1.0 * totalBytesWritten / totalBytesExpectedToWrite; NSLog(@"%f",progress);
}
// 下載完成調(diào)用
- (void)URLSession:(NSURLSession *)session
downloadTask:(NSURLSessionDownloadTask *)downloadTask
didFinishDownloadingToURL:(NSURL *)location {
// location還是一個(gè)臨時(shí)路徑,需要自己挪到需要的路徑(caches下面)
NSString *filePath = [[NSSearchPathForDirectoriesInDomains(NSCachesDirectory, NSUserDomainMask, YES) lastObject] stringByAppendingPathComponent:downloadTask.response.suggestedFilename];
[[NSFileManager defaultManager] moveItemAtURL:location toURL:[NSURL fileURLWithPath:filePath] error:nil];
}
// 任務(wù)完成調(diào)用
- (void)URLSession:(NSURLSession *)session task:(NSURLSessionTask *)task didCompleteWithError:(NSError *)error {
}
NSURLSessionUploadTask
在NSURLSession中,文件上傳方式主要有以下兩種:
NSURLSessionUploadTask *task =
[[NSURLSession sharedSession] uploadTaskWithRequest:request
fromFile:fileName
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
}];
和
[self.session uploadTaskWithRequest:request
fromData:body
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
NSLog(@"-------%@", [NSJSONSerialization JSONObjectWithData:data options:kNilOptions error:nil]);
}];
處于安全性考慮,通常我們會(huì)使用POST方式進(jìn)行文件上傳,所以較多使用第二種方式.
但是,NSURLSession并沒有為我們提供比NSURLConnection更方便的文件上傳方式.方法中body處的參數(shù)需要填寫request的請(qǐng)求體(http協(xié)議規(guī)定格式的大長串).因?yàn)槟阌?0%的可能性用了AFNetworking,即使是自己寫的應(yīng)該也是copy,所以代碼就不貼了我們只說方法呵呵噠.
斷點(diǎn)下載
NSURLSessionDownloadTask提供了與斷點(diǎn)下載相關(guān)的幾個(gè)方法:
// 使用這種方式取消下載可以得到將來用來恢復(fù)的數(shù)據(jù),保存起來
[self.task cancelByProducingResumeData:^(NSData *resumeData) {
self.resumeData = resumeData;
}];
// 由于下載失敗導(dǎo)致的下載中斷會(huì)進(jìn)入此協(xié)議方法,也可以得到用來恢復(fù)的數(shù)據(jù)
- (void)URLSession:(NSURLSession *)session task:(NSURLSessionTask *)task didCompleteWithError:(NSError *)error
{
// 保存恢復(fù)數(shù)據(jù)
self.resumeData = error.userInfo[NSURLSessionDownloadTaskResumeData];
}
// 恢復(fù)下載時(shí)接過保存的恢復(fù)數(shù)據(jù)
self.task = [self.session downloadTaskWithResumeData:self.resumeData];
// 啟動(dòng)任務(wù)
[self.task resume];
以目前我對(duì)NSURLSession的理解這種斷點(diǎn)下載只支持應(yīng)用內(nèi)斷點(diǎn),如果程序在下載過程中途關(guān)閉,則不能恢復(fù)下載.(暫時(shí)對(duì)NSURLSession理解還不全面,不敢妄下斷論,如有不妥簡(jiǎn)友們可以溝通下)
其他
此外,task們自身有都擁有下面幾個(gè)方法
- (void)suspend;
- (void)resume;
- (void)cancel;
suspend可以讓當(dāng)前的任務(wù)暫停
resume方法不僅可以啟動(dòng)任務(wù),還可以喚醒suspend狀態(tài)的任務(wù)
cancel方法可以取消當(dāng)前的任務(wù),你也可以向處于suspend狀態(tài)的任務(wù)發(fā)送cancel消息,任務(wù)如果被取消便不能再恢復(fù)到之前的狀態(tài).
NSURLSessionConfiguration
簡(jiǎn)單地說,就是session的配置信息.如:
NSURLSessionConfiguration *config = [NSURLSessionConfiguration defaultSessionConfiguration];
// 超時(shí)時(shí)間
config.timeoutIntervalForRequest = 10;
// 是否允許使用蜂窩網(wǎng)絡(luò)(后臺(tái)傳輸不適用)
config.allowsCellularAccess = YES;
// 還有很多可以設(shè)置的屬性
有沒有發(fā)現(xiàn)我們使用的Configuration都是默認(rèn)配置:[NSURLSessionConfiguration defaultSessionConfiguration],其實(shí)它的配置有三種類型:
+ (NSURLSessionConfiguration *)defaultSessionConfiguration;
+ (NSURLSessionConfiguration *)ephemeralSessionConfiguration;
+ (NSURLSessionConfiguration *)backgroundSessionConfigurationWithIdentifier:(NSString *)identifier
表示了NSURLSession幾種不同的工作模式.
默認(rèn)的配置會(huì)將緩存存儲(chǔ)在磁盤上,第二種瞬時(shí)會(huì)話模式不會(huì)創(chuàng)建持久性存儲(chǔ)的緩存,第三種后臺(tái)會(huì)話模式允許程序在后臺(tái)進(jìn)行上傳下載工作.
除了支持任務(wù)的暫停和斷點(diǎn)續(xù)傳,我覺得NSURLSession之于NSURLConnection的最偉大的進(jìn)步就是支持后臺(tái)上傳下載任務(wù),這又是一個(gè)可以深入討論的話題.但在這方面我還沒有進(jìn)行深入的研究,待后續(xù)了解之后另行開貼.
PS:AFNetWorking從2.0版本就有了基于NSURLSession的系列封裝,感興趣的童鞋自行前往了解.
