NSURLSession入门及应用（请求管理器开发）

2016-10-27 本文已影响135人 Jabber_YQ

前言

现如今几乎所有的app都需要联网，而一个app中也可能存在上百个接口，我最早学习的时候，都是直接用AFN在VC中访问服务器的，这样做虽然暂时简单了开发，但是却使得VC变成了垃圾桶，当遇到问题时也会很头疼。下面我来分享个较好的方法，自定义一个请求管理器。

NSURLSession的简单使用

磨刀不误砍柴工，作为一个想着进步的程序员，不可能一辈子都用AFN，而了解掌握一些系统的类也是尤为重要的。
从iOS9.0开始，NSURLConnection就被苹果废除了，取而代之的是NSURLSession，那么我们就来学习一下NSURLSession的使用吧。

一、Get请求

1.Get简单方法

- (void)get
{
    // 获得NSURLSession对象
    NSURLSession *session = [NSURLSession sharedSession];
    
    
    // 创建请求
    NSString *urlStr = @"http://music.163.com/api/playlist/detail?id=108970502";
    NSURLRequest *request = [NSURLRequest requestWithURL:[NSURL URLWithString:urlStr]];
    
    // 创建任务
    NSURLSessionDataTask *task = [session dataTaskWithRequest:request completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
        NSLog(@"%@", [NSJSONSerialization JSONObjectWithData:data options:kNilOptions error:nil]);
    }];
    
    // 启动任务
    [task resume];
}

2.Get代理方法 <NSURLSessionDataDelegate>

- (void)getDelegate
{
    // 获得NSURLSession对象
    NSURLSession *session = [NSURLSession sessionWithConfiguration:[NSURLSessionConfiguration defaultSessionConfiguration] delegate:self delegateQueue:[[NSOperationQueue alloc] init]];
    
    // 创建请求
    NSString *urlStr = @"http://music.163.com/api/playlist/detail?id=108970502";
    NSURLRequest *request = [NSURLRequest requestWithURL:[NSURL URLWithString:urlStr]];
    
    // 创建任务
    NSURLSessionDataTask *task = [session dataTaskWithRequest:request];
    
    // 启动任务
    [task resume];
}

// 接收到服务器的响应
- (void)URLSession:(NSURLSession *)session dataTask:(NSURLSessionDataTask *)dataTask didReceiveResponse:(NSURLResponse *)response completionHandler:(void (^)(NSURLSessionResponseDisposition))completionHandler
{
    // 需要允许处理服务器的响应，才会继续接收服务器返回的数据
    completionHandler(NSURLSessionResponseAllow);
}


// 接收到服务器的数据（可能会被调用多次）
- (void)URLSession:(NSURLSession *)session dataTask:(NSURLSessionDataTask *)dataTask didReceiveData:(NSData *)data
{
    NSLog(@"%@", data);
}


// 请求成功或者失败（如果失败，error有值）
- (void)URLSession:(NSURLSession *)session task:(NSURLSessionTask *)task didCompleteWithError:(NSError *)error
{
    
}

二、Post请求

1.Post简单方法

    // 获得NSURLSession对象
    NSURLSession *session = [NSURLSession sharedSession];
    
    // 创建请求
    NSString *urlStr = @"http://music.163.com/api/playlist/detail?id=108970502";
    NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:urlStr]];
    request.HTTPMethod = @"POST"; // 请求方法
    
    // 创建任务
    NSURLSessionDataTask *task = [session dataTaskWithRequest:request completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
        NSLog(@"%@", [NSJSONSerialization JSONObjectWithData:data options:kNilOptions error:nil]);
    }];
    
    // 启动任务
    [task resume];

2.Post代理方法

和get的代理方法类似，只是需要改变request的请求方法以及请求体。

三、download

1.download简单方法

    // 获得NSURLSession对象
    NSURLSession *session = [NSURLSession sharedSession];
   
    // 获得下载任务
    NSURLSessionDownloadTask *task = [session downloadTaskWithURL:[NSURL URLWithString:@"http://m2.music.126.net/2ExmqXDnHZDH8qAORqRhew==/7978056373223494.mp3"] completionHandler:^(NSURL *location, NSURLResponse *response, NSError *error) {
        
        // 文件将来存放的真实路径
        NSString *file = [[NSSearchPathForDirectoriesInDomains(NSCachesDirectory, NSUserDomainMask, YES) lastObject] stringByAppendingPathComponent:response.suggestedFilename];
        
        // 剪切location的临时文件到真实路径
        NSFileManager *mgr = [NSFileManager defaultManager];
        [mgr moveItemAtURL:location toURL:[NSURL fileURLWithPath:file] error:nil];
    }];
    
    // 启动任务
    [task resume];

这边下载后的文件后保存在location地址，我们需要做的是把这个文件移动到指定的位置。

2.download代理方法<NSURLSessionDownloadDelegate>

- (void)downloadDelegate
{
    // 获得NSURLSession对象
    NSURLSession *session = [NSURLSession sessionWithConfiguration:[NSURLSessionConfiguration defaultSessionConfiguration] delegate:self delegateQueue:[[NSOperationQueue alloc] init]];
    
    // 获得下载任务
    NSURLSessionDownloadTask *task = [session downloadTaskWithURL:[NSURL URLWithString:@"http://m2.music.126.net/2ExmqXDnHZDH8qAORqRhew==/7978056373223494.mp3"]];
    
    // 启动任务
    [task resume];
}


- (void)URLSession:(NSURLSession *)session task:(NSURLSessionTask *)task didCompleteWithError:(NSError *)error
{

}

- (void)URLSession:(NSURLSession *)session downloadTask:(NSURLSessionDownloadTask *)downloadTask didResumeAtOffset:(int64_t)fileOffset expectedTotalBytes:(int64_t)expectedTotalBytes
{
    NSLog(@"didResumeAtOffset");
}

/**
 * 每当写入数据到临时文件时，就会调用一次这个方法
 * totalBytesExpectedToWrite:总大小
 * totalBytesWritten: 已经写入的大小
 * bytesWritten: 这次写入多少
 */
- (void)URLSession:(NSURLSession *)session downloadTask:(NSURLSessionDownloadTask *)downloadTask didWriteData:(int64_t)bytesWritten totalBytesWritten:(int64_t)totalBytesWritten totalBytesExpectedToWrite:(int64_t)totalBytesExpectedToWrite
{
    NSLog(@"%f", 1.0 * totalBytesWritten / totalBytesExpectedToWrite);
}

// 下载完毕就会调用一次这个方法
- (void)URLSession:(NSURLSession *)session downloadTask:(NSURLSessionDownloadTask *)downloadTask didFinishDownloadingToURL:(NSURL *)location
{
    NSString *file = [[NSSearchPathForDirectoriesInDomains(NSCachesDirectory, NSUserDomainMask, YES) lastObject] stringByAppendingPathComponent:downloadTask.response.suggestedFilename];
    
    NSFileManager *mgr = [NSFileManager defaultManager];
    [mgr moveItemAtURL:location toURL:[NSURL fileURLWithPath:file] error:nil];
}

四、upload

1.upload简单方法

- (void)upload
{
    // 获得NSURLSession对象
    NSURLSession *session = [NSURLSession sharedSession];
    
    // 创建"可变"请求对象
    NSURL *url = [NSURL URLWithString:@"http://6:32812/upload"];
    NSMutableURLRequest *request  =[NSMutableURLRequest requestWithURL:url];
    request.HTTPMethod = @"POST";
    
    // 设置请求头,告诉服务器本次长传的时文件信息 // 这一块的内容是不变的!
    NSString *contentType = [NSString stringWithFormat:@"multipart/form-data; boundary=%@",bound];
    [request setValue:contentType forHTTPHeaderField:@"Content-Type"];
    
    // 设置请求体,拼接文件传输格式
    NSMutableString *bodyHeaderStr = [NSMutableString stringWithFormat:@"--%@\r\n",bound];
    [bodyHeaderStr appendFormat:@"Content-Disposition: form-data; name=%@; filename=%@\r\n",@"userfile",@"JSON"];
    [bodyHeaderStr appendString:@"Content-Type: application/octet-stream\r\n\r\n"];//两个换行
    NSData *fileData = [NSData dataWithContentsOfFile:@"本地文件路径"];
    NSMutableString *bodyFooterStr = [NSMutableString stringWithFormat:@"\r\n--%@--",bound];
    //拼接成二进制数据
    NSMutableData *bodyData = [NSMutableData data];
    [bodyData appendData:[bodyHeaderStr dataUsingEncoding:NSUTF8StringEncoding]];
    [bodyData appendData:fileData];
    [bodyData appendData:[bodyFooterStr dataUsingEncoding:NSUTF8StringEncoding]];

    NSURLSessionUploadTask *uploadTask = [session uploadTaskWithRequest:request fromData:bodyData completionHandler:^(NSData * _Nullable data, NSURLResponse * _Nullable response, NSError * _Nullable error) {
        
        //  解析服务器返回的数据
        NSLog(@"%@",[[NSString alloc]initWithData:data encoding:NSUTF8StringEncoding]);
    }];
    
    //发送请求
    [uploadTask resume];
}

2.uploadDelegate

// 主要代码
- (void)uploadDelegate
{
    // 获得NSURLSession对象 
    NSURLSession *session = [NSURLSession sessionWithConfiguration:[NSURLSessionConfiguration defaultSessionConfiguration] delegate:self delegateQueue:[NSOperationQueue mainQueue]];
}

/* 
bytesSent:本次上传的数据大小
totalBytesSent:已经上传数据的总大小 
totalBytesExpectedToSend:文件的总大小
 */
-(void)URLSession:(NSURLSession *)session task:(NSURLSessionTask *)task didSendBodyData:(int64_t)bytesSent totalBytesSent:(int64_t)totalBytesSent totalBytesExpectedToSend:(int64_t)totalBytesExpectedToSend
{ 
    NSLog(@"%f",1.0 * totalBytesSent /totalBytesExpectedToSend);
}

上传较为麻烦，如果嫌麻烦可以直接使用第三方框架。

自定义请求管理器

既然NSURLSession基本会用了，那么我们就可以用它做一个请求管理器了。
首先先新建一个继承NSObject的类：YQRequestManager。然后思考这个管理器需要完成什么任务。
举个例子，我们需要获取我喜欢的歌曲列表，那么就需要声明一个方法:

- (void)fetchMyLikeMusicListWithUrl:(NSString *)url;

然后去.m文件中实现。可是怎么才能把获取到的数据传出来给控制器呢。可以使用delegate，也可以使用block。下面我来介绍一下block方法（block相比较代理方法更加直接明了）：

第一步：声明Block：

typedef  void(^musicListRequestSussess)(NSMutableArray *likeMusicList);       //加载完成后返回数据并刷新列表
typedef  void(^musicListRequestFail)(); // 失败

第二步：声明对象方法

- (void)fetchMyLikeMusicListWithUrl:(NSString *)url requestSussess:(musicListRequestSussess)sussess requestFail:(musicListRequestFail)fail;

第三步：方法实现

- (void)fetchMyLikeMusicListWithUrl:(NSString *)url requestSussess:(musicListRequestSussess)sussess requestFail:(musicListRequestFail)fail
{
    if (!url) {
        return;
    }
    NSString *dataPathStr = [NSSearchPathForDirectoriesInDomains(NSLibraryDirectory, NSUserDomainMask, YES).lastObject stringByAppendingPathComponent:@"likeMusicListJSONData"];
    NSURLSession *session = [NSURLSession sharedSession];
    NSURLSessionTask *task = [session dataTaskWithURL:[NSURL URLWithString:url] completionHandler:^(NSData * _Nullable data, NSURLResponse * _Nullable response, NSError * _Nullable error) {
        if (!error) {
            //解析数据
            NSMutableArray *likeMusicList = [NSMutableArray array];
            // 返回数据 刷新
            sussess(likeMusicList);
        } else {
            fail();
        }
    }];
    [task resume];
}

PS：这里使用的是NSURLSession的get简单方法，也可以使用代理方法等等。

控制器调用

    NSString *urlStr = @"http://music.163.com/api/playlist/detail?id=108970502";
    // 单例
    YQRequestManager *manager = [YQRequestManager shareRequestManager];
    [manager fetchMyLikeMusicListWithUrl:urlStr requestSussess:^(NSMutableArray *likeMusicList) {
        // 获取到likeMusicList
        // 更新界面
    } requestFail:^{
        NSLog(@"获取数据失败");
    }];