现在大部分的项目都需要将服务器返回的JSON数据转换为Model再使用。罪最原始的办法就就是使用KVC 方法。
其次就是使用目前常用的字典转模型工具，Mantle, MJExtension, JSONModel, 虽然他们做的事情都是一样的，但是使用方法区别还是蛮大的，以及在一些细节上的处理也是不同的。
| 常用的集中方法 |
|---|
| * KVC |
| * Mantle |
| * MJExtension |
| * JSONModel |
文档详细度:
JSONModel > MJExtension > Mantle
性能：
JSONModel > MJExtension > Mantle
参考文档：
Mantle、JSONModel、MJExtension性能测试
一、KVC
BSERootNoticeModel.m
#import "BSERootNoticeModel.h"
@implementation BSERootNoticeModel
- (instancetype)initWithDict:(NSDictionary *)dict
{
self = [super init];
if (self) {
[self setValuesForKeysWithDictionary:dict];
}
return self;
}
-(void)setValue:(id)value forUndefinedKey:(NSString *)key{
}
-(void)setNilValueForKey:(NSString *)key{
}
@end
BSERootNoticeModel.h
#import <Foundation/Foundation.h>
@interface BSERootNoticeModel : NSObject
@property(nonatomic,strong)NSString *noticeType;
@property(nonatomic,strong)NSString *content;
@property(nonatomic,strong)NSString *endDate;
- (instancetype)initWithDict:(NSDictionary *)dict;
@end
赋值时使用方法
BSERootNoticeModel *model = [[BSERootNoticeModel alloc]initWithDict:dic];
要点：
核心函数
[self setValuesForKeysWithDictionary:dict];
使用KVC 的时候需要注意 在相应的Model类里面需要重写以下两个方法，防止闪退。
-(void)setValue:(id)value forUndefinedKey:(NSString *)key;
-(void)setNilValueForKey:(NSString *)key;
二、 Mantle 使用
使用Mantle 的Model 需要集成MTLModel 并且实现MTLJSONSerializing 协议。
简单的例子就不来了，可以直接到Github上面查看，这里上一个比较典型全面的例子。
- (NSDictionary *)JSONDict {
if (_JSONDict == nil) {
_JSONDict = @{@"name" : [NSNull null],
@"age" : @20,
@"sex" : @0,
@"login_date" : @"1445136827",
@"phone" : @{
@"name" : @"小明的iPhone",
@"price" : @5000
}
@"books" : @[
@{@"name" : @"西游记"},
@{@"name" : @"三国演义"}
]
};
}
return _JSONDict;
}
对应模型的特点: 1、有NSNull对象, 2、模型里面嵌套模型, 3、模型里面有数组，数组里面有模型.
对应的模型如下:
.h 文件
typedef NS_ENUM(NSUInteger, Sex) {
SexMale,
SexFemale
};
@interface BookForMantle : MTLModel <MTLJSONSerializing>
@property (nonatomic, copy, nullable) NSString *name;
@end
@interface PhoneForMantle : MTLModel <MTLJSONSerializing>
@property (nonatomic, copy, nullable) NSString *name;
@property (nonatomic, assign) double price;
@end
@interface UserForMantle : MTLModel <MTLJSONSerializing>
@property (nonatomic, copy, nullable) NSString *name;
@property (nonatomic, assign) NSInteger age;
@property (nonatomic, assign) Sex sex;
@property (nonatomic, strong, nullable) NSDate *loginDate;
@property (nonatomic, strong, nullable) PhoneForMantle *phone;
@property (nonatomic, copy, nullable) NSArray<BookForMantle *> *books;
@end
.m 文件
@implementation PhoneForMantle
+ (NSDictionary *)JSONKeyPathsByPropertyKey {
return @{@"name" : @"name",
@"price" : @"price"};
}
@end
@implementation BookForMantle
+ (NSDictionary *)JSONKeyPathsByPropertyKey {
return @{@"name" : @"name"};
}
@end
@implementation UserForMantle
// 该map不光是JSON->Model, Model->JSON也会用到
+ (NSDictionary *)JSONKeyPathsByPropertyKey {
return @{@"name" : @"name",
@"age" : @"age",
@"sex" : @"sex",
@"loginDate" : @"login_date",
@"phone" : @"phone",
@"books" : @"books"};
}
// 模型里面的模型
+ (NSValueTransformer *)phoneTransformer {
return [MTLJSONAdapter dictionaryTransformerWithModelClass:[PhoneForMantle class]];
}
// 模型里面的数组
+ (NSValueTransformer *)booksTransformer {
return [MTLJSONAdapter arrayTransformerWithModelClass:[BookForMantle class]];
}
// 时间 将 NSNumber类型的时间转换为NSDate类型
+ (NSValueTransformer *)loginDateJSONTransformer {
return [MTLValueTransformer transformerUsingForwardBlock:^id(NSString *timeIntervalSince1970, BOOL *success, NSError *__autoreleasing *error) {
NSTimeInterval timeInterval = [timeIntervalSince1970 doubleValue];
NSDate *date = [NSDate dateWithTimeIntervalSince1970:timeInterval];
return date;
} reverseBlock:^id(NSDate *date, BOOL *success, NSError *__autoreleasing *error) {
NSTimeInterval timeInterval = date.timeIntervalSince1970;
return @(timeInterval).stringValue;
}];
}
@end
对应的解析方法:
// 注意: Mantle不会自动转类型，如：String->Int, 一旦类型不匹配，直接crash
// Json->Model
// 该方法会调用key-key map方法。
self.userForMantle = [MTLJSONAdapter modelOfClass:[UserForMantle class] fromJSONDictionary:self.JSONDict error:nil];
// 这种方式只是简单的使用KVC进行赋值。不会调用key-key map方法, 要求属性和JSON字典中的key名称相同，否则就crash
// self.userForMantle = [UserForMantle modelWithDictionary:self.JSONDict error:&error];
// Model -> JSON
// 一旦有属性为nil, Mantle会转换成NSNull对象放到JSON字典中，这里有一个坑，使用NSUserDefault存储这样的JSON字典时，程序crash，原因是不可以包含NSNull对象。
NSDictionary *jsonDict = [MTLJSONAdapter JSONDictionaryFromModel:self.userForMantle error:nil];
三、JSOMModel 的使用
仍旧使用上面的例子，对应的模型如下:
// BookForJsonModel
@protocol BookForJsonModel
@end
@interface BookForJsonModel : JSONModel
@property (nonatomic, copy, nullable) NSString *name;
@end
@implementation BookForJSONModel
// 前面是服务器字段，后面是模型属性字段
+ (JSONKeyMapper *)keyMapper {
return [[JSONKeyMapper alloc] initWithDictionary:@{
@"name" : @"name"
}];
}
@end
// PhoneForJSONModel
@interface PhoneForJSONModel : JSONModel
@property (nonatomic, copy, nullable) NSString *name;
@property (nonatomic, assign) double price;
@end
@implementation PhoneForJSONModel
+ (JSONKeyMapper *)keyMapper {
return [[JSONKeyMapper alloc] initWithDictionary:@{
@"name" : @"name",
@"price" : @"price"
}];
}
@end
// UserForJSONModel
@interface UserForJSONModel : JSONModel
@property (nonatomic, copy, nullable) NSString *name;
@property (nonatomic, assign) NSInteger age;
@property (nonatomic, assign) Sex sex;
@property (nonatomic, strong, nullable) NSDate *loginDate;
@property (nonatomic, strong, nullable) PhoneForJSONModel *phone;
// 注意协议 model -> model Array
@property (nonatomic, copy, nullable) NSArray<BookForJSONModel> *books;
@end
@implementation UserForJSONModel
+ (JSONKeyMapper *)keyMapper {
return [[JSONKeyMapper alloc] initWithDictionary:@{
@"name" : @"name",
@"age" : @"age",
@"sex" : @"sex",
@"login_date" : @"loginDate",
@"phone" : @"phone",
@"books" : @"books"
}];
}
// 允许所有字段为空
+ (BOOL)propertyIsOptional:(NSString *)propertyName {
return YES;
}
@end
对应的解析方法
// JSON->Model
UserForJSONModel *user = [[UserForJSONModel alloc] initWithDictionary:self.JSONDict error:nil];
// Model->JSON
NSDictionary *dict = [user toDictionary];
JSONModel各方面都挺好的，唯一需要注意的地方是它归档的方式, 它不是将对象归档，而是转换成字典再归档。
-(instancetype)initWithCoder:(NSCoder *)decoder{
NSString* json = [decoder decodeObjectForKey:@"json"];
JSONModelError *error = nil;
self = [self initWithString:json error:&error];
if (error) {
JMLog(@"%@",[error localizedDescription]);
}
return self;
}
-(void)encodeWithCoder:(NSCoder *)encoder
{
[encoder encodeObject:self.toJSONString forKey:@"json"];//将对象转换成json字符串再归档
}
四、MJExtension的使用
MJExtension 不再详细介绍，大家可以直接看github readme文件已经介绍的很详细
