Objective-C KVO

此文实际成于 2015/08/11

KVO 与实例变量

如何正确的对实例变量进行 KVO 编程?

下面是一个简单的带有一个实例变量的类。

@interface KVOObject : NSObject{
@public
    NSString *_foo;
}
@end

@implementation KVOObject  @end

然后是一个测试类,进行 KVO

@interface KVOObjectDemo : NSObject
@property (nonatomic,strong) KVOObject *kvoObject;
@end

@interface KVOObjectDemo : NSObject
@property (nonatomic,strong) KVOObject *kvoObject;
@end

NSString * const fooKeyPath = @"_foo";

@implementation KVOObjectDemo

- (instancetype)init
{
    self = [super init];
    if (self) {
        _kvoObject = [KVOObject new];
        [_kvoObject addObserver:self forKeyPath:fooKeyPath options:NSKeyValueObservingOptionNew context:nil];
    }
    return self;
}

- (void)observeValueForKeyPath:(NSString *)keyPath ofObject:(id)object change:(NSDictionary *)change context:(void *)context
{
    NSLog(@"%s keyPath:%@",__FUNCTION__,keyPath);
    if ([fooKeyPath isEqualToString:keyPath]) {
        NSLog(@"foo value changed to \"%@\"  instance value:\"%@\"",change[NSKeyValueChangeNewKey],_kvoObject->_foo);
    } else {
        [super observeValueForKeyPath:keyPath ofObject:object change:change context:context];
    }
}

- (void)dealloc
{
    printf("dealloc");
    [_kvoObject removeObserver:self forKeyPath:fooKeyPath];
}

@end

测试代码:

         KVOObjectDemo *kvodemo = [KVOObjectDemo new];
         kvodemo.kvoObject->_foo = @"good";
         [kvodemo.kvoObject setValue:@"really cool" forKey:fooKeyPath];
  1. 首先是设置 fooKeyPath_foo
    运行输出结果如下 :
2015-08-11 08:41:06.684 ObjcDemo[34376:17203392] -[KVOObjectDemo observeValueForKeyPath:ofObject:change:context:] keyPath:_foo
2015-08-11 08:41:06.684 ObjcDemo[34376:17203392] foo value changed to "really cool"  instance value:"really cool"
dealloc

结果显示 KVO 编程成功。

  1. 再设置 fooKeyPathfoo
    运行输出结果如下 :
2015-08-11 08:43:16.816 ObjcDemo[34426:17204277] -[KVOObjectDemo observeValueForKeyPath:ofObject:change:context:] keyPath:foo
2015-08-11 08:43:16.817 ObjcDemo[34426:17204277] foo value changed to "really cool"  instance value:"really cool"
dealloc

结果也是 OK 的。

查看文档发现 setValue:forKey: 帮我们做了大量的事情。

setValue:foKey: 的默认搜索顺序

  1. 搜索接收类 与 set<Key>: 匹配的 setter
  2. 如果没有找到 setter 并且类方法 accessInstanceVariableDirectly 返回 YES (此类方法,默认返回 YES)
    搜索接收类中实例变量的名字与 _<key>,_is<Key>,<key>,is<Key> 匹配的实例变量。
  1. 如果匹配的 setter 或者实例变量找到了,将用于赋值。如果有必要的话,
    值将以在Representing Non-Object Values 讨论的方式从对象中抽取出来。

  2. 如果都没有搜索到,将调用接收者的 setValue:forUndefinedKey:, 此方法的默认实现是抛出 NSUndefinedKeyException ,你可以重写些方法。

  3. 如果有对应的 setter,并且如果参数类型不是一个对象指针,但是值为 nil,此时将调用。 -setNilValueForKey:
    其默认实现是抛出NSInvalidArgumentException.但你可以重写此方法。如果是其他类型,在调用相应方法时 NSNumber/NSValue 转换会提前进行。

参考: Accessor Search Implementation Details

KVO 的几个选项

public struct NSKeyValueObservingOptions:OptionSetType{
    public static var New: NSKeyValueObservingOptions { get }
    public static var Old: NSKeyValueObservingOptions { get }
    @available(iOS 2.0, *)
    public static var Initial: NSKeyValueObservingOptions { get }
    @available(iOS 2.0, *)
    public static var Prior: NSKeyValueObservingOptions { get }
}

在 observe 回调方法:

    override func observeValueForKeyPath(keyPath: String?, ofObject object: AnyObject?, change: [String : AnyObject]?, context: UnsafeMutablePointer<Void>) {
   }

有这么一个参数: change: [String : AnyObject]?
他是一个字典。我们知道 我们使用 KVO 就是想当某个值变化的时候通知我们。告诉我们值的变化。
如果 KVO 选项中带有 .New 表示变更列表中需要包含新的值,
.Old 表示变更列表中带上新的值。

.Initial 这个选项是新加的, 这是用来处理这种场景的,就是当我们添加此 observer时是否应该马上
调用的observeValueForKeyPath:.... 这个函数。来告诉此方法要感兴趣的的属性现在的值。

一些错误

注册了某一个KeyPath 但是没有处理会报错

super.observeValueForKeyPath(keyPath, ofObject: object, change: change, context: context)

2015-11-16 12:13:17.554 BXLoadMoreControl_Example[9020:15633890] *** Terminating app due to uncaught exception 'NSInternalInconsistencyException', reason: '<BXLoadMoreControl.BXLoadMoreControlHelper: 0x7fef426438c0>: An -observeValueForKeyPath:ofObject:change:context: message was received but not handled.
Key path: contentOffset
Observed object: <UITableView: 0x7fef4281c000; frame = (0 0; 320 568); clipsToBounds = YES; autoresize = W+H; gestureRecognizers = <NSArray: 0x7fef42450680>; layer = <CALayer: 0x7fef42447980>; contentOffset: {0, 0}; contentSize: {600, 0}>

Observer 没有移除,但是对象已经被释放

Terminating app due to uncaught exception 'NSInternalInconsistencyException', reason: 'An instance 0x15e44460 of class AVAudioPlayer was deallocated while key value observers were still registered with it. Current observation info: <NSKeyValueObservationInfo 0x15e42630> (
<NSKeyValueObservance 0x15ea17b0: Observer: 0x15d71a00, Key path: currentTime, Options: <New: YES, Old: NO, Prior: NO> Context: 0x15d71ba8, Property: 0x15ea1770>

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

推荐阅读更多精彩内容