YYModel的底层实现原理

匿名 (未验证) 提交于 2019-12-03 00:22:01


实际使用时,需要对其遍历,取出容器中得字典,然后继续字典转模型。(YYModel的核心是通过runtime获取结构体中得Ivars的值,将此值定义为key,然后给keyvalue值,所以我们需要自己遍历容器(NSArrayNSSetNSDictionary),获取每一个值,然后KVC)总结起来就是:底层核心是运用runtime获取类结构体中Ivars,进行KVC操作,然后根据不同情况进行分别处理

1.Model 属性名和 JSON 中的 Key 不相同

// JSON: {     "n":"Harry Pottery",     "p": 256,     "ext" : {         "desc" : "A book written by J.K.Rowing."     },     "ID" : 100010 }  // Model: @interface Book : NSObject @property NSString *name; @property NSInteger page; @property NSString *desc; @property NSString *bookID; @end @implementation Book //返回一个 Dict,将 Model 属性名对映射到 JSON 的 Key。 + (NSDictionary *)modelCustomPropertyMapper {     return @{@"name" : @"n",              @"page" : @"p",              @"desc" : @"ext.desc",              @"bookID" : @[@"id",@"ID",@"book_id"]}; } @end

你可以把一个或一组 json key (key path) 映射到一个或多个属性。如果一个属性没有映射关系,那默认会使用相同属性名作为映射。
在 json->model 的过程中:如果一个属性对应了多个 json key,那么转换过程会按顺序查找,并使用第一个不为空的值。
在 model->json 的过程中:如果一个属性对应了多个 json key (key path),那么转换过程仅会处理第一个 json key (key path);如果多个属性对应了同一个 json key,则转换过过程会使用其中任意一个不为空的值。

2.Model 包含其他 Model

// JSON {     "author":{         "name":"J.K.Rowling",         "birthday":"1965-07-31T00:00:00+0000"     },     "name":"Harry Potter",     "pages":256 }  // Model: 什么都不用做,转换会自动完成 @interface Author : NSObject @property NSString *name; @property NSDate *birthday; @end @implementation Author @end  @interface Book : NSObject @property NSString *name; @property NSUInteger pages; @property Author *author; //Book 包含 Author 属性 @end @implementation Book @end

3.容器类属性

@class Shadow, Border, Attachment;  @interface Attributes @property NSString *name; @property NSArray *shadows; //Array<Shadow> @property NSSet *borders; //Set<Border> @property NSMutableDictionary *attachments; //Dict<NSString,Attachment> @end  @implementation Attributes // 返回容器类中的所需要存放的数据类型 (以 Class 或 Class Name 的形式)。 + (NSDictionary *)modelContainerPropertyGenericClass {     return @{@"shadows" : [Shadow class],              @"borders" : Border.class,              @"attachments" : @"Attachment" }; } @end

在实际使用过过程中,[Shadow class]Border.class@"Attachment"没有明显的区别。
这里仅仅是创建作者有说明,实际使用时,需要对其遍历,取出容器中得字典,然后继续字典转模型。(YYModel的核心是通过runtime获取结构体中得Ivars的值,将此值定义为key,然后给keyvalue值,所以我们需要自己遍历容器(NSArrayNSSetNSDictionary),获取每一个值,然后KVC)。

  • 具体的代码实现如下:
NSDictionary *json =[self getJsonWithJsonName:@"ContainerModel"]; ContainerModel *containModel = [ContainerModel yy_modelWithDictionary:json]; NSDictionary *dataDict = [containModel valueForKey:@"data"]; //定义数组,接受key为list的数组 self.listArray = [dataDict valueForKey:@"list"];   //遍历数组 [self.listArray enumerateObjectsUsingBlock:^(id  _Nonnull obj, NSUInteger idx, BOOL * _Nonnull stop) {         NSDictionary *listDict = obj;         //获取数组中得字典         List *listModel = [List yy_modelWithDictionary:listDict];         //获取count 和 id         NSString *count = [listModel valueForKey:@"count"];         NSString *id = [listModel valueForKey:@"id"];

4.黑名单与白名单

@interface User @property NSString *name; @property NSUInteger age; @end  @implementation Attributes // 如果实现了该方法,则处理过程中会忽略该列表内的所有属性 + (NSArray *)modelPropertyBlacklist {     return @[@"test1", @"test2"]; } // 如果实现了该方法,则处理过程中不会处理该列表外的属性。 + (NSArray *)modelPropertyWhitelist {     return @[@"name"]; } @end

5.数据校验与自定义转换

实际这个分类的目的比较简单和明确。
就是对判断是否为时间戳,然后对时间戳进行处理,调用
_createdAt = [NSDate dateWithTimeIntervalSince1970:timestamp.floatValue];
获取时间。

// JSON: {     "name":"Harry",     "timestamp" : 1445534567     //时间戳 }  // Model: @interface User @property NSString *name; @property NSDate *createdAt; @end  @implementation User // 当 JSON 转为 Model 完成后,该方法会被调用。 // 你可以在这里对数据进行校验,如果校验不通过,可以返回 NO,则该 Model 会被忽略。 // 你也可以在这里做一些自动转换不能完成的工作。 - (BOOL)modelCustomTransformFromDictionary:(NSDictionary *)dic {     NSNumber *timestamp = dic[@"timestamp"];     if (![timestamp isKindOfClass:[NSNumber class]]) return NO;     _createdAt = [NSDate dateWithTimeIntervalSince1970:timestamp.floatValue];     return YES; }  // 当 Model 转为 JSON 完成后,该方法会被调用。 // 你可以在这里对数据进行校验,如果校验不通过,可以返回 NO,则该 Model 会被忽略。 // 你也可以在这里做一些自动转换不能完成的工作。 - (BOOL)modelCustomTransformToDictionary:(NSMutableDictionary *)dic {     if (!_createdAt) return NO;     dic[@"timestamp"] = @(n.timeIntervalSince1970);     return YES; } @end
  • 需要注意的时,如果用插件,对时间戳类型或默认创建为NSUInteger类型,需要将其更改为NSDate类型。

6.Coding/Copying/hash/equal/description

以下方法都是YYModel的简单封装,实际使用过程和系统方法区别不大。对其感兴趣的可以点进方法内部查看。

@interface YYShadow :NSObject <NSCoding, NSCopying> @property (nonatomic, copy) NSString *name; @property (nonatomic, assign) CGSize size; @end  @implementation YYShadow // 直接添加以下代码即可自动完成 - (void)encodeWithCoder:(NSCoder *)aCoder {   [self yy_modelEncodeWithCoder:aCoder];  } - (id)initWithCoder:(NSCoder *)aDecoder {   self = [super init];   return [self yy_modelInitWithCoder:aDecoder];  } - (id)copyWithZone:(NSZone *)zone {   return [self yy_modelCopy];  } - (NSUInteger)hash {   return [self yy_modelHash];  } - (BOOL)isEqual:(id)object {   return [self yy_modelIsEqual:object];  } - (NSString *)description {   return [self yy_modelDescription];  } @end

二、ESJsonFormat与YYModel的结合使用

彩蛋
给大家介绍一款插件,配合ESJsonFormat


易学教程内所有资源均来自网络或用户发布的内容,如有违反法律规定的内容欢迎反馈
该文章没有解决你所遇到的问题?点击提问,说说你的问题,让更多的人一起探讨吧!