iOS實現斷點續傳

阿新 • • 發佈：2018-12-07

網路下載是我們在專案中經常要用到的功能，如果是小檔案的下載，比如圖片和文字之類的，我們可以直接請求源地址，然後一次下載完畢。但是如果是下載較大的音訊和視訊檔案，不可能一次下載完畢，使用者可能下載一段時間，關閉程式，回家接著下載。這個時候，就需要實現斷點續傳的功能。讓使用者可以隨時暫停下載，下次開始下載，還能接著上次的下載的進度。

今天我們來看看如何自己簡單的封裝一個斷點續傳的類，實現如下功能。

使用者只需要呼叫一個介面即可以下載，同時可以獲取下載的進度。
下載成功，可以獲取檔案儲存的位置
下載失敗，給出失敗的原因
可以暫停下載，下次開始下載，接著上次的進度繼續下載

原理講解

要實現斷點續傳的功能，通常都需要客戶端記錄下當前的下載進度，並在需要續傳的時候通知服務端本次需要下載的內容片段。

在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中實現回撥。具體程式碼參考下面的完整程式碼

完整程式碼實現

下面是完整的程式碼實現

#import <Foundation/Foundation.h>
typedef void (^successBlock) (NSString *fileStorePath);
typedef void (^faileBlock) (NSError *error);
typedef void (^progressBlock) (float progress);

@interface DownLoadManager : NSObject <NSURLSessionDataDelegate>
@property (copy) successBlock  successBlock;
@property (copy) faileBlock      failedBlock;
@property (copy) progressBlock    progressBlock;


-(void)downLoadWithURL:(NSString *)URL
              progress:(progressBlock)progressBlock
               success:(successBlock)successBlock
                 faile:(faileBlock)faileBlock;

+ (instancetype)sharedInstance;
-(void)stopTask;

@end

//
//  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 - <NSURLSessionDataDelegate>
/**
 * 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 =  @"http://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

總結

這裡只能實現單個任務下載，大家可以自己想想辦法，看如何實現多工下載，並且實現斷點續傳功能。

並且為了更加便於操作，建議把儲存資訊換成使用資料庫儲存。

Demo下載地址

作者：西木柚子
連結：https://www.jianshu.com/p/0e6deea7de87
來源：簡書
簡書著作權歸作者所有，任何形式的轉載都請聯絡作者獲得授權並註明出處。

iOS實現斷點續傳

原理講解

難點說明

完整程式碼實現

如何呼叫

總結

iOS實現斷點續傳

iOS-AFNetworking實現斷點續傳功能

iOS-NSURLSessionDataTask實現斷點續傳功能

用AsyncTask實現斷點續傳

rsync 實現斷點續傳

用Java實現斷點續傳 (HTTP)

5.2 SpringBoot實現斷點續傳功能 > 我的程式猿之路：第四十二章

java多執行緒實現斷點續傳下載

Python實現斷點續傳下載檔案，大檔案下載還怕下載到一半就斷了嗎？不存在！

簡單實現斷點續傳+MVP+Retrofit+RxJava

Java 實現斷點續傳 (HTTP)

http range實現斷點續傳（斷點續載）

libcurl實現斷點續傳

C#檔案下載（實現斷點續傳）

用 Java 實現斷點續傳 (HTTP)

自定義Source實現斷點續傳

FTP下用reget實現斷點續傳（FTP下get顯示進度）

python實現斷點續傳下載檔案

Android檔案下載（實現斷點續傳）

結合服務端實現斷點續傳

iOS實現斷點續傳

原理講解

難點說明

完整程式碼實現

如何呼叫

總結

相關推薦