Mantle 使用之小坑坑

最近工作中需要一个序列化Model的功能，于是发现了Mantle， Mantle 对于大多数iOS开发者来说可能并不是很陌生，用来帮助开发者方便的将JSON转换成Model的开源库，极大的方便了开发者构建数据结构。本文只是简单的介绍一下Mantle的使用，主要目的的记录一下最近遇到的一个问题。

1.Mabel的简单使用

以下是参考Mantle的GitHub说明：

你的Model类名称叫GHIssue，基本数据结构如下：

typedef enum : NSUInteger {
    GHIssueStateOpen,
    GHIssueStateClosed
} GHIssueState;

@interface GHIssue : MTLModel <MTLJSONSerializing>

@property (nonatomic, copy, readonly) NSURL *URL;
@property (nonatomic, copy, readonly) NSURL *HTMLURL;
@property (nonatomic, copy, readonly) NSNumber *number;
@property (nonatomic, assign, readonly) GHIssueState state;
@property (nonatomic, copy, readonly) NSString *reporterLogin;
@property (nonatomic, strong, readonly) GHUser *assignee;
@property (nonatomic, copy, readonly) NSDate *updatedAt;

@property (nonatomic, copy) NSString *title;
@property (nonatomic, copy) NSString *body;

@property (nonatomic, copy, readonly) NSDate *retrievedAt;

@end

@implementation GHIssue

+ (NSDateFormatter *)dateFormatter {
    NSDateFormatter *dateFormatter = [[NSDateFormatter alloc] init];
    dateFormatter.locale = [[NSLocale alloc] initWithLocaleIdentifier:@"en_US_POSIX"];
    dateFormatter.dateFormat = @"yyyy-MM-dd'T'HH:mm:ss'Z'";
    return dateFormatter;
}

+ (NSDictionary *)JSONKeyPathsByPropertyKey {
    return @{
        @"URL": @"url",
        @"HTMLURL": @"html_url",
        @"number": @"number",
        @"state": @"state",
        @"reporterLogin": @"user.login",
        @"assignee": @"assignee",
        @"updatedAt": @"updated_at"
    };
}

+ (NSValueTransformer *)URLJSONTransformer {
    return [NSValueTransformer valueTransformerForName:MTLURLValueTransformerName];
}

+ (NSValueTransformer *)HTMLURLJSONTransformer {
    return [NSValueTransformer valueTransformerForName:MTLURLValueTransformerName];
}

+ (NSValueTransformer *)stateJSONTransformer {
    return [NSValueTransformer mtl_valueMappingTransformerWithDictionary:@{
        @"open": @(GHIssueStateOpen),
        @"closed": @(GHIssueStateClosed)
    }];
}

+ (NSValueTransformer *)assigneeJSONTransformer {
    return [MTLJSONAdapter dictionaryTransformerWithModelClass:GHUser.class];
}

+ (NSValueTransformer *)updatedAtJSONTransformer {
    return [MTLValueTransformer transformerUsingForwardBlock:^id(NSString *dateString, BOOL *success, NSError *__autoreleasing *error) {
        return [self.dateFormatter dateFromString:dateString];
    } reverseBlock:^id(NSDate *date, BOOL *success, NSError *__autoreleasing *error) {
        return [self.dateFormatter stringFromDate:date];
    }];
}

- (instancetype)initWithDictionary:(NSDictionary *)dictionaryValue error:(NSError **)error {
    self = [super initWithDictionary:dictionaryValue error:error];
    if (self == nil) return nil;
    // Store a value that needs to be determined locally upon initialization.
    _retrievedAt = [NSDate date];
    return self;
}

@end

使用的时候，比如你有一个JSON格式如下：

{
    "url: "http://honeyeeb.com",
    "html_url": "http://honeyeeb.com",
    "number": 2,
    "state": 0,
    "user": {
        "login: "123456"
    },
    "assignee": {
        "name": "honeyeeb",
    },
    "updated_at": "2017-04-16 16:00:00 +0000"
}

创建GHIssue对象的时候可以像下面代码一样：

NSError *error = nil;
GHIssue *user = [MTLJSONAdapter modelOfClass:GHIssue.class fromJSONDictionary:JSONDictionary error:&error];

以上是最简单的使用。

小坑坑

由于调研不够充分或者对Mantle了解不够充分，在使用的过程中发现以下问题：

1. JSON数据值类型与定义的Model属性类型不一致时解析不到数据
2. Model属性值是枚举时JSON数据值不在枚举列表中，数据解析失败或者直接Crash

关于问题1

JSON数据中有这么一对儿值：

"number": 2

GHIssue的属性定义与之相符：

@property (nonatomic, copy, readonly) NSNumber *number;

所以能正常序列化成Model或者Model反序列化成JSON。

但是某种情况下得到的JSON并不一定和iOS开发者定义的Model属性类型一致，比如JSON修改成如下:

"number": "2"

那么JSON序列化到Model得到的是nil，由此猜想Mantle是比较强类型的解析。

关于问题2

GHIssue中的枚举GHIssueState只有两个值(对应基本数据类型：0、1)。

JSON数据中"state": 0的值得范围刚好在GHIssueState中，可以刚好的解析。

but，如果想对GHIssueState进行扩展，就是目前的GHIssueStateOpen和GHIssueStateClose作为基本的值内部使用，其它的可以自己添加扩展，问题来了：

1. GHIssue实现了+stateJSONTransformer协议，因为GHIssue并不知道扩展后的数据，当JSON中的数据不在方法中时，解析直接Crash
2. GHIssue没有实现+stateJSONTransformer协议，当JSON中的数据不在方法中时，数据解析失败。

小结

对Mantle了解的不是特别深入，只是简单使用，发现Mantle库对数据格式要求比较严格，使用时需要认真仔细查看数据结构， 如果想深入了解Mantle的原理，推荐阅读《iOS进阶指南》试读之《Mantle解析》一文，如果文中有错误还请帮忙指出。