iOS --- 使用NSOperation和NSURLSession封装一个串行下载器

本文介绍了使用NSOperation和NSURLSession来实现串行下载的需求.

为何要这样

iOS中使用NSURLSession的NSURLSessionDownloadTask进行下载:
对于NSURLSessionDownloadTask对象, 执行resume方法之后, 即开始下载任务.
而下载进度是通过NSURLSessionDelegate的对应方法进行更新.
这意味着在发起下载任务后, 实际的下载操作是异步执行的.
如果顺序发起多个下载任务(执行resume方法), 各个任务的下载情况完全是在NSURLSessionDelegate的回调方法中体现. 这样会出现几个问题:

• 多任务同时下载: 在iOS上NSURLSession允许4个任务同时下载，在一些应用体验上其实不如单个顺序下载(如音乐下载, 相机AR素材包下载等, 与其多首歌曲同时下载, 不如优先下载完一首, 用户可以尽快使用).
• 任务间有依赖关系: 如AR素材包本身下载完成之后, 还要依赖另外的一个配置文件(Config.zip)等下载完成, 则即使该AR素材包下载完成, 但依然无法使用, 不能置为已下载状态.
• 优先级问题: 如有的任务的优先级比较高, 则需要做到优先下载.
• 下载完成时间不确定: 如上的使用场景, 因AR素材包和依赖文件的下载完成顺序也不确定, 导致必须采用一些机制去触发全部下载完毕的后续操作(如通知等).
• 下载超时: NSURLSessionDownloadTask对象执行resume后, 如果在指定时间内未能下载完毕会出现下载超时, 多个任务同时下载时容易出现.

目标

以上边讲的AR素材包的场景为例, 我们想要实现一个下载机制:

• 顺序点击多个AR素材, 发起多个下载请求, 但优先下载一个素材包, 以便用户可以尽快体验效果.
• 对于有依赖关系的素材包, 先下载其依赖的配置文件, 再下载素材包本身, 素材包本身的下载完成状态即是该AR整体的下载完成状态.

实现过程

综合以上的需求, 使用NSOperation来封装下载任务, 但需要监控其状态. 使用NSOperationQueue来管理这些下载任务.

NSOperation的使用

CSDownloadOperation继承自NSOperation, 不过对于其executing, finished, cancelled状态, 需要使用KVO监控.

因为KVO依赖于属性的setter方法, 而NSOperation的这三个属性是readonly的, 所以NSOperation在执行中的这些状态变化不会自动触发KVO, 而是需要我们额外做一些工作来手动触发KVO.

其实, 可以简单理解为给NSOperation的这三个属性自定义setter方法, 以便在其状态变化时触发KVO.

@interface CSDownloadOperation : NSOperation

@end

@interface CSDownloadOperation ()

// 因这些属性是readonly, 不会自动触发KVO. 需要手动触发KVO, 见setter方法.
@property (assign, nonatomic, getter = isExecuting)     BOOL executing;
@property (assign, nonatomic, getter = isFinished)      BOOL finished;
@property (assign, nonatomic, getter = isCancelled)     BOOL cancelled;

@end

@implementation CSDownloadOperation

@synthesize executing       = _executing;
@synthesize finished        = _finished;
@synthesize cancelled       = _cancelled;


- (void)setExecuting:(BOOL)executing
{
    [self willChangeValueForKey:@"isExecuting"];
    _executing = executing;
    [self didChangeValueForKey:@"isExecuting"];
}

- (void)setFinished:(BOOL)finished
{
    [self willChangeValueForKey:@"isFinished"];
    _finished = finished;
    [self didChangeValueForKey:@"isFinished"];
}

- (void)setCancelled:(BOOL)cancelled
{
    [self willChangeValueForKey:@"isCancelled"];
    _cancelled = cancelled;
    [self didChangeValueForKey:@"isCancelled"];
}

@end

NSOperation执行时, 发起NSURLSessionDownloadTask的下载任务(执行resume方法), 然后等待该任务下载完成, 才去更新NSOperation的下载完成状态. 然后NSOperationQueue才能发起下一个任务的下载.

在初始化方法中, 构建好NSURLSessionDownloadTask对象, 及下载所需的一些配置等.

- (void)p_setupDownload {
    NSURLSessionConfiguration *config = [NSURLSessionConfiguration defaultSessionConfiguration];
    self.urlSession = [NSURLSession sessionWithConfiguration:config
                                                    delegate:self
                                               delegateQueue:[NSOperationQueue mainQueue]];

    NSURL *url = [NSURL URLWithString:self.downloadItem.urlString];
    NSURLRequest *request = [NSURLRequest requestWithURL:url
                                             cachePolicy:NSURLRequestReloadIgnoringLocalCacheData
                                         timeoutInterval:kTimeoutIntervalDownloadOperation];
    self.downloadTask = [self.urlSession downloadTaskWithRequest:request];
    self.downloadTask.taskDescription = self.downloadItem.urlString;
}

重写其start, main和cancel方法:

/**
 必须重写start方法.
 若不重写start, 则cancel掉一个op, 会导致queue一直卡住.
 */
- (void)start
{
//    NSLog(@"%s %@", __func__, self);

    // 必须设置finished为YES, 不然也会卡住
    if ([self p_checkCancelled]) {
        return;
    }

    self.executing  = YES;

    [self main];
}

- (void)main
{
    if ([self p_checkCancelled]) {
        return;
    }

    [self p_startDownload];

    while (self.executing) {
        if ([self p_checkCancelled]) {
            return;
        }
    }
}

- (void)cancel
{
    [super cancel];

    [self p_didCancel];
}

在p_startDownload方法中发起下载:

- (void)p_startDownload
{
    [self.downloadTask resume];
}

使用NSURLSessionDownloadDelegate来更新下载状态

实现该协议的回调方法, 更新下载进度, 下载完成时更新状态.

- (void)URLSession:(NSURLSession *)session
      downloadTask:(NSURLSessionDownloadTask *)downloadTask
didFinishDownloadingToURL:(NSURL *)location
{
    // xxx
    [self p_done];
    // xxx
}

/* Sent periodically to notify the delegate of download progress. */
- (void)URLSession:(NSURLSession *)session
      downloadTask:(NSURLSessionDownloadTask *)downloadTask
      didWriteData:(int64_t)bytesWritten
 totalBytesWritten:(int64_t)totalBytesWritten
totalBytesExpectedToWrite:(int64_t)totalBytesExpectedToWrite
{
    CGFloat progress = 1.0 * totalBytesWritten / totalBytesExpectedToWrite;
    // xxx
    // 更新下载进度等
    // xxx
}

- (void)p_done
{
//    NSLog(@"%s %@", __func__, self);

    [self.urlSession finishTasksAndInvalidate];
    self.urlSession = nil;

    self.executing  = NO;
    self.finished   = YES;
}

使用NSOperationQueue来管理串行下载队列

NSOperation中发起下载之后, 并不会立即设置其finished为YES, 而是会有一个while循环, 一直等到NSURLSessionDownloadDelegate的回调方法执行, 才会更新其finished状态.

而NSOperationQueue的特点就是上一个NSOperation的finished状态未置为YES, 不会开始下一个NSOperation的执行.

设置优先级

对NSOperation的优先级进行设置即可.

CSDownloadOperationQueue *queue = [CSDownloadOperationQueue sharedInstance];
CSDownloadOperation *op = [[CSDownloadOperation alloc] initWithDownloadItem:downloadItem
                                                               onOperationQueue:queue];
op.downloadDelegate = self;

// AR背景的优先级提升
op.queuePriority = NSOperationQueuePriorityHigh;

获取下载进度及下载完成状态

通过实现CSDownloadOperationQueueDelegate, 以观察者的身份来接收下载进度及下载完成状态.

// MARK: - CSDownloadOperationQueueDelegate

/**
 CSDownloadOperationQueueDelegate通知obsever来更新下载进度
 */
@protocol CSDownloadOperationQueueDelegate 

@optional
- (void)CSDownloadOperationQueue:(CSDownloadOperationQueue *)operationQueue
               downloadOperation:(CSDownloadOperation *)operation
             downloadingProgress:(CGFloat)progress;

- (void)CSDownloadOperationQueue:(CSDownloadOperationQueue *)operationQueue
               downloadOperation:(CSDownloadOperation *)operation
                downloadFinished:(BOOL)isSuccessful;

@end

注意这里观察者模式的使用:
observer为继承delegate的对象, 内存管理语义当然为weak.

// MARK: - observer

/**
 use observer to notify the downloading progress and result
 */
- (void)addObserver:(id)observer;
- (void)removeObserver:(id)observer;

所以, 需要使用NSValue的nonretainedObjectValue. 除此之外, 可以使用NSPointerArray来实现弱引用对象的容器.

- (NSMutableArray  *)observers {
    if (!_observers) {
        _observers = [NSMutableArray array];
    }

    return _observers;
}

- (void)addObserver:(id)observer {
    @synchronized (self.observers) {
        BOOL isExisting = NO;

        for (NSValue *value in self.observers) {
            if ([value.nonretainedObjectValue isEqual:observer]) {
                isExisting = YES;
                break;
            }
        }

        if (!isExisting) {
            [self.observers addObject:[NSValue valueWithNonretainedObject:observer]];
            NSLog(@"@");
        }
    }
}

- (void)removeObserver:(id)observer {
    @synchronized (self.observers) {
        NSValue *existingValue = nil;

        for (NSValue *value in self.observers) {
            if ([value.nonretainedObjectValue isEqual:observer]) {
                existingValue = value;
                break;
            }
        }

        if (existingValue) {
            [self.observers removeObject:existingValue];
        }
    }
}

Demo地址

CSSerialDownloader