IOS:KVC原理與自定義

一、KVC簡介

KVC其實就是鍵值對Key-Value Coding,它是蘋果提供給咱們處理對象的一種機制。一般咱們對屬性的操做會經過他的setget方法,可是這須要咱們指定相應的setKeygetKey等方法,隨着屬性列表的增加咱們訪問這些屬性也必須如此。相反,key-value coding提供了一個簡單的消息傳遞接口,容許咱們經過這個統一的接口去改變全部的屬性(這其實就是咱們一般用的json轉model的原理)json

二、KVC原理分析

2.一、KVC設值過程

kvc的設值會調用setValue:forKey:其設值過程流程圖以下:api

  1. 按順序查找set<Key>_set<Key>這些方法,若是找到當即調用相應方法並傳遞name參數設值,結束。數組

  2. 若是沒有找到以上的全部方法,判斷accessInstanceVariablesDirectly方法返回值若是返回YES,依次判斷_key,_is<Key>,key,isKey等成員變量是否存在,根據順序存在即賦值並結束。bash

  3. 若是accessInstanceVariablesDirectly方法也返回NO,或者上述全部成員變量均不存在,調用setValue:forUndefinedKey:並拋出異常並崩潰。markdown

  4. 注意,KVC的設值都是對成員變量的值進行操做,上述_key,_is<Key>,key,isKey等都是成員變量,而不是屬性,屬性設值的本質其實就是調用set方法,其內部就是對成員變量進行賦值,一般咱們只定義了@property的屬性,只不過是系統自動幫咱們生成了相應的成員變量。app

2.二、KVC取值過程

kvc的取值會調用ValueForKey:可是其對值的搜索過程不一樣於setValue:forKey:this

  1. 依次查找實例方法:get<key>,<key>,is<Key>,_<key>,若是找到跳轉到第5步。spa

  2. 判斷是否屬於NSArrray,基因而否找到NSArray相關的實例方法如:countOf<Key>,objectIn<Key>AtIndex:<key>AtIndexes指針

  3. 判斷是否屬於NSSet,基因而否有NSSet相關的方法:countOf<Key>, enumeratorOf<Key>and memberOf<Key>:code

  4. 若是上述方法都不存在,判斷對象的類方法accessInstanceVariablesDirectly 返回值,若是返回YES,按順序查找成員變量_<key>, _is<Key>, <key>, 或 is<Key>,若是找到直接直接獲取實例變量的值並跳到5繼續執行,不然執行6

  5. 檢索屬性值,若是是指針對象,直接返回結果;若是該值是可轉化爲NSNumber類型的值,那麼將該值轉化爲NSNumber並返回;除此之外將該值轉化爲NSValue類型的值做爲結果返回。

  6. 若是上述過程都失敗,調用valueForUndefinedKey:並拋出一個異常。

3.自定義KVC

3.一、思路

  1. 既然針對的是對象,那麼咱們就應該是針對NSObject的一個擴展Category

  2. 結合上面咱們瞭解了KVC有取值和設值的過程,因此咱們要自定義setValue:forKey:以及ValueForKey:的方法。

  3. customSetValue:forKey:方法:

    • 查找 set 和 _set 方法;
    • 根據 accessInstanceVariablesDirectly 方法的返回值一次判斷_key,_is<Key>,key, isKey等實例變量,找到實例變量並複製,結束。
    • 若是沒找到拋異常。
  4. customValueForKey:方法:

    • 找到相關方法 get countOf objectInAtIndex找到返回相應方法的返回值做爲結果;
    • 根據 accessInstanceVariablesDirectly 方法的返回值一次判斷_key,_is<Key>,key, isKey等實例變量,找到實例變量直接返回,結束。
    • 若是沒找到拋異常。

3.二、具體實現

- (void)customSetValue:(nullable id)value forKey:(NSString *)key{
    // 容錯判斷
    if (key == nil  || key.length == 0) return;
    // 找到相關方法 set<Key> _set<Key> setIs<Key>
    NSString *Key = key.capitalizedString;
    
    // 拼接方法
    NSString *setKey = [NSString stringWithFormat:@"set%@:",Key];
    NSString *_setKey = [NSString stringWithFormat:@"_set%@:",Key];
    NSString *setIsKey = [NSString stringWithFormat:@"setIs%@:",Key];
    NSArray *methodList = @[setKey,_setKey,setIsKey];
    for (NSInteger i = 0; i < methodList.count; i ++) {
        NSString *methodName = methodList[i];
        if ([self respondsToSelector:NSSelectorFromString(key)]) {
#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Warc-performSelector-leaks"
            [self performSelector:NSSelectorFromString(methodName) withObject:value];
#pragma clang diagnostic pop
            return;
        }
    }
    
    // 判斷是否可以直接賦值實例變量
    if (![self.class accessInstanceVariablesDirectly] ) {
        @throw [NSException exceptionWithName:@"UnknownKeyException" reason:[NSString stringWithFormat:@"****[%@ valueForUndefinedKey:]: this class is not key value coding-compliant for the key name.****",self] userInfo:nil];
    }
    
    // 找相關實例變量進行賦值
    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);
    
    NSArray *appendPrefix = @[@"_",@"_is",@"",@"is"];
    for (NSInteger i = 0; i < appendPrefix.count; i ++) {
        NSString *instanceName = [NSString stringWithFormat:@"%@%@",appendPrefix[i],key];
        if ([mArray containsObject:instanceName]) {
            // 獲取相應的 ivar
            Ivar ivar = class_getInstanceVariable([self class], instanceName.UTF8String);
            // 對相應的 ivar 設置值
            object_setIvar(self , ivar, value);
            return;
        }
    }
    
    // 若是找不到相關實例
    @throw [NSException exceptionWithName:@"UnknownKeyException" reason:[NSString stringWithFormat:@"****[%@ %@]: this class is not key value coding-compliant for the key name.****",self,NSStringFromSelector(_cmd)] userInfo:nil];
}

複製代碼

- (id)customValueForKey:(NSString *)key{
    
    // 容錯
    if (key == nil  || key.length == 0) {
        return nil;
    }
    
    // 找到相關方法 get<Key> <key> countOf<Key>  objectIn<Key>AtIndex
    NSString *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:@(num)];
                [mArray addObject:objc];
            }
            return mArray;
        }
    }
#pragma clang diagnostic pop
    
    // 判斷是否可以直接賦值實例變量
    if (![self.class accessInstanceVariablesDirectly] ) {
        @throw [NSException exceptionWithName:@"UnknownKeyException" reason:[NSString stringWithFormat:@"****[%@ valueForUndefinedKey:]: this class is not key value coding-compliant for the key name.****",self] userInfo:nil];
    }
    
    // 找相關實例變量進行賦值
    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);
 
    NSArray *appendPrefix = @[@"_",@"_is",@"",@"is"];
    for (NSInteger i = 0; i < appendPrefix.count; i ++) {
        NSString *instanceName = [NSString stringWithFormat:@"%@%@",appendPrefix[i],key];
        if ([mArray containsObject:instanceName]) {
            Ivar ivar = class_getInstanceVariable([self class], instanceName.UTF8String);
            return object_getIvar(self, ivar);;
        }
    }
    return nil;
}
複製代碼

4.KVC使用的一些細節

  1. 針對Int類型的key的寫法
[object setValue:@123 forKey:@"count"];
複製代碼
  1. 若是對Int類型的傳一個NSString的值如:[object setValue:@"123" forKey:@"count"],系統會自動幫咱們轉換成__NSCFNumber的類型,說明KVC具備自動轉型的功能

  2. 結構體的取值以及設值要轉換爲NSValue做爲中間媒介。

  3. setNilValueForKey:的方法只針對NSNumber(int,bool, etc..)以及NSValue(結構體)相關的數據生效,針對指針對象賦值nil並不會走到這個方法。

  4. 集合操做符的使用

// @sum用來計算集合中right keyPath指定的屬性的總和 
NSNumber *sum = [bookrack valueForKeyPath:@"@sum.bookPrice"];
NSLog(@"sum: %f", [sum floatValue]);
----------------------------------------------------------------
// @avg用來計算集合中right keyPath指定的屬性的平均值 
NSNumber *avgNum = [bookrack valueForKeyPath:@"@avg.bookPrice"];
----------------------------------------------------------------
// @max,@min 用來查找集合中right keyPath指定屬性的最大值和最小值 
NSNumber *max = [bookrack valueForKeyPath:@"@max.bookPrice"];
NSNumber *min = [bookrack valueForKeyPath:@"@min.bookPrice"];
----------------------------------------------------------------
// @unionOfObjects將集合中的全部對象的同一個屬性放在數組中返回。 
NSArray *priceArray = [bookrack valueForKeyPath:@"@unionOfObjects.bookPrice"];
----------------------------------------------------------------
// @distinctUnionOfObjects將集合中對象的屬性進行去重後並返回。 
NSArray *nameArray = [bookrack valueForKeyPath:@"@distinctUnionOfObjects.bookName"];
複製代碼
  1. 若是在集合對象中操做的屬性,原本就是NSNumber類型,則能夠像下面這樣,直接用self表明值自身
NSArray *array = @[@(productA.price), @(productB.price), @(productC.price), @(productD.price)];
NSNumber *avg = [array valueForKeyPath:@"@avg.self"];
複製代碼
  1. KVC在實踐中也有不少用處,例如UITabbarUIPageControl這樣的控件,系統已經爲咱們封裝好了,可是對於一些樣式的改變並無提供足夠的API,這種狀況就須要咱們用KVC進行操做了

5.總結

以上就是我的針對KVC的一些總結,有問題但願您隨時提出。如今正值新型肺炎疫情期間,你們或許有的已經開始復工了,有的或許還在家進行隔離,但願你們都注意保護本身,保護家人,保護你們。

相關文章
相關標籤/搜索