iOS网络2——NSURLSession使用详解

原文在此

一、整体介绍

二、使用的一般步骤

1 NSURL：请求地址，定义一个网络资源路径：

NSURL *url = [NSURL URLWithString:@"协议://主机地址/路径?参数&参数"];

2 NSURLRequest：请求，根据前面的NSURL建立一个请求：

NSURLRequest *request = [NSURLRequest requestWithURL:url cachePolicy:NSURLRequestUseProtocolCachePolicy timeoutInterval:30.0];

// 告诉服务器数据为json类型
[request setValue:@"application/json" forHTTPHeaderField:@"Content-Type"];
// 设置请求体(json类型)
NSData *jsonData = [NSJSONSerialization dataWithJSONObject:@{@"userid":@"123456"} options:NSJSONWritingPrettyPrinted error:nil];
request.HTTPBody = jsonData;

3 NSURLSession：创建NSURLSession发送请求

三 举例

1.NSURLSession请求网络数据

/// 向网络请求数据
- (void)NSURLSessionTest {
// 1.创建url
// 请求一个网页
NSString *urlString = @"/article/5225257.html";

// 一些特殊字符编码
urlString = [urlString stringByAddingPercentEncodingWithAllowedCharacters:[NSCharacterSet URLQueryAllowedCharacterSet]];
NSURL *url = [NSURL URLWithString:urlString];

// 2.创建请求 并：设置缓存策略为每次都从网络加载 超时时间30秒
NSURLRequest *request = [NSURLRequest requestWithURL:url cachePolicy:NSURLRequestReloadIgnoringLocalCacheData timeoutInterval:30];

// 3.采用苹果提供的共享session
NSURLSession *sharedSession = [NSURLSession sharedSession];

// 4.由系统直接返回一个dataTask任务
NSURLSessionDataTask *dataTask = [sharedSession dataTaskWithRequest:request completionHandler:^(NSData * _Nullable data, NSURLResponse * _Nullable response, NSError * _Nullable error) {
// 网络请求完成之后就会执行，NSURLSession自动实现多线程
NSLog(@"%@",[NSThread currentThread]);
if (data && (error == nil)) {
// 网络访问成功
NSLog(@"data=%@",[[NSString alloc] initWithData:data encoding:NSUTF8StringEncoding]);
} else {
// 网络访问失败
NSLog(@"error=%@",error);
}
}];

// 5.每一个任务默认都是挂起的，需要调用 resume 方法
[dataTask resume];
}

2.NSURLSession文件下载

/// 文件下载
- (void)NSURLSessionDownloadTaskTest {
// 1.创建url
NSString *urlString = [NSString stringWithFormat:@"http://localhost/周杰伦 - 枫.mp3"];
// 一些特殊字符编码
urlString = [urlString stringByAddingPercentEncodingWithAllowedCharacters:[NSCharacterSet URLQueryAllowedCharacterSet]];
NSURL *url = [NSURL URLWithString:urlString];

// 2.创建请求
NSURLRequest *request = [NSURLRequest requestWithURL:url];

// 3.创建会话，采用苹果提供全局的共享session
NSURLSession *sharedSession = [NSURLSession sharedSession];

// 4.创建任务
NSURLSessionDownloadTask *downloadTask = [sharedSession downloadTaskWithRequest:request completionHandler:^(NSURL * _Nullable location, NSURLResponse * _Nullable response, NSError * _Nullable error) {
if (error == nil) {
// location:下载任务完成之后,文件存储的位置，这个路径默认是在tmp文件夹下!
// 只会临时保存，因此需要将其另存
NSLog(@"location:%@",location.path);

// 采用模拟器测试，为了方便将其下载到Mac桌面
//            NSString *filePath = [NSSearchPathForDirectoriesInDomains(NSCachesDirectory, NSUserDomainMask, YES) lastObject];
NSString *filePath = @"/Users/userName/Desktop/周杰伦 - 枫.mp3";
NSError *fileError;
[[NSFileManager defaultManager] copyItemAtPath:location.path toPath:filePath error:&fileError];
if (fileError == nil) {
NSLog(@"file save success");
} else {
NSLog(@"file save error: %@",fileError);
}
} else {
NSLog(@"download error:%@",error);
}
}];

// 5.开启任务
[downloadTask resume];
}

3.NSURLSession文件上传

/// 以流的方式上传，大小理论上不受限制，但应注意时间
- (void) NSURLSessionBinaryUploadTaskTest {
// 1.创建url  采用Apache本地服务器
NSString *urlString = @"http://localhost/upload.php";
urlString = [urlString stringByAddingPercentEncodingWithAllowedCharacters:[NSCharacterSet URLFragmentAllowedCharacterSet]];
NSURL *url = [NSURL URLWithString:urlString];

// 2.创建请求
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:url];
// 文件上传使用post
request.HTTPMethod = @"POST";

// 3.开始上传   request的body data将被忽略，而由fromData提供
[[[NSURLSession sharedSession] uploadTaskWithRequest:request fromData:[NSData dataWithContentsOfFile:@"/Users/userName/Desktop/IMG_0359.jpg"]     completionHandler:^(NSData * _Nullable data, NSURLResponse * _Nullable response, NSError * _Nullable error) {
if (error == nil) {
NSLog(@"upload success：%@",[[NSString alloc] initWithData:data encoding:NSUTF8StringEncoding]);
} else {
NSLog(@"upload error:%@",error);
}
}] resume];
}

MAX_FILE_SIZE

request的body data in this request object are ignored

--boundary
Content-Disposition:form-data;name=”表单控件名称”;filename=”上传文件名称”
Content-Type:要上传文件MIME Types

要上传文件二进制数据;

--boundary--

/// 文件上传
- (void)NSURLSessionUploadTaskTest {
// 1.创建url  采用Apache本地服务器
NSString *urlString = @"http://localhost/upload/upload.php";
urlString = [urlString stringByAddingPercentEncodingWithAllowedCharacters:[NSCharacterSet URLFragmentAllowedCharacterSet]];
NSURL *url = [NSURL URLWithString:urlString];

// 2.创建请求
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:url];
// 文件上传使用post
request.HTTPMethod = @"POST";
NSString *contentType = [NSString stringWithFormat:@"multipart/form-data; boundary=%@",@"boundary"];
[request setValue:contentType forHTTPHeaderField:@"Content-Type"];
// 3.拼接表单，大小受MAX_FILE_SIZE限制(2MB)  FilePath:要上传的本地文件路径  formName:表单控件名称，应于服务器一致
NSData* data = [self getHttpBodyWithFilePath:@"/Users/userName/Desktop/IMG_0359.jpg" formName:@"file" reName:@"newName.png"];
request.HTTPBody = data;
// 根据需要是否提供，非必须,如果不提供，session会自动计算
[request setValue:[NSString stringWithFormat:@"%lu",data.length] forHTTPHeaderField:@"Content-Length"];

// 4.1 使用dataTask
[[[NSURLSession sharedSession] dataTaskWithRequest:request completionHandler:^(NSData * _Nullable data, NSURLResponse * _Nullable response, NSError * _Nullable error) {
if (error == nil) {
NSLog(@"upload success：%@",[[NSString alloc] initWithData:data encoding:NSUTF8StringEncoding]);
} else {
NSLog(@"upload error:%@",error);
}

}] resume];
#if 0
// 4.2 开始上传 使用uploadTask   fromData:可有可无，会被忽略
[[[NSURLSession sharedSession] uploadTaskWithRequest:request fromData:nil     completionHandler:^(NSData * _Nullable data, NSURLResponse * _Nullable response, NSError * _Nullable error) {
if (error == nil) {
NSLog(@"upload success：%@",[[NSString alloc] initWithData:data encoding:NSUTF8StringEncoding]);
} else {
NSLog(@"upload error:%@",error);
}
}] resume];
#endif
}

/// filePath:要上传的文件路径   formName：表单控件名称  reName：上传后文件名
- (NSData *)getHttpBodyWithFilePath:(NSString *)filePath formName:(NSString *)formName reName:(NSString *)reName
{
NSMutableData *data = [NSMutableData data];
NSURLResponse *response = [self getLocalFileResponse:filePath];
// 文件类型：MIMEType  文件的大小：expectedContentLength  文件名字：suggestedFilename
NSString *fileType = response.MIMEType;

// 如果没有传入上传后文件名称,采用本地文件名!
if (reName == nil) {
reName = response.suggestedFilename;
}

// 表单拼接
NSMutableString *headerStrM =[NSMutableString string];
[headerStrM appendFormat:@"--%@\r\n",@"boundary"];
// name：表单控件名称  filename：上传文件名
[headerStrM appendFormat:@"Content-Disposition: form-data; name=%@; filename=%@\r\n",formName,reName];
[headerStrM appendFormat:@"Content-Type: %@\r\n\r\n",fileType];
[data appendData:[headerStrM dataUsingEncoding:NSUTF8StringEncoding]];

// 文件内容
NSData *fileData = [NSData dataWithContentsOfFile:filePath];
[data appendData:fileData];

NSMutableString *footerStrM = [NSMutableString stringWithFormat:@"\r\n--%@--\r\n",@"boundary"];
[data appendData:[footerStrM  dataUsingEncoding:NSUTF8StringEncoding]];
//    NSLog(@"dataStr=%@",[[NSString alloc] initWithData:data encoding:NSUTF8StringEncoding]);
return data;
}
/// 获取响应，主要是文件类型和文件名
- (NSURLResponse *)getLocalFileResponse:(NSString *)urlString
{
urlString = [urlString stringByAddingPercentEncodingWithAllowedCharacters:[NSCharacterSet URLFragmentAllowedCharacterSet]];
// 本地文件请求
NSURL *url = [NSURL fileURLWithPath:urlString];
NSURLRequest *request = [NSURLRequest requestWithURL:url];

__block NSURLResponse *localResponse = nil;
// 使用信号量实现NSURLSession同步请求
dispatch_semaphore_t semaphore = dispatch_semaphore_create(0);
[[[NSURLSession sharedSession] dataTaskWithRequest:request completionHandler:^(NSData * _Nullable data, NSURLResponse * _Nullable response, NSError * _Nullable error) {
localResponse = response;
dispatch_semaphore_signal(semaphore);
}] resume];
dispatch_semaphore_wait(semaphore, DISPATCH_TIME_FOREVER);
return  localResponse;
}

四 NSURLSessionConfiguration

NSURLSessionConfiguration *config = [NSURLSessionConfiguration defaultSessionConfiguration];
// delegateQueue：请求完成回调函数和代理函数的运行线程，如果为nil则系统自动创建一个串行队列，不影响sessionTask的运行线程
NSURLSession *session = [NSURLSession sessionWithConfiguration:config delegate:self delegateQueue:[NSOperationQueue mainQueue]];

configuration.HTTPAdditionalHeaders = @{
@"Accept": @"application/json",
@"Accept-Language": @"en",
@"Authorization": authString,
@"User-Agent": userAgentString
};

附录——服务器端文件上传PHP源代码

<?php
header("Content-type: application/json; charset=utf-8");
// 配置文件需要上传到服务器的路径，需要允许所有用户有可写权限，否则无法上传！
$uploaddir = 'images/';
// file表单名称，应与客户端一致
$uploadfile = $uploaddir . basename($_FILES['file']['name']);

move_uploaded_file($_FILES['file']['tmp_name'], $uploadfile);

echo json_encode($_FILES);
?>

<?php
/** 二进制流生成文件
* $_POST 无法解释二进制流，需要用到 $GLOBALS['HTTP_RAW_POST_DATA'] 或 php://input
* $GLOBALS['HTTP_RAW_POST_DATA'] 和 php://input 都不能用于 enctype=multipart/form-data
* @param    String  $file   要生成的文件路径
* @return   boolean
*/
function binary_to_file($file){
$content = $GLOBALS['HTTP_RAW_POST_DATA'];          // 需要php.ini设置
if(empty($content)){
$content = file_get_contents('php://input');    // 不需要php.ini设置，内存压力小
}
$ret = file_put_contents($file, $content, true);
return $ret;
}
$file_dir="images/image.png";  // 固定的文件名,注意设置images文件夹权限为所有用户可读写！！！
binary_to_file($file_dir);
?>

示例代码下载