自动去除nil的NSDictionary和NSArray构造方法(9.25更新)

tips: 9.25更新了一下实现方式, 让实现更简洁, 更科学

背景

NSDictionary和NSArray在日常开发中的重要性和频率无需多言, 但是有时候在构造的时候会要对nil做一系列的判断, 最近作者在整理这类因为nil而导致crash的问题时, 不辞辛苦地给每个潜在为空的点都加上了判断.

思考

为什么我们不在初始化的时候fix掉这个问题呢? 所以这次我打算在构造的时候, 过滤掉nil. (关于这个做法是好是坏, 在最后有一些讨论)

目标

  1. 一般我初始化NSDictionary会用两种方式
    a.literal syntax即NSDictionary *dic = @{key1:value1, key2:value2}; 这是最常用的
    b.NSDictionary *dic = [NSDictionary dictionaryWithObjectsAndKeys:value1, key1, value2, key2, nil]; 这个也相对常见
  2. 初始化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, 仔细想想, 的确可以满足我的需求, 可以重写掉一些构造方法

过程

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

推荐阅读更多精彩内容

  • 转至元数据结尾创建: 董潇伟,最新修改于: 十二月 23, 2016 转至元数据起始第一章:isa和Class一....
    40c0490e5268阅读 1,679评论 0 9
  • 北去的候鸟雁南飞,人们都在寻找着属于自己的远方,不停地追寻着自己的脚步,可谁又曾经想到过脚下的路是那么的坎坷不平,...
    一夜知秋朵阅读 366评论 0 3
  • 早春,花未开草未醒的季节,据说只有田野返青的麦苗可以给春天一个模糊的注解。就是为了那难得的一片青翠吧,周末我们向着...
    闲的发呆阅读 492评论 4 5
  • 我的活动所感便是我好似投入海底,变成一尾鱼儿,自由自在的遨游,吸收日月精华,用海水涤荡灵魂,海无边无际内敛深邃,水...
    一朵野菊阅读 372评论 0 0