iOS开发·KVC:字典转模型,防止因本地未定义字段(后台的字段与本地字符串名不一致)导致数据转换过程中的奔溃

将后台JSON数据中的字典转成本地的模型,我们一般选用部分优秀的第三方框架,如SBJSON、JSONKit、MJExtension、YYModel等。但是,一些简单的数据,我们也可以尝试自己来实现转换的过程。

更重要的是,有时候在iOS面试的时候,部分面试官会不仅问你某种场景会用到什么框架,更会问你如果要你来实现这个功能,你有没有解决思路?所以,自己实现字典转模型还是有必要掌握的。有了这个基础,在利用运行时runtime的动态特性,你也可以实现这些第三方框架。

笔者的KVC系列为:

1. 建模

假设网络请求图片信息并在APP的界面上展示,这里新建一个图书图片的模型,id表示图书的ID,imgUrl是图书的封面地址(可以用SDWebImage加载该图),nameStr时图书的名字,introduceStr是图书的简介。

我们建立一个模型如下(暂不先管id这个含有关键字的属性,后面会讲):

  • BookModel.h
#import <Foundation/Foundation.h>

@interface BookModel : NSObject
@property (nonatomic,strong) NSString *id;
@property (nonatomic,strong) NSString *imgUrlStr;
@property (nonatomic,strong) NSString *nameStr;
@property (nonatomic,strong) NSString *introduceStr;

+ (instancetype)getBookModelWithDict:(NSDictionary *)dict;

@end
  • BookModel.m
#import "BookModel.h"
@implementation BookModel
+ (instancetype)getBookModelWithDict:(NSDictionary *)dict
{
    BookModel *bookModel = [[self alloc] init];
    [bookModel setValuesForKeysWithDictionary:dict];
    return bookModel;
}
@end

当然,你也可以一个一个地为每个属性分别写setValue,不嫌麻烦的话

#import "BookModel.h"
@implementation BookModel
+ (instancetype)getBookModelWithDict:(NSDictionary *)dict
{
    BookModel *bookModel = [[self alloc] init];
    [bookModel setValue:[dict valueForKey:@"id"] forKey:@"id"];
    [bookModel setValue:[dict valueForKey:@"imgUrlStr"] forKey:@"imgUrlStr"];
    [bookModel setValue:[dict valueForKey:@"nameStr"] forKey:@"nameStr"];
    [bookModel setValue:[dict valueForKey:@"introduceStr"] forKey:@"introduceStr"];
    return bookModel;
}
@end

2. 含有模型未定义属性同名字段的字典

字典转模型过程中也会遇到一些问题,比如,字典里面有多余的keyValue,但是模型没有定义同名属性,使用setValuesForKeysWithDictionary就会崩溃了。

但是,只需要重写- (void)setValue:(id)value forUndefinedKey:(NSString *)key方法即可防止未定义的字段与本地字符串名不一致导致的奔溃。

  • BookModel.m
-(void)setValue:(id)value forUndefinedKey:(NSString *)key{
    //空的什么都不写都可以
}

3. 含有系统关键字同名字段的字典

如上所示,许多JSON数据里面会有一个id的字段, 而id是iOS的一个关键字,不能用关键字定义属性名,此时我们就需要在model类中修改这个属性的名字,并在- (void)setValue:(id)value forUndefinedKey:(NSString *)key的方法体中重写该方法,以针对id字段作特殊处理。

  • BookModel.h
@property (nonatomic,strong) NSString *bookId;
  • BookModel.m
- (void)setValue:(id)value forUndefinedKey:(NSString *)key  {
    if([key isEqualToString:@"id"]){
        //self.bookId = value;//不推荐
        [self setValue:value forKey:@"bookId"]; // 推荐
    }
}

4. 示例

假设,APP本地里面用plist写了一个字典数组,然后写一个CustomerListModel模型。现在,需要将这个plist字典数组转换成CustomerListModel模型数组,并在VC取值出来赋给表单元cell的模型数组,用于展示数据。示例的用法参考如下:

  • CustomerListModel.m
#import "CustomerListModel.h"

@implementation CustomerListModel

//kvc实现字典转模型
- (instancetype)initWithDict:(NSDictionary *)dict{
    if (self = [super init]) {
        [self setValuesForKeysWithDictionary:dict];
    }
    return self;
}

//防止与后台字段不匹配而造成崩溃
- (void)setValue:(id)value forUndefinedKey:(NSString *)key{}

//类方法:实现字典转模型,返回模型对象
+ (instancetype)customerListModelWithDict:(NSDictionary *)dict;{
    return [[self alloc]initWithDict:dict];
}

//类方法:实现字典转模型,返回模型对象数组
+ (NSArray<CustomerListModel *> *)customerListModelsWithPlistName:(NSString *)plistName;{
    //获取路径
    NSString *path = [[NSBundle mainBundle]pathForResource:plistName ofType:@"plist"];
    //读取plist
    NSArray *dictArr = [NSArray arrayWithContentsOfFile:path];
    //字典转模型
    NSMutableArray *modelArr = [NSMutableArray array];
    [dictArr enumerateObjectsUsingBlock:^(NSDictionary *dict, NSUInteger idx, BOOL * _Nonnull stop) {
        [modelArr addObject:[self customerListModelWithDict:dict]];
    }];
    return modelArr.copy;
}

@end
  • 调用处的VC中
    • 1).导入模型对象头文件,并声明模型对象数组属性:
@property (nonatomic, strong) NSArray<GloryListModel *> * customerListModelArr;
    • 2).重写懒加载,并在tableView的代理方法调取模型数组用于显示:
#pragma mark - 懒加载模型数组
- (NSArray< CustomerListModel *> *)customerListModelArr{
    if (!_customerListModelArr) {
        _customerListModelArr = [CustomerListModel customerListModelsWithPlistName:@"GloryList"];
    }
    return _customerListModelArr;
}

//cell delegate
- (UITableViewCell *)tableView:(UITableView *)tableView cellForRowAtIndexPath:(NSIndexPath *)indexPath{
    GloryListCell *cell = [tableView dequeueReusableCellWithIdentifier:NSStringFromClass([GloryListCell class])];
    //定制表格单元分割线
    if ([self.tableView respondsToSelector:@selector(setSeparatorInset:)]) {
        [self.tableView setSeparatorInset:UIEdgeInsetsMake(0, 0, 0, 0)];
    }
    cell.customerListModel = self.customerListModelArr[indexPath.row];
    return cell;
}

5. 小结

划重点:
- (void)setValue:(id)value forUndefinedKey:(NSString *)key方法的作用

  • 1、当实现这个方法以后,对未定义的keyValue的处理,防止奔溃。
-(void)setValue:(id)value forUndefinedKey:(NSString *)key{
    //空的什么都不写都可以
    //return nil;
}
  • 2、如果服务返回的字符串有系统默认不能使用的关键字(例如:id ,description等可以进行转换)
-(void)setValue:(id)value forUndefinedKey:(NSString *)key
{
    if ([key isEqualToString:@"id"]) {
        //self.id1 = value;// 不推荐
        [self setValue:value forKey:@"id1"]; // 推荐
    }
    if ([key isEqualToString:@"description"]) {
        //self.description1 = value;// 不推荐
        [self setValue:value forKey:@"description1"]; // 推荐
    }
}
  • 3、除了自己实现字典转模型,可以考虑选用部分优秀的第三方框架,如MJExtension、YYModel等。
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 158,560评论 4 361
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 67,104评论 1 291
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 108,297评论 0 243
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 43,869评论 0 204
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,275评论 3 287
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,563评论 1 216
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,833评论 2 312
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,543评论 0 197
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,245评论 1 241
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,512评论 2 244
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,011评论 1 258
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,359评论 2 253
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,006评论 3 235
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,062评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,825评论 0 194
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,590评论 2 273
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,501评论 2 268