自动去除nil的NSDictionary和NSArray构造方法
tips: 9.25更新了一下实现方式, 让实现更简洁, 更科学
背景
NSDictionary和NSArray在日常开发中的重要性和频率无需多言, 但是有时候在构造的时候会要对nil做一系列的判断, 最近作者在整理这类因为nil而导致crash的问题时, 不辞辛苦地给每个潜在为空的点都加上了判断.
思考
为什么我们不在初始化的时候fix掉这个问题呢? 所以这次我打算在构造的时候, 过滤掉nil. (关于这个做法是好是坏, 在最后有一些讨论)
目标
- 一般我初始化NSDictionary会用两种方式
a.literal syntax即NSDictionary *dic = @{key1:value1, key2:value2}; 这是最常用的
b.NSDictionary *dic = [NSDictionary dictionaryWithObjectsAndKeys:value1, key1, value2, key2, nil]; 这个也相对常见 - 初始化NSArray一般也对应是两种, 不过后一种不会出现crash, 所以不罗列了:
c.liter syntax即NSArray *array = @[value1, value2, value3];
以上各初始化方法中, 如果:
a.中任意key或者value为nil, 会导致crash
b. key为空, 造成key value 不匹配, 会crash
c. 任意value为nil, 会crash
方法
1.为了解决这个问题, 首先想到的是runtime的class_replaceMethod以及method_exchangeImplementations, 可能是理解还不够透彻, 尝试了好几回都没有达到预期, 所以就改换策略了
2.再然后考虑过继承, 但是很快被否决, 不能为了这么个问题, 就大张旗鼓地把全部NSDictionary改为XXDictionary, 得不偿失, 纯粹坑爹.
3.最后想到的是category, 仔细想想, 的确可以满足我的需求, 可以重写掉一些构造方法
过程
-
首先要找到重写哪个方法, dictionaryWithObjectsAndKeys:好说, 很直白 , 但是literal sytax要重写哪个呢? 很简单, 故意把nil传进去, 然后开启异常断点, 启动之后就会断住了.如图:
找到重写方法
所以我们需要在category里面重写
+(instancetype)dictionaryWithObjects:(const id _Nonnull __unsafe_unretained *)objects forKeys:(const id<NSCopying> _Nonnull __unsafe_unretained *)keys count:(NSUInteger)cnt
代码实现如下:
+(instancetype)dictionaryWithObjects:(const id _Nonnull __unsafe_unretained *)objects forKeys:(const id<NSCopying> _Nonnull __unsafe_unretained *)keys count:(NSUInteger)cnt
{
NSUInteger keyCnt = 0, valueCnt = 0;
__unsafe_unretained id *objPtr = objects; // 指向objects初始位置
__unsafe_unretained id *keyPtr = keys; // 指向keys初始位置
// 遍历找到为key nil的位置
for ( ; keyCnt < cnt; keyCnt ++, objPtr++) {
if (*objPtr == 0)
{
break;
}
}
// 遍历找到为key nil的位置
for ( ; valueCnt < cnt; valueCnt ++, keyPtr++) {
if (*keyPtr == 0) // 遍历找到为key nil的位置
{
break;
}
}
// 找到最小值
NSUInteger minCnt = MIN(keyCnt, valueCnt);
// 构造合适的key,object array
NSArray *vs = [NSArray arrayWithObjects:objects count:minCnt];
NSArray *ks = [NSArray arrayWithObjects:keys count:minCnt];
// 用下面的方法构造
return [self dictionaryWithObjects:vs forKeys:ks];
}
2.dictionaryWithObjectsAndKeys:
这里主要对keys和objects的数量进行对比, 通过对va_list操作分离出object和key
代码实现:
+(instancetype)dictionaryWithObjectsAndKeys:(id)firstObject, ...
{
NSMutableArray *objects = [[NSMutableArray alloc] init];
NSMutableArray *keys = [[NSMutableArray alloc] init];
id eachObject;
va_list argumentList;
if (firstObject)
{
[objects addObject: firstObject];
va_start(argumentList, firstObject);
NSUInteger index = 1;
while ((eachObject = va_arg(argumentList, id)))
{
(index++ & 0x01) ? [keys addObject: eachObject] : [objects addObject: eachObject];
}
va_end(argumentList);
}
if (objects.count == keys.count)
{
// 直接写空 跳到最后返回
}
else
{
(objects.count < keys.count)?[keys removeLastObject]:[objects removeLastObject];
}
return [self dictionaryWithObjects:objects forKeys:keys];
}
- NSArray的整个过程与Dictionary相差不多, 代码上更简单一些:
找到需要改写的方法为:
+(instancetype)arrayWithObjects:(const id _Nonnull __unsafe_unretained *)objects count:(NSUInteger)cnt
代码实现:
+(instancetype)arrayWithObjects:(const id _Nonnull __unsafe_unretained *)objects count:(NSUInteger)cnt
NSUInteger count = 0;
__unsafe_unretained id *objPtr = objects;
NSMutableArray *ma = [NSMutableArray new];
for ( ; count < cnt; count ++, objPtr++) {
if (*objPtr == 0)
{
break;
}
[ma addObject:*tmp];
}
return [[NSArray alloc] initWithArray:ma];
}
4.编译警告
在__unsafe_unretained id *objPtr = objects;3处会有一个警告, 暂时没有发现影响
结果
如下图所示, 构造NSDictionary无论是key 还是object有nil都不会crash, 当然会丢失掉一个key或者object, 用literal syntax构造array也会主动丢弃掉nil
运行结果
声明一下, 这些代码只作了初步的测试, 在我的测试代码里面是可以跑通的, 同事因为全局替换, 会有很多系统构造也调用新的代码, app没有出现问题, 从一定程度上来说, 替换是成功的.
讨论
crash的确是让大家十分痛恨的一件事情, 无论是开发者还是用户, 但是, 如果没有直接crash, 可能会使得一些bug非常难以发现, app也会有奇奇怪怪的表现, 所以, 具体是想让app更健壮 还是让bug出现的更明显, 这是一个问题.
一个小技巧:
在用NSMutableDictionary的时候, 会塞入一些键值对, 当value为nil时候, 用setObject:forKey:会crash, 但是用setValue:forKey:不会, 但是会移除掉这个key(如有). 值得注意的是, key为nil的情况, 两个方法都会crash.
更新
今天受http://www.cocoachina.com/ios/20150925/13459.html的启发, 在入参上进行了一些修改, 可以把代码变得更加简单, 通知可以直接nil, 而不会截断后面的参数, 通知也推荐看一下他用runtime的的实现, 把一些访问也做了保护;
NSDictionary:
+(instancetype)dictionaryWithObjects:(const id[])objects forKeys:(const id[])keys count:(NSUInteger)cnt
{
NSMutableArray *validKeys = [NSMutableArray new];
NSMutableArray *validObjs = [NSMutableArray new];
for (NSUInteger i = 0; i < cnt; i ++) {
if (objects[i] && keys[i])
{
[validKeys addObject:keys[i]];
[validObjs addObject:objects[i]];
}
}
return [self dictionaryWithObjects:validObjs forKeys:validKeys];
}
NSArray:
+(instancetype)arrayWithObjects:(const id [])objects count:(NSUInteger)cnt
{
NSMutableArray *ma = [NSMutableArray new];
for (NSUInteger i = 0; i < cnt; i ++) {
if (objects[i])
{
[ma addObject:objects[i]];
}
}
return [[NSArray alloc] initWithArray:ma];
}
