本人在用runtime进行归档时遇到could not set nil as the value for the key
, 写下此文, 结论是在initWithCoder里的setValue:forKey
方法前, 进行value非nil的判断
如果要在iOS中使用归档, 需要遵守<NSCoding>
协议并实现encodeWithCoder
和initWithCode
方法, 然后手写所有属性, 大概代码如下
// 归档方法
- (void)encodeWithCoder:(NSCoder *)aCoder
{
[aCoder encodeObject:self.name forKey:@"name"];
[aCoder encodeInteger:self.age forKey:@"age"];
[aCoder encodeObject:self.gender forKey:@"gender"];
}
// 反归档方法
- (instancetype)initWithCoder:(NSCoder *)aDecoder
{
self = [super init];
if (self != nil) {
self.name = [aDecoder decodeObjectForKey:@"name"];
self.age = [aDecoder decodeIntegerForKey:@"age"];
self.gender = [aDecoder decodeObjectForKey:@"gender"];
}
return self;
}
手写所有属性非常复杂,而且容易出错, 所以网上有使用runtime机制来进行自动归档, 大概代码如下
- (void)encodeWithCoder:(NSCoder *)encoder
{
unsigned int count = 0;
Ivar *ivars = class_copyIvarList([Person class], &count);
for (int i = 0; i<count; i++) {
// 取出i位置对应的成员变量
Ivar ivar = ivars[i];
// 查看成员变量
const char *name = ivar_getName(ivar);
// 归档
NSString *key = [NSString stringWithUTF8String:name];
id value = [self valueForKey:key];
[encoder encodeObject:value forKey:key];
}
free(ivars);
}
- (id)initWithCoder:(NSCoder *)decoder
{
if (self = [super init]) {
unsigned int count = 0;
Ivar *ivars = class_copyIvarList([Person class], &count);
for (int i = 0; i<count; i++) {
// 取出i位置对应的成员变量
Ivar ivar = ivars[i];
// 查看成员变量
const char *name = ivar_getName(ivar);
// 解档
NSString *key = [NSString stringWithUTF8String:name];
id value = [decoder decodeObjectForKey:key];
// 设置到成员变量身上
[self setValue:value forKey:key];
}
free(ivars);
}
return self;
}
然而, 我在实际使用的过程中却遇到一个坑, initWithCoder
中的[self setValue:value forKey:key];
, 归档时, 存的会把用assign
修饰的类型, 比如int
, float
都变成NSNumber
, 取的时候也是NSNumber
, 最后赋值到属性时, 才变成对应的数据类型。 如果该类有只有1个int a属性, 归档时a为0, 系统就把他作为NSNumber
类型的@0
存起来, 取的时候取出@0
, 再[self setValue:value forKey:key];
, 这时, 如果代码加一个属性int b, 重新跑一次程序, 便会crash could not set nil as the value for the key b
, 因为 NSString *key = [NSString stringWithUTF8String:name];
会取得key为@"b", 再回去value为nil, setValue:nil
时就会crash, 之前a虽然也为0, 但是a的value其实是@0, 所以不会crash。
细思极恐, 如果单例类用runtime进行归档, 测试没问题上线, 下次这个单例类加了一个int类型的属性, 测试也不会有问题, 而用户进行增量更新时, 归档的文件没有被删除, 用户就会无限crash。
那为什么测试测不出来呢, 因为如果从来没有归档过的话是不会走initWithCoder, 而走init的。
所以, 我们需要在initWithCoder里的setValue:forKey
方法前, 进行value非nil的判断
还有一点要注意, Ivar *ivars = class_copyIvarList([Person class], &count);
中, 不应使用 [self class]
, 因为如果有个Women类继承Person类, [self class]返回的是Women, 而不是Person, 这样在子类调用父类初始化方法时, 就没有走原来父类应该走的逻辑。
最终代码如下
- (void)encodeWithCoder:(NSCoder *)encoder
{
unsigned int count = 0;
Ivar *ivars = class_copyIvarList([Person class], &count);
for (int i = 0; i<count; i++) {
// 取出i位置对应的成员变量
Ivar ivar = ivars[i];
// 查看成员变量
const char *name = ivar_getName(ivar);
// 归档
NSString *key = [NSString stringWithUTF8String:name];
id value = [self valueForKey:key];
[encoder encodeObject:value forKey:key];
}
free(ivars);
}
- (id)initWithCoder:(NSCoder *)decoder
{
if (self = [super init]) {
unsigned int count = 0;
Ivar *ivars = class_copyIvarList([Person class], &count);
for (int i = 0; i<count; i++) {
// 取出i位置对应的成员变量
Ivar ivar = ivars[i];
// 查看成员变量
const char *name = ivar_getName(ivar);
// 解档
NSString *key = [NSString stringWithUTF8String:name];
// 必须进行非空判断, 不然改代码会crash
if (value) {
id value = [decoder decodeObjectForKey:key];
}
// 设置到成员变量身上
[self setValue:value forKey:key];
}
free(ivars);
}
return self;
}