NSURLSessionDataDelegate的代理方法使用总

2017-06-07 本文已影响72人宇亭

核心类

NSURLSession
NSURLSessionConfiguration
NSURLSessionTask
1. NSURLSessionDataTask
2. NSURLSessionDownload

代理

NSURLSessionDelegate
NSURLSessionTaskDelegate
NSURLSessionDataDelegate
NSURLSessionDownloadDelegate

NSURLSession相关的API

/** 创建NSURLSession对象的类方法. */
+ (NSURLSession *)sessionWithConfiguration:(NSURLSessionConfiguration *)configuration delegate:(id<NSURLSessionDelegate>)delegate delegateQueue:(NSOperationQueue *)queue

/** 通过URL, 返回一个数据任务. */
- (NSURLSessionDataTask *)dataTaskWithURL:(NSURL *)url

/** 通过request请求, 返回一个数据任务. */
- (NSURLSessionDataTask *)dataTaskWithRequest:(NSURLRequest *)request

NSURLSessionDataDelegate

/**  告诉delegate已经接受到服务器的初始应答, 准备接下来的数据任务的操作. */
- (void)URLSession:(NSURLSession *)session dataTask:(NSURLSessionDataTask *)dataTask didReceiveResponse:(NSURLResponse *)response completionHandler:(void (^)(NSURLSessionResponseDisposition disposition))completionHandler

/** 告诉delegate已经接收到部分数据. */
- (void)URLSession:(NSURLSession *)session dataTask:(NSURLSessionDataTask *)dataTask didReceiveData:(NSData *)data


/** 告诉delegate, data task 已经转变成download task. */
- (void)URLSession:(NSURLSession *)session dataTask:(NSURLSessionDataTask *)dataTask didBecomeDownloadTask:(NSURLSessionDownloadTask *)downloadTask

NSURLSessionTaskDelegate

/** 告诉delegate, task已经完成. */
- (void)URLSession:(NSURLSession *)session task:(NSURLSessionTask *)task didCompleteWithError:(NSError *)error

NSURLSessionDownloadDelegate

/** 告诉delegate, download task已经完成. */
- (void)URLSession:(NSURLSession *)session downloadTask:(NSURLSessionDownloadTask *)downloadTask didFinishDownloadingToURL:(NSURL *)location

编码思路

正常实现data任务的下载.
data任务转成download任务, 完成下载.
取消data任务下载.

创建绘话和任务

- (void)handleData /*-> 自己定义的一个方法. */
{

     /** 1. 创建NSURLSessionConfiguration类的对象, 这个对象被用于创建NSURLSession类的对象. */     
     NSURLSessionConfiguration *configura = [NSURLSessionConfiguration defaultSessionConfiguration];

    /**
     * 2. 创建NSURLSession的对象.
     * 参数一 : NSURLSessionConfiguration类的对象.(第1步创建的对象.)
     * 参数二 : session的代理人. 如果为nil, 系统将会提供一个代理人.
     * 参数三 : 一个队列, 代理方法在这个队列中执行. 如果为nil, 系统会自动创建一系列的队列.
     * 注: 只能通过这个方法给session设置代理人, 因为在NSURLSession中delegate属性是只读的.
     */

    NSURLSession *session = [NSURLSession sessionWithConfiguration:configura delegate:self delegateQueue:nil];

    /** 3. 创建URL. */
    NSURL *url = [NSURL URLWithString:@"http://c.3g.163.com/photo/api/list/0096/4GJ60096.json"];
    /** 4. 创建request. */
    NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:url];

    /** request请求方式为: GET. 如果是POST, 还需要设置HTTPBody属性. */


    /** 5. 创建数据类型的任务. */
    NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request];

    /** 6. 开始任务. */
    [dataTask resume];

    /** 7. 在session中的所有任务都完成之后, 使session失效. */
   [session finishTasksAndInvalidate];

}

实现代理监听

接收到返回信息时(还未开始下载), 执行的代理方法.

/** 
 * NSURLSessionDataDelegate方法实现. 
 * completionHandler block块内的参数 disposition 是一个枚举值:
 * 
 * typedef NS_ENUM (NSInteger,NSURLSessionResponseDisposition ) {
   NSURLSessionResponseCancel = 0, /**-> 取消任务. */
   NSURLSessionResponseAllow = 1,  /**-> 任务正常进行. */ 
   NSURLSessionResponseBecomeDownload = 2 /**-> 从data task 转换成 download task, 并调用 
 - URLSession:dataTask:didReceiveResponse:completionHandler: 代理方法. */
}; 
 */
- (void)URLSession:(NSURLSession *)session dataTask:(NSURLSessionDataTask *)dataTask didReceiveResponse:(NSURLResponse *)response completionHandler:(void (^)(NSURLSessionResponseDisposition disposition))completionHandler
{

    /** a. 初始化allData属性(步骤1中设置的属性). */
    self.allData = [NSMutableData data];

    /** b. 让任务继续正常进行.(如果没有写这行代码, 将不会执行下面的代理方法.) */
    completionHandler(NSURLSessionResponseAllow);

}

接收返回的数据


/** NSURLSessionDataDelegate方法实现. */

- (void)URLSession:(NSURLSession *)session dataTask:(NSURLSessionDataTask *)dataTask didReceiveData:(NSData *)data
{
    /** 接收返回的数据. */
    [self.allData appendData:data];
}

任务完成之后调用

/** 
 * NSURLSessionTaskDelegate方法实现.
 * 任务完成加载数据之后调用的代理方法.
 */
- (void)URLSession:(NSURLSession *)session task:(NSURLSessionTask *)task didCompleteWithError:(NSError *)error
{
    /** 处理数据. */
    NSError *er = nil;
    id result = [NSJSONSerialization JSONObjectWithData:self.allData options:NSJSONReadingMutableContainers error:&er];
    NSLog(@"result: %@", result);
}

data任务转成download任务, 完成下载.

当转换成download task时, 会下载资源数据到磁盘文件上, 我们不需要自己接收数据了.我们还需要签订NSURLSessionDownloadDelegate.

- (void)URLSession:(NSURLSession *)session dataTask:(NSURLSessionDataTask *)dataTask didReceiveResponse:(NSURLResponse *)response completionHandler:(void (^)(NSURLSessionResponseDisposition))completionHandler
{
    /** 把data task 转换成 download task. */
  completionHandler(NSURLSessionResponseBecomeDownload);
}

**注意:当data task 转换成 download task 时, 我们必须调用NSURLSessionDataDelegate中的
-URLSession:dataTask:didBecomeDownloadTask: 方法. **

因为已经转换成download task, 所以接下来将调用NSURLSessionDownloadDelegate的方法

- (void)URLSession:(NSURLSession *)session dataTask:(NSURLSessionDataTask *)dataTask didBecomeDownloadTask:(NSURLSessionDownloadTask *)downloadTask
{
    /** 此方法内可以不写任何代码, 但必须被调用. 否则将不会执行下面的代理方法. */
}
- (void)URLSession:(NSURLSession *)session downloadTask:(NSURLSessionDownloadTask *)downloadTask didFinishDownloadingToURL:(NSURL *)location
{

            /** 从提供的URL中读取数据. */
        NSData *data = [NSData dataWithContentsOfURL:location];
        /** 处理数据. */
        NSError *er = nil;
        id result = [NSJSONSerialization JSONObjectWithData:data options:NSJSONReadingMutableContainers error:&er];
        NSLog(@"result: %@", result);


}

取消data任务下载.

- (void)URLSession:(NSURLSession *)session dataTask:(NSURLSessionDataTask *)dataTask didReceiveResponse:(NSURLResponse *)response completionHandler:(void (^)(NSURLSessionResponseDisposition))completionHandler
{

     /** 取消data task 的下载. 之后将不会执行任何的代理方法了. */
    completionHandler(NSURLSessionResponseCancel);
}