技术学习

iOS 下载功能(断点续传)

2018-08-26  本文已影响1028人  翀鹰精灵

我们来看看如何自己简单的实现一个断点续传的功能,思路如下:

思路步骤:

1.文件的存放
1.1 如果正在下载,放在temp+名称文件下;
1.2 如果下载完成,放在cache+名称文件下.
1.3 这里名称参考SDWebImage里面,使用MD+URL来命名,防止重复资源.

2.判断,URL地址,对应的资源,是否已经下载完毕
2.1 告诉外界,下载完毕,并且传递相关信息(本地的的路径,文件的大小) return
2.2 检测,临时文件是否存在

2.2.1 临时文件不存在,从0字节开始请求资源。 return
2.2.2 临时文件存在,直接以当前的存在文件大小,作为开始字节,去网络请求资源

获取本地大小/获取文件的总大小
2.2.2.1 本地大小 == 总大小 ==>> 移动到下载完成的路径中.
2.2.2.2 本地大小 > 总大小 ==>> 删除本地临时缓存(因为此时缓存中是错误的),从0字节开始下载.
2.2.2.3 本地大小 < 总大小 ==>> 从本地大小开始下载.

一 、下载功能实现-下载机制

1.创建一个FDownLoader工具类,并封装一个downLoader下载的方法,初始代码如下:

- (void)downLoader:(NSURL*)url {
    
    //1.文件的存放
    NSString *fileName = url.lastPathComponent;
    /// 下载完成的路径
    NSString *downLoaderPath = [kCachePath stringByAppendingPathComponent:fileName];
    /// 临时文件路径
    NSString *downLoadingrPath = [kTmpPath stringByAppendingPathComponent:fileName];
    
     //2.判断,URL地址,对应的资源,是否已经下载完毕
    if ([FFileTool fileExists:downLoaderPath]) {
        // 告诉外界,已经下载完成;
        return;
    }
    if (![FFileTool fileExists:downLoadingrPath]) {
        // 从0字节开始请求资源
        [self downLoadWithURL:url offset:0];
        return;
    }
}
#pragma mark -- <私有方法>
/// 根据开始字节去请求资源
- (void)downLoadWithURL:(NSURL *)url offset:(long long)offset {
    NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:url cachePolicy:NSURLRequestReloadIgnoringLocalCacheData timeoutInterval:0];
    [request setValue:[NSString stringWithFormat:@"bytes=%lld-",offset] forHTTPHeaderField:@"Range"];
    // session 分配的task,默认挂起状态
    NSURLSessionDataTask *dataTask = [self.session dataTaskWithRequest:request];
    
    [dataTask resume];
}
#pragma mark -- <NSURLSessionDataDelegate>
/// 第一次接收到响应的时候调用(响应投,并没有具体的资源内容)
/*通过这个方法,系统提供的回调代码块,可以控制,是继续请求,还是取消本次请求*/
- (void)URLSession:(NSURLSession *)session dataTask:(NSURLSessionDataTask *)dataTask didReceiveResponse:(NSHTTPURLResponse *)response completionHandler:(void (^)(NSURLSessionResponseDisposition))completionHandler {
    //总大小 250523
    NSLog(@"%@",response);
    //本地缓存
    _totalSize = [response.allHeaderFields[@"Content-Length"]longLongValue];
    NSString *contentRangeStr = response.allHeaderFields[@"content-range"];
    if (contentRangeStr.length != 0) {
      _totalSize  =   [[contentRangeStr componentsSeparatedByString:@"/"].lastObject longLongValue];
    }
    //比对本地大小和总大小
    // 2.2.2.1 本地大小 == 总大小 ==>> 移动到下载完成的路径中.
    if (_tmpSize == _totalSize) {
        // 1.移动到下载完成文件夹
        [FFileTool moveFile:self.downLoadingrPath toPath:self.downLoaderPath];
        // 2.取消本次请求
        completionHandler(NSURLSessionResponseCancel);
        return;
    }
    // 2.2.2.2 本地大小 > 总大小  ==>> 删除本地临时缓存(因为此时缓存中是错误的),从0字节开始下载.
    if (_tmpSize > _totalSize) {
        // 1.删除临时缓存
        [FFileTool removeFile:self.downLoadingrPath];
        // 2.从0开始下载
        [self downLoader:response.URL];
        // [self downLoadWithURL:url offset:0]; 如果删除失败,会出现继续往错误的缓存中追加数据的操作.
        // 3.取消本次请求
        completionHandler(NSURLSessionResponseCancel);
        return;
    }
    // 2.2.2.3 本地大小 < 总大小  ==>>  从本地大小开始下载.
    completionHandler(NSURLSessionResponseAllow);
}

/// 当用户确定,继续接受数据的时候调用
- (void)URLSession:(NSURLSession *)session dataTask:(NSURLSessionDataTask *)dataTask didReceiveData:(NSData *)data {
    NSLog(@"在接受后序数据");
}

/// 请求完成的时候调用(!=请求成功/失败)
- (void)URLSession:(NSURLSession *)session task:(NSURLSessionTask *)task didCompleteWithError:(NSError *)error {
    NSLog(@"请求完成");
}

至此,整个下载的机制已经初步完成了,下面就是接受到数据以后,需要写入文件的操作,并且保存数据。
Tips:

Content-Length:代表请求的大小,不等于资源总大小
content-range:资源的总大小

所以,资源总大小应该从Content-Length里面取(无论是否设置Range头,Content-Length都会存在),但是如果有content-range这个字段,应该从content-range里面取,因为content-range这个字段需要设置 [request setValue:[NSString stringWithFormat:@"bytes=%lld-",offset] forHTTPHeaderField:@"Range"];Range头才会有的。

二、下载功能实现-保存数据

在开始下载的地方,创建输出流

   // 2.2.2.3 本地大小 < 总大小  ==>>  从本地大小开始下载.
    self.outputStream = [NSOutputStream outputStreamToFileAtPath:self.downLoadingrPath append:YES];
    [self.outputStream open];
    completionHandler(NSURLSessionResponseAllow);

/// 当用户确定,继续接受数据的时候调用
- (void)URLSession:(NSURLSession *)session dataTask:(NSURLSessionDataTask *)dataTask didReceiveData:(NSData *)data {
     [self.outputStream write:data.bytes maxLength:data.length];
    NSLog(@"在接受后序数据");
}

Tips:

这里写入数据不使用writeToFile:<#(nonnull NSString *)#> atomically:<#(BOOL)#>],容易造成内存峰值,所以使用输出流,输出流这种方式,文件还是在磁盘里面,不占内存。

三、下载-完善功能

一般一个下载器,基本操作应该包含下载/继续下载,暂停,取消,删除等操作,具体需要和业务场景来结合,这里暂时只考虑基本的操作,后序可追加。

 // 暂停
- (void)pauseCurrentTask {
    [self.dataTask suspend];
}
// 取消
- (void)cancleCurrentTask {
    //[self.dataTask cancel];
    [self.session invalidateAndCancel];
    self.session = nil;
}
// 取消和删除
- (void)cancleAndClean {
    [self cancleAndClean];
    [FFileTool removeFile:self.downLoadingrPath];
}

四、下载-状态控制

在下载监听器中,按钮的状态也是一个非常重要的内容,需要考虑按钮不同状态下需要响应不同的操作,这里用枚举值,在各个下载控制方法中,去试验对应的状态,下面列举出来按钮常见的几种状态:

typedef NS_ENUM(NSUInteger, FDownLoadState) {
    FDownLoadStatePause, //暂停
    FDownLoadStateDownLoading, //正在下载
    FDownLoadStatePauseSuccess,
    FDownLoadStatePauseFailed
};

这里,状态需要不断的调试,才知道在FDownLoader工具类里面如何设置对应的状态,具体见Demo中各状态的设置。

五、下载-事件-数据传递

目前为止,下载的基本功能是实现了,但是需要将FDownLoader工具类里面的值告诉外界,方法很多,我们可以通过代理,block,通知等多种方式,这里采用block,所以定义下面几个block传值:

@property (nonatomic,copy) void(^downLoadInfo)(long long totalSize);
@property (nonatomic,copy) void(^stateChange)(FDownLoadState state);
@property (nonatomic,assign,readonly)float progress;
@property (nonatomic,copy) void(^progressChange)(float progress);
@property (nonatomic,copy) void(^successBlock)(NSString *cachePath);
@property (nonatomic,copy) void(^failedBlock)(void);

为方便用户外界调用,这里又封装了一个统一的调用方法:

- (void)downLoader:(NSURL*)url
      downLoadInfo:(DownLoadInfoBlock)downLoadInfo
          progress:(ProgressBlock)progressBlock
           success:(SuccessBlock)successBlock
            failed:(FailedBlock)failedBlock;

此时,外界调用就比较简洁了,使用如下:

    [self.downLoader downLoader:url downLoadInfo:^(long long totalSize) {
        NSLog(@"下载信息:%lld",totalSize);
    } progress:^(float progress) {
        NSLog(@"下载进度:%f",progress);
    } success:^(NSString *cachePath) {
        NSLog(@"下载成功路径:%@",cachePath);
    } failed:^{
        NSLog(@"下载失败");
    }];
    [self.downLoader setStateChange:^(FDownLoadState state) {
        NSLog(@"状态:%lu",(unsigned long)state);
    }];
    
六、下载-多任务下载

我们封装的这个FDownLoader工具类,与URL地址是一一对应的关系,所以,这里一个FDownLoader对应一个URL地址资源,里面也只涵盖一个URL资源状态以及下载信息等各种信息,这是单任务下载。但是,如果要实现多任务下载,则需要创建多个FDownLoader负责下载每个URL资源。

这里我们创建一个FFDownLoaderManager管理类,来管理FDownLoader下载,其实这个FFDownLoaderManager属于上层业务管理类。
这里设计用一个字典,以URL的md5值为key,以download为value,这个字典就负责维护所有download对象,这个key就是URL对应的md5,因为URL地址可能有特殊符号,这里先了解下md5的加密方法如下:

- (NSString *)md5 {
    
    const char * data =  self.UTF8String;
    unsigned char md[CC_MD5_DIGEST_LENGTH];
    // 作用: 把C语言的字符串 ->md5
    CC_MD5(data, (CC_LONG)strlen(data), md);
    
    NSMutableString *result = [NSMutableString stringWithCapacity:CC_MD5_DIGEST_LENGTH * 2];
    for (int i = 0; i < CC_MD5_DIGEST_LENGTH; i ++) {
        [result appendFormat:@"%02x",md[i]];
    }
    return result;
}

多任务下载逻辑核心代码:

- (void)downLoader:(NSURL*)url
      downLoadInfo:(DownLoadInfoBlock)downLoadInfo
          progress:(ProgressBlock)progressBlock
           success:(SuccessBlock)successBlock
            failed:(FailedBlock)failedBlock {

    // 1. url
    NSString *urlMD5 = [url.absoluteString md5];
    // 2.根据urlMD5,查找相应的下载器
    FDownLoader *downLoader =self.downLoaderInfo[urlMD5];
    if (downLoader == nil) {
        downLoader = [[FDownLoader alloc]init];
        self.downLoaderInfo[urlMD5] = downLoader;
    }
    
    [downLoader downLoader:url downLoadInfo:downLoadInfo progress:progressBlock success:^(NSString *filePath) {
        //拦截block 
        // 下载完成之后,移除下载器
        [self.downLoaderInfo removeObjectForKey:urlMD5];
        successBlock(filePath);
    } failed:failedBlock];
}

Demo下载地址.

上一篇下一篇

猜你喜欢

热点阅读