梦素琴箫,肿瘤康复网,搜搜e点通
ios实现断点续传，网络下载是我们在项目中经常要用到的功能，如果是小文件的下载，比如图片和文字之类的，我们可以直接请求源地址，然后一次下载完毕。但是如果是下载较大的音频和视频文件，不可能一次下载完毕，用户可能下载一段时间，关闭程序，回家接着下载。这个时候，就需要实现断点续传的功能。让用户可以随时暂停下载，下次开始下载，还能接着上次的下载的进度。
今天我们来看看如何自己简单的封装一个断点续传的类，实现如下功能。
使用者只需要调用一个接口即可以下载，同时可以获取下载的进度。
下载成功，可以获取文件存储的位置
下载失败，给出失败的原因
可以暂停下载，下次开始下载，接着上次的进度继续下载
要实现断点续传的功能，通常都需要客户端记录下当前的下载进度，并在需要续传的时候通知服务端本次需要下载的内容片段。
在http1.1协议（rfc2616）中定义了断点续传相关的http头的range和content-range字段，一个最简单的断点续传实现大概如下：
客户端下载一个1024k的文件，已经下载了其中512k
网络中断，客户端请求续传，因此需要在http头中申明本次需要续传的片段：
range:bytes=512000-
这个头通知服务端从文件的512k位置开始传输文件
服务端收到断点续传请求，从文件的512k位置开始传输，并且在http头中增加：
content-range:bytes 512000-/1024000
并且此时服务端返回的http状态码应该是206，而不是200。
1. 客户端如何获取已经下载的文件字节数
客户端这边，我们需要记录下每次用户每次下载的文件大小，然后实现原理讲解中步骤1的功能。
那么如何记载呢？
其实我们可以直接获取指定路径下文件的大小，ios已经提供了相关的功能，实现代码如下
[[[nsfilemanager defaultmanager] attributesofitematpath: filestorepath error:nil][nsfilesize] integervalue]
2.如何获取被下载文件的总字节数
上一步，我们获取了已经下载文件的字节数，这里我们需要获取被下载文件的总字节数，有了这两个值，我们就可以算出下载进度了。
那么如何获取呢？这里我们需要用到http 头部的conten-length字段，先来看看该字段的含义
content-length用于描述http消息实体的传输长度the transfer-length of the
message-body。在http协议中，消息实体长度和消息实体的传输长度是有区别，比如说gzip压缩下，消息实体长度是压缩前的长度，消息实体的传输长度是gzip压缩后的长度。
简单点说，content-length表示被下载文件的字节数。
对比原理讲解的第三步，我们可以看到如果要计算出文件的总字节数，那么必须把已经下载的字节数 加上 content-length。
我们需要把每个被下载文件的总字节数存储起来，这里我们选择使用plist文件来记载，plist文件包含一个字典。设置文件名为键值，已经下载的文件字节数为值。
文件名为了防止重复，这里我们设置文件名为下载url的hash值，可以保证不重重。
实现代码如下：
我要评论
- (void)urlsession:(nsurlsession *)session datatask:(nsurlsessiondatatask *)datatask didreceiveresponse:(nshttpurlresponse *)response completionhandler:(void (^)(nsurlsessionresponsedisposition))completionhandler
{
self.totallength = [response.allheaderfields[@"content-length"] integervalue] + downloadlength;
nsmutabledictionary *dict = [nsmutabledictionary dictionarywithcontentsoffile: totallengthplist];
if (dict == nil) dict = [nsmutabledictionary dictionary];
dict[ filename] = @(self.totallength);
[dict writetofile: totallengthplist atomically:yes];
}
上述nssessiondelegate方法会在请求收到回应的时候调用一次，我们可以在该方法中获取回应信息，取出content-length字段。
3.封装一个方法，实现下载进度，成功，失败提示
我们可以模仿afnetwork，把下载封装到一个方法，然后使用不同的block来实现下载进度，成功，失败后的回调。
定义如下：
-(void)downloadwithurl:(nsstring *)url
progress:(progressblock)progressblock
success:(successblock)successblock
faile:(faileblock)faileblock
{
self.successblock = successblock;
self.failedblock = faileblock;
self.progressblock = progressblock;
self.downloadurl = url;
[self.task resume];
}
上面的三个block都采用宏定义方式，这样看起来比较简洁，具体代码参考下面的完整代码。
然后我们可以在nsurlsessiondatadelegate的对应的代理方法中去实现三个block的调用，然后传入相应的参数。这样当其他人调用我们的方法，就可以在相应的block中实现回调。具体代码参考下面的完整代码
完整代码实现
下面是完整的代码实现
//
// downloadmanager.m
// test1
//
// created by mia on 16/7/30.
// copyright ? 2016年 mia. all rights reserved.
//
#import "downloadmanager.h"
#import "nsstring+hash.h"
@interface downloadmanager ()
/** 下载任务 */
@property (nonatomic, strong) nsurlsessiondatatask *task;
/** session */
@property (nonatomic, strong) nsurlsession *session;
/** 写文件的流对象 */
@property (nonatomic, strong) nsoutputstream *stream;
/** 文件的总大小 */
@property (nonatomic, assign) nsinteger totallength;
@property(nonatomic,strong)nsstring *downloadurl;
@end
// 文件名（沙盒中的文件名），使用md5哈希url生成的，这样就能保证文件名唯一
#define filename self.downloadurl.md5string
// 文件的存放路径（caches）
#define filestorepath [[nssearchpathfordirectoriesindomains(nscachesdirectory, nsuserdomainmask, yes) lastobject] stringbyappendingpathcomponent: filename]
// 使用plist文件存储文件的总字节数
#define totallengthplist [[nssearchpathfordirectoriesindomains(nscachesdirectory, nsuserdomainmask, yes) lastobject] stringbyappendingpathcomponent:@"totallength.plist"]
// 文件的已被下载的大小
#define downloadlength [[[nsfilemanager defaultmanager] attributesofitematpath: filestorepath error:nil][nsfilesize] integervalue]
@implementation downloadmanager
#pragma mark - 创建单例
static id _instance;
+ (instancetype)allocwithzone:(struct _nszone *)zone
{
static dispatch_once_t oncetoken;
dispatch_once(&oncetoken, ^{
_instance = [super allocwithzone:zone];
});
return _instance;
}
+ (instancetype)sharedinstance
{
static dispatch_once_t oncetoken;
dispatch_once(&oncetoken, ^{
_instance = [[self alloc] init];
});
return _instance;
}
- (id)copywithzone:(nszone *)zone
{
return _instance;
}
- (id)mutablecopywithzone:(nszone *)zone {
return _instance;
}
#pragma mark - 公开方法
-(void)downloadwithurl:(nsstring *)url
progress:(progressblock)progressblock
success:(successblock)successblock
faile:(faileblock)faileblock
{
self.successblock = successblock;
self.failedblock = faileblock;
self.progressblock = progressblock;
self.downloadurl = url;
[self.task resume];
nslog(@"%p----%p",self,[downloadmanager sharedinstance]);
}
-(void)stoptask{
[self.task suspend ];
}
#pragma mark - getter方法
- (nsurlsession *)session
{
if (!_session) {
_session = [nsurlsession sessionwithconfiguration:[nsurlsessionconfiguration defaultsessionconfiguration] delegate:self delegatequeue:[[nsoperationqueue alloc] init]];
}
return _session;
}
- (nsoutputstream *)stream
{
if (!_stream) {
_stream = [nsoutputstream outputstreamtofileatpath: filestorepath append:yes];
}
return _stream;
}
- (nsurlsessiondatatask *)task
{
if (!_task) {
nsinteger totallength = [[nsdictionary dictionarywithcontentsoffile: totallengthplist][ filename] integervalue];
if (totallength && downloadlength == totallength) {
nslog(@"######文件已经下载过了");
return nil;
}
// 创建请求
nsmutableurlrequest *request = [nsmutableurlrequest requestwithurl:[nsurl urlwithstring: self.downloadurl]];
// 设置请求头
// range : bytes=xxx-xxx，从已经下载的长度开始到文件总长度的最后都要下载
nsstring *range = [nsstring stringwithformat:@"bytes=%zd-", downloadlength];
[request setvalue:range forhttpheaderfield:@"range"];
// 创建一个data任务
_task = [self.session datataskwithrequest:request];
}
return _task;
}
#pragma mark -
/**
* 1.接收到响应
*/
- (void)urlsession:(nsurlsession *)session datatask:(nsurlsessiondatatask *)datatask didreceiveresponse:(nshttpurlresponse *)response completionhandler:(void (^)(nsurlsessionresponsedisposition))completionhandler
{
// 打开流
[self.stream open];
/*
（content-length字段返回的是服务器对每次客户端请求要下载文件的大小）
比如首次客户端请求下载文件a，大小为1000byte，那么第一次服务器返回的content-length = 1000，
客户端下载到500byte，突然中断，再次请求的range为 “bytes=500-”，那么此时服务器返回的content-length为500
所以对于单个文件进行多次下载的情况（断点续传），计算文件的总大小，必须把服务器返回的content-length加上本地存储的已经下载的文件大小
*/
self.totallength = [response.allheaderfields[@"content-length"] integervalue] + downloadlength;
// 把此次已经下载的文件大小存储在plist文件
nsmutabledictionary *dict = [nsmutabledictionary dictionarywithcontentsoffile: totallengthplist];
if (dict == nil) dict = [nsmutabledictionary dictionary];
dict[ filename] = @(self.totallength);
[dict writetofile: totallengthplist atomically:yes];
// 接收这个请求，允许接收服务器的数据
completionhandler(nsurlsessionresponseallow);
}
/**
* 2.接收到服务器返回的数据（这个方法可能会被调用n次）
*/
- (void)urlsession:(nsurlsession *)session datatask:(nsurlsessiondatatask *)datatask didreceivedata:(nsdata *)data
{
// 写入数据
[self.stream write:data.bytes maxlength:data.length];
float progress = 1.0 * downloadlength / self.totallength;
if (self.progressblock) {
self.progressblock(progress);
}
// 下载进度
}
/**
* 3.请求完毕（成功\失败）
*/
- (void)urlsession:(nsurlsession *)session task:(nsurlsessiontask *)task didcompletewitherror:(nserror *)error
{
if (error) {
if (self.failedblock) {
self.failedblock(error);
self.successblock = nil;
self.progressblock = nil;
self.failedblock = nil;
}
self.stream = nil;
self.task = nil;
}else{
if (self.successblock) {
self.successblock(filestorepath);
self.successblock = nil;
self.progressblock = nil;
self.failedblock = nil;
}
// 关闭流
[self.stream close];
self.stream = nil;
// 清除任务
self.task = nil;
}
}
@end
如何调用
@interface viewcontroller ()
@end
@implementation viewcontroller
/**
* 开始下载
*/
- (ibaction)start:(id)sender {
// 启动任务
nsstring * downloadurl = @"https://audio.xmcdn.com/group11/m01/93/af/wkgda1dzzjlbl0gcapuzejqk84y539.m4a";
[[downloadmanager sharedinstance]downloadwithurl:downloadurl progress:^(float progress) {
nslog(@"###%f",progress);
} success:^(nsstring *filestorepath) {
nslog(@"###%@",filestorepath);
} faile:^(nserror *error) {
nslog(@"###%@",error.userinfo[nslocalizeddescriptionkey]);
}];
}
/**
* 暂停下载
*/
- (ibaction)pause:(id)sender {
[[downloadmanager sharedinstance]stoptask];
}
@end
总结
这里只能实现单个任务下载，大家可以自己想想办法，看如何实现多任务下载，并且实现断点续传功能。
并且为了更加便于操作，建议把存储信息换成使用存储。
如对本文有疑问，请在下面进行留言讨论，广大热心网友会与你互动！！ 点击进行留言回复
网友评论