当 NSDictionary 遇见 nil
Demo project: NSDictionary-NilSafe
问题
相信用 Objective-C 开发 iOS 应用的人对下面的 crash 不会陌生:
*** -[__NSPlaceholderDictionary initWithObjects:forKeys:count:]: attempt to insert nil object from objects[1]
*** setObjectForKey: key cannot be nil
*** setObjectForKey: object cannot be nil
Objective-C 里的 NSDictionary
是不支持 nil
作为 key 或者 value 的。但是总会有一些地方会偶然往 NSDictionary
里插入 nil
value。在我们的项目开发过程中,有两个很常见的场景:
- 记 event log(button click 或者 page impression 之类)的时候,比如:
[Logging log:SOME_PAGE_IMPRESSION_EVENT eventData:@{
@"some_value": someObject.someValue,
}];www.90168.org
- 发 API request 的时候,比如:
NSDictionary *params = @{
@"some_key": someValue,
};
[[APIClient sharedClient] post:someURL params:params callback:callback];
最初,我们的代码里存在很多如下片段:
[Logging log:SOME_PAGE_IMPRESSION_EVENT eventData:@{
@"some_value": someObject.someValue ?: @"",
}];
NSDictionary *params = @{
@"some_key": someValue ?: @"",
};
或者:
NSMutableDictionary *params = [NSMutableDictionary dictionary];
if (someValue) {
params[@"some_key"] = someValue;
}
这样做有几个坏处:
- 冗余代码太多
- 一不小心就会忘记检查 nil,有些 corner case 只有上线出现 live crash 了才会被发现
- 我们的 API 大部分是以 JSON 格式传参的,所以一个
nil
的值不论是传空字符串还是不传,在语义上都不是很正确,甚至还可能会导致一些奇怪的 server bug
所以我们希望 NSDictionary
用起来是这样的:
- 插入
nil
的时候不会 crash - 插入
nil
以后它对应的 key 的确存在,且能取到值(NSNull) - 被 serialize 成 JSON 的时候,被转成 null
- 让
NSNull
更接近nil
,可以吃任何方法不 crash
测试用例
这个任务很适合测试驱动开发,所以可以把上一节的需求简单转化成以下测试用例:
- (void)testLiteral {
id nilVal = nil;
id nilKey = nil;
id nonNilKey = @"non-nil-key";
id nonNilVal = @"non-nil-val";
NSDictionary *dict = @{
nonNilKey: nilVal,
nilKey: nonNilVal,
};
XCTAssertEqualObjects([dict allKeys], @[nonNilKey]);
XCTAssertNoThrow([dict objectForKey:nonNilKey]);
id val = dict[nonNilKey];
XCTAssertEqualObjects(val, [NSNull null]);
XCTAssertNoThrow([val length]);
XCTAssertNoThrow([val count]);
XCTAssertNoThrow([val anyObject]);
XCTAssertNoThrow([val intValue]);
XCTAssertNoThrow([val integerValue]);
}
- (void)testKeyedSubscript {
NSMutableDictionary *dict = [NSMutableDictionary dictionary];
id nilVal = nil;
id nilKey = nil;
id nonNilKey = @"non-nil-key";
id nonNilVal = @"non-nil-val";
dict[nonNilKey] = nilVal;
dict[nilKey] = nonNilVal;
XCTAssertEqualObjects([dict allKeys], @[nonNilKey]);
XCTAssertNoThrow([dict objectForKey:nonNilKey]);
}
- (void)testSetObject {
NSMutableDictionary *dict = [NSMutableDictionary dictionary];
id nilVal = nil;
id nilKey = nil;
id nonNilKey = @"non-nil-key";
id nonNilVal = @"non-nil-val";
[dict setObject:nilVal forKey:nonNilKey];
[dict setObject:nonNilVal forKey:nilKey];
XCTAssertEqualObjects([dict allKeys], @[nonNilKey]);
XCTAssertNoThrow([dict objectForKey:nonNilKey]);
}
- (void)testArchive {
id nilVal = nil;
id nilKey = nil;
id nonNilKey = @"non-nil-key";
id nonNilVal = @"non-nil-val";
NSDictionary *dict = @{
nonNilKey: nilVal,
nilKey: nonNilVal,
};
NSData *data = [NSKeyedArchiver archivedDataWithRootObject:dict];
NSDictionary *dict2 = [NSKeyedUnarchiver unarchiveObjectWithData:data];
XCTAssertEqualObjects([dict2 allKeys], @[nonNilKey]);
XCTAssertNoThrow([dict2 objectForKey:nonNilKey]);
}
- (void)testJSON {
id nilVal = nil;
id nilKey = nil;
id nonNilKey = @"non-nil-key";
id nonNilVal = @"non-nil-val";
NSDictionary *dict = @{
nonNilKey: nilVal,
nilKey: nonNilVal,
};
NSData *data = [NSJSONSerialization dataWithJSONObject:dict options:0 error:NULL];
NSString *jsonString = [[NSString alloc] initWithData:data encoding:NSUTF8StringEncoding];
NSString *expectedString = @"{\"non-nil-key\":null}";
XCTAssertEqualObjects(jsonString, expectedString);
}
以上代码在 demo project 里可以找到,改造以前,所有 case 应该都会 fail,改造的目的是让他们都能通过。
Method Swizzling
根据 crash log,dictionary 主要有三个入口传入 nil object:
- 字面量初始化一个 dictionary 的时候,会调用
dictionaryWithObjects:forKeys:count:
- 直接调用
setObject:forKey
的时候 - 通过下标方式赋值的时候,会调用
setObject:forKeyedSubscript:
所以可以通过 method swizzling,把这四个方法(还有 initWithObjects:forKeys:count:
,虽然没有发现哪里有调用到它)替换成自己的方法,在 key 为 nil 的时候忽略,在 value 为 nil 的时候,替换为 NSNull 再插入。
其中 setObject:forKey
方法因为是通过 class cluster 实现的,所以实际替换的是 __NSDictionaryM
的方法。
以 dictionaryWithObjects:forKeys:count:
为例:
+ (instancetype)gl_dictionaryWithObjects:(const id [])objects forKeys:(const id<NSCopying> [])keys count:(NSUInteger)cnt {
id safeObjects[cnt];
id safeKeys[cnt];
NSUInteger j = 0;
for (NSUInteger i = 0; i < cnt; i++) {
id key = keys[i];
id obj = objects[i];
if (!key) {
continue;
}
if (!obj) {
obj = [NSNull null];
}
safeKeys[j] = key;
safeObjects[j] = obj;
j++;
}
return [self gl_dictionaryWithObjects:safeObjects forKeys:safeKeys count:j];
}
完整代码参见 GitHub 源文件。
引入这个 category 以后,所有测试用例都可以顺利通过了。
NSNull 的安全性
如上修改 NSDictionary 以后,从 dictionary 里拿到 NSNull 的几率就变高了,所以我们希望 NSNull 可以像 nil 一样,接受所有方法调用并且返回 nil/0。
起初,我们用 libextobjc 里的 EXTNil 作为 placeholder 让 null 更安全。后来发觉其实可以参照 EXTNil 的实现直接 swizzle NSNull 本身的方法,让它可以接受所有方法调用:
- (NSMethodSignature *)gl_methodSignatureForSelector:(SEL)aSelector {
NSMethodSignature *sig = [self gl_methodSignatureForSelector:aSelector];
if (sig) {
return sig;
}
return [NSMethodSignature signatureWithObjCTypes:@encode(void)];
}www.90168.org
- (void)gl_forwardInvocation:(NSInvocation *)anInvocation {
NSUInteger returnLength = [[anInvocation methodSignature] methodReturnLength];
if (!returnLength) {
// nothing to do
return;
}
// set return value to all zero bits
char buffer[returnLength];
memset(buffer, 0, returnLength);
[anInvocation setReturnValue:buffer];
}
总结
至此,我们解决了第一节中提到的所有问题,有了一个 nil safe 的 NSDictionary。这个方案在实际项目中使用了一年多,效果良好,唯一遇到过的一个坑是往 NSUserDefaults 里写入带 NSNull 的 dictionary 的时候会 crash:Attempt to insert non-property list object
。当然这不是这个方案本身带来的问题,解决方法是把 dictionary archive 或者 serialize 成 JSON 后再写入 User Defaults,但是话说回来,复杂的结构体还是考虑从 User Defaults 中拿走吧。
当 NSDictionary 遇见 nil的更多相关文章
- NSArray和NSDictionary添加空对象,以及nil和Nil和NULL和NSNull
因为在NSArray和NSDictionary中nil中有特殊的含义(表示列表结束),所以不能在集合中放入nil值.如要确实需要存储一个表示“什么都没有”的值,可以使用NSNull类. NSNull只 ...
- iOS的nil,Null,NSNull的使用
今天做项目时,在数组里面取值时,发现里面有NSNull的对象,然后用数组里面对应的对象赋值时出现各种问题,总是报错.后面经过研究和查资料,总算解决了这一问题. nil用来给对象赋值(Objective ...
- iOS-nil,Nil,NULL的区别
一.简述 1.nil用来给对象赋值(Objective-C中的任何对象都属于id类型) 2.NULL则给任何指针赋值,NULL和nil不能互换 3.nil用于类指针赋值(在Objective-C中类是 ...
- IOS 学习笔记 2015-03-20 O之 nil,Nil,NULL,NSNull
1.oc最好 用nil [ nil 任意方法],不会崩溃 nil 是一个对象值.NULL是一个通用指针(泛型指针). 2. NSNULL,NULL和nil在本质上应该是一样的,NULL和nil其 ...
- objective-C nil,Nil,NULL 和NSNull的小结
nil用来给对象赋值(Object-C的任何对象都属于id类型),NULL则给任何指针赋值,NULL和nil不能互换,nil用于类指针赋值(在Object-C中类是一个对象,是类的meta-class ...
- OC中的野指针,空指针,nil,Nil,NULL,NSNULL小结
周末与一个老朋友吃饭聊天,因为他正在培训班学习iOS开发,就随便聊了几句,发现自己OC基础上的欠缺和一些知识点的混淆.特此整理如下. 1.空指针 没有存储任何内存地址的指针就称为空指针(NULL指针) ...
- ios nil、NULL和NSNull 的使用
nil用来给对象赋值(Objective-C中的任何对象都属于id类型),NULL则给任何指针赋值,NULL和nil不能互换,nil用于类指针赋值(在Objective-C中类是一个对象,是类的met ...
- NSString json 车NSDictionary
NSData *jsonContent = [[userInfo objectForKey:@"acme"] dataUsingEncoding:NSUTF8StringEncod ...
- nil、Nil、NULL与NSNull的区别及应用
总结 nil:OC中的对象的空指针 Nil:OC中类的空指针 NULL:C类型的空指针 NSNull:数值类的空对象 详细解析应用如下: 1.nil 指向一个对象的指针为空 在objc.h中的定义 ...
随机推荐
- 关于Hibernate的关联映射
何为关联映射 由于数据库的表与表之间存在的管理关系,可以分为一对一,一对多和多对多关联,一般情况下,在数据库设计中是通过表的外键来建立各种关系的,在Hibernate中则把数据库表与表之间的关系数据映 ...
- viewpager中彻底性动态添加、删除Fragment
为了解决彻底删除fragment,我们要做的是:1.将FragmentPagerAdapter 替换成FragmentStatePagerAdapter,因为前者只要加载过,fragment中的视图就 ...
- 常用shell命令操作
1.找出系统中所有的*.c 和*.h 文件 (-o 或者) $find / -name "*.cpp" -o -name "*.h" 2.设定 eth0 的 I ...
- SESSION机制
一:Session与Cookie Session:在服务器端创建并存放在服务器的内存中的,Session的内容存储是键值对的列表,格式:名称 | 类型:长度:值 Session的生命周期:在php.i ...
- Java中length,length(),size()区别
length属性:用于获取数组长度. eg: int ar[] = new int{1,2,3} /** * 数组用length属性取得长度 */ int lenAr = ar.length;//此处 ...
- 13.代理模式(Proxy Pattern)
using System; namespace Test { //抽象角色:声明真实对象和代理对象的共同接口. //代理角色:代理对象角色内部含有对真实对象的引用,从而可以操作真实对象, //同时代理 ...
- ASP.NET Web Api 实现数据的分页(转载)
转载地址:http://www.cnblogs.com/fzrain/p/3542608.html 前言 这篇文章我们将使用不同的方式实现手动分页(关于高端大气上档次的OData本文暂不涉及,但有可能 ...
- [Maven] Missing artifact (解决办法)
在使用Eclipse的Maven插件时,经常会遇到Missing artifact的编译错误,特别是在新环境中搭建相关项目时,经常出现类似此问题,今天一位同事又遇到了,经过一顿问题原因查找,始终无法解 ...
- Cygwin的安装与配置
去cygwin的官网去下载: 安装: 初次安装 卸载 使用过程中安装新的工具包 参考http://blog.csdn.net/superbinbin1/article/details/10147421 ...
- 【rqnoj28】[Stupid]愚蠢的宠物
题目描述 背景 大家都知道,sheep有两只可爱的宠物(一只叫神牛,一只叫神菜).有一天,sheep带着两只宠物到狗狗家时,这两只可爱的宠物竟然迷路了…… 描述 狗狗的家因为常常遭到猫猫的攻击,所以不 ...