NSURLSessionTask

作者: 翻这个墙 | 来源:发表于2017-11-17 11:39 被阅读42次

    1. NSURLSessionTask介绍

    • 继承自NSObject

    1.1 NSURLSessionTask常见方法

    // 取消
    - (void)cancel;
    
    // 暂停
    - (void)suspend;
    
    // 开始
    - (void)resume;
    

    1.2 NSURLSessionTask的子类

    • NSURLSessionDataTask
    • NSURLSessionUploadTask
    • NSURLSessionDownloadTask

    2. NSURLSessionDataTask

    • 父类是NSURLSessionTask
    • 可实现所有下载方法

    2.1 NSURLSessionDataTask发送网络请求

    2.1.1 NSURLSessionDataTask-block发送网络请求(推荐)

    (1)发送get、post请求

    
        //1.设置请求路径
        NSURL *url = [NSURL URLWithString:@"http://120.25.226.186:32812/login?username=ss&pwd=ss&type=JSON"];
    
        //2.根据路径设置请求对象-get请求
        NSURLRequest *request = [NSURLRequest requestWithURL:url];
    
    /*
    //创建一个请求对象,这是请求方法为POST,把参数放在请求体中传递
        NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:url];
        request.HTTPMethod = @"POST";
        request.HTTPBody = [@"username=520it&pwd=520it&type=JSON" dataUsingEncoding:NSUTF8StringEncoding];
    */
    
        //3..创建NSURLSession对象(可以获取单例对象)
        NSURLSession *session = [NSURLSession sharedSession];
    
        //4..根据NSURLSession对象创建一个Task
    
        //方法参数说明
        /*
        注意:该block是在子线程中调用的,如果拿到数据之后要做一些UI刷新操作,那么需要回到主线程刷新
        第一个参数:需要发送的请求对象
        block:当请求结束拿到服务器响应的数据时调用block
        block-NSData:该请求的响应体
        block-NSURLResponse:存放本次请求的响应信息,响应头,真实类型为NSHTTPURLResponse
        block-NSErroe:请求错误信息
         */
       NSURLSessionDataTask * dataTask =  [session dataTaskWithRequest:request completionHandler:^(NSData * __nullable data, NSURLResponse * __nullable response, NSError * __nullable error) {
    
            //拿到响应头信息
            NSHTTPURLResponse *res = (NSHTTPURLResponse *)response;
    
            //6.解析拿到的响应数据
            NSLog(@"%@\n%@",[[NSString alloc]initWithData:data encoding:NSUTF8StringEncoding],res.allHeaderFields);
        }];
    
        //5..执行Task
        //注意:刚创建出来的task默认是挂起状态的,需要调用该方法来启动任务(执行任务)
        [dataTask resume];
    

    (2)发送get请求的第二种方式

      //注意:该方法内部默认会把URL对象包装成一个NSURLRequest对象(默认是GET请求)
        //方法参数说明
        /*
        //第一个参数:发送请求的URL地址
        //block:当请求结束拿到服务器响应的数据时调用block
        //block-NSData:该请求的响应体
        //block-NSURLResponse:存放本次请求的响应信息,响应头,真实类型为NSHTTPURLResponse
        //block-NSErroe:请求错误信息
         */
    - (nullable NSURLSessionDataTask *)dataTaskWithURL:(NSURL *)url completionHandler:(void (^)(NSData * __nullable data, NSURLResponse * __nullable response, NSError * __nullable error))completionHandler;
    
    2.1.2 NSURLSessionDataTask-delegate(代理)发送网络请求
    
    (1)发送请求,通过代理监听
    -(void)touchesBegan:(NSSet<UITouch *> *)touches withEvent:(UIEvent *)event
    {
        //1.创建session,并设置代理
        /*
         第一个参数:session对象的全局配置设置,一般使用默认配置就可以
         第二个参数:谁成为session对象的代理
         第三个参数:代理方法在哪个队列中执行(在哪个线程中调用),如果是主队列那么在主线程中执行,如果是非主队列,那么在子线程中执行
         */
        NSURLSession *session = [NSURLSession sessionWithConfiguration:[NSURLSessionConfiguration defaultSessionConfiguration] delegate:self delegateQueue:[[NSOperationQueue alloc]init]];
    
        //2.创建task,通过url创建的task是get请求
        NSURLRequest *request = [NSURLRequest requestWithURL:[NSURL URLWithString:@"http://120.25.226.186:32812/resources/images/minion_02.png"]];
    
    /* 通过NSMutableURLRequest创建task可发送post请求;
        //2.创建请求对象
        NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:url];
    
        //2.1更改请求方法
        request.HTTPMethod = @"POST";
    
        //2.2设置请求体
        request.HTTPBody = [@"username=520it&pwd=520it" dataUsingEncoding:NSUTF8StringEncoding];
    
        //2.3请求超时
        request.timeoutInterval = 5;
    
        //2.4设置请求头
        [request setValue:@"ios 9.0" forHTTPHeaderField:@"User-Agent"];
    */
    
        //3.使用什么task,需要遵守对应的协议,dataTask需要遵守<NSURLSessionDataDelegate>
        NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request];
    
        //4.启动task
        [dataTask resume];
    }
    
    
    (2)实现代理方法,监听请求
    #pragma mark -----------------
    #pragma mark NSURLSessionDataDelegate
    /*
     1.当接收到服务器响应的时候调用
         session:发送请求的session对象
         dataTask:根据NSURLSession创建的task任务
         response:服务器响应信息(响应头)
         completionHandler:通过该block回调,告诉服务器端是否接收返回的数据
     */
    -(void)URLSession:(NSURLSession *)session dataTask:(NSURLSessionDataTask *)dataTask didReceiveResponse:(NSURLResponse *)response completionHandler:(void (^)(NSURLSessionResponseDisposition))completionHandler
    {
        self.fileData = [NSMutableData data];
        NSLog(@"didReceiveResponse");
    
        //默认情况下,当接收到服务器响应之后,服务器认为客户端不需要接收数据,所以后面的代理方法不会调用
        //如果需要继续接收服务器返回的数据,那么需要调用block,并传入对应的策略
    
        /*
            NSURLSessionResponseCancel = 0, 取消任务
            NSURLSessionResponseAllow = 1,  接收任务
            NSURLSessionResponseBecomeDownload = 2, 转变成下载
            NSURLSessionResponseBecomeStream NS_ENUM_AVAILABLE(10_11, 9_0) = 3, 转变成流
        */
    
        completionHandler(NSURLSessionResponseAllow);
    
    }
    
    /*2.当接收到服务器返回的数据的时候调用,可能被调用多次*/
    -(void)URLSession:(NSURLSession *)session dataTask:(NSURLSessionDataTask *)dataTask didReceiveData:(NSData *)data
    {
        [self.fileData appendData:data];
    
        NSLog(@"didReceiveData");
    }
    /*
     3.当请求完成之后调用该方法
     不论是请求成功还是请求失败都调用该方法,如果请求失败,那么error对象有值,否则那么error对象为空
     */
    -(void)URLSession:(NSURLSession *)session task:(NSURLSessionTask *)task didCompleteWithError:(NSError *)error
    {
        NSLog(@"didCompleteWithError");
    
        [[NSOperationQueue mainQueue]addOperationWithBlock:^{
            //刷新
            UIImage *image = [UIImage imageWithData:self.fileData];
            self.imageView.image = image;
        }];
    
    }
    
    
    (3)执行任务(其它方法,如暂停、取消等)
    
        //启动task
        //[dataTask resume];
        //其它方法,如取消任务,暂停任务等
        //[dataTask cancel];
        //[dataTask suspend];
    

    3. NSURLSessionUploadTask子类

    3.1 NSURLSessionUploadTask

    • 父类是NSURLSessionDataTask

    (1)实现文件上传的方法

          /*
         第一个参数:请求对象
         第二个参数:请求体(要上传的文件数据)
         block回调:
         NSData:响应体
         NSURLResponse:响应头
         NSError:请求的错误信息
         */
        NSURLSessionUploadTask *uploadTask =  [session uploadTaskWithRequest:request fromData:data completionHandler:^(NSData * __nullable data, NSURLResponse * __nullable response, NSError * __nullable error)
    

    (2)设置代理,在代理方法中监听文件上传进度

    /*
     调用该方法上传文件数据
     如果文件数据很大,那么该方法会被调用多次
     参数说明:
         totalBytesSent:已经上传的文件数据的大小
         totalBytesExpectedToSend:文件的总大小
     */
    -(void)URLSession:(nonnull NSURLSession *)session task:(nonnull NSURLSessionTask *)task didSendBodyData:(int64_t)bytesSent totalBytesSent:(int64_t)totalBytesSent totalBytesExpectedToSend:(int64_t)totalBytesExpectedToSend
    {
        NSLog(@"%.2f",1.0 * totalBytesSent/totalBytesExpectedToSend);
    }
    

    3.2 NSURLSessionDownloadTask

    • 父类是NSURLSessionTask
    • 内部已实现边下载边写入文件,所以不用担心内存
    • 文件下载后默认保存在tmp文件目录,需要开发人员手动的剪切到合适的沙盒目录
    • 可实现断点下载,无法实现离线断点下载
    • 除离线断点下载及小文件下载外,是最优的下载的类

    3.2.1 NSURLSessionDownloadTask-block发送网络请求

    1. downloadTask内部默认已经实现了变下载边写入操作,所以不用开发人员担心内存问题
    • 文件下载后默认保存在tmp文件目录,需要开发人员手动的剪切到合适的沙盒目录
    • 缺点:没有办法监控下载进度
    3.2.1.1 NSURLSessionDownloadTask-downloadTaskWithRequest方式
    //1.创建session
        NSURLSession *session = [NSURLSession sharedSession];
    
        //2.创建task
        NSURLRequest *request = [NSURLRequest requestWithURL:[NSURL URLWithString:@"http://120.25.226.186:32812/resources/images/minion_03.png"]];
    
        /*
         completionHandler:
            request:请求体
            response:响应头信息
            location:url,下载文件的临时保存路径,内部默认已经实现了变下载边写入沙盒的操作
            error:该请求的错误信息
         */
        NSURLSessionDownloadTask *downloadTask =[session downloadTaskWithRequest:request completionHandler:^(NSURL * _Nullable location, NSURLResponse * _Nullable response, NSError * _Nullable error) {
    
            NSLog(@"%@",location);
    
            NSString *caches = [NSSearchPathForDirectoriesInDomains(NSCachesDirectory, NSUserDomainMask, YES) lastObject];
            NSString *fullpath = [caches stringByAppendingPathComponent:response.suggestedFilename];
    
            //剪切操作
            NSFileManager *manager = [NSFileManager defaultManager];
            /*
             第一个参数:要剪切的文件的url
             第二个参数:要剪切到什么地方去
             */
            [manager moveItemAtURL:location toURL:[NSURL fileURLWithPath:fullpath] error:nil];
    
            NSLog(@"%@",fullpath);
        }];
    
        //3.启动任务
        [downloadTask resume];
    
    3.2.1.2 NSURLSessionDownloadTask-downloadTaskWithURL方式
     /*
         第一个参数:要下载文件的url路径
         第二个参数:当接收完服务器返回的数据之后调用该block
         location:下载的文件的保存地址(默认是存储在沙盒中tmp文件夹下面,随时会被删除)
         response:服务器响应信息,响应头
         error:该请求的错误信息
         */
        //说明:downloadTaskWithURL方法已经实现了在下载文件数据的过程中边下载文件数据,边写入到沙盒文件的操作
        NSURLSessionDownloadTask *downloadTask = [session downloadTaskWithURL:url completionHandler:^(NSURL * __nullable location, NSURLResponse * __nullable response, NSError * __nullable error)
    

    3.2.2 NSURLSessionDownloadTask-delegate(代理)发送网络请求

    1. 内部已实现边下载边写入文件,所以不用担心内存
    • 文件下载后默认保存在tmp文件目录,需要开发人员手动的剪切到合适的沙盒目录
    • 可实现断点下载,无法实现离线断点下载
    • 除离线断点下载及小文件下载外,是最优的下载的类
    -(void)touchesBegan:(NSSet<UITouch *> *)touches withEvent:(UIEvent *)event
    {
        //1.创建session
        NSURLSession *session = [NSURLSession sessionWithConfiguration:[NSURLSessionConfiguration defaultSessionConfiguration] delegate:self delegateQueue:[NSOperationQueue mainQueue]];
    
        //2.创建task
        NSURLSessionDownloadTask *downloadTask =  [session downloadTaskWithURL:[NSURL URLWithString:@"http://120.25.226.186:32812/resources/videos/minion_02.mp4"]];
    
        //3.启动task
        [downloadTask resume];
    }
    
    #pragma mark --------------
    #pragma mark NSURLSessionDownloadDelegate
    
    /*当接收到服务器返回的数据的时候调用,该方法用来写数据
     bytesWritten:本次写入数据的大小
     totalBytesWritten:已经写入到沙盒中的数据的大小
     totalBytesExpectedToWrite:文件的总大小
     */
    -(void)URLSession:(NSURLSession *)session downloadTask:(NSURLSessionDownloadTask *)downloadTask didWriteData:(int64_t)bytesWritten totalBytesWritten:(int64_t)totalBytesWritten totalBytesExpectedToWrite:(int64_t)totalBytesExpectedToWrite
    {
        NSLog(@"didWriteData");
        NSLog(@"%f",1.0 *totalBytesWritten/totalBytesExpectedToWrite);
        self.progressView.progress = 1.0 *totalBytesWritten/totalBytesExpectedToWrite;
    }
    
    /*
        Resume:恢复
        取消之后再次下载就会调用这个方法|恢复下载的时候调用该方法
     fileOffset:恢复之后,要从文件的什么地方开发下载
     expectedTotalBytes:该文件数据的总大小
     */
    -(void)URLSession:(NSURLSession *)session downloadTask:(NSURLSessionDownloadTask *)downloadTask didResumeAtOffset:(int64_t)fileOffset expectedTotalBytes:(int64_t)expectedTotalBytes
    {
         NSLog(@"didResumeAtOffset");
    }
    
    /*当下载完成之后会调用这个方法*/
    -(void)URLSession:(NSURLSession *)session downloadTask:(NSURLSessionDownloadTask *)downloadTask didFinishDownloadingToURL:(NSURL *)location
    {
        NSLog(@"didFinishDownloadingToURL");
        NSLog(@"%@",location);
    
        //caches
        NSString *fullPath = [[NSSearchPathForDirectoriesInDomains(NSCachesDirectory, NSUserDomainMask, YES) firstObject] stringByAppendingPathComponent:downloadTask.response.suggestedFilename];
        //剪切文件
        [[NSFileManager defaultManager] moveItemAtURL:location toURL:[NSURL fileURLWithPath:fullPath] error:nil];
    
        NSLog(@"%@",fullPath);
    }
    
    /*当整个请求结束的时候会调用*/
    // 如果请求失败,那么error有值
    -(void)URLSession:(NSURLSession *)session task:(NSURLSessionTask *)task didCompleteWithError:(NSError *)error
    {
         NSLog(@"didCompleteWithError");
    }
    

    相关文章

      网友评论

        本文标题:NSURLSessionTask

        本文链接:https://www.haomeiwen.com/subject/gpadvxtx.html