断言NSAssert的使用

1. NSAssert

断言(NSAssert)是一个宏,在开发过程中使用NSAssert可以及时发现程序中的问题。

NSAssert声明如下:

#define NSAssert(condition, desc, ...)
  • condition:条件表达式。条件成立时,运行后面程序;不成立时,抛出带有desc描述的异常信息。
  • desc:异常描述,通常为NSString类型对象。用于描述条件表达式不成立的错误信息和参数的占位符。
  • ...:desc字符串中的参数。

假设我们需要判断变量值是否大于5,我们可以用如下代码进行判断。

    int i = 6;
    NSAssert(i>5, @"i must bigger than 5");

运行后,控制台没有任何输出。

把变量i的值改为2,如下所示:

    int i = 2;
    NSAssert(i>5, @"i must bigger than 5");

运行demo,demo会崩溃。在控制台输出如下信息:

*** Assertion failure in -[ViewController viewDidLoad], /Users/ad/Library/Mobile Documents/com~apple~CloudDocs/file2016/NSAssert0709/NSAssert0709/ViewController.m:23
*** Terminating app due to uncaught exception 'NSInternalInconsistencyException', reason: 'i must bigger than 5'

通过控制台输出的信息,可以得到崩溃发生于:ViewController类的viewDidLoad方法中,该文件位于/Users/ad/Library/Mobile Documents/comappleCloudDocs/file2016/NSAssert0709/NSAssert0709/ViewController.m,导致崩溃的代码位于第23行,崩溃原因为:i must bigger than 5。

使用NSAssert时可以对输出信息进行传值。

    int i = 2;
    NSAssert1(i>5, @"The real value is %i", i);

输出为:

*** Assertion failure in -[ViewController viewDidLoad], /Users/ad/Library/Mobile Documents/com~apple~CloudDocs/file2016/NSAssert0709/NSAssert0709/ViewController.m:23
*** Terminating app due to uncaught exception 'NSInternalInconsistencyException', reason: 'The real value is 2'

NSAssert用于Objective-C,NSCAssert用于C语言中。

NSAssert1desc带有一个参数,NSAssert2desc带有两个参数,……,NSAssert5带有五个参数。断言可以带有零至五个参数。

也许你会好奇为什么desc中不使用[NSString stringWithFormat:...]格式,而要有五个NSAssert?因为NSAssert()的实现就是一个宏,因此,要处理异常信息中不同数量参数,就要有多个宏,所以就有了NSAssert(condition, dest)NSAssert1(condition, formatDest, arg1)NSAssert2(condition, formatDest, arg1, arg2)...NSAssert5(...)

NSAssertNSLog都可以在控制台输出,但NSAssert输出后程序立即crash,控制台也会输出程序遇到错误的位置等信息,而NSLog只用于输出信息。

2. NSParameterAssert

如果需要判断传入参数是否符合要求,可以使用NSParameterAssert

- (NSString *)processItem:(NSUInteger)index {
    NSParameterAssert(index<self.myArray.count);
    // do something else
}

如果传入参数index大于myArray数组内元素数量,则程序会崩溃。控制它输出如下:

*** Assertion failure in -[ViewController processItem:], /Users/ad/Library/Mobile Documents/com~apple~CloudDocs/file2016/NSAssert0709/NSAssert0709/ViewController.m:31
*** Terminating app due to uncaught exception 'NSInternalInconsistencyException', reason: 'Invalid parameter not satisfying: index<self.myArray.count'

崩溃信息中会告诉你哪一行代码出错了,崩溃原因是什么。

NSParameterAssert用于Objective-C,NSCParameterAssert用于C语言中。

3. 断言默认只存在于debug版

从Xcode 4.2开始,release版默认关闭了断言。也就是当编译发布版时,任何调用NSAssert的地方都被空行替换。所以,不要在NSAssert内执行任何有效操作。

如果想要在发布版中使用NSAssert,可以在Build Setting中的Enable Foundation Assertions中修改。

AssertRelease.png

4. NSError

NSError应该用在不是编程错误所产生的error,如文件未找到一类非致命性错误。你可以把错误信息发送给调用者,调用者会进行处理并继续执行,也可以用警报控制器展现给用户。

总结

对来源于系统内部的可靠数据使用断言,即用断言来处理绝不应该发生的情况。不要对外部不可靠数据(如用户输入、文件、网络读取等)使用断言,即对于外部不可靠数据或预期会发生的情况应当使用错误处理。同时要避免把需要执行的代码放到断言中,断言可以看成可执行的注释。

来源于系统外部的数据都是不可信的,需要严格检查(通常是错误处理)才能放行到系统内部,这相当于一个守卫。而对于系统内部的交互(如调用其他方法),如果每次也都要去处理输入的数据,也就相当于系统没有可信的边界,会让代码变的臃肿。事实上,在系统内部传递给方法正确的参数是调用者的责任,调用者应该确保传递给所调用方法的数据是符合要求的。这样就隔离了不可靠的外部环境和可靠的内部环境,降低复杂度。

但在开发阶段,代码极可能存在缺陷,有可能是处理外部数据的逻辑不周全或调用内部方法的代码存在错误,最终造成调用失败。这个时候,断言就可以发挥作用,用来确诊到底哪一部分问题导致程序出错。在清理了所有缺陷后,内外有别的信用体系就建立起来了。等到发行版的时候,这些断言就没有存在的必要了。

单元测试可能是一个更好的方法,但有些情况下(如复杂的算法过程中),我们希望在代码中执行检查,这时断言将更有效。

参考资料:

  1. What is NSAssert1?
  2. Objective-C: Assertion vs. Exception vs. Error
  3. iOS开发中断言的使用—NSAssert()

欢迎更多指正:https://github.com/pro648/tips/wiki

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 206,214评论 6 481
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 88,307评论 2 382
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 152,543评论 0 341
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 55,221评论 1 279
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 64,224评论 5 371
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,007评论 1 284
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,313评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,956评论 0 259
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,441评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,925评论 2 323
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,018评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,685评论 4 322
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,234评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,240评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,464评论 1 261
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,467评论 2 352
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,762评论 2 345

推荐阅读更多精彩内容

  • NSAssert()是一个宏,用于开发阶段调试程序中的Bug,通过为NSAssert()传递条件表达式来断定是否属...
    小木___Boy阅读 42,481评论 5 103
  • Xcode 已经默认将release环境下的断言取消了, 免除了忘记关闭断言造成的程序不稳定. 所以不用担心 在开...
    Crazy2015阅读 1,394评论 0 1
  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,599评论 18 139
  • 作者:[美] 马歇尔 · 卢森堡出版社:华夏出版社ISBN:978–7–5080–5100–0版次:2014年9月...
    学陟阅读 6,243评论 11 168
  • 女贞子的花即将开了,黄绿发白的花簇浮在枝叶上。整个树冠便是深浅叠加的绿色图层。一只麻雀在花簇上跳跃。风来了,树冠被...
    绿萝宝贝阅读 265评论 14 8