YYModel几种使用场景

August 31, 2017

model的属性名映射到其他key

比较常用,比如将模型中的属性名"ID"映射到json中的"id"

//返回一个 Dict，将 Model 属性名对映射到 JSON 的 Key。
+ (NSDictionary *)modelCustomPropertyMapper {
    return @{@"name" : @"n",
             @"page" : @"p",
             @"desc" : @"ext.desc",
             @"bookID" : @[@"id",@"ID",@"book_id"]};
}

model的一个属性为其他模型

不需要其他操作

容器类型

@class Shadow, Border, Attachment;

@interface Attributes
@property NSString *name;
@property NSArray *shadows; //Array<Shadow>
@property NSSet *borders; //Set<Border>
@property NSMutableDictionary *attachments; //Dict<NSString,Attachment>
@end

@implementation Attributes
// 返回容器类中的所需要存放的数据类型 (以 Class 或 Class Name 的形式)。
+ (NSDictionary *)modelContainerPropertyGenericClass {
    return @{@"shadows" : [Shadow class],
             @"borders" : Border.class,
             @"attachments" : @"Attachment" };
}
@end

黑名单与白名单(个人不常用)

@interface User
@property NSString *name;
@property NSUInteger age;
@end
    
@implementation Attributes
// 如果实现了该方法，则处理过程中会忽略该列表内的所有属性
+ (NSArray *)modelPropertyBlacklist {
    return @[@"test1", @"test2"];
}
// 如果实现了该方法，则处理过程中不会处理该列表外的属性。
+ (NSArray *)modelPropertyWhitelist {
    return @[@"name"];
}
@end

数据校验与自定义转换(灵活使用)

// JSON:
{
    "name":"Harry",
    "timestamp" : 1445534567
}
    
// Model:
@interface User
@property NSString *name;
@property NSDate *createdAt;
@end

@implementation User
// 当 JSON 转为 Model 完成后，该方法会被调用。
// 你可以在这里对数据进行校验，如果校验不通过，可以返回 NO，则该 Model 会被忽略。
// 你也可以在这里做一些自动转换不能完成的工作。
- (BOOL)modelCustomTransformFromDictionary:(NSDictionary *)dic {
    NSNumber *timestamp = dic[@"timestamp"];
    if (![timestamp isKindOfClass:[NSNumber class]]) return NO;
    _createdAt = [NSDate dateWithTimeIntervalSince1970:timestamp.floatValue];
    return YES;
}
    
// 当 Model 转为 JSON 完成后，该方法会被调用。
// 你可以在这里对数据进行校验，如果校验不通过，可以返回 NO，则该 Model 会被忽略。
// 你也可以在这里做一些自动转换不能完成的工作。
- (BOOL)modelCustomTransformToDictionary:(NSMutableDictionary *)dic {
    if (!_createdAt) return NO;
    dic[@"timestamp"] = @(n.timeIntervalSince1970);
    return YES;
}
@end

modelCustomTransformFromDictionary: 模型转换完成后会调用，在这里可以做一些值的修改

- (BOOL)modelCustomTransformFromDictionary:(NSDictionary *)dic {
    
    if ([dic[@"recordStatus"] isKindOfClass:[NSString class]]) {
        NSString *invType = dic[@"recordStatus"] ;
        if (invType.length == 0 ) {
            _recordStatus = @"";
        }
        //0未确认1确认已通过2确认未通过
        NSDictionary *dic = @{@"0":@"未确认",
                              @"1":@"确认已通过",
                              @"2":@"确认未通过"
                              };
        _recordStatus =  dic[invType];
    }
    
    return YES;
}

modelCustomTransformToDictionary:,当 Model 转为 JSON 完成后，该方法会被调用。可以对不需要的字段进行处理

- (BOOL)modelCustomTransformToDictionary:(NSMutableDictionary *)dic {
    //model转成dic不要`oilTypeText`
    if ([dic.allKeys containsObject:@"oilTypeText"]) {
        dic[@"oilTypeText"] = nil;
    }
    return YES;
}