key-value coding

作者: edison0428 | 来源:发表于2017-08-29 15:43 被阅读152次

About key-value coding(关于KVC)

关键值编码是一种机制，使非正式协议NSKeyValueCoding对象采取提供间接访问性能，当一个对象遵守键值编码时，它的属性可以通过字符串参数通过简明的方式进行寻址，这种间接访问机制也可以直接访问实例变量

你通常使用访问器方法访问一个对象的属性。一个get访问器（或getter方法）返回一个属性的值。set访问器（或setter方法）设置一个属性的值。在Objective-C中，你也可以直接访问属性的实例变量。以任何这些方式访问对象属性都很简单，但需要调用特定于属性的方法或变量名，随着属性列表的增长或变化，访问这些属性的代码也必须随之改变。与此相反，键值兼容的对象提供了一个简单的消息传递接口，它的所有属性都是一致的

key-value coding 也是其它一些技术的基本概念，比如：kvo，core data......

Using Key-Value Coding Compliant Objects(使用键值对兼容对象)

一个对象如果是直接或者间接继承于NSObject，
并且都遵守NSKeyValueCoding 协议和一些基本方法的实现(这句话的意思如下，其实nsobject已经遵守了NSKeyValueCoding协议)

0410AF7F-1341-400A-ADD9-9143B03419E0.png

所以其实简单的来说只要满足第一个条件它就有kvc的功能

Key-Value Coding Fundamentals(KVC的基本概念)
Accessing Object Properties(访问对象的属性)

对象通常在接口声明中指定属性，而这些属性属于几个类别中的一个

1 Attributes

这些都是一些简单的值，比如基本类型，NSString ,NSNumber,以及其它一些不可改变类型比如NSColor都是属于Attributes

2 To-one relationships

这些是具有自身属性的可变对象, 对象的属性可以在不改变对象本身的情况下更改，其实可以理解这个属性为自定义对象(我自己的推测理解)

3 To-many relationships

这些是集合对象。你通常使用NSArray或者NSSet持有这样一个集合，虽然自定义集合类也是可能的

把官网的示意图截取下来

1417FE9F-022F-4E3B-A2C5-F22C9233F679.png

为了保持封装性，一个对象通常提供的接口的属性访问器方法。对象的作者可以显式地写这些方法，也可以依赖编译器synthesize 自动地合成它们(set和get方法)，无论哪种方法，在编译之前都得设置好属性名或者方法名

这是直接的，但缺乏灵活性。另一方面，键值兼容的对象提供了一种更一般的机制来使用字符串标识符访问对象的属性。
为了保持封装性，

Identifying an Object’s Properties with Keys and Key Paths

键是标识特定属性的字符串

[myAccount setValue:@(100.0) forKey:@"currentBalance"];

Getting Attribute Value Using key
1. - (nullable id)valueForKey:(NSString *)key;
2.- (nullable id)valueForKeyPath:(NSString *)keyPath;
3.- (NSDictionary<NSString *, id> *)dictionaryWithValuesForKeys:(NSArray<NSString *> *)keys;
4.- (nullable id)valueForUndefinedKey:(NSString *)key;

注意：集合对象，比如NSArray,NSSet,NSDictionary,都不能包含为nil的值，所以如果你在设置值的时候，可以用NSNull对象，NSNull提供单实例表示对象属性的值为nil，默认的实现方法dictionaryWithValuesForKeys: 和setValuesForKeysWithDictionary:将自动转换 NSNull (字典里的参数) and nil (储存的属性)

当你使用一个键路径是处理属性时，如果键路径中的最后一个键是一个多对关系（也就是它引用集合），那么返回的值就是这个键对应所有值的一个集合，比如请求一个键路径的值transactions.payee那么返回一个数组，这个数组包含transactions下payee所有的值

Setting Attribute Values Using Keys
1.- (void)setValue:(nullable id)value forKey:(NSString *)key;
2.- (void)setValue:(nullable id)value forKeyPath:(NSString *)keyPath;
3.- (void)setValue:(nullable id)value forUndefinedKey:(NSString *)key;
4.- (void)setValuesForKeysWithDictionary:(NSDictionary<NSString *, id> *)keyedValues;

在默认的实现中，如果你要给非对象(比如int) 的属性设置nil，那么就会抛出一个异常，如果重写了setNilValueForKey，就不会奔溃，也可以在这个方法里改变值

Using Collection Operators(集合操作)

当你使用valueForKeyPath时，可以嵌入集合运算符在里面，集合运算符是一个小的关键字列表，前面是（@）

A6B7444C-84C7-4523-B054-08888C4846B6.png

集合操作展示三种基本行为类型

Aggregation Operators

以某种方式合并集合的对象,然后返回一个对象，该对象通常与右键路径中命名的属性的数据类型相匹配，但是@count是一个例外，它没有正确的关键路径和总是返回一个NSNumber实例,因为它返回的是集合的个数
1.@avg

NSMutableArray * arr=[[NSMutableArray alloc ]init];
Person * personOne = [[Person alloc ] init];
personOne.age=@"13";
[arr addObject:personOne];
Person * personTwo = [[Person alloc ] init];
personTwo.age=@"14";
[arr addObject: personTwo];
Person * personThree= [[Person alloc ] init];
personThree.age=@"15";
[arr addObject: personThree];
NSLog(@"平均值=%@",arr valueForKeyPath:@"@avg.age");
//14

2.@count
返回一个NSNumber实例集合中对象的数量

NSLog(@"集合个数=%@",arr valueForKeyPath:@"@count"); 
//3

3.@max
在由右键路径命名的集合条目中搜索并返回最大的条目。搜索进行比较使用比较的方法，如：许多基础类定义的，比如NSNumber类。因此，由右键路径指示的属性必须持有对该消息有意义响应的对象。搜索忽略空值集合条目

NSLog(@"最大值=%@",arr valueForKeyPath:@"@max.age");
//15

4.@min

NSLog(@"最小值=%@",arr valueForKeyPath:@"@min.age");
//13

5.@sum

NSLog(@"求和=%@",arr valueForKeyPath:@"@sum.age");
//42

Array Operators

返回与右键路径指示的对象的特定集合相对应的对象数组
1.@distinctUnionOfObjects
创建并返回包含与右键路径指定的属性相对应的集合的不同对象的数组

NSLog(@"返回数组下对象的某个属性的全部值，是个数组=%@",[arr valueForKeyPath:@"@distinctUnionOfObjects.age"]);
    /*
     =(
     15,
     13,
     14
     )

     */

注意：@distinctUnionOfObjects操作者会删除重复的对象，比如如果有三个14，那么就只返回一个14
2.@unionOfObjects
跟@distinctUnionOfObjects相反，它不会删除重复对象，如果有三个14，还是三个14全部返回

NSLog(@"返回数组下对象的某个属性的全部值，是个数组=%@",[arr valueForKeyPath:@"@unionOfObjects.age"]);
    /*
     =(
     13,
     14,
     14
     )

     
     */

Nesting Operators
Representing Non-Object Values(表示非对象值)

简单的总结几句话：setValue的时候如果不是value不是对象，那么转成对象，valueForKey的时候，因为返回的是id，如果是标量类型比如int,float都那么返回的是NSNumber ,把NSNumber转成int或者float，如果是结构体类型，那么返回的就是NSValue，把NSValue转成NSRect,NSPoint,NSSize,NSRange就行

Validating Properties(验证属性)

KVC提供了属性值,用来验证key对应的Value是否可用的方法
validateValue:forKey:error: 和validateValue:forKeyPath:error方法
这个方法的默认实现是去探索类里面是否有一个这样的方法：-(BOOL)validate<Key>:error:如果有这个方法，就调用这个方法来返回，没有的话就直接返回YES


@implementation Person


-(BOOL)validateAge:(id *)value error:(out NSError * _Nullable __autoreleasing *)outError{  //在implementation里面加这个方法，它会验证是否设了非法的value
    NSString* inValue = *value;
    //country = country.capitalizedString;
    if ([inValue isEqualToString:@"10"]) {
        return NO;
    }
    return YES;
}


@end



    Person * personOne =[[Person alloc] init];
    personOne.age=13;
    NSError* error;
    id value = @"10";
    NSString* key = @"age";
    BOOL result = [personOne validateValue:&value forKey:key error:&error]; //如果没有重写-(BOOL)-validate<Key>:error:，默认返回Yes
    if (result) {
        NSLog(@"键值匹配");
        [personOne setValue:value forKey:key];
    }
    else{
        NSLog(@"键值不匹配"); //不能设为日本，基他国家都行
    }
    NSString* age = [personOne valueForKey:@"age"];
    NSLog(@"age:%@",age);
/*
2017-08-29 14:31:27.850 KVC[4580:93769] 键值不匹配
2017-08-29 14:31:27.850 KVC[4580:93769] age:13
*/

Accessor Search Patterns(搜索key的模式)
Setter的基本搜索方式

规则也是：先找相关方法，再找相关变量
1.先去找相关方法：set<Key>
2.那么去判断类的实现文件中有没有实现：+(BOOL)accessInstanceVariablesDirectly，不实现默认返回YES
3.如果返回no，则执行setValue:(id)value forUndefinedKey:(NSString *)key(抛出一个异常，如果实现文件中没有重写该方法，则会奔溃，如果重写了，则不会奔溃，还可以在这个方法给没有找到的key一个替代值)
4.如果返回的yes，则找相关变量：那么按_<key>，_is<Key>，<key>，is<key>的顺序搜索成员名，如果也没找到则执行setValue:(id)value forUndefinedKey:(NSString *)key

Getter的基本搜索方式

总体规则是：先找相关方法，在找相关
1.先去找相关方法，如果相关方法没找到
2.那么去判断类的实现文件中有没有实现：+(BOOL)accessInstanceVariablesDirectly，不实现默认返回YES，
3.如果返回NO,直接执行kvc的:setValue:(id)value forUndefinedKey:(NSString *)key方法(抛出一个异常，如果实现文件中没有重写该方法，则会奔溃，如果重写了，则不会奔溃，还可以在这个方法给没有找到的key一个替代值)
4.如果返回的是yes，则继续再去找相关变量
5.如果还没找到相关，也会执行:setValue:(id)value forUndefinedKey:(NSString *)key方法

相关方法指的是：
1.get<Key>,<key>,is<Key>,或者_<key>(官网上说了还可以有这个方法，但是我试了并没有用，那么就先保险的确定前三个吧)
2.如果上面的getter没有找到，KVC则会查找countOf<Key>,objectIn<Key>AtIndex,<Key>AtIndex格式的方法。如果countOf<Key>和另外两个方法中的要个被找到，那么就会返回一个可以响应NSArray所的方法的代理集合(它是NSKeyValueArray，是NSArray的子类)，调用这个代理集合的方法，或者说给这个代理集合发送NSArray的方法，就会以countOf<Key>,objectIn<Key>AtIndex,<Key>AtIndex这几个方法组合的形式调用。还有一个可选的get<Ket>:range:方法。所以你想重新定义KVC的一些功能，你可以添加这些方法，需要注意的是你的方法名要符合KVC的标准命名方法，包括方法签名
3.还没查到，那么查找countOf<Key>、enumeratorOf<Key>、memberOf<Key>:格式的方法。
如果这三个方法都找到，那么就返回一个可以响应NSSet所有方法的代理集合(collection proxy object)。发送给这个代理集合(collection proxy object)的NSSet消息方法，就会以countOf<Key>、enumeratorOf<Key>、memberOf<Key>:组合的形式调用

相关变量：
那么按_<key>，_is<Key>，<key>，is<key>的顺序直接搜索成员名
这里不推荐这么做，因为这样直接访问实例变量破坏了封装性

Getter的有序集合的搜索方式(比如NSMutableArray)

mutableArrayValueForKey:搜索方式如下：

搜索insertObject:in<Key>AtIndex:、removeObjectFrom<Key>AtIndex:或者insert<Key>:atIndexes、remove<Key>AtIndexes:格式的方法。
如果至少一个insert方法和至少一个remove方法找到，那么同样返回一个可以响应NSMutableArray所有方法的代理集合。那么发送给这个代理集合的NSMutableArray消息方法，以insertObject:in<Key>AtIndex:、removeObjectFrom<Key>AtIndex:、insert<Key>:atIndexes、remove<Key>AtIndexes:组合的形式调用。还有两个可选实现的接口：replaceObjectIn<Key>AtIndex:withObject:、replace<Key>AtIndexes:with<Key>:。
否则，搜索set<Key>:格式的方法，如果找到，那么发送给代理集合的NSMutableArray最终都会调用set<Key>:方法。
也就是说，mutableArrayValueForKey取出的代理集合修改后，用set<Key>:重新赋值回去。这样做效率会差很多，所以推荐实现上面的方法。
否则，那么如果类方法accessInstanceVariablesDirectly返回YES，那么按_<key>，<key>的顺序直接搜索成员名。如果找到，那么发送的NSMutableArray消息方法直接转交给这个成员处理。
再找不到，调用setValue:forUndefinedKey:

Getter的搜索无序集合成员，如：NSSet

mutableSetValueForKey:搜索方式如下：

搜索add<Key>Object:、remove<Key>Object:或者add<Key>:、remove<Key>:格式的方法，如果至少一个insert方法和至少一个remove方法找到，那么返回一个可以响应NSMutableSet所有方法的代理集合。那么发送给这个代理集合的NSMutableSet消息方法，以add<Key>Object:、remove<Key>Object:、add<Key>:、remove<Key>:组合的形式调用。还有两个可选实现的接口：intersect<Key>、set<Key>:。
如果reciever是ManagedObejct，那么就不会继续搜索了。
否则，搜索set<Key>:格式的方法，如果找到，那么发送给代理集合的NSMutableSet最终都会调用set<Key>:方法。也就是说，mutableSetValueForKey取出的代理集合修改后，用set<Key>:重新赋值回去。这样做效率会差很多，所以推荐实现上面的方法。
否则，那么如果类方法accessInstanceVariablesDirectly返回YES，那么按_<key>，<key>的顺序直接搜索成员名。如果找到，那么发送的NSMutableSet消息方法直接转交给这个成员处理。
再找不到，调用setValue:forUndefinedKey:。

关于Getter的搜索比如mutableArrayValueForKey和
mutableSetValueForKey我几乎没有用过，如果有人用的很溜，请指教

总结

相比直接访问KVC的效率会稍低一点，所以只有当你非常需要它提供的可扩展性时才使用它。

key-value coding

About key-value coding(关于KVC)

Using Key-Value Coding Compliant Objects(使用键值对兼容对象)

Key-Value Coding Fundamentals(KVC的基本概念)

Accessing Object Properties(访问对象的属性)

1 Attributes

2 To-one relationships

3 To-many relationships

Identifying an Object’s Properties with Keys and Key Paths

Getting Attribute Value Using key

1. - (nullable id)valueForKey:(NSString *)key;

2.- (nullable id)valueForKeyPath:(NSString *)keyPath;

3.- (NSDictionary<NSString , id> )dictionaryWithValuesForKeys:(NSArray<NSString > )keys;

4.- (nullable id)valueForUndefinedKey:(NSString *)key;

Setting Attribute Values Using Keys

1.- (void)setValue:(nullable id)value forKey:(NSString *)key;

2.- (void)setValue:(nullable id)value forKeyPath:(NSString *)keyPath;

3.- (void)setValue:(nullable id)value forUndefinedKey:(NSString *)key;

4.- (void)setValuesForKeysWithDictionary:(NSDictionary<NSString , id> )keyedValues;

Using Collection Operators(集合操作)

Aggregation Operators

Array Operators

Nesting Operators

Representing Non-Object Values(表示非对象值)

Validating Properties(验证属性)

Accessor Search Patterns(搜索key的模式)

Setter的基本搜索方式

Getter的基本搜索方式

Getter的有序集合的搜索方式(比如NSMutableArray)

Getter的搜索无序集合成员，如：NSSet

总结

相关文章

网友评论

延伸阅读

深度阅读

栏目导航

热点阅读

key-value coding

About key-value coding(关于KVC)

Using Key-Value Coding Compliant Objects(使用键值对兼容对象)

Key-Value Coding Fundamentals(KVC的基本概念)

Accessing Object Properties(访问对象的属性)

1 Attributes

2 To-one relationships

3 To-many relationships

Identifying an Object’s Properties with Keys and Key Paths

Getting Attribute Value Using key

1. - (nullable id)valueForKey:(NSString *)key;

2.- (nullable id)valueForKeyPath:(NSString *)keyPath;

3.- (NSDictionary<NSString *, id> *)dictionaryWithValuesForKeys:(NSArray<NSString *> *)keys;

4.- (nullable id)valueForUndefinedKey:(NSString *)key;

Setting Attribute Values Using Keys

1.- (void)setValue:(nullable id)value forKey:(NSString *)key;

2.- (void)setValue:(nullable id)value forKeyPath:(NSString *)keyPath;

3.- (void)setValue:(nullable id)value forUndefinedKey:(NSString *)key;

4.- (void)setValuesForKeysWithDictionary:(NSDictionary<NSString *, id> *)keyedValues;

Using Collection Operators(集合操作)

Aggregation Operators

Array Operators

Nesting Operators

Representing Non-Object Values(表示非对象值)

Validating Properties(验证属性)

Accessor Search Patterns(搜索key的模式)

Setter的基本搜索方式

Getter的基本搜索方式

Getter的有序集合的搜索方式(比如NSMutableArray)

Getter的搜索无序集合成员，如：NSSet

总结

相关文章

网友评论

延伸阅读

深度阅读

栏目导航

热点阅读

3.- (NSDictionary<NSString , id> )dictionaryWithValuesForKeys:(NSArray<NSString > )keys;

4.- (void)setValuesForKeysWithDictionary:(NSDictionary<NSString , id> )keyedValues;