KVC
全称Key-Value Coding(键值编码),是一个基于NSKeyValueCoding协议实现的机制,可通过key对对象的属性进行存取操作,而不是调用明确的存取方法。
常见的API:
// setter方法
- (void)setValue:(id)value forKeyPath:(NSString *)keyPath;
- (void)setValue:(id)value forKey:(NSString *)key;
// getter方法
- (id)valueForKeyPath:(NSString *)keyPath;
- (id)valueForKey:(NSString *)key;
key和keyPath的区别:
keyPath的功能要更强大,keyPath可以对属性进行深层的访问,key则是直接找到对应的value。举个例子:
NSDictionary *dic = @{@"array":@[@"1",@"2",@"1"],
@"dictionary":@{@"name":@"Lily",@"sexy":@"female"}};
NSString *name = [dic valueForKeyPath:@"dictionary.name"];
NSString *name1 = [[dic valueForKey:@"dictionary"] valueForKey:@"name"];
NSLog(@"%@ -- %@",name,name1);; // Lily -- Lily
除此之外keyPath还有一些便捷的用法,参见那些不为人知的KVC;
KVC还可以批量赋值和取值,
- (NSDictionary<NSString *, id> *)dictionaryWithValuesForKeys:(NSArray<NSString *> *)keys;
- (void)setValuesForKeysWithDictionary:(NSDictionary<NSString *, id> *)keyedValues;
使用KVC的setValuesForKeysWithDictionary方法可以进行字典转模型;
setValue:ForKey:的实现原理
调用setValue:ForKey:,会按照setKey:、_setKey:的顺序查找方法实现,找到后传递参数,调用方法;没找到方法,查看+accessInstanceVariablesDirectly方法(即是否直接访问对象成员变量)的返回值。返回NO,调用setValue:forUndefinedKey:并抛出异常NSUnKnownKeyException;返回YES,按照_key、_isKey、key、isKey顺序查找成员变量找到成员变量直接赋值,如果没有找到对应的成员变量调用setValue:forUndefinedKey:并抛出异常NSUnKnownKeyException;
valueForKey:的实现原理
调用valueForKey:会按照getKey、key、isKey、_key顺序查找方法,找到直接调用;如果没有找到方法,查看+accessInstanceVariablesDirectly(即是否直接访问对象成员变量)方法的返回值。返回NO,调用valueForUndefinedKey:并抛出异常NSUnKnownKeyException;返回YES,则按照_key、_isKey、key、isKey顺序查找成员变量,找到成员变量直接取值,如果没有找到成员变量调用valueForUndefinedKey:并抛出异常NSUnKnownKeyException;
异常处理
根据上述setValue:ForKey:和valueForKey:的实现原理,如果没有找到对应的key或keyPath,会调用对应的异常方法。异常方法的默认实现是抛出异常,可以重写下面两个方法进行处理避免程序崩溃。
//取值时
- (id)valueForUndefinedKey:(NSString *)key;
//赋值时
- (void)setValue:(id)value forUndefinedKey:(NSString *)key;
KVO<NSKeyValueObserving>
是一个非正式协议,定义了对象之间观察和通知状态改变的通用机制,即当被观察对象A的某个属性发生改变时,观察者B会收到通知,并作出响应。
KVO使用的条件和步骤:
1.被观察对象必须支持KVC(继承自NSObject的类都支持KVC),变更属性值时执行了setter方法、或者使用了KVC赋值,才会触发KVO机制
2.观察者必须实现-(void)observeValueForKeyPath:ofObject:change:context: 方法
3.被观察者对象要用- (void)addObserver:forKeyPath:options:context:方法注册观察者
4.用完要移除观察者- (void)removeObserver:forKeyPath: 或者- (void)removeObserver:forKeyPath:context:
方法参数说明:
1、- (void)addObserver: forKeyPath:options: context:
/*
observer:观察者对象
keyPath:被观察的属性
options:监听选项,这个值可以是NSKeyValueObservingOptions选项的组合
context:添加观察者时的上下文信息,它可以被用作区分那些绑定同一个keypath的不同对象的观察者。比如说观察一些继承自同一个父类的子类,而这些子类都有一个相同的keyPath
*/
- (void)addObserver:(NSObject *)observer forKeyPath:(NSString *)keyPath options:(NSKeyValueObservingOptions)options context:(nullable void *)context;
NSKeyValueObservingOptions
//设置后会在observeValueForKeyPath方法的change字典里存入更新后的值。
NSKeyValueObservingOptionNew
//设置后会在observeValueForKeyPath方法的change字典里存入更新前的值,也就是原有的值。
NSKeyValueObservingOptionOld
//设置后会在添加观察者的时候立即发送一次通知给观察者,并且在注册观察者方法之前返回。
//也就是在addObserver方法执行之后就立即发送了一次通知。
NSKeyValueObservingOptionInitial
//会在值被改变之前发送一次通知,并且在change字典里多了一个叫notificationIsPrior的key,值是1。
//而且change字典不会包含new(NSKeyValueChangeNewKey)这个key。当然值改变后的那次通知也会发,也就是说会发送两次通知。
NSKeyValueObservingOptionPrior
2、-(void)observeValueForKeyPath:ofObject:change:context:
/*
keyPath:被观察的属性
object:被观察的对象
change:这是一个字典,它包含了属性被修改的一些信息。这个字典中包含的值会根据我们在添加观察者时(addObserver方法)设置的options参数有所变化。
context:同上面的方法
*/
-(void)observeValueForKeyPath:(NSString *)keyPath ofObject:(id)object change:(NSDictionary<NSKeyValueChangeKey,id> *)change context:(void *)context
change字典里面的键值对,系统提供了这些预定义的key供我们使用
NSKeyValueChangeKindKey 可以用@"kind"替代,也就是change[NSKeyValueChangeKindKey]等价于change[@"kind"]
NSKeyValueChangeNewKey 可以用@"new"替代
NSKeyValueChangeOldKey 可以用@"old"替代
NSKeyValueChangeIndexesKey 可以用@"indexes"替代
NSKeyValueChangeNotificationIsPriorKey 可以用@"notificationIsPrior"替代
change字典里面会有哪些key出现取决于在addObserver方法中options参数的设置情况。
NewKey和OldKey,就是options设置NSKeyValueObservingOptionNew和NSKeyValueObservingOptionOld时会在change里加入的键值对。
NSKeyValueChangeNotificationIsPriorKey是在设置了NSKeyValueObservingOptionPrior选项后当被观察的值将要改变(但是还未改变)时发送的通知里会有的key,对应的是一个布尔值。
NSKeyValueChangeKindKey对应的value是一个枚举值,当被观察的值被设置时(setter方法调用时)KindKey对应的值为1(NSKeyValueChangeSetting)。如果观测的值是一个可变数组,那么当数组执行插入,删除,替换时kindKey会对应Insertion,Removal和Replacement。
typedef NS_ENUM(NSUInteger, NSKeyValueChange) {
NSKeyValueChangeSetting = 1,
NSKeyValueChangeInsertion = 2,
NSKeyValueChangeRemoval = 3,
NSKeyValueChangeReplacement = 4,
};
KVO的实现原理
当对一个实例对象的属性添加监听,在程序运行时,会动态的创建一个类NSKVONotifying_XXX继承自该实例对象的类,并修改该实例对象的isa指针指向NSKVONotifying_XXX类。新创建的类对应被观察属性的setter方法实现是_NSSetXXXValueAndNotify函数,_NSSetXXXValueAndNotify内部实现是:
[self willChangeValueForKey:XXX];
// 调用原来的setter实现
[self didChangeValueForKey:XXX];
didChangeValueForKey:内部会调用observerobserveValueForKeyPath:ofObject:change:context:方法;
NSKVONotifying_XXX类会包含以下方法:
- (void)setXXX:(int)age;//内部调用_NSSetXXXValueAndNotify
- (Class)class;//会返回实例对象的类对象,为了屏蔽内部实现,隐藏NSKVONotifying_XXX类的存在;
- (BOOL)_isKVOA; //表示是KVO对象
- (void)dealloc; // 说明添加KVO的对象,在销毁时需要做一些处理工作;
手动通知
默认情况下通知会被自动发送,但我们也可以手动触发。这时候需要在被观察对象的类里面重写+ (BOOL)automaticallyNotifiesObserversForKey:方法。例如被观察对象有一个属性叫"count",我们希望这个属性被修改时的通知由我们手动控制,就需要在被观察对象的类文件里面这样写:
+ (BOOL)automaticallyNotifiesObserversForKey:(NSString *)key{
// 如果属性为count则关闭自动发送通知
BOOL automatic = YES;
if ([key isEqualToString:@"count"]) {
automatic = NO;
} else {
// 对于对象中其它没有处理的属性,我们需要调用[super automaticallyNotifiesObserversForKey:key],以避免无意中修改了父类的属性的处理方式
automatic = [super automaticallyNotifiesObserversForKey:key];
}
return automatic;
}
然后再对"count"属性的setter方法做如下处理:
- (void)setCount:(NSString *) count{
//当两次赋予的值完全相等时,没有必要再发送通知。这个if的条件语句可以根据实际需要自行修改,或者干脆不写。
if (_ count != count) {
[self willChangeValueForKey:@"count"];
_count = count;
[self didChangeValueForKey:@"count"];
}
}
注意 willChangeValueForKey:和didChangeValueForKey:方法在默认自动发送通知的情况下是由系统自动调用的,在手动通知时需要我们自己来调用,并且不应该重写这两个方法。
注册依赖建
有时一个属性的改变需要依赖其他的属性,比如一个叫"fullName"的属性,这个属性依赖于"firstName"和"lastName"。
//fullName的getter方法
- (NSString *)fullName{
return [NSString stringWithFormat:@"%@ %@", _firstName, _lastName];
}
这种情况下如果firstName发生了变化,fullName的值自然也会改变,但是由于没有直接使用setter方法设置fullName,所以如果不做特殊设置的话KVO是不会发送通知的。
这种情况就需要使用注册依赖建来解决。
+ (NSSet<NSString *> *)keyPathsForValuesAffectingValueForKey:(NSString *)key{
NSSet *keyPaths = [super keyPathsForValuesAffectingValueForKey:key];
if ([key isEqualToString:@"fullName"]) {
keyPaths = [keyPaths setByAddingObjectsFromArray:@[@"firstName", @"lastName"]];
}
return keyPaths;
}
这样不论firstName,lastName,fullName中的哪个值发生了变化,监听fullName的KVO都会被触发。
还可以使用下面这个方法来达到同样的目的。这个方法的使用规则是+ (NSSet *)keyPathsForValuesAffecting + 属性名(注意属性名首字母大写)。
+ (NSSet *)keyPathsForValuesAffectingFullName {
return [NSSet setWithObjects:@"firstName", @"lastName", nil];
}