iOS 下载URL不断改变的情况下 使用 resumeData做断点续传

Apple 在 iOS 7 之后将原有的 NSURLConnection 替换成了新的 NSURLSession ,新的 NSURLSession 包含诸多新的特性,其中有一项就是在应用退出到后台以及崩溃后,系统可以继续帮我们进行上传、下载任务。同时,NSURLSession 对一些任务进行了很好的封装。例如我们只需要使用下面这种方法就可以开始一个下载任务,非常简单。
task = [self.session downloadTaskWithResumeData:resumeData];
同时, NSURLSession 对进行中的任务也可以做到很好的管理。通过系统的 delegate 方法,例如

- (void)URLSession:(NSURLSession *)session downloadTask:(NSURLSessionDownloadTask *)downloadTask
      didWriteData:(int64_t)bytesWritten
 totalBytesWritten:(int64_t)totalBytesWritten
totalBytesExpectedToWrite:(int64_t)totalBytesExpectedToWrite
{
//可以获取进度等
}
NSURLSessionDownloadTask断点续传

NSURLSessionDownloadTask 可以通过 suspend 方法进行暂停,并在程序没有被终止之前通过 resume 方法进行恢复。也可以通过 [task cancelByProducingResumeData:^(NSData *resumeData){ }];进行暂停,同样也是通过resume恢复下载。

[task cancelByProducingResumeData:^(NSData *resumeData){
       //localPath:本地路径
      [resumeData writeToFile:localPath   atomically:YES];

 }];

这样就可以通过这个 resumeData 就可以方便的在应用关闭、重新启动后进行下载任务的续传了。

实际运用中碰到的问题

项目中使用 NSURLSession 来完成一些下载任务。需要续传时很自然的就使用到了 resumeData 来恢复下载任务。想象很美好,现实很残酷。因为项目中的下载任务,资源的 URL 是有时效的,每一次请求资源的 URL 都会发生改变。当从 resumeData 中恢复出一个 NSURLSessionDownloadTask 后,由于在 resumeData 中包含了第一次请求的 request。所以开始任务后就会出错。收到的响应状态码是 404,因为资源的 URL 发生了改变。

resumeData的内容

将 resumeData 存入一个文件后打开,格式是这样的:

<?xml version="1.0" encoding="UTF-8"?\>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd"\>
<plist version="1.0">
<dict>
    <key>NSURLSessionDownloadURL</key>
    <string>https://d1opms6zj7jotq.cloudfront.net/idea/ideaIC-15.0.2-custom-jdk-bundled.dmg</string>
    <key>NSURLSessionResumeBytesReceived</key>
    <integer>25858975</integer>
    <key>NSURLSessionResumeCurrentRequest</key>
    <data>
    YnBsaXN0MDDUAQIDBAUGcnNYJHZlcnNpb25YJG9iamVjdHNZJGFyY2hpdmVyVCR0b3AS
    AAGGoK8QFwcIKUVLTFJTVFU4VjpXWGRlZmdoaWpuVSRudWxs3xAeCQoLDA0ODxAREhMU
    FRYXGBkaGxwdHh8gISIjJCUmJygpKissLSgvMDErMysqKio4Jzo7Kj0qPyo7QjhDUyQx
    ... 后面省略
    </data>
    <key>NSURLSessionResumeEntityTag</key>
    <string>"054beecc2c7dbd16d58ecb9084ab4b79-19"</string>
    <key>NSURLSessionResumeInfoTempFileName</key>
    <string>CFNetworkDownload_desnj1.tmp</string>
    <key>NSURLSessionResumeInfoVersion</key>
    <integer>2</integer>
    <key>NSURLSessionResumeOriginalRequest</key>
    <data>
    YnBsaXN0MDDUAQIDBAUGTk9YJHZlcnNpb25YJG9iamVjdHNZJGFyY2hpdmVyVCR0b3AS
    AAGGoKwHCCM5P0BGR0gvSUpVJG51bGzfEBgJCgsMDQ4PEBESExQVFhcYGRobHB0eHyAh
    IiMkJSInKCOg==
    ... 后面省略
    </data>
    <key>NSURLSessionResumeServerDownloadDate</key>
    <string>Mon, 07 Dec 2015 21:52:40 GMT</string>
</dict>
</plist>

其中NSURLSessionDownloadURL是资源的URL。NSURLSessionResumeBytesReceived记录下来了已经下载完成的字节数。NSURLSessionResumeCurrentRequest以及NSURLSessionResumeOriginalRequest是当前以及初始请求时的对象。是通过NSKeyArchiverencode出的数据。NSURLSessionResumeEntityTag是 E-Tag部分。NSURLSessionResumeInfoTempFileNam是下载过程中临时文件所存储的位置,存储在应用程序tmp
文件夹下。我们需要的就是这几个部分。

重新生成 ResumeData

上代码:

- (NSData *)newResumeDataFromOldResumeData:(NSData *)resumeData withURLString:(NSString *)urlString{

    if (!resumeData || !urlString ) return nil;
     NSMutableDictionary *resumeDataDic =[NSPropertyListSerialization propertyListWithData:resumeData options:NSPropertyListImmutable format:nil error:nil];
    
    //生成一个新的NSURLMutableRequest
    NSMutableURLRequest *newResumeRequest =[NSMutableURLRequest requestWithURL:[NSURL URLWithString:urlString]];
    
    //为NSURLMutableRequest 为 HTTP 请求的头部增加了一个 Range
    NSInteger bytes =[[resumeDataDic objectForKey:@"NSURLSessionResumeBytesReceived"] integerValue];
    NSString *bytesStr =[NSString stringWithFormat:@"bytes=%ld-",bytes];
    [newResumeRequest addValue:bytesStr forHTTPHeaderField:@"Range"];

    // 重新将 NSURLMutableRequest encode 为 NSData 。
    NSData *newResumeData =[NSKeyedArchiver archivedDataWithRootObject:newResumeRequest];
    [resumeDataDic setObject:newResumeData forKey:@"NSURLSessionResumeCurrentRequest"];
    [resumeDataDic setObject:urlString forKey:@"NSURLSessionDownloadURL"];
    NSData *data =[NSPropertyListSerialization dataWithPropertyList:resumeDataDic format:NSPropertyListXMLFormat_v1_0 options:0 error:nil];
    
    return data;
}

将 plist 文件重新读回应用中后是一个 NSData 文件,首先第一步将 NSData 通过 NSData(contentsOfFile: savePath) 从之前存储的 plist 文件中读取。并转化为 NSMutableDictionary

第二步重新生成一个 NSURLMutableRequest ,之所以用 Mutable,是因为方便后面自定义信息。

第二行代码通过为 NSURLMutableRequest 为 HTTP 请求的头部增加了一个 Range 字段,这样我们就可以从 Range 标明的位置执行下载了。

第三步重新将 NSURLMutableRequest encode 为 NSData 。

第四步讲新的 URL 和 新生成的 NSData 存储到字典中。

第五步将字典重新序列化为 NSData 。

这样就完成了,只要每一次停止时生成一个数据,开始时读取、修改数据。就可以在下载的URL不断改变的情况下进行断点续传了。

推荐阅读更多精彩内容