iOS中使用NSProgress类来创建UI进度条的方法详解

一、引言

在ios7之前，系统一直没有提供一个完整的框架来描述任务进度相关的功能。这使得在开发中进行耗时任务进度的监听将什么麻烦，在ios7之后，系统提供了nsprogress类来专门报告任务进度。

二、创建单任务进度监听器

单任务进度的监听是nsprogress最简单的一种运用场景，我们来用定时器模拟一个耗时任务，示例代码如下：

@interface viewcontroller ()
{
 nsprogress * progress;
}
@end

@implementation viewcontroller

- (void)viewdidload {
 [super viewdidload];
 // do any additional setup after loading the view, typically from a nib.
 //这个方法将创建任务进度管理对象 unitcount是一个基于ui上的完整任务的单元数
 progress = [nsprogress progresswithtotalunitcount:10];
 nstimer * timer = [nstimer scheduledtimerwithtimeinterval:1 target:self selector:@selector(task) userinfo:nil repeats:yes];
 //对任务进度对象的完成比例进行监听
 [progress addobserver:self forkeypath:@"fractioncompleted" options:nskeyvalueobservingoptionnew context:nil];
}
- (void)observevalueforkeypath:(nsstring *)keypath ofobject:(id)object change:(nsdictionary *)change context:(void *)context

{
 nslog(@"进度= %f",progress.fractioncompleted);
}
-(void)task{
 //完成任务单元数+1
 
 if (progress.completedunitcount<progress.totalunitcount) {
  progress.completedunitcount +=1;
 }
 
}

上面的示例代码中，fractioncompleted属性为0-1之间的浮点值，为任务的完成比例。nsprogress对象中还有两个字符串类型的属性，这两个属性将进度信息转化成固定的格式：

//显示完后比例 如：10% completed
@property (null_resettable, copy) nsstring *localizeddescription;
//完成数量 如：1 of 10
@property (null_resettable, copy) nsstring *localizedadditionaldescription;

三、创建多任务进度监听器

上面演示了只有一个任务时的进度监听方法，实际上，在开发中，一个任务中往往又有许多子任务，nsprogress是以树状的结构进行设计的，其支持子任务的嵌套，示例如下：

- (void)viewdidload {
 [super viewdidload];
 // do any additional setup after loading the view, typically from a nib.
 //这个方法将创建任务进度管理对象 unitcount是一个基于ui上的完整任务的单元数
 progress = [nsprogress progresswithtotalunitcount:10];
 //对任务进度对象的完成比例进行监听
 [progress addobserver:self forkeypath:@"fractioncompleted" options:nskeyvalueobservingoptionnew context:nil];
 //向下分支出一个子任务 子任务进度总数为5个单元 即当子任务完成时 父progerss对象进度走5个单元
 [progress becomecurrentwithpendingunitcount:5];
 [self subtaskone];
 [progress resigncurrent];
 //向下分出第2个子任务
 [progress becomecurrentwithpendingunitcount:5];
 [self subtaskone];
 [progress resigncurrent];
}

-(void)subtaskone{
 //子任务总共有10个单元
 nsprogress * sub =[nsprogress progresswithtotalunitcount:10];
 int i=0;
 while (i<10) {
  i++;
  sub.completedunitcount++;
 }
}

- (void)observevalueforkeypath:(nsstring *)keypath ofobject:(id)object change:(nsdictionary *)change context:(void *)context

{
 nslog(@"= %@",progress.localizedadditionaldescription);
}

nsprogress的这种树状设计模式乍看起来确实有些令人费解，有一点需要注意，becomecurrentwithpendingunitcount:方法的意义是将此nsprogress对象注册为当前线程任务的根进度管理对象，resigncurrent方法为取消注册，这两个方法必须成对出现，当一个nsprogress对象被注册为当前线程的根节点时，后面使用类方法 progresswithtotalunitcount:创建的nsprogress对象都默认作为子节点添加。

四、ios9之后进行多任务进度监听的新设计方法

        正如上面的例子所演示，注册根节点的方式可读性很差，代码结构也不太清晰，可能apple的工程师们也觉得如此，在ios9之后，nsprogress类中又添加了一些方法，通过这些方法可以更加清晰的表达进度指示器之间的层级结构，示例代码如下：

- (void)viewdidload {
 [super viewdidload];
 // do any additional setup after loading the view, typically from a nib.
 //这个方法将创建任务进度管理对象 unitcount是一个基于ui上的完整任务的单元数
 progress = [nsprogress progresswithtotalunitcount:10];
 //对任务进度对象的完成比例进行监听
 [progress addobserver:self forkeypath:@"fractioncompleted" options:nskeyvalueobservingoptionnew context:nil];
 //创建子节点
 nsprogress * sub = [nsprogress progresswithtotalunitcount:10 parent:progress pendingunitcount:5];
 nsprogress * sub2 = [nsprogress progresswithtotalunitcount:10 parent:progress pendingunitcount:5];
 for (int i=0; i<10; i++) {
  sub.completedunitcount ++;
  sub2.completedunitcount ++;
 }
}

如上面代码所示，代码结构变得更加清晰，可操作性也更强了。

五、一点小总结

//获取当前线程的进度管理对象根节点
//注意：当有nsprogress对象调用了becomecurrentwithpendingunitcount:方法后，这个方法才能获取到
+ (nullable nsprogress *)currentprogress;
//创建一个nsprogress对象，需要传入进度的单元数量
+ (nsprogress *)progresswithtotalunitcount:(int64_t)unitcount;
//和上一个方法功能相似 ios9之后的新方法
+ (nsprogress *)discreteprogresswithtotalunitcount:(int64_t)unitcount;
//ios9之后的新方法 创建某个进度指示器节点的子节点
+ (nsprogress *)progresswithtotalunitcount:(int64_t)unitcount parent:(nsprogress *)parent pendingunitcount:(int64_t)portionofparenttotalunitcount;
//nsprogress实例的初始化方法 自父节点参数可以为nil
- (instancetype)initwithparent:(nullable nsprogress *)parentprogressornil userinfo:(nullable nsdictionary *)userinfoornil;
//注册为当前线程根节点
- (void)becomecurrentwithpendingunitcount:(int64_t)unitcount;
//取消注册 与注册方法必须同步出现
- (void)resigncurrent;
//ios9新方法 向一个节点中添加一个子节点
- (void)addchild:(nsprogress *)child withpendingunitcount:(int64_t)inunitcount;
//进度单元总数
@property int64_t totalunitcount;
//已完成的进度单元数
@property int64_t completedunitcount;
//是否可取消
@property (getter=iscancellable) bool cancellable;
//是否可暂停
@property (getter=ispausable) bool pausable;
//进度比例 0-1之间
@property (readonly) double fractioncompleted;
//取消
- (void)cancel;
//暂停
- (void)pause;
//恢复
- (void)resume

六、关于nsprogress对象的用户配置字典

在nsprogress对象的用户字典中可以设置一些特定的键值来进行显示模式的设置，示例如下：

//设置剩余时间 会影响localizedadditionaldescription的值
/*
例如：0 of 10 — about 10 seconds remaining
*/
[progress setuserinfoobject:@10 forkey:nsprogressestimatedtimeremainingkey];
//设置完成速度信息 会影响localizedadditionaldescription的值
/*
例如：zero kb of 10 bytes (15 bytes/sec)
*/
[progress setuserinfoobject:@15 forkey:nsprogressthroughputkey];
/*
下面这些键值的生效 必须将nsprogress对象的kind属性设置为 nsprogresskindfile
nsprogressfileoperationkindkey键对应的是提示文字类型 会影响localizeddescription的值
nsprogressfileoperationkindkey可选的对应值如下：
nsprogressfileoperationkinddownloading： 显示downloading files…
nsprogressfileoperationkinddecompressingafterdownloading： 显示decompressing files…
nsprogressfileoperationkindreceiving： 显示receiving files…
nsprogressfileoperationkindcopying： 显示copying files…
*/
 [progress setuserinfoobject:nsprogressfileoperationkinddownloading forkey:nsprogressfileoperationkindkey];
/*
nsprogressfiletotalcountkey键设置显示的文件总数 
例如：copying 100 files…
*/
 [progress setuserinfoobject:@100 forkey:nsprogressfiletotalcountkey];
//设置已完成的数量
[progress setuserinfoobject:@1 forkey:nsprogressfilecompletedcountkey];

七、在ui中显示进度步骤总结
以下有几个在视图或者视图控制器中显示进度的步骤：
1.在你调用一个长时间运行的任务之前，借助+progresswithtotalunitcount:.方法建立一个nsprogress实例。 参数totalunitcount将会包括“要完成的总工作单元的数量”。
 
有一点很重要，要从ui图层的角度完全理解这个数值；你不会被要求猜测有多少个实际工作对象以及有多少种类的工作单元（字节？像素？文字行数？）。如果你遍历集合并且计划为每一个集合元素调用该实例对象，该参数经常会是1或者也许是一个集合中的元素的数量 。
 
2.使用kvo注册一个进度的fractioncompleted属性的观察者。类似于nsoperation,nsprogress被设计借助kvo来使用。在mac，这使得通过cocoa bindings绑定一个nsprogress实例到一个进度条或者标签上变得非常容易。在ios上，你将会在kvo observer handle中手动更新你的ui。
 
除了fractioncompleted, completedunitcount和totalunitcount属性之外，nsprogress也有一个localizeddescription (@"50% completed")，并且还有一个localized additional description (@"3 of 6")，其能够被绑定到文本标签。kvo通知在改变nsprogress对象属性值的线程中发送，因此确保在你的主线程中手动更新ui。
 
3.当前的进度对象通过调用-becomecurrentwithpendingunitcount:方法建立新的进度对象。在这里，pendingunitcount这个参数相当于“是要被接收者完成的总的工作单元的量要完成的工作的一部分”。你可以多次调用这个方法并且每次传递totalunitcount（本次代码完成的占比）的一部分。在集合元素的迭代示例中，我们将会在每一次迭代中调用[progress becomecurrentwithpendingunitcount:1];
 
4.调用工作对象的方法。由于当前进度是一个局部线程概念，你必须在你调用becomecurrentwithpendingunitcount:的相同的线程中做这个事情。如果工作对象的api被设计成在主线程中调用，那这就不是一个问题，就像我对大部分api的看法那样(brent simmons 也这么认为)。
 
但是如果你的ui 层正在建立一个后台队列并且调用工作对象来同步那个队列，那要确保将 becomecurrentwithpendingunitcount:和resigncurrent放到相同的dispatch_async()块中调用。
 
5.在你的进度对象中调用-resigncurrent。这个方法是和-becomecurrentwith pendingunitcount:相对应的，并且会调用相同的次数 。你可以在实际工作被完成以前调用resigncurrent,因此你不需要等待，直到你得到一个来自工作对象的完成通知。