目录
一、Apple提供的URL加载类
二、URL Loading 类介绍
1. 会话类型
2. 任务类型
2.1 NSURLSessionDataTask 数据任务示例
2.2 NSURLSessionDownloadTask下载任务示例
2.3 NSURLSessionUploadTask 上传任务示例
三、总结
一、Apple提供的URL Loading 类
先看一张官网给出的结构图
这张图中对URL的加载类分成了1个主要加载部分，和5个辅助加载部分：
1.1 主要加载类 （NSURLSession、NSURLRequest、NSURLResponse...）
1.2 协议支持类 （NSURLProtocol）
1.3 身份验证和凭据类（NSURLAuthenticationChallenge、NSURLCredentialStorage...）
1.4 Cookie Storage类（NSHTTPCookieStorage、NSHTTPCookie）
1.5 Session配置类（NSURLSessionConfiguration）
1.6 请求与响应 缓存管理类 （NSURLCache、NSCacheURLRequest）
NSURLSession类和其他辅助类提供下载资源的API，还提供了丰富的代理方法，用于支持身份验证（NSURLAuthenticationChallenge、NSURLCredentialStorage...），并使您的应用程序能够在您的应用程序未运行时执行后台下载，或者在iOS中停止应用时执行后台下载。
NSURLSession除了支持http请求外，还支持data、file、ftp、、https、代理服务器和SOCKS网关，也可以使用自己的自定义网络协议（NSURLProtocol）和URL方案为自己的应用程序添加支持
二、URL Loading 类介绍
URL Loading类中的NSURLConnection类在iOS 9 之后已经被遗弃了，我们使用最多的网络请求工具AFNetworking3.0之后 也是全部将NSURLConnection完全替换成了NSURLSession.
我们发起网络请求分为3步
- 配置
NSURLSession（配置会话类型） - 创建任务
NSURLSessionTask - 启动任务
[task resume] - 回调请求结果
1.会话类型
NSURLSession * sessionManager = [NSURLSession sessionWithConfiguration:(nonnull NSURLSessionConfiguration *)]
也就是NSURLSession初始化配置NSURLSessionConfiguration提供了3种
-
defaultSessionConfiguration 默认会话，永久性的磁盘的缓存并将凭据存储在用户的钥匙串中。 -
ephemeralSessionConfiguration 短暂会话，不会将任何数据存储到磁盘中,所有缓存，凭据存储等都保存在RAM中并与会话相关联。因此，当您的应用程序使会话无效时，它们将自动清除。 -
backgroundSessionConfiguration 后台会话, 类似于默认会话，但是在单独的进程处理所有数据传输
NSURLSession * sessionManager = [NSURLSession sharedSession];使用了defaultSessionConfiguration
我们也可以自定义会话类型，对NSURLSessionConfiguration进行配置
/* 缓存策略 */
NSURLRequestCachePolicy requestCachePolicy;
/* 请求超时时间 */
NSTimeInterval timeoutIntervalForRequest;
/* 响应超时时间 */
NSTimeInterval timeoutIntervalForResource;
/* 网络请求类型 */
NSURLRequestNetworkServiceType networkServiceType;
/* 是否允许使用移动蜂窝数据 */
BOOL allowsCellularAccess;
/* 是否允许在会话完成后响应启动等时间，只能在后台下载模式下使用 */
BOOL sessionSendsLaunchEvents;
/* cookie 使用策略 */
@property NSHTTPCookieAcceptPolicy HTTPCookieAcceptPolicy;
/* 使用cookie时的管理类 */
@property (nullable, retain) NSHTTPCookieStorage *HTTPCookieStorage;
/* 身份认证类 */
@property (nullable, retain) NSURLCredentialStorage *URLCredentialStorage;
/* 缓存类 */
@property (nullable, retain) NSURLCache *URLCache;
2.任务类型
NSURLSessionDataTask 数据任务
数据任务使用NSData对象发送和接收数据。数据任务可以在每收到一个数据时将数据回调回来，或者完成是将所有数据回调回来。NSURLSessionUploadTask 上传任务
上传任务与数据任务类似，但它们也会发送数据（通常以文件的形式），并且在应用程序未运行时支持后台上传NSURLSessionDownloadTask 下载任务
下载任务以文件的形式检索数据，并在应用程序未运行时支持后台下载和上传。
2.1 NSURLSessionDataTask数据任务示例
一个简单的GET请求
NSURLSession *sessionManager = [NSURLSession sharedSession];
NSURL *URL = [NSURL URLWithString:@"https//:www.baidu.com"];
// 不设置HTTPMethod默认为GET请求
// request.HTTPMethod = @"GET";
NSURLSessionDataTask *dataTask = [sessionManager dataTaskWithURL:URL
completionHandler:^(NSData * _Nullable data,
NSURLResponse * _Nullable response,
NSError * _Nullable error)
{
}];
[dataTask resume];
一个简单的POST请求示例
NSDictionary *dict = @{@"operation": @"idtext",
@"requestno": [NSUUID UUID].UUIDString,
@"filenamelist": @[@{@"file" : base64String}]};
NSData *jsonDate = [NSJSONSerialization dataWithJSONObject:dict options:0 error:nil];
// request 配置
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:urlString]];
request.timeoutInterval = 10;
request.HTTPMethod = @"POST";
request.HTTPBody = jsonDate;
// 发起请求
NSURLSession *session = [NSURLSession sharedSession];
_task = [session dataTaskWithRequest:request
completionHandler:^(NSData *data,
NSURLResponse *response,
NSError *error){
}
GET与POST的区别
GET请求的数据会附在URL之后（就是把数据放置在HTTP协议头中），以?分割URL和传输数据，参数之间以&相连，如：login.action?name=hyddd&password=jhhshsh&verify=%E4%BD%A0%E5%A5%BD。
POST是把提交的数据则放置在是HTTP的请求体中
2.2 NSURLSessionDownloadTask后台下载任务示例
发起下载请求
NSURLSessionConfiguration* sessionConfig = [NSURLSessionConfiguration backgroundSessionConfigurationWithIdentifier:identifier];
NSURLSession *session = [NSURLSession sessionWithConfiguration:sessionConfig
delegate:self
delegateQueue:nil];
NSURLSessionDownloadTask *downloadTask = [session downloadTaskWithRequest:request];
[downloadTask resume];
AppDelegate中对后台事件完成回调处理
- (void)application:(UIApplication *)application
handleEventsForBackgroundURLSession:(NSString *)identifier
completionHandler:(void (^)(void))completionHandler{
// 你必须重新建立一个后台 seesion ，系统会自动与创建的session关联
[[BLDownlowdHanlder shareHandler] initBackgroundSessionWithId:identifier];
// 保存 completion handler 以在处理 session 事件后更新 UI
[self.completionHandlerDictionary setObject:completionHandler forKey:identifier];
}
代理接受数据
// 下载进度的状态信息
- (void)URLSession:(NSURLSession *)session
downloadTask:(NSURLSessionDownloadTask *)downloadTask
didWriteData:(int64_t)bytesWritten
totalBytesWritten:(int64_t)totalBytesWritten
totalBytesExpectedToWrite:(int64_t)totalBytesExpectedToWrite
{
NSLog(@"Session %@ download task %@ wrote an additional %lld bytes (total %lld bytes) out of an expected %lld bytes.\n", session, downloadTask, bytesWritten, totalBytesWritten, totalBytesExpectedToWrite);
}
// 尝试恢复以前失败的下载成功
- (void)URLSession:(NSURLSession *)session
downloadTask:(NSURLSessionDownloadTask *)downloadTask
didResumeAtOffset:(int64_t)fileOffset
expectedTotalBytes:(int64_t)expectedTotalBytes
{
NSLog(@"Session %@ download task %@ resumed at offset %lld bytes out of an expected %lld bytes.\n", session, downloadTask, fileOffset, expectedTotalBytes);
}
// 提供存储下载内容的临时文件的URL
// 在此方法返回之前，必须打开文件进行读取或将其移动到永久位置。当此方法返回时，临时文件如果仍然存在于其原始位置，将被删除。
- (void)URLSession:(NSURLSession *)session
downloadTask:(NSURLSessionDownloadTask *)downloadTask
didFinishDownloadingToURL:(NSURL *)location
{
// 回调APPdDelegate中保存的completionHandler()
APPDelegate.completionHandlers[session.configuration.identifier]();
// 移动临时文件到指定位置
NSFileManager *fileManager = [NSFileManager defaultManager];
NSURL *cacheDirectory = [[fileManager URLsForDirectory:NSCachesDirectory inDomains:NSUserDomainMask] firstObject];
NSError *moveError = nil;
if ([fileManager moveItemAtURL:location toURL:cacheDirectory error:moveError]) {
// ...
}
}
断点下载
// URLSessionDelegate 代理方法
// 由于下载失败，暂停，下载完成都会回调此方法，app进程退出后下载未完成，再次进入也会回调此方法
// 保存数据
- (void)URLSession:(NSURLSession *)session
task:(NSURLSessionTask *)task
didCompleteWithError:(NSError *)error
{
// 保存恢复数据
self.resumeData = error.userInfo[NSURLSessionDownloadTaskResumeData];
}
// 暂停下载
- (void)taskSuspend{
// 使用这种方式取消下载可以得到将来用来恢复的数据
[self.task cancelByProducingResumeData:^(NSData *resumeData) {
self.resumeData = resumeData;
}];
}
// 恢复下载
- (void)taskResume{
// 恢复下载时接过保存的恢复数据
self.task = [self.session downloadTaskWithResumeData:self.resumeData];
// 启动任务
[self.task resume];
}
后台下载参照文章HK_Hank
我的DEMO
2.3 NSURLSessionUploadTask 上传任务示例
NSURLSession提供了方便的API上传文件，有三种方式：NSData对象上传，作为文件上传，流的方式上传，对应的API：
NSData对象上传，uploadTaskWithRequest:fromData:或uploadTaskWithRequest:fromData:completionHandler:作为
文件上传,uploadTaskWithRequest:fromFile:
或uploadTaskWithRequest:fromFile:completionHandler:流的方式上传,uploadTaskWithStreamedRequest:
无论使用哪种上传方式，都必须遵守上传文件的格式，iOS 深入浅出 网络编程之HTTP初识,介绍了上传文件时HTTPBody的格式
使用NSData对象上传
NSString *MPboundary = [[NSString alloc]initWithFormat:@"--%@", @"boundary"];
NSString *endMPboundary = [[NSString alloc]initWithFormat:@"%@--",MPboundary];
NSString *end = [[NSString alloc]initWithFormat:@"\r\n%@",endMPboundary];
NSMutableData *fileData = [NSMutableData data];
NSMutableString *bodyString = [[NSMutableString alloc]init];
// 非文件参数
NSDictionary *dict = @{@"p_id": p_id, @"name": name, @"return_image": @"1"};
NSArray *keys= [dict allKeys];
//遍历keys
for (int i = 0;i < keys.count;i++) {
NSString *key = keys[i];
[bodyString appendFormat:@"%@\r\n", MPboundary];
[bodyString appendFormat:@"Content-Disposition: form-data; name=\"%@\"\r\n\r\n",key];
[bodyString appendFormat:@"%@\r\n",[dict objectForKey:key]];
}
// 文件
[bodyString appendFormat:@"%@\r\n",MPboundary];
[bodyString appendFormat:@"Content-Disposition: form-data; name=\"file\"; filename=\"file\"\r\n"];
[bodyString appendFormat:@"Content-Type: image/png\r\n\r\n"];
[fileData appendData:[bodyString dataUsingEncoding:NSUTF8StringEncoding]];
[fileData appendData:data];
[fileData appendData:[end dataUsingEncoding:NSUTF8StringEncoding]];
NSMutableURLRequest *request=[NSMutableURLRequest requestWithURL:[NSURL URLWithString: uploadURL] cachePolicy:1 timeoutInterval:2.0f];
request.HTTPMethod = @"POST";
request.timeoutInterval = 15.0;
NSString *content = [[NSString alloc]initWithFormat:@"multipart/form-data; boundary=%@", @"boundary"];
[request setValue:content forHTTPHeaderField:@"Content-Type"];
[request setValue:[NSString stringWithFormat:@"%lu", (unsigned long)[fileData length]] forHTTPHeaderField:@"Content-Length"];
// 上传文件
NSURLSessionUploadTask *uploadTask = [[NSURLSession sharedSession] uploadTaskWithRequest:request
fromData:fileData
completionHandler:^(NSData * _Nullable data,
NSURLResponse * _Nullable response,
NSError * _Nullable error)
{
}];
[uploadTask resume];
使用Stream上传
// 与data上传的格式相同，对data进行配置,然后将fileData转为Stream
mutableRequest.HTTPBodyStream = [[NSInputStream alloc] initWithData: fileData];
NSURLSessionUploadTask *uploadTask = [defaultSession uploadTaskWithStreamedRequest:mutableRequest];
[uploadTask resume];
还需要实现URLSession: task: needNewBodyStream方法，
因为session不一定倒回提供流重读数据,应用程序负责提供一个新的流在session必须重试请求(例如,如果认证失败)。我们要实现URLSession: task: needNewBodyStream提供Stream。
- (void)URLSession:(NSURLSession *)session
task:(NSURLSessionTask *)task
needNewBodyStream:(void (^)(NSInputStream *bodyStream))completionHandler
{
NSInputStream *inputStream = nil;
if (task.originalRequest.HTTPBodyStream && [task.originalRequest.HTTPBodyStream conformsToProtocol:@protocol(NSCopying)]) {
inputStream = [task.originalRequest.HTTPBodyStream copy];
}
if (completionHandler) {
completionHandler(inputStream);
}
}
使用NSURLSessionDataTask上传文件
NSURLSessionDataTask同样可以上传文件， NSURLSessionUploadTask只是用做上传的功能区分，实质是一样的
NSString *MPboundary = [[NSString alloc]initWithFormat:@"--%@", @"boundary"];
NSString *endMPboundary = [[NSString alloc]initWithFormat:@"%@--",MPboundary];
NSString *end = [[NSString alloc]initWithFormat:@"\r\n%@",endMPboundary];
NSMutableData *fileData = [NSMutableData data];
NSMutableString *bodyString = [[NSMutableString alloc]init];
// 非文件参数
NSDictionary *dict = @{@"p_id": p_id, @"name": name, @"return_image": @"1"};
NSArray *keys= [dict allKeys];
//遍历keys
for (int i = 0;i < keys.count;i++) {
NSString *key = keys[i];
[bodyString appendFormat:@"%@\r\n", MPboundary];
[bodyString appendFormat:@"Content-Disposition: form-data; name=\"%@\"\r\n\r\n",key];
[bodyString appendFormat:@"%@\r\n",[dict objectForKey:key]];
}
// 文件
[bodyString appendFormat:@"%@\r\n",MPboundary];
[bodyString appendFormat:@"Content-Disposition: form-data; name=\"file\"; filename=\"file\"\r\n"];
[bodyString appendFormat:@"Content-Type: image/png\r\n\r\n"];
[fileData appendData:[bodyString dataUsingEncoding:NSUTF8StringEncoding]];
[fileData appendData:data];
[fileData appendData:[end dataUsingEncoding:NSUTF8StringEncoding]];
NSMutableURLRequest *request=[NSMutableURLRequest requestWithURL:[NSURL URLWithString: uploadURL] cachePolicy:1 timeoutInterval:2.0f];
request.HTTPMethod = @"POST";
request.timeoutInterval = 15.0;
NSString *content = [[NSString alloc]initWithFormat:@"multipart/form-data; boundary=%@", @"boundary"];
[request setValue:content forHTTPHeaderField:@"Content-Type"];
[request setValue:[NSString stringWithFormat:@"%lu", (unsigned long)[fileData length]] forHTTPHeaderField:@"Content-Length"];
// 上传文件
request.HTTPBody = fileData;
NSURLSessionDataTask *datatask = [[NSURLSession sharedSession] dataTaskWithRequest:request
completionHandler:^(NSData * _Nullable data,
NSURLResponse * _Nullable response,
NSError * _Nullable error)
{
[datatask resume];
关于cookie的介绍请查看我的另一篇文章iOS 深入浅出 网络编程之 NSHTTPCookie/NSHTTPCookieStorage
关于Cache的介绍请查看我的另一篇文章iOS 深入浅出 网络编程之 NSURLCache
关于Authentication And Credentials部分请查看官方文档
总结
使用NSURLSession请求的大致流程为，配置NSURLSession，配置NSURLRequest，创建NSURLSessionTask，发起请求，中间穿插了，身份认证，Cookie，Cache处理等。