Key-Value Coding Fundamatals--Accessing Object Properties

键值编码基础-- 访问对象属性

访问对象属性

对象通常在其接口声明中指定属性, 这些属性属于以下几种类别之一:

属性. 指简单值, 例如标量(scalars)、字符串或布尔值。值对象(如NSNumber)和其他不可变类型(如NSColor) 也被视为属性。
一对一关系. 指具有自己属性的可变对象。对象的属性可以在对象本身不变的情况下更改。例如，银行帐户对象(bank account object)可能具有owner属性，该属性是Person对象的实例，该Person对象具有address属性。owner的address可能会更改，而不会更改银行帐户持有的owner。银行帐户的owner没有变更。只有Person的address 发生改变。
一对多关系. 指集合对象。你通常使用NSArray或NSSet保存此类集合的实例，但也可以使用自定义集合类。

清单 2-1中声明的BankAccount对象演示了每种类型的属性。

清单 2-1BankAccount对象的属性

@interface BankAccount : NSObject

@property (nonatomic) NSNumber* currentBalance;              // An attribute
@property (nonatomic) Person* owner;                         // A to-one relation
@property (nonatomic) NSArray<Transaction*>* transactions;   // A to-many relation

@end
复制代码

为了保持封装，对象通常为其接口上的属性提供访问器方法。对象的作者可以显式地编写这些方法，也可以依赖编译器自动合成它们。无论哪种方式，使用这些访问器之一的代码的作者必须在编译之前将属性名称写入代码中。访问器方法的名称成为使用它的代码的静态部分。例如，给定清单2-1中声明的BankAccount对象，编译器会合成一个可以为myAccount实例调用的setter ：

[myAccount setCurrentBalance:@(100.0)];
复制代码

这是直接的，但缺乏灵活性。另一方面，符合键值编码的对象提供了使用字符串标识符访问对象属性的更通用机制。

使用Keys 和 Key Paths标识对象的属性

键(key)是标识特定属性的字符串。通常, 按照惯例, 表示属性的键(key)是代码中显示的属性名。键(key)必须使用 ASCII 编码, 不能包含空格, 并且通常以小写字母开头 (尽管有例外, 如在许多类中的URL属性)。

由于清单 2-1中的BankAccount类是符合键值编码的, 所以它能识别键(即它的属性的名称)owner、currentBalance和transactions 。您也可以通过其键来设置值, 而不是调用setCurrentBalance:方法:

[myAccount setValue:@(100.0) forKey:@"currentBalance"];
复制代码

实际上, 您可以使用不同的键参数通过相同方法来设置myAccount对象的所有属性。因为参数是字符串类型, 所以它可以在运行时操作变量。

键路径Key path是一个用点操作符.来分隔键的字符串, 用于指定要遍历的对象属性序列。序列中第一个键的属性是相对于接收者的, 每个后续键相对于上一个属性的值进行计算。键路径(Key path)对于使用单个方法深入调用对象的层次结构很有用。

例如, 应用于银行帐户实例的键路径owner.address.street是指存储在银行帐户所有者地址中的街道字符串的值, 假设Person和Address类也符合的键值编码。

注意在 Swift 中, 您可以使用#keyPath表达式, 而不是使用字符串来指示键或键路径。这提供了编译时检查的优点, 详见*Using Swift with Cocoa and Objective-C (Swift 4.2) 中的Keys and Key Paths*章节。

使用键获取属性值

对象在遵循NSKeyValueCoding协议时符合键值编码。继承自的对象（NSObject提供协议的基本方法的默认实现）会自动采用此协议的某些默认行为。这样的对象至少实现了以下基于键的基本getter：

valueForKey: - 返回由key参数指定的属性的值。如果根据访问者搜索模式中描述的规则无法找到key命名的属性，则该对象会向自身发送valueForUndefinedKey:消息。valueForUndefinedKey:引发的默认实现抛出NSUndefinedKeyException异常，但是子类可以覆盖此方法并更优雅地处理这种情况。
valueForKeyPath: - 返回相对于接收器的指定键路径的值。keyPath序列中的任何对象都不符合特定key的键值编码 - 即，默认实现valueForKey:无法找到访问器方法 - -那么就会接收valueForUndefinedKey:消息。
dictionaryWithValuesForKeys: - 返回相对于接收器的一组键所对应的值。该方法为数组中的每个键调用valueForKey:。返回的NSDictionary包含数组中所有键的值。

注意集合对象 (如NSArray、 NSSet和NSDictionary) 不能包含nil的值。而是使用NSNull对象表示nil值。NSNull提供一个表示对象属性的nil值的单个实例。dictionaryWithValuesForKeys:的默认实现和相关的setValuesForKeysWithDictionary:会在NSNull (在字典参数中) 和nil(在存储的属性中)之间进行自动转换。

当您使用KeyPath来寻址属性时, 如果键路径中的最后一个键是一对多关系 (即引用集合), 则在多对键的右侧,返回的值是一个包含键的所有值的集合。例如, 请求键路径 "transactions.payee" 的值返回包含所有transaction对象中payee对象的数组。这也适用于KeyPath中的多个数组。KeyPath accounts.transactions.payee返回一个数组，其中包含所有帐户中所有交易的所有收款人对象。

使用键设置属性值

与 getter一样, 符合键值编码的对象也提供了一小组通用setter，其默认行为基于以下NSKeyValueCoding协议的实现NSObject:

setValue:forKey: - 将指定键设置为给定值。setValue:forKey:的默认实现会自动对表示标量和结构体的NSNumber和NSValue对象执行解包操作，并将它们设置到相应的属性中。有关包装(warp)和解包(unwarp)语义的详细信息，请参阅Representing Non-Object Values。

如果接收setter调用的对象中没有对应指定键的属性，该对象将给自己发送一个[setValue:forUndefinedKey:]消息。setValue:forUndefinedKey:的默认实现将抛出NSUndefinedKeyException异常。但是, 子类可以重写此方法以自定义方式处理请求。

setValue:forKeyPath: 在相对于接收者的指定键路径上设置给定值。键路径序列中指定键所对应的对象如果不是键值编码兼容的，将会收到setValue:forUndefinedKey:消息。
setValuesForKeysWithDictionary: 将指定字典中的值设置到接收者的属性中, 使用字典键标识属性。默认实现调用每个键值对的setValue:forKey: , 根据需要用nil替换NSNull对象。

在默认实现中, 当您尝试将非对象属性设置为nil值时, 符合键值编码兼容对象将自己发送一个setNilValueForKey:消息。setNilValueForKey:的默认实现将抛出[NSInvalidArgumentException]异常, 但对象可以重写此方法以替换默认值或标记值, 详见处理非对象值。

使用键简化对象访问

想知道基于key的 getter 和 setter 如何简化代码, 请查看下面的示例。在 macOS 中, NSTableView和NSOutlineView对象的标识符字符串与每个它们的列相关联。如果表的模型对象不是符合键值编码的, 则表的数据源方法将强制检查每个列标识符, 依次查找要返回的正确属性, 如清单 2-2所示。此外, 在将来, 当您向模型中添加另一个属性时, 在本例中为Person 对象, 还必须重新访问数据源方法, 添加另一个条件来测试新属性并返回相关值.

清单 2-2 不基于键值编码的数据源方法的实现

- (id)tableView:(NSTableView *)tableview objectValueForTableColumn:(id)column row:(NSInteger)row {
    id result = nil;
    Person *person = [self.people objectAtIndex:row];

    if ([[column identifier] isEqualToString:@"name"]) {
        result = [person name];
    } else if ([[column identifier] isEqualToString:@"age"]) {
        result = @([person age]);  // Wrap age, a scalar, as an NSNumber
    } else if ([[column identifier] isEqualToString:@"favoriteColor"]) {
        result = [person favoriteColor];
    } // And so on...

    return result;
}

复制代码

另一方面,清单 2-3展示了相同数据源的方法的一个更紧凑的实现, 该数据源方法使用的是键值编码兼容的Person对象。仅使用valueForKey: getter, 数据源方法将使用列标识符作为键返回适当的值。除了更短的时间外, 它还更通用, 因为在以后添加新列时, 只要列标识符始终与模型对象的属性名称匹配, 它就会继续保持不变。

清单 2-3基于键值编码的数据源方法的实现

- (id)tableView:(NSTableView *)tableview objectValueForTableColumn:(id)column row:(NSInteger)row {
    return [[self.people objectAtIndex:row] valueForKey:[column identifier]];
}
复制代码

由于笔者水平有限，文中如果有错误的地方，或者有更好的方法，还望大神指出。附上本文的所有 demo 下载链接，【GitHub】。如果你看完后觉得对你有所帮助，还望在 GitHub 上点个 star。赠人玫瑰，手有余香。

[译]2.1-Key-Value Coding Programming Guide 官方文档第二部分