簡單說說 MJExtension 實(shí)現(xiàn)原理

原始方法

  • 實(shí)現(xiàn)我們的模型是這樣的,只有2個(gè)屬性
@interface BMUser : NSObject
@property (nonatomic, copy) NSString *name; ///< name
@property (nonatomic, assign) int age;      ///< age
@end
  • 使用最原始的方法把json->Models時(shí),代碼如下
// 1.獲取json數(shù)據(jù)
NSString *json = @"{\"name\" : \"idhong\", \"age\" : 15}";
// 2.json->NSDictionary
NSDictionary *jsonDict = [NSJSONSerialization JSONObjectWithData:[json dataUsingEncoding:NSUTF8StringEncoding] options:kNilOptions error:NULL];
// 3.創(chuàng)建user
BMUser *user = [BMUser new];
// 4.賦值
user.name = jsonDict[@"name"];
user.age = [jsonDict[@"age"] intValue];
// 其他屬性設(shè)置
NSLog(@"");
  • 稍微優(yōu)化下,使用setValuesForKeysWithDictionary可以簡化賦值代碼如下。
// 1.獲取json數(shù)據(jù)
NSString *json = @"{\"name\" : \"idhong\", \"age\" : 15}";
// 2.json->NSDictionary
NSDictionary *jsonDict = [NSJSONSerialization JSONObjectWithData:[json dataUsingEncoding:NSUTF8StringEncoding] options:kNilOptions error:NULL];
// 3.創(chuàng)建user
BMUser *user = [BMUser new];
// 4.賦值
[user setValuesForKeysWithDictionary:jsonDict];    

如果屬性特別多,而且模型嵌套模型時(shí)手寫就特別麻煩而且容易出錯(cuò),其中至少包括如下問題;

  • 1.模型的屬性是另一個(gè)模型
  • 2.模型的屬性是數(shù)組(數(shù)組中的對象又是模型)
  • 3.以及相互嵌套等。
  • 使用setValuesForKeysWithDictionary無法解決問題,同時(shí)手動編碼無法想象。

歸根結(jié)底 json -> Model 主要是以下3步

  • 1.創(chuàng)建模型

  • 2.為模型中的屬性賦值

  • 3.返回模型

  • 其中最核心的就是第2步,怎么樣動態(tài)的為模型賦值,當(dāng)然是使用Runtime,MJExtension 算是使用率較多的一個(gè)庫,下面就簡單分析下其實(shí)現(xiàn)原理吧。

  • 1.使用Runtime動態(tài)獲取模型的屬性(包括繼承鏈的所有屬性,MJExtension對模型的屬性做了緩存,下次轉(zhuǎn)換時(shí)自己使用,空間換時(shí)間)

  • 2.又第1步獲取到的屬性可以解析出各屬性的全部信息(包括屬性類型,屬性修飾符等參考這里 )

  • 3.第2步獲取屬性后,取到屬性名在去NSDictionary)中獲出相應(yīng)的值

  • 4.在第3步取出的值使用KVC設(shè)置給Model即可(MJExtension使用KVC賦值,YYModel底層是直接使用objc_msgSend)

  • 5.所以為什么如果模型中有屬性是數(shù)組,數(shù)組中又是模型時(shí),需要我們指定其類型,才可為我們主動將其轉(zhuǎn)換。

怎樣自己實(shí)現(xiàn)MJExtension

  • 動態(tài)獲取模型屬性
  • 解析屬性相關(guān)信息
  • 如果是數(shù)組類型,因?yàn)椴恢罃?shù)組中應(yīng)該存放具體的類型,所以需提供方法讓使用者提供具體的類型
  • 使用KVC賦值
  • 其他擴(kuò)展信息,包括黑名單,白名單,換屬性名,轉(zhuǎn)換結(jié)束等等擴(kuò)展信息。

分析MJExtension

  • 引用一張圖

MJExtension 一共21個(gè)文件,主要用3個(gè)類,5個(gè)分類

  • MJExtension.h頭文件
  • MJExtensionConst 一些常量,宏,版本控制等
  • MJFoundation主要是提供判斷是否為Foundation框架的類
  • MJProperty封裝屬性對象(objc_property_t內(nèi)部包括屬性名稱,屬性類型等相關(guān)信息)
  • MJPropertyKey 屬性的key
  • MJPropertyType 屬性類型(類型標(biāo)識符這里,是否id,是否基本數(shù)據(jù)類型等)
  • NSString+MJExtension字符串的一些擴(kuò)展(包括下劃線,大小寫等處理)
  • NSObject+MJProperty主要提供遍歷一個(gè)類的屬性列表
  • NSObject+MJCoding提供歸檔功能
  • NSObject+MJClass提供擴(kuò)展功能,黑名單,白名單,數(shù)組中的類型自定義等。

MJExtension源碼解讀

  • 我們使用最基本的dict->Model方法是:
+ (instancetype)mj_objectWithKeyValues:(id)keyValues;

其實(shí)現(xiàn)在NSObject+MJKeyValue.m的203行如下

+ (instancetype)mj_objectWithKeyValues:(id)keyValues
{
    return [self mj_objectWithKeyValues:keyValues context:nil];
}

內(nèi)部調(diào)用了下面的方法

+ (instancetype)mj_objectWithKeyValues:(id)keyValues context:(NSManagedObjectContext *)context
{
    // 獲得JSON對象
    keyValues = [keyValues mj_JSONObject];
    MJExtensionAssertError([keyValues isKindOfClass:[NSDictionary class]], nil, [self class], @"keyValues參數(shù)不是一個(gè)字典");
    
    if ([self isSubclassOfClass:[NSManagedObject class]] && context) {
        NSString *entityName = [NSStringFromClass(self) componentsSeparatedByString:@"."].lastObject;
        return [[NSEntityDescription insertNewObjectForEntityForName:entityName inManagedObjectContext:context] mj_setKeyValues:keyValues context:context];
    }
    return [[[self alloc] init] mj_setKeyValues:keyValues];
}

首先是mj_JSONObject方法,其作用是把NSData或者NSString為NSDictionary類型,因?yàn)樯厦娴姆椒ㄖС諲SDictionary,NSString,NSData類型,其具體實(shí)現(xiàn)就不在贅述了。

這里先不考慮CoreData及NSManagedObject

然后是創(chuàng)建模型同時(shí)調(diào)用賦值屬性

[[[self alloc] init] mj_setKeyValues:keyValues]

最后調(diào)到

- (instancetype)mj_setKeyValues:(id)keyValues context:(NSManagedObjectContext *)context

此方法是整個(gè)庫的核心代碼部分。

- (instancetype)mj_setKeyValues:(id)keyValues context:(NSManagedObjectContext *)context
{
    // 獲得JSON對象
    keyValues = [keyValues mj_JSONObject];
    
    MJExtensionAssertError([keyValues isKindOfClass:[NSDictionary class]], self, [self class], @"keyValues參數(shù)不是一個(gè)字典");
    
    Class clazz = [self class];
    NSArray *allowedPropertyNames = [clazz mj_totalAllowedPropertyNames];
    NSArray *ignoredPropertyNames = [clazz mj_totalIgnoredPropertyNames];
    
    //通過封裝的方法回調(diào)一個(gè)通過運(yùn)行時(shí)編寫的,用于返回屬性列表的方法。
    [clazz mj_enumerateProperties:^(MJProperty *property, BOOL *stop) {
        @try
        {
            // 0.檢測是否被忽略
            if (allowedPropertyNames.count && ![allowedPropertyNames containsObject:property.name]) return;
            if ([ignoredPropertyNames containsObject:property.name]) return;
            
            // 1.取出屬性值
            id value;
            NSArray *propertyKeyses = [property propertyKeysForClass:clazz];
            for (NSArray *propertyKeys in propertyKeyses) {
                value = keyValues;
                for (MJPropertyKey *propertyKey in propertyKeys) {
                    value = [propertyKey valueInObject:value];
                }
                if (value) break;
            }
            
            // 值的過濾
            id newValue = [clazz mj_getNewValueFromObject:self oldValue:value property:property];
            if (newValue != value) { // 有過濾后的新值
                [property setValue:newValue forObject:self];
                return;
            }
            
            // 如果沒有值,就直接返回
            if (!value || value == [NSNull null]) return;
            
            // 2.復(fù)雜處理
            MJPropertyType *type = property.type;
            Class propertyClass = type.typeClass;
            Class objectClass = [property objectClassInArrayForClass:[self class]];
            
            // 不可變 -> 可變處理
            if (propertyClass == [NSMutableArray class] && [value isKindOfClass:[NSArray class]]) {
                value = [NSMutableArray arrayWithArray:value];
            } else if (propertyClass == [NSMutableDictionary class] && [value isKindOfClass:[NSDictionary class]]) {
                value = [NSMutableDictionary dictionaryWithDictionary:value];
            } else if (propertyClass == [NSMutableString class] && [value isKindOfClass:[NSString class]]) {
                value = [NSMutableString stringWithString:value];
            } else if (propertyClass == [NSMutableData class] && [value isKindOfClass:[NSData class]]) {
                value = [NSMutableData dataWithData:value];
            }
            
            if (!type.isFromFoundation && propertyClass) { // 模型屬性
                value = [propertyClass mj_objectWithKeyValues:value context:context];
            } else if (objectClass) {
                if (objectClass == [NSURL class] && [value isKindOfClass:[NSArray class]]) {
                    // string array -> url array
                    NSMutableArray *urlArray = [NSMutableArray array];
                    for (NSString *string in value) {
                        if (![string isKindOfClass:[NSString class]]) continue;
                        [urlArray addObject:string.mj_url];
                    }
                    value = urlArray;
                } else { // 字典數(shù)組-->模型數(shù)組
                    value = [objectClass mj_objectArrayWithKeyValuesArray:value context:context];
                }
            } else {
                if (propertyClass == [NSString class]) {
                    if ([value isKindOfClass:[NSNumber class]]) {
                        // NSNumber -> NSString
                        value = [value description];
                    } else if ([value isKindOfClass:[NSURL class]]) {
                        // NSURL -> NSString
                        value = [value absoluteString];
                    }
                } else if ([value isKindOfClass:[NSString class]]) {
                    if (propertyClass == [NSURL class]) {
                        // NSString -> NSURL
                        // 字符串轉(zhuǎn)碼
                        value = [value mj_url];
                    } else if (type.isNumberType) {
                        NSString *oldValue = value;
                        
                        // NSString -> NSNumber
                        if (type.typeClass == [NSDecimalNumber class]) {
                            value = [NSDecimalNumber decimalNumberWithString:oldValue];
                        } else {
                            value = [numberFormatter_ numberFromString:oldValue];
                        }
                        
                        // 如果是BOOL
                        if (type.isBoolType) {
                            // 字符串轉(zhuǎn)BOOL(字符串沒有charValue方法)
                            // 系統(tǒng)會調(diào)用字符串的charValue轉(zhuǎn)為BOOL類型
                            NSString *lower = [oldValue lowercaseString];
                            if ([lower isEqualToString:@"yes"] || [lower isEqualToString:@"true"]) {
                                value = @YES;
                            } else if ([lower isEqualToString:@"no"] || [lower isEqualToString:@"false"]) {
                                value = @NO;
                            }
                        }
                    }
                }
                
                // value和property類型不匹配
                if (propertyClass && ![value isKindOfClass:propertyClass]) {
                    value = nil;
                }
            }
            
            // 3.賦值
            [property setValue:value forObject:self];
        } @catch (NSException *exception) {
            MJExtensionBuildError([self class], exception.reason);
            MJExtensionLog(@"%@", exception);
        }
    }];
    
    // 轉(zhuǎn)換完畢
    if ([self respondsToSelector:@selector(mj_keyValuesDidFinishConvertingToObject)]) {
        [self mj_keyValuesDidFinishConvertingToObject];
    }
    return self;
}

獲取模型可以轉(zhuǎn)換和忽略的屬性

NSArray *allowedPropertyNames = [clazz mj_totalAllowedPropertyNames];
NSArray *ignoredPropertyNames = [clazz mj_totalIgnoredPropertyNames];

此方法在調(diào)用時(shí),這里做了緩存處理,只會訪問一次,同時(shí)會調(diào)到外層的使用者實(shí)現(xiàn)的方法中

然后調(diào)用

+ (void)mj_enumerateProperties:(MJPropertiesEnumeration)enumeration

遍歷所有的屬性,此方法同樣做了緩存處理,如果某Class遍歷過,此庫內(nèi)部會把其數(shù)組緩存起來,下次直接遍歷即可

Block回調(diào)中可以獲取到每一個(gè)MJProperty(封裝的屬性)

幾步比較常規(guī)的操作,在庫用用詳細(xì)的注釋

  • 檢測是否被忽略
  • 取出屬性值
  • 值的過濾(提供了尾部可以對特殊值做處理的功能)

復(fù)雜類型處理

實(shí)現(xiàn)是對NSArray->NSMutableArray,NSData->NSMutableData,NSDictionary->NSMutableDictionary做可變處理。

因?yàn)閷?fù)雜類型需繼續(xù)繼續(xù)轉(zhuǎn)換。

如果是模型( !type.isFromFoundation && propertyClass )就重復(fù)最開始的方法

如果是NSURL 就把NSString轉(zhuǎn)換為NSURL

如果是 字典數(shù)組-由繼續(xù)最開始的方法調(diào)用

NSNumber類型

BOOL等類型的轉(zhuǎn)換

最后使用KVC賦值,當(dāng)然在內(nèi)部做了是否支持KVC的判斷。

// 3.賦值
[property setValue:value forObject:self];

總結(jié)

綜上所述,MJExtension的底層實(shí)現(xiàn)還算常規(guī),動態(tài)獲取屬性 屬性的類型判斷 必要的緩存 KVC賦值 其他性細(xì)節(jié)優(yōu)化和擴(kuò)展。

其他

有時(shí)間分析下YYModel,其使用到了CoreFoundationobjc_msgSend。

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時(shí)請結(jié)合常識與多方信息審慎甄別。
平臺聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點(diǎn),簡書系信息發(fā)布平臺,僅提供信息存儲服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容