鍵值編碼(Key-Value Coding,簡稱 KVC)是一套由 Foundation 框架提供的機制,讓你能夠透過字串鍵(key)間接讀寫物件的屬性,而不必直接呼叫存取器方法。
@interface Hello : NSObject
@property NSString *greeting;
@end
@implementation Hello
- (id)init {
if ((self = [super init])) {
_greeting = @"Hello";
}
return self;
}
@end
int main(int argc, const char * argv[]) {
@autoreleasepool {
Hello *hello = [Hello new];
// 等同於 hello.greeting = @"Hi"
[hello setValue:@"Hi" forKey:@"greeting"];
// 等同於 NSLog(@"%@", hello.greeting)
NSLog(@"%@", [hello valueForKey:@"greeting"]);
}
return 0;
}
相較於傳統的屬性存取方式,鍵值編碼屬於「基於組態」的存取模式,能夠降低程式碼之間的耦合度、精簡語句,同時讓後續的維護與擴充更為容易。
KVC 透過「鍵」與「鍵路徑」來定位屬性。鍵是用來標識屬性的字串;鍵路徑則描述了一條需要逐層遍歷的屬性鏈。鍵路徑同樣可以搭配點語法使用:
@interface Hello : NSObject
@property NSString *greeting;
@end
@implementation Hello
- (id)init {
if ((self = [super init])) {
_greeting = @"Hello";
}
return self;
}
@end
@interface Person : NSObject
@property Hello *hello;
@end
@implementation Person
- (id)init {
if ((self = [super init])) {
_hello = [Hello new];
}
return self;
}
@end
int main(int argc, const char * argv[]) {
@autoreleasepool {
Person *person = [Person new];
// 等同於 person.hello.greeting = @"Hi"
[person setValue:@"Hi" forKeyPath:@"hello.greeting"];
// 等同於 NSLog(@"%@", person.hello.greeting)
NSLog(@"%@", [person valueForKeyPath:@"hello.greeting"]);
}
return 0;
}
當存取的鍵並未定義時,可以藉由 NSObject 所遵循的 NSKeyValueCoding 協定中的 valueForUndefinedKey: 方法來妥善處理:
@implementation Person
// ...
- (id)valueForUndefinedKey:(NSString *)key {
// 若傳入的鍵為 hi,則回傳 hello 屬性,否則拋出例外
if ((nil != key) && ([@"hi" isEqualToString:key])) {
return self.hello;
}
[NSException raise:NSUndefinedKeyException format:@"key %@ not defined", key];
return nil;
}
@end
int main(int argc, const char * argv[]) {
@autoreleasepool {
Person *person = [Person new];
// 可以正常存取
NSLog(@"%@", [person valueForKeyPath:@"hi.greeting"]);
// 會拋出例外
NSLog(@"%@", [person valueForKeyPath:@"Hi.greeting"]);
}
return 0;
}
此外,KVC 也提供了值驗證的基礎設施,對應的驗證方法選擇器為 validate<key>:error:,其中 <key> 即為屬性名稱:
@implementation Person
// ...
- (BOOL)validateHello:(id *)value error:(NSError * __autoreleasing *)error {
if (*value == nil) {
if (error != NULL) {
*error = [NSError errorWithDomain:@"Invalid Property Value (nil)" code:1 userInfo:nil];
}
return NO;
}
return YES;
}
@end
int main(int argc, const char * argv[]) {
@autoreleasepool {
Person *person = [Person new];
Hello *hello = [Hello new];
[hello setValue:@"Hi" forKey:@"greeting"];
NSError *error;
BOOL valid = [person validateValue:&hello forKey:@"hello" error:&error];
if (valid) {
[person setValue:hello forKey:@"hello"];
NSLog(@"%@", [person valueForKeyPath:@"hello.greeting"]);
}
}
return 0;
}
鍵值觀察(Key-Value Observing,簡稱 KVO)讓物件能夠監聽另一個物件特定屬性的變化,並在數值改變時收到通知。以下示範如何新增與移除觀察者:
int main(int argc, const char * argv[]) {
@autoreleasepool {
Person *person = [Person new];
Hello *hello = [Hello new];
// 新增觀察者
[person addObserver:hello forKeyPath:@"hello"
options:NSKeyValueObservingOptionNew context:NULL];
// 移除觀察者
[person removeObserver:hello forKeyPath:@"hello"];
}
return 0;
}
許多開發者會好奇 KVO 與通知機制(NSNotification)之間的差異,以下整理幾個關鍵區別:
以下透過一個完整的範例來實作 KVO。首先建立一個被觀察的 Person 類別:
#import <Foundation/Foundation.h>
@interface Person : NSObject
@property (readonly) NSString *fullName; // 唯讀屬性,由 firstName 與 lastName 組合而成
@property NSString *firstName;
@property NSString *lastName;
- (id)initWithFirstName:(NSString *)fname lastName:(NSString *)lname;
@end
#import "Person.h"
#define CodersErrorDomain @"CodersErrorDomain"
#define kInvalidValueError 1
@implementation Person
- (id)initWithFirstName:(NSString *)fname lastName:(NSString *)lname {
if ((self = [super init])) {
_firstName = fname;
_lastName = lname;
}
return self;
}
- (NSString *)fullName {
return [NSString stringWithFormat:@"%@ %@", self.firstName, self.lastName];
}
// 鍵值驗證方法
- (BOOL)validateLastName:(id *)value error:(NSError * __autoreleasing *)error {
// 檢查 lastName 是否為空
if (*value == nil) {
if (error != nil) {
NSDictionary *reason = @{NSLocalizedDescriptionKey: @"Last name cannot be nil"};
*error = [NSError errorWithDomain:CodersErrorDomain code:kInvalidValueError userInfo:reason];
}
return NO;
}
// 檢查是否為空白字串
NSUInteger length = [[(NSString *)*value stringByTrimmingCharactersInSet:[NSCharacterSet whitespaceAndNewlineCharacterSet]] length];
if (length == 0) {
if (error != nil) {
NSDictionary *reason = @{NSLocalizedDescriptionKey: @"Last name cannot be nil"};
*error = [NSError errorWithDomain:CodersErrorDomain code:kInvalidValueError userInfo:reason];
}
return NO;
}
return YES;
}
// 註冊相依鍵:fullName 的值取決於 firstName 與 lastName,
// 當這兩個屬性變動時,應通知 fullName 的觀察者
+ (NSSet *)keyPathsForValuesAffectingValueForKey:(NSString *)key {
NSSet *keyPaths = [super keyPathsForValuesAffectingValueForKey:key];
if ([key isEqualToString:@"fullName"]) {
NSArray *affectingKeys = @[@"firstName", @"lastName"];
keyPaths = [keyPaths setByAddingObjectsFromArray:affectingKeys];
}
return keyPaths;
}
@end
接著建立一個 Coder 類別,作為 Person 的觀察者:
#import <Foundation/Foundation.h>
@class Person;
@interface Coder : NSObject
@property Person *person;
@property NSMutableArray *languages; // 有序集合
@end
#import "Coder.h"
@implementation Coder
// 以下四個方法用於處理有序的一對多關係屬性
- (NSUInteger)countOfLanguages {
return [self.languages count];
}
- (NSString *)objectInLanguagesAtIndex:(NSUInteger)index {
return [self.languages objectAtIndex:index];
}
- (void)insertObject:(NSString *)object inLanguagesAtIndex:(NSUInteger)index {
[self.languages insertObject:object atIndex:index];
}
- (void)removeObjectFromLanguagesAtIndex:(NSUInteger)index {
[self.languages removeObjectAtIndex:index];
}
// 當被觀察屬性的值改變時,被觀察物件會呼叫觀察者的這個方法
- (void)observeValueForKeyPath:(NSString *)keyPath ofObject:(id)object
change:(NSDictionary<NSKeyValueChangeKey,id> *)change
context:(void *)context {
id newValue = change[NSKeyValueChangeNewKey];
NSLog(@"Value changed for %@ object, key path: %@, new value: %@",
[object className], keyPath, newValue);
}
@end
再建立一個 Coders 類別,用來測試無序的一對多關係屬性:
#import <Foundation/Foundation.h>
@class Coder;
@interface Coders : NSObject
@property NSSet *developers; // 無序集合
@end
#import "Coders.h"
@implementation Coders
// 以下三個方法用於處理無序的一對多關係屬性
- (NSUInteger)countOfDevelopers {
return [self.developers count];
}
- (NSEnumerator *)enumeratorOfDevelopers {
return [self.developers objectEnumerator];
}
- (Coder *)memberOfDevelopers:(Coder *)object {
return [self.developers member:object];
}
@end
最後在 main.m 中進行整體測試:
#import <Foundation/Foundation.h>
#import "Person.h"
#import "Coder.h"
#import "Coders.h"
int main(int argc, const char * argv[]) {
@autoreleasepool {
// 建立 Person 物件,並以鍵值編碼取得屬性值
Person *curly = [[Person alloc] initWithFirstName:@"Curly" lastName:@"Howard"];
NSLog(@"Person first name: %@", [curly valueForKey:@"firstName"]);
NSLog(@"Person full name: %@", [curly valueForKey:@"fullName"]);
// 建立兩個 Coder 物件
NSArray *langs1 = @[@"Objective-C", @"C"];
Coder *coder1 = [Coder new];
coder1.person = curly;
coder1.languages = [langs1 mutableCopy];
NSLog(@"\nCoder name: %@\n\tlanguages: %@",
[coder1 valueForKeyPath:@"person.fullName"], [coder1 valueForKey:@"languages"]);
Coder *coder2 = [Coder new];
coder2.person = [[Person alloc] initWithFirstName:@"Larry" lastName:@"Fine"];
coder2.languages = [@[@"Objective-C", @"C++"] mutableCopy];
NSLog(@"\nCoder name: %@\n\tlanguages: %@",
[coder2 valueForKeyPath:@"person.fullName"], [coder2 valueForKey:@"languages"]);
// 將 coder1 註冊為 curly 的觀察者,修改被觀察屬性後觀察者會收到通知
[curly addObserver:coder1 forKeyPath:@"fullName"
options:NSKeyValueObservingOptionNew context:NULL];
curly.lastName = @"Fine";
[curly removeObserver:coder1 forKeyPath:@"fullName"];
// 使用 @count 運算子計算集合中的物件總數
Coders *bestCoders = [Coders new];
bestCoders.developers = [[NSSet alloc] initWithArray:@[coder1, coder2]];
NSSet *coders = [bestCoders valueForKey:@"developers"];
NSLog(@"Number of coders = %@", [coders valueForKeyPath:@"@count"]);
// 以空字串測試鍵值驗證方法
NSError *error;
NSString *emptyName = @"";
BOOL valid = [curly validateValue:&emptyName forKey:@"lastName" error:&error];
if (!valid) {
NSLog(@"Error: %@", ([error userInfo])[NSLocalizedDescriptionKey]);
}
}
return 0;
}
執行結果如下:
Person first name: Curly
Person full name: Curly Howard
Coder name: Curly Howard
languages: ( "Objective-C", C )
Coder name: Larry Fine
languages: ( "Objective-C", "C++" )
Value changed for Person object, key path: fullName, new value: Curly Fine
Number of coders = 2
Error: Last name cannot be nil
透過以上範例可以發現,KVC 與 KVO 搭配使用時,不僅能簡化屬性存取,還能在資料變動時自動觸發通知,是實作 Model 層資料綁定的利器。