KVC簡介
KVC全稱Key-Value Coding
铅碍,按照官方定義來說是由NSKeyValueCoding
非正式協議啟用的一種機制租幕,對象采用這種機制來提供對其屬性的間接訪問咐鹤。
常用的KVC方法有:
- (nullable id)valueForKey:(NSString *)key;
- (void)setValue:(nullable id)value forKey:(NSString *)key;
- (nullable id)valueForKeyPath:(NSString *)keyPath;
- (void)setValue:(nullable id)value forKeyPath:(NSString *)keyPath;
還有一些其他的方法在Foundation
框架中的NSKeyValueCoding.h
中都有谎替,只要關于NSObject
的都可以使用KVC以故。
KVC的原理
下面我們來探索一下KVC的取值和賦值過程:
通過Key-Value Coding Programming Guide網址可以看到Search Pattern for the Basic Setter
的關于setter
賦值操作的說明,如下圖所示:
通過文檔說明拐迁,可以了解到一些東西,例如:accessInstanceVariablesDirectly
方法疗绣,_<key>, _is<Key>, <key>, is<Key>
线召,那么這些又是有什么作用的呢?下面通過代碼來探索一下這些屬性和方法的作用:
創(chuàng)建一個Person
類多矮,添加一個name
屬性缓淹,然后實現幾個setter
方法和accessInstanceVariablesDirectly
方法:
+ (BOOL)accessInstanceVariablesDirectly{
return YES;
}
- (void)setName:(NSString *)name{
NSLog(@"%s - %@",__func__,name);
}
- (void)_setName:(NSString *)name{
NSLog(@"%s - %@",__func__,name);
}
- (void)setIsName:(NSString *)name{
NSLog(@"%s - %@",__func__,name);
}
- (void)_setIsName:(NSString *)name{
NSLog(@"%s - %@",__func__,name);
}
在accessInstanceVariablesDirectly
方法返回YES
的過程中,4個setter
方法依次執(zhí)行和注釋塔逃,結果前3個方法對name
屬性的賦值都有作用讯壶,而最后一個方法沒有作用,而當accessInstanceVariablesDirectly
湾盗,則會導致程序崩潰伏蚊;
那么就能明白,對于屬性的賦值格粪,前三個方法都有作用躏吊;
下面來看看賦值問題:
person.h
@interface Person : NSObject{
@public
NSString *_name;
NSString *_isName;
NSString *name;
NSString *isName;
}
- (void)viewDidLoad {
[super viewDidLoad];
Person *person = [[Person alloc] init];
[person setValue:@"OC" forKey:@"name"];
NSLog(@"%@-%@-%@-%@",person->_name,person->_isName,person->name,person->isName);
NSLog(@"%@-%@-%@",person->_isName,person->name,person->isName);
NSLog(@"%@-%@",person->name,person->isName);
NSLog(@"%@",person->isName);
}
在上面的程序中氛改,在.h
中有4個類似的name
屬性,而viewcontroller
中只對name
賦值比伏,對四種屬性值進行打邮ぢ薄;
最后得出的結論是通過對name
賦值凳怨,它對屬性的賦值順序是按照_name
->_isName
->name
->isName
瑰艘;通過對屬性name
的調換,結果還是一摸一樣的肤舞;
賦值方法探索完紫新,來探索一下取值方法過程:
在文檔中有詳細的解釋說明:
下面只截取一部分內容:
同樣的首先探索一下getter
方法的調用問題:
- (NSString *)getName{
return NSStringFromSelector(_cmd);
}
- (NSString *)name{
return NSStringFromSelector(_cmd);
}
- (NSString *)isName{
return NSStringFromSelector(_cmd);
}
- (NSString *)_name{
return NSStringFromSelector(_cmd);
}
- (void)viewDidLoad {
[super viewDidLoad];
Person *person = [[Person alloc] init];
[person setValue:@"OC" forKey:@"name"];
// person->_name = @"_name";
// person->_isName = @"_isName";
// person->name = @"name";
// person->isName = @"isName";
NSLog(@"取值:%@",[person valueForKey:@"name"]);
}
通過一個方法一個方法的注釋和打開,它的取值調用順序為:getName
->name
->isName
->_name
;和蘋果官方文檔的第一點說的一摸一樣李剖。
如果是實例變量芒率,那么它就會按照第四點的順序:
同樣的是使用上面的代碼,將setValue
代碼去掉篙顺,依次打開和執(zhí)行person->name
的設值偶芍,在經過執(zhí)行代碼之后,就會發(fā)現只有第一個_name
的賦值打印是有值的德玫,其他三個都為NULL
匪蟀;不知道讀者有沒有get到重點,在person.h
中有申明4個成員變量宰僧,當將_name
的申明注釋材彪,那么對_isName
的賦值打印是有值的,而其他的依然沒有值琴儿。
這就是KVC的取值和賦值過程段化。
KVC的自定義
既然是自定義KVC,那么一些規(guī)則還是必須按照系統的規(guī)則來造成,例如取值和獲取值的順序等显熏,通過對NSObject
創(chuàng)建分類來實現自定義的KVC,下面來按照步驟實現自定義KVC:
1晒屎、判斷key的值是否存在
2喘蟆、setter的順序問題
3、是否能響應accessInstanceVariablesDirectly
和判斷能否直接賦值實例變量
4鼓鲁、間接變量的設值
5蕴轨、找不到實例變量
- (void)oc_setValue:(nullable id)value forKey:(NSString *)key{
// KVC 自定義
// 1: 判斷什么 key
if (key == nil || key.length == 0) {
return;
}
// 2: setter set<Key>: or _set<Key>,
// key 要大寫
NSString *Key = key.capitalizedString;
// 拼接方法
NSString *setKey = [NSString stringWithFormat:@"set%@:",Key];
NSString *_setKey = [NSString stringWithFormat:@"_set%@:",Key];
NSString *setIsKey = [NSString stringWithFormat:@"setIs%@:",Key];
if ([self oc_performSelectorWithMethodName:setKey value:value]) {
NSLog(@"*********%@**********",setKey);
return;
}else if ([self oc_performSelectorWithMethodName:_setKey value:value]) {
NSLog(@"*********%@**********",_setKey);
return;
}else if ([self oc_performSelectorWithMethodName:setIsKey value:value]) {
NSLog(@"*********%@**********",setIsKey);
return;
}
// 3: 判斷是否響應 accessInstanceVariablesDirectly 返回YES NO 奔潰
// 3:判斷是否能夠直接賦值實例變量
if (![self.class accessInstanceVariablesDirectly] ) {
@throw [NSException exceptionWithName:@"OCUnknownKeyException" reason:[NSString stringWithFormat:@"****[%@ valueForUndefinedKey:]: this class is not key value coding-compliant for the key name.****",self] userInfo:nil];
}
// 4: 間接變量
// 獲取 ivar -> 遍歷 containsObjct -
// 4.1 定義一個收集實例變量的可變數組
NSMutableArray *mArray = [self getIvarListName];
// _<key> _is<Key> <key> is<Key>
NSString *_key = [NSString stringWithFormat:@"_%@",key];
NSString *_isKey = [NSString stringWithFormat:@"_is%@",Key];
NSString *isKey = [NSString stringWithFormat:@"is%@",Key];
if ([mArray containsObject:_key]) {
// 4.2 獲取相應的 ivar
Ivar ivar = class_getInstanceVariable([self class], _key.UTF8String);
// 4.3 對相應的 ivar 設置值
object_setIvar(self , ivar, value);
return;
}else if ([mArray containsObject:_isKey]) {
Ivar ivar = class_getInstanceVariable([self class], _isKey.UTF8String);
object_setIvar(self , ivar, value);
return;
}else if ([mArray containsObject:key]) {
Ivar ivar = class_getInstanceVariable([self class], key.UTF8String);
object_setIvar(self , ivar, value);
return;
}else if ([mArray containsObject:isKey]) {
Ivar ivar = class_getInstanceVariable([self class], isKey.UTF8String);
object_setIvar(self , ivar, value);
return;
}
// 5:如果找不到相關實例
@throw [NSException exceptionWithName:@"OCUnknownKeyException" reason:[NSString stringWithFormat:@"****[%@ %@]: this class is not key value coding-compliant for the key name.****",self,NSStringFromSelector(_cmd)] userInfo:nil];
}
- (BOOL)oc_performSelectorWithMethodName:(NSString *)methodName value:(id)value{
if ([self respondsToSelector:NSSelectorFromString(methodName)]) {
#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Warc-performSelector-leaks"
[self performSelector:NSSelectorFromString(methodName) withObject:value];
#pragma clang diagnostic pop
return YES;
}
return NO;
}
- (NSMutableArray *)getIvarListName{
NSMutableArray *mArray = [NSMutableArray arrayWithCapacity:1];
unsigned int count = 0;
Ivar *ivars = class_copyIvarList([self class], &count);
for (int i = 0; i<count; i++) {
Ivar ivar = ivars[i];
const char *ivarNameChar = ivar_getName(ivar);
NSString *ivarName = [NSString stringWithUTF8String:ivarNameChar];
NSLog(@"ivarName == %@",ivarName);
[mArray addObject:ivarName];
}
free(ivars);
return mArray;
}