笔记-KVC的底层实现原理

作者: 佐_笾 | 来源:发表于2019-03-29 21:23 被阅读22次

KVC

KVC（key-Value coding）键值编码，指iOS开发中，可以允许开发者通过Key名直接访问对象的属性，或者给对象的属性赋值。不需要调用明确的存取方法，这样就可以在运行时动态访问和修改对象的属性，而不是在编译时确定。

KVC的定义都是对NSObject的扩展来实现的(Objective-C中有个显示的NSKeyValueCoding类别名，而Swift没有，也不需要)。所以对于所有继承NSObject的类型，也就是基本上所有的Objective-C对象都能使用KVC（一些纯Swift类和结构体是不支持KVC的）

KVC最重要的四个方法

- (nullable id)valueForKey:(NSString *)key;                          //直接通过Key来取值
- (void)setValue:(nullable id)value forKey:(NSString *)key;          //通过Key来设值
- (nullable id)valueForKeyPath:(NSString *)keyPath;                  //通过KeyPath来取值
- (void)setValue:(nullable id)value forKeyPath:(NSString *)keyPath;  //通过KeyPath来设值

NSKeyValueCoding类别中的其他方法

+ (BOOL)accessInstanceVariablesDirectly;
//默认返回YES，表示如果没有找到Set<Key>方法的话，会按照_key，_iskey，key，iskey的顺序搜索成员，设置成NO就不这样搜索

- (BOOL)validateValue:(inout id __nullable * __nonnull)ioValue forKey:(NSString *)inKey error:(out NSError **)outError;
//KVC提供属性值正确性验证的API，它可以用来检查set的值是否正确、为不正确的值做一个替换值或者拒绝设置新值并返回错误原因。

- (NSMutableArray *)mutableArrayValueForKey:(NSString *)key;
//这是集合操作的API，里面还有一系列这样的API，如果属性是一个NSMutableArray，那么可以用这个方法来返回。

- (nullable id)valueForUndefinedKey:(NSString *)key;
//如果Key不存在，且KVC无法搜索到任何和Key有关的字段或者属性，则会调用这个方法，默认是抛出异常。

- (void)setValue:(nullable id)value forUndefinedKey:(NSString *)key;
//和上一个方法一样，但这个方法是设值。

- (void)setNilValueForKey:(NSString *)key;
//如果你在SetValue方法时面给Value传nil，则会调用这个方法

- (NSDictionary<NSString *, id> *)dictionaryWithValuesForKeys:(NSArray<NSString *> *)keys;
//输入一组key,返回该组key对应的Value，再转成字典返回，用于将Model转到字典。

设置

当调用setValue:属性值 forKey:@"name"代码时，底层的执行机制：

程序优先调用setKey:属性值方法，代码通过setter方法完成设置。注意，这里的key是指成员变量名，首字母大小写要符合KVC的命名规范，下同
如果没有找到setName:方法，KVC机制会检查+(BOOL)accessInstanceVariablesDirectly方法有没有返回YES，默认返回的是YES，如果你重写了该方法让其返回NO，那么在这一步KVC会执行setValue: forUndefineKey:方法，不过一般不会这么做。所以KVC机制会搜索该类里面有没有名为_key的成员变量，无论该变量是在.h，还是在.m文件里定义，也不论用什么样的访问修饰符，只要存在_key命名的变量，KVC都可以对该成员变量赋值。
如果该类既没有setKey:方法，也没有_key成员变量，KVC机制会搜索_isKey的成员变量。
同样道理，如果该类没有setKey：方法，也没有_key和_isKey成员变量，KVC还会继续搜索key和isKey的成员变量，再给他们赋值。
如果上面列出的方法或者成员变量都不存在，系统将会执行该对象的setValue：forUndefinedKey：方法，默认是抛出异常。

如果想让这个类禁用KVC，重写+(BOOL)accessInstanceVariablesDirectly方法，让其返回NO即可，这样的话，如果KVC没有找到setKey：时，会直接调用setValue：forUndefinedKey：方法。

取值

当调用valueForKey：@"name"时，KVC对key的搜索方式不同于setValue：属性值 forKey：@"name"，方式如下

首先按getKey，key，isKey的顺序方法查找getter方法。找到的话就会直接调用。
如果是BOOL或者Int等值类型，会将其包装成一个NSNumber对象。
如果上面的getter没有找到，KVC则会查找countOfKey，objectInKeyAtIndex或keyAtIndexes格式的方法。如果找到countOfKey和另外两个方法中的一个，那么就会返回一个可以响应NSArray所有方法的代理集合（他是NSKeyValueArray，是NSArray的子类），调用这个代理集合的方法或者说给这个代理集合发送属于NSArray的方法，就会以countOfKey，objectInKeyAtIndex或keyAtIndexes这几个方法组合的形式调用，还有一个可选的getKey：range：方法。所以如果你想重新定义KVC的一些功能，你可以添加这些方法。注意的是方法名的命名规则要符合KVC的标准命名方法，包括方法签名。
如果上面的方法没有找到，那么会同时查找countOfKey，enumeratorOfKey，memberOfKey格式的方法。如果这三个方法都找到，那么就返回一个可以响应NSSet所有方法的代理集合，和上面一样，给这个代理集合发NSSet的消息，就会以countOfKey，enumeratorOfKey，memberOfKey组合的形式调用。

简单的说就是如果你在自己的类定义了KVC的实现，并且实现了上面的方法，那么你可以将返回的对象当做数组(NSArray)/集合(NSSet)用了。

如果还没有找到，在检查类方法+(BOOL)accessInstanceVariablesDirectly，如果返回YES，那么和之前的设值一样，会按_key,_isKey,key,isKey的顺序搜索成员变量名，这里不推荐这样做，因为这样直接访问实例变量破坏了封装性，使代码更脆弱。如果重写了+(BOOL)accessInstanceVariablesDirectly返回NO的话，那么直接调用valueForUndefinedKey：
如果还没有找到的话，调用valueForUndefinedKey：

使用keyPath

在开发过程中，一个类的成员变量有可能是自定义类或者其它的复杂数据类型，可以先用KVC获取该属性，然后再用KVC来获取这个自定义类的属性。但是比较麻烦，可以使用KVC的键路径keyPath

- (nullable id)valueForKeyPath:(NSString *)keyPath;                  //通过KeyPath来取值
- (void)setValue:(nullable id)value forKeyPath:(NSString *)keyPath;  //通过KeyPath来设值

参考下面的例子：

// Address类
@interface Address()
@property (nonatomic, copy) NSString *country;
@end

// People类
@interface People()
@property (nonatomic, copy) NSString *name;
@property (nonatomic, strong) Address *address;
@property (nonatomic, assign) NSInteger age;
@end

int main(int argc, const char * argv[]) {
    @autoreleasepool {
        People *people1 = [People new];
        Address *add = [Address new];
        add.country = @"China";
        people1.address = add;
        
        NSString *country1 = people1.address.country;
        NSString *country2 = [people1 valueForKeyPath:@"address.country"];
        NSLog(@"country1:%@   country2:%@",country1,country2);
        
        [people1 setValue:@"USA" forKeyPath:@"address.country"];
        country1 = people1.address.country;
        country2 = [people1 valueForKeyPath:@"address.country"];
        NSLog(@"country1:%@   country2:%@",country1,country2);
    }
    return 0;
}
//打印结果 
2016-04-17 15:55:22.487 KVCDemo[1190:82636] country1:China   country2:China
2016-04-17 15:55:22.489 KVCDemo[1190:82636] country1:USA   country2:USA

KVC处理集合

简单集合运算符

@avg、@count、@max、@min、@sum5种，直接从代码种理解其中含义

#import <Foundation/Foundation.h>

@interface Book : NSObject
@property (nonatomic, copy)  NSString *name;
@property (nonatomic, assign)  NSInteger price;
@end

@implementation Book
@end


int main(int argc, const char * argv[]) {
    @autoreleasepool {
        
        Book *book1 = [Book new];
        book1.name = @"The Great Gastby";
        book1.price = 10;
        Book *book2 = [Book new];
        book2.name = @"Time History";
        book2.price = 20;
        Book *book3 = [Book new];
        book3.name = @"Wrong Hole";
        book3.price = 30;
        Book *book4 = [Book new];
        book4.name = @"Wrong Hole";
        book4.price = 40;
        
        NSArray *arrBooks = @[book1,book2,book3,book4];
        NSNumber *sum = [arrBooks valueForKeyPath:@"@sum.price"];
        NSLog(@"sum:%f",sum.floatValue);
        NSNumber *avg = [arrBooks valueForKeyPath:@"@avg.price"];
        NSLog(@"avg:%f",avg.floatValue);
        NSNumber *count = [arrBooks valueForKeyPath:@"@count"];
        NSLog(@"count:%f",count.floatValue);
        NSNumber *min = [arrBooks valueForKeyPath:@"@min.price"];
        NSLog(@"min:%f",min.floatValue);
        NSNumber *max = [arrBooks valueForKeyPath:@"@max.price"];
        NSLog(@"max:%f",max.floatValue);
        
    }
    return 0;
}

打印结果：
sum:100.000000
avg:25.000000
count:4.000000
min:10.000000
max:40.000000

对象运算符

想比较集合运算符稍微复杂，能以数组的方式返回指定的内容

@distinctUnionOfObjects
@unionOfObjects

它们的返回值都是NSArray，区别是前者返回的元素都是唯一的，是去重以后的结果；后者返回的元素是全集。

#import <Foundation/Foundation.h>
@interface Book : NSObject
@property (nonatomic, copy)  NSString *name;
@property (nonatomic, assign)  NSInteger price;
@end

@implementation Book
@end

int main(int argc, const char * argv[]) {
    @autoreleasepool {
        Book *book1 = [Book new];
        book1.name = @"The Great Gastby";
        book1.price = 40;
        Book *book2 = [Book new];
        book2.name = @"Time History";
        book2.price = 20;
        Book *book3 = [Book new];
        book3.name = @"Wrong Hole";
        book3.price = 30;
        Book *book4 = [Book new];
        book4.name = @"Wrong Hole";
        book4.price = 10;
        Book *book5 = [Book new];
        book5.name = @"Wrong Hole1";
        book5.price = 20;
        
        NSArray* arrBooks = @[book1, book2, book3, book4, book5];
        
        NSLog(@"distinctUnionOfObjects");
        NSArray *arrDistinct = [arrBooks valueForKeyPath:@"@distinctUnionOfObjects.price"];
        for (NSNumber *price in arrDistinct) {
            NSLog(@"%f", price.floatValue);
        }
        NSLog(@"unionOfObjects");
        NSArray *arrUnion = [arrBooks valueForKeyPath:@"@unionOfObjects.price"];
        for (NSNumber *price in arrUnion) {
            NSLog(@"%f", price.floatValue);
        }
    }
    return 0;
}

打印结果：
distinctUnionOfObjects
10.000000
20.000000
30.000000
40.000000
unionOfObjects
10.000000
20.000000
30.000000
40.000000
20.000000

KVC处理字典

当对NSDictionary对象使用KVC时，valueForKey的表现行为和objectForKey一样。所以使用valueForKeyPath用来访问多层嵌套的字典比较方便。

KVC里面还有两个关于NSDictionary的方法：

- (NSDictionary<NSString *, id> *)dictionaryWithValuesForKeys:(NSArray<NSString *> *)keys;
- (void)setValuesForKeysWithDictionary:(NSDictionary<NSString *, id> *)keyedValues;

dictionaryWithValuesForKeys:是指输入一组key，返回这组key对应的属性，在组成一个字典。
setValuesForKeysWithDictionary:是用来修改model种对应key的属性。
看代码：

#import <Foundation/Foundation.h>

@interface Address : NSObject

@end

@interface Address()

@property (nonatomic, copy)NSString *country;
@property (nonatomic, copy)NSString *province;
@property (nonatomic, copy)NSString *city;
@property (nonatomic, copy)NSString *district;

@end

@implementation Address

@end


int main(int argc, const char * argv[]) {
    @autoreleasepool {
        
        //模型转字典
        Address *add = [Address new];
        add.country = @"China";
        add.province = @"Guang Dong";
        add.city = @"Shen Zhen";
        add.district = @"Nan Shan";
        NSArray *arr = @[@"country",@"province",@"city",@"district"];
        NSDictionary *dict = [add dictionaryWithValuesForKeys:arr]; //把对应key所有的属性全部取出来
        NSLog(@"%@",dict);
        
        //字典转模型
        NSDictionary *modifyDict = @{@"country" : @"USA", 
                                    @"province" : @"california", 
                                        @"city" : @"Los angle"
                                    };
        [add setValuesForKeysWithDictionary:modifyDict];            //用key Value来修改Model的属性
        NSLog(@"country:%@  province:%@ city:%@", add.country, add.province, add.city);
    }
    return 0;
}

打印结果：
2018-05-05 17:08:48.824653+0800 KVCKVO[35807:6368235] {
city = "Shen Zhen";
country = China;
district = "Nan Shan";
province = "Guang Dong";
}
2018-05-05 17:08:48.825075+0800 KVCKVO[35807:6368235]
country:USA province:california city:Los angle

KVC的使用

动态的取值和设值

利用KVC动态的取值和设值是最基本的用途

用`KVC`来访问和修改私有变量

对于类里的私有属性，Objective-C是无法直接访问的，但是KVC是可以的。
Model和字典转换

这是KVC强大作用的又一次体现，KVC和Objc的runtime组合可以很容易的实现Model和字典的转换。

修改一些控件的内部属性

这也是iOS开发中必不可少的小技巧。众所周知很多UI控件都由很多内部UI控件组合而成的，但是Apple度没有提供这访问这些控件的API，这样我们就无法正常地访问和修改这些控件的样式。
而KVC在大多数情况可下可以解决这个问题。最常用的就是个性化UITextField中的placeHolderText了。

操作集合

Apple对KVC的valueForKey:方法作了一些特殊的实现，比如说NSArray和NSSet这样的容器类就实现了这些方法。所以可以用KVC很方便地操作集合。

用KVC实现高阶消息传递

当对容器类使用KVC时，valueForKey:将会被传递给容器中的每一个对象，而不是容器本身进行操作。结果会被添加进返回的容器中，这样，开发者可以很方便的操作集合来返回另一个集合。

#import <Foundation/Foundation.h>

int main(int argc, const char * argv[]) {
    @autoreleasepool {
        
        NSArray *arrStr = @[@"english", @"franch", @"chinese"];
        NSArray *arrCapStr = [arrStr valueForKey:@"capitalizedString"];
        for (NSString *str  in arrCapStr) {
            NSLog(@"%@", str);
        }
        NSArray *arrCapStrLength = [arrStr valueForKeyPath:@"capitalizedString.length"];
        for (NSNumber *length  in arrCapStrLength) {
            NSLog(@"%ld", (long)length.integerValue);
        }
    }
    return 0;
}

打印结果：
English
Franch
Chinese
7
6
7

方法capitalizedString被传递到NSArray中的每一项，这样，NSArray的每一员都会执行capitalizedString并返回一个包含结果的新的NSArray。
从打印结果可以看出，所有String的首字母都成功以转成了大写。
同样如果要执行多个方法也可以用valueForKeyPath:方法。它先会对每一个成员调用 capitalizedString方法，然后再调用length，因为length方法返回是一个数字，所以返回结果以NSNumber的形式保存在新数组里。

实现KVO

可参考KVO

参考博客：jackyshan

笔记-KVC的底层实现原理

KVC

设置

取值

使用keyPath

KVC处理集合

简单集合运算符

对象运算符

KVC处理字典

KVC的使用

动态的取值和设值

用`KVC`来访问和修改私有变量

修改一些控件的内部属性

操作集合

用KVC实现高阶消息传递

实现KVO

相关文章

网友评论

延伸阅读

深度阅读

栏目导航

热点阅读

android

iOS面试总结

笔记-KVC的底层实现原理

KVC

设置

取值

使用keyPath

KVC处理集合

简单集合运算符

对象运算符

KVC处理字典

KVC的使用

动态的取值和设值

用KVC来访问和修改私有变量

修改一些控件的内部属性

操作集合

用KVC实现高阶消息传递

实现KVO

相关文章

网友评论

延伸阅读

深度阅读

栏目导航

热点阅读

android

iOS面试总结

用`KVC`来访问和修改私有变量