iOS懒人开发：自动去除字典空值对象,仿系统字典创建方法NSDictionaryOfVariableBindings

说明

模仿系统的快速生成字典的方法NSDictionaryOfVariableBindings并过滤掉值为nil的对象或内容全为空格字符串。

推荐适用场合：网络请求生成参数字典，无需判空。

其他创建字典的地方也可以使用，注意此方法会过滤掉全为空格及@""字符串，如不需要可自行修改。

使用

    NSString *testStr = @"test";
    NSString *nilStr = nil;
    NSString *blankStr = @"   ";
    NSNumber *integerNumber = @124;
    NSNumber *NONumber = @(NO);
    NSNumber *zeroNumer = @0;
    People *peo = [[People alloc] init];
    People *peo_nil = nil;
    NSArray *array = @[];
    NSDictionary *dic = @{};
    
    NSDictionary *param = ZXDictionaryOfVariableBindings(testStr, nil, nilStr, blankStr, integerNumber, NONumber,zeroNumer, peo, peo_nil, array, dic);

param值：

{
    NONumber = 0;
    array =     (
    );
    dic =     {
    };
    integerNumber = 124;
    peo = "";
    testStr = test;
    zeroNumer = 0;
}

可以看到传入的参数可为nil不会崩溃，且生成字典后自动去除了值为nil和全是空格的NSString。

源码

//.h
#define ZXDictionaryOfVariableBindings(...) [Tool _ZXDictionaryOfVariableBindings:@"" # __VA_ARGS__, __VA_ARGS__]

/**
 模仿系统的对象生成字典的宏定义：NSDictionaryOfVariableBindings(...)
 if v1 = @"something"; v2 = nil; v3 = @"something"; v4 = @"";
 ZXDictionaryOfVariableBindings(v1, v2, v3) is equivalent to [NSDictionary dictionaryWithObjectsAndKeys:v1, @"v1", v3, @"v3", nil];
 并且参数的值可为nil,@"", 会自动去除值为nil, @"", @"  "等的对象
 */
+ (NSDictionary *)_ZXDictionaryOfVariableBindings:(NSString *)firstArg, ...;

//.m
+ (NSDictionary *)_ZXDictionaryOfVariableBindings:(NSString *)firstArg, ... {
    firstArg = [firstArg stringByReplacingOccurrencesOfString:@" " withString:@""];
    NSArray *keys = [firstArg componentsSeparatedByString:@","];
    NSMutableDictionary *dic = [NSMutableDictionary dictionaryWithCapacity:keys.count];
    va_list list;
    if (firstArg) {
        va_start(list, firstArg);
        id arg;
        for (NSString *key in keys) {
            arg = va_arg(list, id);
            if (!arg || [arg isKindOfClass:[NSNull class]]) {
                continue;
            }
            if ([arg isKindOfClass:[NSString class]]) {
                if ([[arg stringByTrimmingCharactersInSet:[NSCharacterSet whitespaceAndNewlineCharacterSet]] length] != 0) {
                    [dic setObject:arg forKey:key];
                }
            } else {
                [dic setObject:arg forKey:key];
            }
        }
        va_end(list);
    }
    return dic;
}

原理

废话可不看↓

在开发经常需要创建字典对象，但是创建字典时存入的对象值不能为nil，否则会崩溃。

尤其是在进行网络请求时，更是经常需要对存入字典的对象判空，于是作为一个能少写一行代码绝不多写一个字母的懒癌晚期患者，就想要是创建字典时能自动对传入的对象判空并去除空值对象多好。

于是我就研究了系统的字典快捷创建方法NSDictionaryOfVariableBindings(...)，发现要解决此需求需要了解宏定义的使用，可变参数的使用。

宏定义

NSDictionaryOfVariableBindings初始化字典

创建字典的方法大家都比较熟悉，这里就不再说。

但是有一个根据对象名称创建字典的方法很方便，这里要说一下：

#define NSDictionaryOfVariableBindings(...) _NSDictionaryOfVariableBindings(@"" # __VA_ARGS__, __VA_ARGS__, nil)

这个方法是使用Autolayout时经常使用的一个宏，这个宏可以生成一个变量名到变量值映射的Dictionary。具体使用很简单，不再细说，不知道的同学推荐你们可以使用此方法创建字典，很方便。

使用此宏依旧需要对字典中的对象判空，防止传入空值崩溃，要想自动去除值为nil的对象，要参数传入之后入手，下面就来改造此宏定义自动去除传入的空值。

宏定义中的参数含义

要想改造系统创建字典的方法，首先要知道系统创建字典的原理。

#define NSDictionaryOfVariableBindings(...) _NSDictionaryOfVariableBindings(@"" # __VA_ARGS__, __VA_ARGS__, nil)中有3个参数,下面先搞清楚这三个参数的含义，也就知道了该方法的原理。

@"" # __VA_ARGS__中间#的作用：单个井号的作用是字符串化，将后面的宏参数 用双引号引起来，转为一个C字符串。如：

define GET_NAME(X) #X
int a = 0; 
NSLog(@”%s”,GET_NAME(a)); //output: “a” 
NSLog(@”%s”,GET_NAME(a+3)); //output: “a+3” 
将会得到以下输出：
a 
a+3 

可以看出#，将参数原样转换成字符串常量，如果参数是一个表达式，那么输出这个表达式的原样字符串常量。

前面的@是objc的编译符号，不属于宏操作的对象。如果有宏定义@#expression,出来后就是一个内容是expression的内容的NSString。

__VA_ARGS__表示的是宏定义中的...中的所有参数。可变参数将被统一处理，在这里展开的时候编译器会将__VA_ARGS__直接替换为输入中的所有参数。

回头再看看NSDictionaryOfVariableBindings的定义：

#define NSDictionaryOfVariableBindings(...) _NSDictionaryOfVariableBindings(@"" # __VA_ARGS__, __VA_ARGS__, nil)

如果这样生成两个button的映射：

NSDictionaryOfVariableBindings(button1, button2); 

那么预编译时就会转换成：

_NSDictionaryOfVariableBindings(@"" "button1, button2", button1, button2, nil); 

由于两个常量字符串放在一起就是字符串常量串联，将变成两个字符串常量组合在一起的字符串常量，也就是上面是一个空字符串@""和"button1, button2"串联，所以上面的代码等价于：

_NSDictionaryOfVariableBindings(@"button1, button2", button1, button2, nil); 

那么_NSDictionaryOfVariableBindings函数就可以将它的第一个参数按逗号，分割开作为key，后面就是各个key对应的值了。因此这段代码就创建了一个内容为{ @"button1" = button1, @"button2" = button2 }的Dictionary。

可变参数

再回看宏定义NSDictionaryOfVariableBindings(...),其中...即可变参数，其实可变参数并不少见，比如：

// 日志输出
NSLog(NSString *format, ...);
// NSString实例的创建
+(instancetype)stringWithFormat:(NSString *)format, ...;
// NSArray实例的创建
+(instancetype)arrayWithObjects:(ObjectType)firstObj, ... NS_REQUIRES_NIL_TERMINATION;

可变参数解析也很简单，直接拿封装的源码举例，注释写的很清楚了：

//.m
+ (NSDictionary *)_ZXDictionaryOfVariableBindings:(NSString *)firstArg, ... {
    // 取出第一个参数
    firstArg = [firstArg stringByReplacingOccurrencesOfString:@" " withString:@""];// 去除空格
    NSArray *keys = [firstArg componentsSeparatedByString:@","];
    NSMutableDictionary *dic = [NSMutableDictionary dictionaryWithCapacity:keys.count];
    // 定义一个指向个数可变的参数列表指针
    va_list list;
    if (firstArg) {
        // 初始化变量刚定义的va_list变量，这个宏的第二个参数是第一个可变参数的前一个参数，是一个固定的参数
        va_start(list, firstArg);
        // 用于存放取出的参数,C语言的字符指针, 指针根据offset来指向需要的参数,从而读取参数
        id arg;
        for (NSString *key in keys) {
            // 遍历全部参数 va_arg返回可变的参数(va_arg的第二个参数是你要返回的参数的类型)
            arg = va_arg(list, id);
            if (!arg || [arg isKindOfClass:[NSNull class]]) {
                continue;
            }
            if ([arg isKindOfClass:[NSString class]]) {
                if ([[arg stringByTrimmingCharactersInSet:[NSCharacterSet whitespaceAndNewlineCharacterSet]] length] != 0) {
                    [dic setObject:arg forKey:key];
                }
            } else {
                [dic setObject:arg forKey:key];
            }
        }
        // 清空参数列表，并置参数指针args无效
        va_end(list);
    }
    return dic;
}

其中重点是不像其他字典初始化方法以nil作为传参结束判断的标准。

• 以nil作为传参结束的变参方法：需要在定义方法时标识NS_REQUIRES_NIL_TERMINATION，则初始化时未尾一定要加上nil，如：

+ (instancetype)arrayWithObjects:(id)firstObj, ... NS_REQUIRES_NIL_TERMINATION;

因为这样的方法中没有提供对参数个数的检测，需要判断参数为nil时结束遍历，销毁指针偏移量，否则会崩溃。

• 另外还有不以nil作为结束的变参方法，如NSLog：

FOUNDATION_EXPORT void NSLog(NSString *format, ...) NS_FORMAT_FUNCTION(1,2);
//注意后方的宏定义:NS_FORMAT_FUNCTION(1,2)，我们点击过去之后查看一下
#define NS_FORMAT_FUNCTION(F,A) __attribute__((format(__NSString__, F, A)))

看一下这句代码

__attribute__((format(__NSString__,F, A)))

这句的意思是，参数的第F位是格式化字符串，从A位开始我们开始检查

所以NSLog的第一个参数是一个格式化字符串，通过这个字条串就能获得后面的参数个数，而且能检查参数数量错误。

所以本文创建字典的方法的重点就是用已知个数的可变参数，去除为nil值的对象。

参考链接

• 宏定义：
  
  IOS 宏NSDictionaryOfVariableBindings中的＃
  
  宏定义的黑魔法 - 宏菜鸟起飞手册
  
• 可变参数：
  
  iOS可变参数(va_list)处理
  
  iOS开发中使用可变参数
  
  iOS:在objective-c 使用可变参数
  
• NS_REQUIRES_NIL_TERMINATION/NS_FORMAT_FUNCTION:
  
  OC中的 attribute
  

觉得好用的点个赞❤~