IOS 字典模型互转框架 MJExtension

• MJExtension是一套字典和模型之间互相转换的超轻量级框架

• MJExtension能完成的功能

  • 字典（JSON） --> 模型（Model）

  • 模型（Model） --> 字典（JSON）

  • 字典数组（JSON Array） --> 模型数组（Model Array）

  • 模型数组（Model Array） --> 字典数组（JSON Array）

• 详尽用法主要参考 main.m中的各个函数 以及 NSObject+MJKeyValue.h

MJExtension和JSONModel、Mantle等框架的区别

• 转换速率：

  • 最近一次测试表明：MJExtension > JSONModel > Mantle

  • 各位开发者也可以自行测试

• 具体用法：

  • JSONModel：要求所有模型类必须继承自JSONModel基类

  • Mantle：要求所有模型类必须继承自MTModel基类

  • MJExtension：不需要你的模型类继承任何特殊基类，毫无污染，毫无侵入性

如何使用MJExtension

• cocoapods导入：pod 'MJExtension'

• 手动导入：

  • 将MJExtensionExample/MJExtensionExample/MJExtension文件夹中的所有源代码拽入项目中

  • 导入主头文件：#import "MJExtension.h"

MJExtension.hMJConst.h               MJConst.mMJFoundation.h          MJFoundation.mMJIvar.h                MJIvar.mMJType.h                MJType.mNSObject+MJCoding.h     NSObject+MJCoding.mNSObject+MJIvar.h       NSObject+MJIvar.mNSObject+MJKeyValue.h   NSObject+MJKeyValue.m

最简单的字典转模型

typedef enum {    SexMale,    SexFemale} Sex;@interface User : NSObject@property (copy, nonatomic) NSString *name;@property (copy, nonatomic) NSString *icon;@property (assign, nonatomic) int age;@property (assign, nonatomic) double height;@property (strong, nonatomic) NSNumber *money;@property (assign, nonatomic) Sex sex;@endNSDictionary *dict = @{               @"name" : @"Jack",               @"icon" : @"lufy.png",               @"age" : @20,               @"height" : @"1.55",               @"money" : @100.9,               @"sex" : @(SexFemale)            };// 将字典转为User模型User *user = [User objectWithKeyValues:dict];NSLog(@"name=%@, icon=%@, age=%d, height=%@, money=%@, sex=%d",     user.name, user.icon, user.age, user.height, user.money, user.sex);// name=Jack, icon=lufy.png, age=20, height=1.550000, money=100.9, sex=1

核心代码

• [User objectWithKeyValues:dict]

模型中嵌套模型

@interface Status : NSObject/** 微博文本内容 */@property (copy, nonatomic) NSString *text;/** 微博作者 */@property (strong, nonatomic) User *user;/** 转发的微博 */@property (strong, nonatomic) Status *retweetedStatus;@endNSDictionary *dict = @{               @"text" : @"是啊，今天天气确实不错！",               @"user" : @{                   @"name" : @"Jack",                   @"icon" : @"lufy.png"                },               @"retweetedStatus" : @{                   @"text" : @"今天天气真不错！",                   @"user" : @{                       @"name" : @"Rose",                       @"icon" : @"nami.png"                    }                }            };// 将字典转为Status模型Status *status = [Status objectWithKeyValues:dict];NSString *text = status.text;NSString *name = status.user.name;NSString *icon = status.user.icon;NSLog(@"text=%@, name=%@, icon=%@", text, name, icon);// text=是啊，今天天气确实不错！, name=Jack, icon=lufy.pngNSString *text2 = status.retweetedStatus.text;NSString *name2 = status.retweetedStatus.user.name;NSString *icon2 = status.retweetedStatus.user.icon;NSLog(@"text2=%@, name2=%@, icon2=%@", text2, name2, icon2);// text2=今天天气真不错！, name2=Rose, icon2=nami.png

核心代码

• [Status objectWithKeyValues:dict]

模型中有个数组属性，数组里面又要装着其他模型

@interface Ad : NSObject@property (copy, nonatomic) NSString *image;@property (copy, nonatomic) NSString *url;@end@interface StatusResult : NSObject/** 存放着一堆的微博数据（里面都是Status模型） */@property (strong, nonatomic) NSMutableArray *statuses;/** 存放着一堆的广告数据（里面都是Ad模型） */@property (strong, nonatomic) NSArray *ads;@property (strong, nonatomic) NSNumber *totalNumber;@end@implementation StatusResult// 实现这个方法的目的：告诉MJExtension框架statuses和ads数组里面装的是什么模型/*+ (NSDictionary *)objectClassInArray{    return @{         @"statuses" : [Status class],         @"ads" : [Ad class]    };}+ (Class)objectClassInArray:(NSString *)propertyName{    if ([propertyName isEqualToString:@"statuses"]) {        return [Status class];    } else if ([propertyName isEqualToString:@"ads"]) {        return [Ad class];    }    return nil;}*/// 这个方法对比上面的2个方法更加没有侵入性和污染，因为不需要导入Status和Ad的头文件+ (NSDictionary *)objectClassInArray{    return @{         @"statuses" : @"Status",         @"ads" : @"Ad"    };}@endNSDictionary *dict = @{                       @"statuses" : @[                           @{                               @"text" : @"今天天气真不错！",                               @"user" : @{                                   @"name" : @"Rose",                                   @"icon" : @"nami.png"                               }                            },                           @{                               @"text" : @"明天去旅游了",                               @"user" : @{                                   @"name" : @"Jack",                                   @"icon" : @"lufy.png"                               }                            }                        ],                       @"ads" : @[                           @{                               @"image" : @"ad01.png",                               @"url" : @"http://www.ad01.com"                           },                           @{                               @"image" : @"ad02.png",                               @"url" : @"http://www.ad02.com"                           }                       ],                       @"totalNumber" : @"2014"                    };// 将字典转为StatusResult模型StatusResult *result = [StatusResult objectWithKeyValues:dict];NSLog(@"totalNumber=%@", result.totalNumber);// totalNumber=2014// 打印statuses数组中的模型属性for (Status *status in result.statuses) {    NSString *text = status.text;    NSString *name = status.user.name;    NSString *icon = status.user.icon;    NSLog(@"text=%@, name=%@, icon=%@", text, name, icon);}// text=今天天气真不错！, name=Rose, icon=nami.png// text=明天去旅游了, name=Jack, icon=lufy.png// 打印ads数组中的模型属性for (Ad *ad in result.ads) {    NSLog(@"image=%@, url=%@", ad.image, ad.url);}// image=ad01.png, url=http://www.ad01.com// image=ad02.png, url=http://www.ad02.com

核心代码

• 在模型内部实现+ (NSDictionary *)objectClassInArray方法
  

• [StatusResult objectWithKeyValues:dict]

模型中的属性名和字典中的key不相同(或者需要多级映射)

@interface Bag : NSObject@property (copy, nonatomic) NSString *name;@property (assign, nonatomic) double price;@end@interface Student : NSObject@property (copy, nonatomic) NSString *ID;@property (copy, nonatomic) NSString *desc;@property (copy, nonatomic) NSString *nowName;@property (copy, nonatomic) NSString *oldName;@property (copy, nonatomic) NSString *nameChangedTime;@property (strong, nonatomic) Bag *bag;@end@implementation Student// 实现这个方法的目的：告诉MJExtension框架模型中的属性名对应着字典的哪个key+ (NSDictionary *)replacedKeyFromPropertyName{    return @{                @"ID" : @"id",                @"desc" : @"desciption",                @"oldName" : @"name.oldName",                @"nowName" : @"name.newName",                @"nameChangedTime" : @"name.info.nameChangedTime",                @"bag" : @"other.bag"            };}@endNSDictionary *dict = @{                       @"id" : @"20",                       @"desciption" : @"孩子",                       @"name" : @{                            @"newName" : @"lufy",                            @"oldName" : @"kitty",                            @"info" : @{                                @"nameChangedTime" : @"2013-08"                            }                       },                       @"other" : @{                            @"bag" : @{                                @"name" : @"小书包",                                @"price" : @100.7                            }                       }                   };// 将字典转为Student模型Student *stu = [Student objectWithKeyValues:dict];// 打印Student模型的属性NSLog(@"ID=%@, desc=%@, oldName=%@, nowName=%@, nameChangedTime=%@",          stu.ID, stu.desc, stu.oldName, stu.nowName, stu.nameChangedTime);// ID=20, desc=孩子, oldName=kitty, nowName=lufy, nameChangedTime=2013-08NSLog(@"bagName=%@, bagPrice=%f", stu.bag.name, stu.bag.price);// bagName=小书包, bagPrice=100.700000

核心代码

• 在模型内部实现+ (NSDictionary *)replacedKeyFromPropertyName方法
  

• [Student objectWithKeyValues:dict]

将一个字典数组转成模型数组

NSArray *dictArray = @[                       @{                           @"name" : @"Jack",                           @"icon" : @"lufy.png",                        },                       @{                           @"name" : @"Rose",                           @"icon" : @"nami.png",                        }                    ];// 将字典数组转为User模型数组NSArray *userArray = [User objectArrayWithKeyValuesArray:dictArray];// 打印userArray数组中的User模型属性for (User *user in userArray) {    NSLog(@"name=%@, icon=%@", user.name, user.icon);}// name=Jack, icon=lufy.png// name=Rose, icon=nami.png

核心代码

• [User objectArrayWithKeyValuesArray:dictArray]

将一个模型转成字典

// 新建模型User *user = [[User alloc] init];user.name = @"Jack";user.icon = @"lufy.png";Status *status = [[Status alloc] init];status.user = user;status.text = @"今天的心情不错！";// 将模型转为字典NSDictionary *statusDict = status.keyValues;NSLog(@"%@", statusDict);/*{    text = "今天的心情不错！";    user =     {        icon = "lufy.png";        name = Jack;    };}*/// 多级映射的模型Student *stu = [[Student alloc] init];stu.ID = @"123";stu.oldName = @"rose";stu.nowName = @"jack";stu.desc = @"handsome";stu.nameChangedTime = @"2018-09-08";Bag *bag = [[Bag alloc] init];bag.name = @"小书包";bag.price = 205;stu.bag = bag;NSDictionary *stuDict = stu.keyValues;NSLog(@"%@", stuDict);/*{    desciption = handsome;    id = 123;    name =     {        info =         {            nameChangedTime = "2018-09-08";        };        newName = jack;        oldName = rose;    };    other =     {        bag =         {            name = "小书包";            price = 205;        };    };}*/

核心代码

• status.keyValues、stu.keyValues

将一个模型数组转成字典数组

// 新建模型数组User *user1 = [[User alloc] init];user1.name = @"Jack";user1.icon = @"lufy.png";User *user2 = [[User alloc] init];user2.name = @"Rose";user2.icon = @"nami.png";NSArray *userArray = @[user1, user2];// 将模型数组转为字典数组NSArray *dictArray = [User keyValuesArrayWithObjectArray:userArray];NSLog(@"%@", dictArray);/*(    {        icon = "lufy.png";        name = Jack;    },    {        icon = "nami.png";        name = Rose;    })*/

核心代码

• [User keyValuesArrayWithObjectArray:userArray]

更多用法

• 参考NSObject+MJKeyValue.h

• 参考NSObject+MJCoding.h