源碼學習
- iOS底層學習:KVC 底層原理
- 一、核心 API 與功能特性
- **常用方法**
- KVC 設值 底層原理
- KVC 取值 底層原理
- 自定義KVC
- 設值
- 取值
- **特性:無隱私訪問**
- **原理**
- 四、多元應用場景
- 1. **動態數據處理**
- (1)字典轉模型
- (2)模型轉字典
- 2. **系統控件定制**
- 3. **高階集合操作**
- **(1) 聚合運算**
- **(2) 數組映射**
- **(3) 嵌套集合操作**
iOS底層學習:KVC 底層原理
在 iOS 開發中,KVC(Key-Value Coding,鍵值編碼) 是一種通過字符串鍵名間接訪問對象屬性的機制,基于NSKeyValueCoding
協議實現。它提供了動態訪問對象屬性的能力,無需直接調用存取方法或操作實例變量,極大提升了代碼的靈活性和動態性。
一、核心 API 與功能特性
KVC 提供了一套完整的 API 用于屬性的讀寫、驗證和集合操作,核心方法如下:
常用方法
- 通過
key
設值/取值- 方法原型
//直接通過Key來取值
- (nullable id)valueForKey:(NSString *)key;//通過Key來設值
- (void)setValue:(nullable id)value forKey:(NSString *)key;
? 使用:
// 通過鍵名獲取屬性值
id value = [object valueForKey:@"propertyKey"];
// 通過鍵路徑獲取嵌套屬性值(如:person.student.name)
id value = [object valueForKeyPath:@"keyPath"];
-
通過
keyPath
(即路由
)設值/取值- 方法原型
//通過KeyPath來取值 - (nullable id)valueForKeyPath:(NSString *)keyPath; //通過KeyPath來設值 - (void)setValue:(nullable id)value forKeyPath:(NSString *)keyPath;
使用
// 通過鍵名設置屬性值 [object setValue:newValue forKey:@"propertyKey"]; // 通過鍵路徑設置嵌套屬性值 [object setValue:newValue forKeyPath:@"keyPath"];
其他方法
//默認返回YES,表示如果沒有找到Set<Key>方法的話,會按照_key,_iskey,key,iskey的順序搜索成員,設置成NO就不這樣搜索
+ (BOOL)accessInstanceVariablesDirectly;//KVC提供屬性值正確性驗證的API,它可以用來檢查set的值是否正確、為不正確的值做一個替換值或者拒絕設置新值并返回錯誤原因。
- (BOOL)validateValue:(inout id __nullable * __nonnull)ioValue forKey:(NSString *)inKey error:(out NSError **)outError;//這是集合操作的API,里面還有一系列這樣的API,如果屬性是一個NSMutableArray,那么可以用這個方法來返回。
- (NSMutableArray *)mutableArrayValueForKey:(NSString *)key;//如果Key不存在,且KVC無法搜索到任何和Key有關的字段或者屬性,則會調用這個方法,默認是拋出異常。
- (nullable id)valueForUndefinedKey:(NSString *)key;//和上一個方法一樣,但這個方法是設值。
- (void)setValue:(nullable id)value forUndefinedKey:(NSString *)key;//如果你在SetValue方法時面給Value傳nil,則會調用這個方法
- (void)setNilValueForKey:(NSString *)key;//輸入一組key,返回該組key對應的Value,再轉成字典返回,用于將Model轉到字典。
- (NSDictionary<NSString *, id> *)dictionaryWithValuesForKeys:(NSArray<NSString *> *)keys;
通過 validateValue:forKey:error:
方法驗證屬性值的合法性:
- (BOOL)validateValue:(inout id _Nullable __autoreleasing *)ioValue forKey:(NSString *)inKey error:(out NSError **)outError {// 自定義驗證邏輯(如:限制數值范圍、字符串長度等)if ([inKey isEqualToString:@"age"] && [(NSNumber *)*ioValue integerValue] < 0) {*ioValue = @(0); // 修正非法值if (outError) {*outError = [NSError errorWithDomain:@"ValidationError" code:0 userInfo:@{NSLocalizedDescriptionKey:@"Age cannot be negative"}];}return NO;}return YES;
}
KVC 設值 底層原理
在日常開發中,針對對象屬性的賦值,一般有以下兩種方式
- 直接通過
setter
方法賦值 - 通過KVC鍵值編碼的相關API賦值
LGPerson *person = [[LGPerson alloc] init];
// 1、一般setter 方法
person.name = @"CJL_哈哈";
// 2、KVC方式
[person setValue:@"CJL_嘻嘻" forKey:@"name"];
下面針對使用最多的KVC設值方法:setValue:forKey
,來進行其底層原理的探索。
首先進入setValue:forKey
的聲明,發現是在Foundation
框架中,而Foundation框架是不開源的,所以我們通過觀看官方文檔研究。
當調用setValue:forKey:
設置屬性value
時,其底層的執行流程為
-
【第一步】首先查找是否有這三種setter方法,按照查找順序為
set<Key>:-> _set<Key> -> setIs<Key>
- 如果
有其中任意一個
setter方法,則直接設置屬性的value
(注意:key是指成員變量名
,首字符大小寫需要符合KVC的命名規范) - 如果都
沒有
,則進入【第二步】
- 如果
-
【第二步】:如果沒有第一步中的三個簡單的setter方法,則查找
accessInstanceVariablesDirectly
是否返回YES
-
如果返回
YES
,則查找間接訪問的實例變量進行賦值,查找順序為:
_<key> -> _is<Key> -> <key> -> is<Key>
- 如果找到其中任意一個實例變量,則賦值
- 如果都沒有,則進入【第三步】
-
如果返回
NO
,則進入【第三步】
-
-
【第三步】如果setter方法 或者 實例變量都沒有找到,系統會執行該對象的
setValue:forUndefinedKey:
方法,默認拋出NSUndefinedKeyException
類型的異常
綜上所述,KVC通過 setValue:forKey: 方法設值
的流程以設置LGPerson的對象person的屬性name為例,如下圖所示
KVC 取值 底層原理
同樣的,我們可以通過官方文檔分析KVC取值的底層原理
當調用valueForKey:
時,其底層的執行流程如下
-
【第一步】首先查找getter方法,按照
get<Key> -> <key> -> is<Key> -> _<key>
的方法順序查找,
- 如果
找到
,則進入【第五步】 - 如果
沒有找到
,則進入【第二步】
- 如果
-
【第二步】如果第一步中的getter方法沒有找到,KVC會查找.
countOf <Key>和objectIn <Key> AtIndex :和<key> AtIndexes
- 如果找到
countOf <Key>
和其他兩個中的一個,則會創建一個響應所有NSArray
方法的集合代理對象
,并返回該對象,即NSKeyValueArray
,是NSArray
的子類
。代理對象隨后將接收到的所有NSArray消息轉換為countOf<Key>,objectIn<Key> AtIndex:和<key>AtIndexes:
消息的某種組合,用來創建鍵值編碼對象。如果原始對象還實現了一個名為get<Key>:range:
之類的可選方法,則代理對象也將在適當時使用該方法(注意:方法名的命名規則要符合KVC的標準命名方法,包括方法簽名。) - 如果沒有找到這三個訪問數組的,請繼續進入【第三步】
- 如果找到
-
【第三步】如果沒有找到上面的幾種方法,則會同時查找
countOf <Key>,enumeratorOf<Key>和memberOf<Key>
這三個方法- 如果這三個方法都找到,則會創建一個響應
所有NSSet方法的集合代理對象
,并返回該對象,此代理對象隨后將其收到的所有NSSet
消息轉換為countOf<Key>,enumeratorOf<Key>和memberOf<Key>:
消息的某種組合,用于創建它的對象 - 如果還是沒有找到,則進入【第四步】
- 如果這三個方法都找到,則會創建一個響應
-
【第四步】如果還沒有找到,檢查類方法
InstanceVariablesDirectly
是否YES,依次搜索_<key>,_is<Key>,<key>或is<Key>
的實例變量- 如果搜到,
直接獲取實例變量的值
,進入【第五步】
- 如果搜到,
-
【第五步】根據搜索到的屬性值的類型,返回不同的結果
- 如果是
對象指針
,則直接返回結果 - 如果是
NSNumber支持
的標量類型,則將其存儲在NSNumber實例
中并返回它 - 如果是是
NSNumber不支持
的標量類型,請轉換為NSValue對象
并返回該對象
- 如果是
-
【第六步】如果上面5步的方法
均失敗
,系統會執行該對象的valueForUndefinedKey:
方法,默認拋出NSUndefinedKeyException
類型的異常
綜上所述,KVC通過 valueForKey: 方法取值
的流程以設置LGPerson
的對象person的屬性name
為例,如下圖所示
自定義KVC
根據上述KVC設值和取值的邏輯,我們可以寫一個自定義的KVC。
設值
自定義KVC設置流程,主要分為以下幾個步驟:
- 1、判斷
key非空
- 2、查找
setter
方法,順序是:setXXX、_setXXX、 setIsXXX
- 3、判斷是否響應
accessInstanceVariablesDirectly
方法,即間接訪問實例變量,- 返回
YES
,繼續下一步設值, - 如果是
NO
,則崩潰
- 返回
- 4、間接訪問變量賦值(只會走一次),順序是:
_key、_isKey、key、isKey
- 4.1 定義一個收集實例變量的可變數組
- 4.2 通過
class_getInstanceVariable
方法,獲取相應的 ivar - 4.3 通過
object_setIvar
方法,對相應的 ivar 設置值
- 5、如果找不到相關實例變量,則拋出異常
@interface NSObject (GCKVC)//設值
- (void)gc_setValue:(nullable id)value forKey:(NSString *)key;
//取值
- (nullable id)gc_valueForKey:(NSString *)key;@end@implementation NSObject (GCKVC)//設值
- (void)gc_setValue:(nullable id)value forKey:(NSString *)key{// 1、判斷key 是否存在if (key == nil || key.length == 0) return;// 2、找setter方法,順序是:setXXX、_setXXX、 setIsXXX// key 要大寫NSString *Key = key.capitalizedString;// key 要大寫NSString *setKey = [NSString stringWithFormat:@"set%@:", Key];NSString *_setKey = [NSString stringWithFormat:@"_set%@:", Key];NSString *setIsKey = [NSString stringWithFormat:@"setIs%@:", Key];if ([self gc_performSelectorWithMethodName:setKey value:value]) {NSLog(@"*************%@*************", setKey);return;}else if([self gc_performSelectorWithMethodName:_setKey value:value]){NSLog(@"*************%@*************", _setKey);return;}else if([self gc_performSelectorWithMethodName:setIsKey value:value]){NSLog(@"*************%@*************", setIsKey);return;}// 3、判斷是否響應`accessInstanceVariablesDirectly`方法,即間接訪問實例變量,返回YES,繼續下一步設值,如果是NO,則崩潰if (![self.class accessInstanceVariablesDirectly]) {@throw [NSException exceptionWithName:@"GCUnKnownKeyException" reason:[NSString stringWithFormat:@"****[%@ valueForUndefinedKey:]: this class is not key value coding-compliant for the key name.****",self] userInfo:nil];}// 4、間接訪問變量賦值,順序為:_key、_isKey、key、isKey// 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 獲取相應的 ivarIvar 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:@"GCUnknownKeyException" reason:[NSString stringWithFormat:@"****[%@ %@]: this class is not key value coding-compliant for the key name.****",self,NSStringFromSelector(_cmd)] userInfo:nil];
}// 獲取實例變量名列表
- (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];[mArray addObject:ivarName];}free(ivars);return mArray;
}@end
取值
取值的自定義代碼如下,分為以下幾步
- 1、判斷
key非空
- 2、查找相應方法,順序是:
get<Key>、 <key>、 countOf<Key>、 objectIn<Key>AtIndex
- 3、判斷是否能夠直接賦值實例變量,即判斷是否響應
accessInstanceVariablesDirectly
方法,間接訪問實例變量,- 返回
YES
,繼續下一步取值 - 如果是
NO
,則崩潰
- 返回
- 4、間接訪問實例變量,順序是
:_<key> _is<Key> <key> is<Key>
- 4.1 定義一個收集實例變量的
可變數組
- 4.2 通過
class_getInstanceVariable
方法,獲取相應的 ivar - 4.3 通過
object_getIvar
方法,返回相應的 ivar 的值
- 4.1 定義一個收集實例變量的
// 取值
- (nullable id)gc_valueForKey:(NSString *)key {// 1、判斷非空if (key == nil || key.length == 0) {return nil;}// 2、找到相關方法:get<Key> <key> countOf<Key> objectIn<Key>AtIndex// key 要大寫//capitalizedString 會將每個單詞的首字母大寫,其余小寫。//例如:key = @"firstName" → capitalizedString 后為 @"FirstName" → 方法名 getFirstName。但是URL會變成UrlNSString *Key = key.capitalizedString;// 拼接方法NSString *getKey = [NSString stringWithFormat:@"get%@", Key];NSString *countOfKey = [NSString stringWithFormat:@"countOf%@", Key];NSString *objectInKeyAtIndex = [NSString stringWithFormat:@"objectIn%@AtIndex:", Key];#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Warc-performSelector-leaks"if ([self respondsToSelector:NSSelectorFromString(getKey)]) {return [self performSelector:NSSelectorFromString(getKey)];} else if ([self respondsToSelector:NSSelectorFromString(key)]) {return [self performSelector:NSSelectorFromString(key)];}// 集合類型else if ([self respondsToSelector:NSSelectorFromString(countOfKey)]) {if ([self respondsToSelector:NSSelectorFromString(objectInKeyAtIndex)]) {int num = (int)[self performSelector:NSSelectorFromString(countOfKey)];NSMutableArray *mArray = [NSMutableArray arrayWithCapacity:1];for (int i = 0; i < num - 1; i++) {num = (int)[self performSelector:NSSelectorFromString(countOfKey)];}for (int j = 0; j < num; j++) {id objc = [self performSelector:NSSelectorFromString(objectInKeyAtIndex) withObject:@(j)];[mArray addObject:objc];}return mArray;}}
#pragma clang diagnostic pop// 3、判斷是否響應 `accessInstanceVariablesDirectly` 方法if (![self.class accessInstanceVariablesDirectly]) {@throw [NSException exceptionWithName:@"GCUnKnownKeyException" reason:[NSString stringWithFormat:@"****[%@ valueForUndefinedKey:]: this class is not key value coding-compliant for the key name.****", self] userInfo:nil];}// 4. 找相關實例變量進行取值,順序為:_<key>、_is<Key>、<key>、is<Key>NSMutableArray *mArray = [self getIvarListName];NSString *_key = [NSString stringWithFormat:@"_%@", key];NSString *_isKey = [NSString stringWithFormat:@"_is%@", Key];NSString *isKey = [NSString stringWithFormat:@"is%@", Key];if ([mArray containsObject:_key]) {Ivar ivar = class_getInstanceVariable([self class], _key.UTF8String);return object_getIvar(self, ivar);} else if ([mArray containsObject:_isKey]) {Ivar ivar = class_getInstanceVariable([self class], _isKey.UTF8String);return object_getIvar(self, ivar);} else if ([mArray containsObject:key]) {Ivar ivar = class_getInstanceVariable([self class], key.UTF8String);return object_getIvar(self, ivar);} else if ([mArray containsObject:isKey]) {Ivar ivar = class_getInstanceVariable([self class], isKey.UTF8String);return object_getIvar(self, ivar);}return @"";
}
特性:無隱私訪問
KVC 可訪問私有屬性(突破 @private
/@protected
限制):
// Person.h
@interface Person : NSObject {@privateNSString *_secretCode; // 私有實例變量
}@property (nonatomic, copy) NSString *publicName; // 公開屬性
@end// Person.m
@implementation Person
// 不暴露 _secretCode 的任何方法
@end
通過KVC強制訪問私有屬性
// 創建一個對象
Person *person = [[Person alloc] init];// 合法操作:通過屬性訪問公開字段
person.publicName = @"Alice";// 非法操作(編譯器會報錯):直接訪問私有變量
// person->_secretCode = @"123"; // 編譯錯誤:'secretCode' is private// 但通過 KVC 可以繞過限制
[person setValue:@"TOP_SECRET_123" forKey:@"secretCode"]; // 讀取私有變量
NSString *stolenSecret = [person valueForKey:@"secretCode"];
NSLog(@"竊取的私有變量值: %@", stolenSecret);
// 輸出:竊取的私有變量值: TOP_SECRET_123
原理
KVC 查找順序:
- 先嘗試調用
setSecretCode:
或_setSecretCode:
方法(不存在)。 - 然后直接訪問實例變量
_secretCode
(即使它是@private
)。
如果需要保護私有屬性,可重寫 accessInstanceVariablesDirectly
返回 NO
:
四、多元應用場景
1. 動態數據處理
(1)字典轉模型
// 模型類
@interface Person : NSObject
@property (nonatomic, copy) NSString *name;
@property (nonatomic, assign) NSInteger age;
@end// 批量賦值
NSDictionary *data = @{@"name": @"Alice", @"age": @25};
Person *person = [[Person alloc] init];
[person setValuesForKeysWithDictionary:data]; // KVC 批量賦值
(2)模型轉字典
NSDictionary *dict = [person dictionaryWithValuesForKeys:@[@"name", @"age"]]; // KVC 提取屬性值
2. 系統控件定制
修改 UITextField
占位符顏色(私有屬性 _placeholderLabel
):
UITextField *textField = [[UITextField alloc] init];
UILabel *placeholderLabel = [textField valueForKey:@"_placeholderLabel"];
placeholderLabel.textColor = [UIColor lightGrayColor]; // 通過 KVC 修改私有屬性
3. 高階集合操作
在對容器類使用KVC
時,valueForKey:將會被傳遞給容器中的每一個對象,而不是對容器本身進行操作,結果會被添加到返回的容器中,這樣,可以很方便的操作集合 來返回 另一個集合(如:首字母大寫):
NSArray *arr = @[@"hello", @"world"];
NSArray *capitalizedArr = [arr valueForKey:@"capitalizedString"]; // 結果:@[@"Hello", @"World"]
有如下Person類
@interface Person : NSObject
@property (nonatomic, copy) NSString *name;
@property (nonatomic, assign) NSInteger age;
@property (nonatomic, assign) CGFloat salary;
@end// 數據準備
NSArray *people = @[[Person personWithName:@"Alice" age:25 salary:5000],[Person personWithName:@"Bob" age:30 salary:8000],[Person personWithName:@"Charlie" age:28 salary:6000]
];
(1) 聚合運算
操作符 | 作用 | 示例 |
---|---|---|
@count | 返回集合元素個數 | [people valueForKeyPath:@"@count"] → 3 |
@sum | 求和 | [people valueForKeyPath:@"@sum.age"] → 83 |
@avg | 平均值 | [people valueForKeyPath:@"@avg.salary"] → 6333.33 |
@max | 最大值 | [people valueForKeyPath:@"@max.age"] → 30 |
@min | 最小值 | [people valueForKeyPath:@"@min.salary"] → 5000 |
(2) 數組映射
操作符 | 作用 | 示例 |
---|---|---|
@unionOfObjects | 提取屬性組成新數組(不去重) | [people valueForKeyPath:@"@unionOfObjects.name"] → ["Alice", "Bob", "Charlie"] |
@distinctUnionOfObjects | 提取屬性并去重 | 若兩人同名,結果會去重 |
(3) 嵌套集合操作
如果集合中嵌套集合(如 NSArray<NSArray *>
):
NSArray *departments = @[@[person1, person2], @[person3, person4]
];
// 提取所有員工的 name(扁平化)
NSArray *allNames = [departments valueForKeyPath:@"@unionOfArrays.name"];
當然我們還可以通過自定義方法來實現自定義操作
@implementation Person// 自定義 KVC 集合操作符
- (id)valueForKeyPath:(NSString *)keyPath {if ([keyPath hasSuffix:@"@median"]) {NSArray *values = [self valueForKeyPath:[keyPath substringToIndex:keyPath.length - 7]];return [self medianOfArray:values];}return [super valueForKeyPath:keyPath];
}- (NSNumber *)medianOfArray:(NSArray *)numbers {// 計算中位數邏輯...
}@end// 使用
NSNumber *medianAge = [people valueForKeyPath:@"age@median"];