官方文档点这里:NSKeyValueCoding
、Key-Value Coding Programming Guide。
NSKeyValueCoding 非正式协议定义了一个机制:可以通过名字访问对象的属性,不用调用访问器(getter 和 setter),不用当作对象实例变量来访问。
Overview
访问对象属性最基本的函数是 *set Value: for Key: * 和 value For Key:,默认实现是调用对象的访问器(getter 和 setter)或直接访问对象的实例变量。
Symbols
Getting Values
- (id)valueForKey:(NSString *)key;
- 返回和 key 同名的变量的值。
- key 是属性名。
- 查找顺序看 Key-Value Coding Programming Guide 的 Accessor Search Patterns 章节。
- (id)valueForKeyPath:(NSString *)keyPath;
- 返回特定变量的值。
- keyPath 是由 .property 组成的路径,比如 “department.name” 或 “department.manager.lastName”.
- 函数的默认实现是调用 valueForKey: 获取最后的值。
- (NSDictionary<NSString *,id> *)dictionaryWithValuesForKeys:(NSArray<NSString *> *)keys;
- 返回一个字典,包含 keys 和对应的 values。
- 函数的默认实现是对每个 key 调用 valueForKey:。用 NSNull 代替返回的 nil。
- (id)valueForUndefinedKey:(NSString *)key;
- 当 valueForKey: 函数找不到对应的值时,会调用本函数。
- 默认实现是抛出 NSUndefinedKeyException 异常。
- 子类可以重写本函数,返回适当的值。
- (NSMutableArray *)mutableArrayValueForKey:(NSString *)key;
// demo
// 定义一个可变数组
@property (nonatomic, strong) NSMutableArray *mArray;
// 数组初始化
self.mArray = [NSMutableArray new];
[self.mArray addObject:[UIView new]];
// 注册观察者
[self addObserver:self forKeyPath:@"mArray" options: NSKeyValueObservingOptionNew context:NULL];
// 分别测试 5 种情况
// 1、变化类型是 NSKeyValueChangeSetting
self.mArray = nil;
// 2、没有收到通知
[self.mArray removeLastObject];
// 3、没有收到通知
NSMutableArray *ma = [self valueForKey:@"mArray"];
[ma removeLastObject];
// 4、变化类型是 NSKeyValueChangeRemoval
NSMutableArray *ma = [self mutableArrayValueForKeyPath:@"mArray"];
[ma removeLastObject];
// 5、没有收到通知
NSMutableArray *ma = [self mutableArrayValueForKeyPath:@"mArray"];
UIView *view = ma[0];
view.backgroundColor = [UIColor redColor];
- 返回一个可变的数组代理,提供对一个 ordered to-many relationship(比如数组) 的读写权限。
- 文档看不太懂,还是直接上代码吧。文档看懂的同学还请告诉我,文档点这里。
- 通过代码发现,只有通过本方法获取的数组对象,增删改元素时,才会收到通知。
- (NSMutableArray *)mutableArrayValueForKeyPath:(NSString *)keyPath;
- 具体请看 mutableArrayValueForKey:函数。
- (NSMutableSet *)mutableSetValueForKey:(NSString *)key;
- (NSMutableSet *)mutableSetValueForKeyPath:(NSString *)keyPath;
- 返回一个可变的集合代理,提供对一个 unordered to-many relationship(比如集合) 的读写权限。
- 具体参考 mutableArrayValueForKey:函数。
- (NSMutableOrderedSet *)mutableOrderedSetValueForKey:(NSString *)key;
- (NSMutableOrderedSet *)mutableOrderedSetValueForKeyPath:(NSString *)keyPath;
- 返回一个可变、有序的集合对象,提供对一个 uniquing ordered to-many relationship 的读写权限。
- 具体参考 mutableArrayValueForKey:函数。
- unordered to-many relationship 和 uniquing ordered to-many relationship 的区别?知道的同学希望告诉我一下。官方文档:NSSet、NSOrderedSet。
Setting Values
- (void)setValue:(id)value
forKeyPath:(NSString *)keyPath;
- 设置特定变量的值。
- keyPath 是由 .property 组成的路径,比如 “department.name” 或 “department.manager.lastName”.
- 函数默认实现是调用 valueForKey: 获取变量,然后调用 setValue:forKey: 设置变量的值。
- 如果目标对象没有为属性实现访问器,对属性的操作是 retain 而不是 copy 或 assign。(When using this method, and the destination object does not implement an accessor for the value, the default behavior is for that object to retain value rather than copy or assign value.)
- (void)setValuesForKeysWithDictionary:(NSDictionary<NSString *,id> *)keyedValues;
- 默认实现是调用 setValue:forKey: ,会用 NSNull 代替 nil。
- (void)setNilValueForKey:(NSString *)key;
- 当 setValue:forKey: 给标量(scalar value, such as an int or float) 设置 nil 的时候,调用该方法。
- 函数默认抛出一个 NSInvalidArgumentException 异常。
- 子类可以重写函数,用0或其他值来代替 nil,或者再次调用 setValue:forKey: 赋值,或者直接设置变量值。
- (void)setValue:(id)value
forKey:(NSString *)key;
- 设置和 key 同名的变量值为 value。
- 不懂这里的 relate 和 unrelating 会发生什么:If key identifies a to-one relationship, relate the object specified by value to the receiver, unrelating the previously related object if there was one. Given a collection object and a key that identifies a to-many relationship, relate the objects contained in the collection to the receiver, unrelating previously related objects if there were any.
- *set Value: for Key: *使用的查找模式,详情请看 Key-Value Coding Programming Guide 的 Accessor Search Patterns 章节。
- In a reference-counted environment, if the instance variable is accessed directly, value is retained. 这句话什么意思?
- (void)setValue:(id)value
forUndefinedKey:(NSString *)key;
- 当 setValue:forKey: 找不到 key 对应的属性时,调用本函数。
- 默认抛出 NSUndefinedKeyException 异常。子类可以重写函数处理特定的 key。
总结:当 setValue:forKey: 找不到属性,或者给标量设置 nil 时,会调用 setValue: forUndefinedKey: 或者 setNilValueForKey:,两个函数默认抛出异常,子类可以重写处理特殊情况。
Changing Default Behavior
@property(class, readonly) BOOL accessInstanceVariablesDirectly;
- 找不到属性的访问器时,是否直接访问属性的实例变量。
- 默认返回 YES。子类可以重写返回 NO。
Validation
- (BOOL)validateValue:(inout id _Nullable *)ioValue
forKey:(NSString *)inKey
error:(out NSError * _Nullable *)outError;
// demo,验证新值对变量 age 是否有效
- (BOOL)validateAge:(id *)ioValue error:(NSError * __autoreleasing *)outError {
if (*ioValue == nil) {
// Value is nil: Might also handle in setNilValueForKey
*ioValue = @(0);
} else if ([*ioValue floatValue] < 0.0) {
if (outError != NULL) {
*outError = [NSError errorWithDomain:PersonErrorDomain
code:PersonInvalidAgeCode
userInfo:@{ NSLocalizedDescriptionKey
: @"Age cannot be negative" }];
}
return NO;
}
return YES;
}
- 验证指针指向的值,对属性是否合理有效(比如年龄不能为负数)。
- ioValue 是指针,指向属性的新值。本函数可能会修改指针指向的值,使其有效。
- key 是对象的属性名。
- outError 包含 ioValue 指向的值无效的原因。
- 如果新值对属性是有效的,或者新值可以被修改为有效的,则返回 YES,否则返回 NO。
- 函数的默认实现是查找类似 validate<Key>: error: 的函数,找到了就调用并且返回结果,找不到就返回 YES。
- 调用这个函数的对象,不要释放(release) ioValue 或 outError。
- 详细解释点这里 Adding Validation。
- (BOOL)validateValue:(inout id _Nullable *)ioValue
forKeyPath:(NSString *)inKeyPath
error:(out NSError * _Nullable *)outError;
- 请参考函数 validateValue: forKey: error:。
Constants
Key Value Coding Exception Names
const NSExceptionName NSUndefinedKeyException;
- 当 kvc 操作失败时会抛出该异常。
- 异常的 user info dictionary 至少包含两个条目:@"NSTargetObjectUserInfoKey" 和 * @"NSUnknownUserInfoKey"*。详情请看 NSUndefinedKeyException userInfo Keys 部分。
NSUndefinedKeyException userInfo Keys
@"NSTargetObjectUserInfoKey"
@"NSUnknownUserInfoKey"
- NSTargetObjectUserInfoKey: 被执行 kvc 的对象。
- NSUnknownUserInfoKey: kvc 操作使用的 key。
Array operators
NSKeyValueOperator const NSAverageKeyValueOperator; // 求平均值
NSKeyValueOperator const NSCountKeyValueOperator; // 统计总数
NSKeyValueOperator const NSDistinctUnionOfArraysKeyValueOperator; // 获取嵌套数组中不同的值
NSKeyValueOperator const NSDistinctUnionOfObjectsKeyValueOperator; // 获取不同的值
NSKeyValueOperator const NSDistinctUnionOfSetsKeyValueOperator; // 获取嵌套集合中不同的值
NSKeyValueOperator const NSMaximumKeyValueOperator; // 获取最大值
NSKeyValueOperator const NSMinimumKeyValueOperator; // 获取最小值
NSKeyValueOperator const NSSumKeyValueOperator; // 求和
NSKeyValueOperator const NSUnionOfArraysKeyValueOperator; // 获取嵌套数组中的值,不去重
NSKeyValueOperator const NSUnionOfObjectsKeyValueOperator; // 获取所有的值,不去重
NSKeyValueOperator const NSUnionOfSetsKeyValueOperator; // 获取嵌套集合中的值,不去重
- 定义了对数组的操作符,用于 kvc。
- 详细介绍和编程指导点这里:Using Collection Operators。