MJExtension 转换速度快、使用简单方便的字典转模型框架
MJExtension
A fast, convenient and nonintrusive conversion between JSON and model.
转换速度快、使用简单方便的字典转模型框架
GitHub：CoderMJLee ｜ Blog：mjios(Chinese) ｜ PR is welcome，or feedback
Contents
Getting Started 【开始使用】
Features 【能做什么】
Installation 【安装】
Examples 【示例】
JSON -> Model
JSONString -> Model
Model contains model
Model contains model-array
Model name - JSON key mapping
JSON array -> model array
Model -> JSON
Model array -> JSON array
Core Data
Coding
Camel -> underline
NSString -> NSDate, nil -> @""
More use cases
Getting Started【开始使用】
Features【能做什么】
MJExtension是一套字典和模型之间互相转换的超轻量级框架
JSON-->Model、Core Data ModelJSONString-->Model、Core Data ModelModel、Core Data Model-->JSONJSON Array-->Model Array、Core Data Model ArrayJSONString-->Model Array、Core Data Model ArrayModel Array、Core Data Model Array-->JSON ArrayCoding all properties of model in one line code.
只需要一行代码，就能实现模型的所有属性进行Coding（归档和解档）
Installation【安装】
From CocoaPods【使用CocoaPods】
pod 'MJExtension'
Manually【手动导入】
Drag all source files under floder
MJExtensionto your project.【将MJExtension文件夹中的所有源代码拽入项目中】Import the main header file：
#import "MJExtension.h"【导入主头文件：#import "MJExtension.h"】
MJExtension.h MJConst.h MJConst.m MJFoundation.h MJFoundation.m MJProperty.h MJProperty.m MJType.h MJType.m NSObject+MJCoding.h NSObject+MJCoding.m NSObject+MJProperty.h NSObject+MJProperty.m NSObject+MJKeyValue.h NSObject+MJKeyValue.m
Examples【示例】
The most simple JSON -> Model【最简单的字典转模型】
typedef enum {
SexMale,
SexFemale
} Sex;@interface User : NSObject@property (copy, nonatomic) NSString *name;@property (copy, nonatomic) NSString *icon;@property (assign, nonatomic) unsigned int age;@property (copy, nonatomic) NSString *height;@property (strong, nonatomic) NSNumber *money;@property (assign, nonatomic) Sex sex;@property (assign, nonatomic, getter=isGay) BOOL gay;@end/***********************************************/NSDictionary *dict = @{ @"name" : @"Jack", @"icon" : @"lufy.png", @"age" : @20, @"height" : @"1.55", @"money" : @100.9, @"sex" : @(SexFemale), @"gay" : @"true"// @"gay" : @"1"// @"gay" : @"NO"};// JSON -> UserUser *user = [User mj_objectWithKeyValues:dict];NSLog(@"name=%@, icon=%@, age=%zd, height=%@, money=%@, sex=%d, gay=%d", user.name, user.icon, user.age, user.height, user.money, user.sex, user.gay);// name=Jack, icon=lufy.png, age=20, height=1.550000, money=100.9, sex=1
JSONString -> Model【JSON字符串转模型】
// 1.Define a JSONStringNSString *jsonString = @"{\"name\":\"Jack\", \"icon\":\"lufy.png\", \"age\":20}";// 2.JSONString -> UserUser *user = [User mj_objectWithKeyValues:jsonString];// 3.Print user's propertiesNSLog(@"name=%@, icon=%@, age=%d", user.name, user.icon, user.age);// name=Jack, icon=lufy.png, age=20
Model contains model【模型中嵌套模型】
@interface Status : NSObject@property (copy, nonatomic) NSString *text;@property (strong, nonatomic) User *user;@property (strong, nonatomic) Status *retweetedStatus;@end/***********************************************/NSDictionary *dict = @{ @"text" : @"Agree!Nice weather!", @"user" : @{ @"name" : @"Jack", @"icon" : @"lufy.png"
}, @"retweetedStatus" : @{ @"text" : @"Nice weather!", @"user" : @{ @"name" : @"Rose", @"icon" : @"nami.png"
}
}
};// JSON -> StatusStatus *status = [Status mj_objectWithKeyValues:dict];NSString *text = status.text;NSString *name = status.user.name;NSString *icon = status.user.icon;NSLog(@"text=%@, name=%@, icon=%@", text, name, icon);// text=Agree!Nice weather!, 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=Nice weather!, name2=Rose, icon2=nami.png
Model contains model-array【模型中有个数组属性，数组里面又要装着其他模型】
@interface Ad : NSObject@property (copy, nonatomic) NSString *image;@property (copy, nonatomic) NSString *url;@end@interface StatusResult : NSObject/** Contatins status model */@property (strong, nonatomic) NSMutableArray *statuses;/** Contatins ad model */@property (strong, nonatomic) NSArray *ads;@property (strong, nonatomic) NSNumber *totalNumber;@end/***********************************************/// Tell MJExtension what type model will be contained in statuses and ads.[StatusResult mj_setupObjectClassInArray:^NSDictionary *{ return @{ @"statuses" : @"Status", // @"statuses" : [Status class],
@"ads" : @"Ad"
// @"ads" : [Ad class]
};
}];// Equals: StatusResult.m implements +mj_objectClassInArray method.NSDictionary *dict = @{ @"statuses" : @[
@{ @"text" : @"Nice weather!", @"user" : @{ @"name" : @"Rose", @"icon" : @"nami.png"
}
},
@{ @"text" : @"Go camping tomorrow!", @"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"};// JSON -> StatusResultStatusResult *result = [StatusResult mj_objectWithKeyValues:dict];NSLog(@"totalNumber=%@", result.totalNumber);// totalNumber=2014// Printingfor (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=Nice weather!, name=Rose, icon=nami.png// text=Go camping tomorrow!, name=Jack, icon=lufy.png// Printingfor (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
Model name - JSON key mapping【模型中的属性名和字典中的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/***********************************************/// How to map[Student mj_setupReplacedKeyFromPropertyName:^NSDictionary *{ return @{ @"ID" : @"id", @"desc" : @"desciption", @"oldName" : @"name.oldName", @"nowName" : @"name.newName", @"nameChangedTime" : @"name.info[1].nameChangedTime", @"bag" : @"other.bag"
};
}];// Equals: Student.m implements +mj_replacedKeyFromPropertyName method.NSDictionary *dict = @{ @"id" : @"20", @"desciption" : @"kids", @"name" : @{ @"newName" : @"lufy", @"oldName" : @"kitty", @"info" : @[ @"test-data",
@{ @"nameChangedTime" : @"2013-08"
}
]
}, @"other" : @{ @"bag" : @{ @"name" : @"a red bag", @"price" : @100.7
}
}
};// JSON -> StudentStudent *stu = [Student mj_objectWithKeyValues:dict];// PrintingNSLog(@"ID=%@, desc=%@, oldName=%@, nowName=%@, nameChangedTime=%@",
stu.ID, stu.desc, stu.oldName, stu.nowName, stu.nameChangedTime);// ID=20, desc=kids, oldName=kitty, nowName=lufy, nameChangedTime=2013-08NSLog(@"bagName=%@, bagPrice=%f", stu.bag.name, stu.bag.price);// bagName=a red bag, bagPrice=100.700000
JSON array -> model array【将一个字典数组转成模型数组】
NSArray *dictArray = @[
@{ @"name" : @"Jack", @"icon" : @"lufy.png"
},
@{ @"name" : @"Rose", @"icon" : @"nami.png"
}
];// JSON array -> User arrayNSArray *userArray = [User mj_objectArrayWithKeyValuesArray:dictArray];// Printingfor (User *user in userArray) { NSLog(@"name=%@, icon=%@", user.name, user.icon);
}// name=Jack, icon=lufy.png// name=Rose, icon=nami.png
Model -> JSON【将一个模型转成字典】
// New modelUser *user = [[User alloc] init];
user.name = @"Jack";
user.icon = @"lufy.png";
Status *status = [[Status alloc] init];
status.user = user;
status.text = @"Nice mood!";// Status -> JSONNSDictionary *statusDict = status.mj_keyValues;NSLog(@"%@", statusDict);/* { text = "Nice mood!"; user = { icon = "lufy.png"; name = Jack; }; } */// More complex situationStudent *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 = @"a red bag";
bag.price = 205;
stu.bag = bag;NSDictionary *stuDict = stu.mj_keyValues;NSLog(@"%@", stuDict);/*{ ID = 123; bag = { name = "\U5c0f\U4e66\U5305"; price = 205; }; desc = handsome; nameChangedTime = "2018-09-08"; nowName = jack; oldName = rose;} */
Model array -> JSON array【将一个模型数组转成字典数组】
// New model arrayUser *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];// Model array -> JSON arrayNSArray *dictArray = [User mj_keyValuesArrayWithObjectArray:userArray];NSLog(@"%@", dictArray);/* ( { icon = "lufy.png"; name = Jack; }, { icon = "nami.png"; name = Rose; } ) */
Core Data
NSDictionary *dict = @{ @"name" : @"Jack", @"icon" : @"lufy.png", @"age" : @20, @"height" : @1.55, @"money" : @"100.9", @"sex" : @(SexFemale), @"gay" : @"true"
};// This demo just provide simple stepsNSManagedObjectContext *context = nil;
User *user = [User mj_objectWithKeyValues:dict context:context];
[context save:nil];
Coding
#import "MJExtension.h"@implementation Bag// NSCoding ImplementationMJExtensionCodingImplementation@end/***********************************************/// what properties not to be coded[Bag mj_setupIgnoredCodingPropertyNames:^NSArray *{ return @[@"name"];
}];// Equals: Bag.m implements +mj_ignoredCodingPropertyNames method.// Create modelBag *bag = [[Bag alloc] init];
bag.name = @"Red bag";
bag.price = 200.8;NSString *file = [NSHomeDirectory() stringByAppendingPathComponent:@"Desktop/bag.data"];// Encoding[NSKeyedArchiver archiveRootObject:bag toFile:file];// DecodingBag *decodedBag = [NSKeyedUnarchiver unarchiveObjectWithFile:file];NSLog(@"name=%@, price=%f", decodedBag.name, decodedBag.price);// name=(null), price=200.800000
Camel -> underline【统一转换属性名（比如驼峰转下划线）】
// Dog#import "MJExtension.h"@implementation Dog+ (NSString *)mj_replacedKeyFromPropertyName121:(NSString *)propertyName{ // nickName -> nick_name
return [propertyName mj_underlineFromCamel];
}@end// NSDictionaryNSDictionary *dict = @{ @"nick_name" : @"旺财", @"sale_price" : @"10.5", @"run_speed" : @"100.9"
};// NSDictionary -> DogDog *dog = [Dog mj_objectWithKeyValues:dict];// printingNSLog(@"nickName=%@, scalePrice=%f runSpeed=%f", dog.nickName, dog.salePrice, dog.runSpeed);
NSString -> NSDate, nil -> @""【过滤字典的值（比如字符串日期处理为NSDate、字符串nil处理为@""）】
// Book#import "MJExtension.h"@implementation Book- (id)mj_newValueFromOldValue:(id)oldValue property:(MJProperty *)property{ if ([property.name isEqualToString:@"publisher"]) { if (oldValue == nil) return @"";
} else if (property.type.typeClass == [NSDate class]) { NSDateFormatter *fmt = [[NSDateFormatter alloc] init];
fmt.dateFormat = @"yyyy-MM-dd"; return [fmt dateFromString:oldValue];
} return oldValue;
}@end// NSDictionaryNSDictionary *dict = @{ @"name" : @"5分钟突破iOS开发", @"publishedTime" : @"2011-09-10"
};// NSDictionary -> BookBook *book = [Book mj_objectWithKeyValues:dict];// printingNSLog(@"name=%@, publisher=%@, publishedTime=%@", book.name, book.publisher, book.publishedTime);
More use cases【更多用法】
Please reference to
NSObject+MJKeyValue.handNSObject+MJCoding.h