JSONModel源码

参考博客：

JSONModel源码解析

JSONModel初始化方法

JSONModel对外给出了许多常见的初始化方法：

- (instancetype)initWithDictionary:(NSDictionary *)dict error:(NSError **)err;
- (instancetype)initWithData:(NSData *)data error:(NSError **)error;
// 创建一个新的模型实例，并使用来自文本参数的JSON初始化它。 
// 该方法假定输入文本为UTF8编码。
- (instancetype)initWithString:(NSString *)string error:(JSONModelError **)err;
// 创建一个新的模型实例，并使用使用给定编码的文本参数的JSON初始化它。
- (instancetype)initWithString:(NSString *)string usingEncoding:(NSStringEncoding)encoding error:(JSONModelError **)err;

让我们来看看其实现：

- (instancetype)initWithData:(NSData *)data error:(NSError *__autoreleasing *)err
{
   
    //check for nil input
    if (!data) {
   
        if (err) *err = [JSONModelError errorInputIsNil];
        return nil;
    }
    //read the json
    JSONModelError* initError = nil;
    id obj = [NSJSONSerialization JSONObjectWithData:data
                                             options:kNilOptions
                                               error:&initError];
    if (initError) {
   
        if (err) *err = [JSONModelError errorBadJSON];
        return nil;
    }
    //init with dictionary
    id objModel = [self initWithDictionary:obj error:&initError];
    if (initError && err) *err = initError;
    return objModel;
}

- (id)initWithString:(NSString*)string error:(JSONModelError**)err
{
   
    JSONModelError* initError = nil;
    id objModel = [self initWithString:string usingEncoding:NSUTF8StringEncoding error:&initError];
    if (initError && err) *err = initError;
    return objModel;
}

- (id)initWithString:(NSString *)string usingEncoding:(NSStringEncoding)encoding error:(JSONModelError**)err
{
   
    //check for nil input
    if (!string) {
   
        if (err) *err = [JSONModelError errorInputIsNil];
        return nil;
    }
    JSONModelError* initError = nil;
    id objModel = [self initWithData:[string dataUsingEncoding:encoding] error:&initError];
    if (initError && err) *err = initError;
    return objModel;
}

我们发现，这几个初始化方法最终实际上都还是调用了:

- (id)initWithDictionary:(NSDictionary*)dict error:(NSError**)err;

这个方法可以说是核心方法，让我们来看看他的实现如何。

-(id)initWithDictionary:(NSDictionary*)dict error:(NSError**)err
{
   
    //check for nil input
    //1.为空判断
    if (!dict) {
   
        if (err) *err = [JSONModelError errorInputIsNil];
        return nil;
    }

    //invalid input, just create empty instance
    //2.类型判断
    if (![dict isKindOfClass:[NSDictionary class]]) {
   
        if (err) *err = [JSONModelError errorInvalidDataWithMessage:@"Attempt to initialize JSONModel object using initWithDictionary:error: but the dictionary parameter was not an 'NSDictionary'."];
        return nil;
    }

    //create a class instance
    //3.核心，初始化映射property
    self = [self init];
    if (!self) {
   

        //super init didn't succeed
        if (err) *err = [JSONModelError errorModelIsInvalid];
        return nil;
    }

    //check incoming data structure
    //4.检查映射结构是否能够从dictionary中找到相应的数据
    if (![self __doesDictionary:dict matchModelWithKeyMapper:self.__keyMapper error:err]) {
   
        return nil;
    }

    //import the data from a dictionary
    //5.进行数据赋值
    if (![self __importDictionary:dict withKeyMapper:self.__keyMapper validation:YES error:err]) {
   
        return nil;
    }

    //run any custom model validation
    //6.本地数据检查
    if (![self validate:err]) {
   
        return nil;
    }

    //model is valid! yay!
    return self;
}

主要分为以下6块：

• 1.空值判断
• 2.输入类型dictionary判断
• 3.初始化：解析model对象，并且映射property
• 4.查值：检查model property名与数据来源json字典中数据名，判断是否所有property都有值
• 5.赋值：进行赋值
• 6.本地数据正确性检查

以下我将主要解析3，4，5这三部分的主代码。

初始化

  -(void)__setup__
{
   
    //if first instance of this model, generate the property list
    //使用AssociateObject进行映射property的缓存，判断是否映射过
    if (!objc_getAssociatedObject(self.class, &kClassPropertiesKey)) {
   
        [self __inspectProperties];
    }

    //if there's a custom key mapper, store it in the associated object
    //获取对象的keyMapper影射，同样使用AssociateObject进行映射property的缓存
    id mapper = [[self class] keyMapper];
    if ( mapper && !objc_getAssociatedObject(self.class, &kMapperObjectKey) ) {
   
        objc_setAss