iOS YYModel的使用

热门标签

特别声明:文章多为网络转载,资源使用一般不提供任何帮助,特殊资源除外,如有侵权请联系!

iOS开发中总会用到各种JSON与模型相互转换的需求,之前的项目中一直使用MJExtension,但是最近发现一个轻量级的库YYModel,使用简单,性能也很不错,接下来就说说YYModel的一些简单的用法及注意事项.

  • JSON转换为模型,或者模型转换为JSON的例子
//JSON
{
    accountId = "<null>";
    avatarUrl = "http://thirdwx.qlogo.cn/mmopen/vi_32/sqicFCgiaheqCFbjrYgTmwXUQOB5l5Iyo47cVVp2cLlHARck6XgXscqicJ2ZVibicCbGH4iaVcQz8ptXqbV6n9ic5iaL9g/132";
    unionId = o2t87wKAR1pNRZR0cnReBT608mok;
    userid = 11703346;
    wxNickName = "\U90a3\U5496";
}
//Model
@interface MyFansModel : NSObject
@property (nonatomic, strong) NSString *avatarUrl;
@property (nonatomic, strong) NSString *wxNickName;
@property (nonatomic, strong) NSString *accountId;
@property (nonatomic, strong) NSString *unionId;
@property (nonatomic, strong) NSString *userid;
@end
//JSON转换为模型
MyFansModel *fansModel = [MyFansModel yy_modelWithJSON:dic];
MyFansModel *fansModel = [MyFansModel yy_modelWithDictionary:dic];

//模型转换为JSON
NSDictionary *json = [fansModel yy_modelToJSONObject];
  • 手动创建的模型和服务端返回的模型属性名称不一致时的例子
//JSON
{ "merchantId" = "<null>";
  "avatar" = "http://thirdwx.qlogo.cn/mmopen/vi_32/sqicFCgiaheqCFbjrYgTmwXUQOB5l5Iyo47cVVp2cLlHARck6XgXscqicJ2ZVibicCbGH4iaVcQz8ptXqbV6n9ic5iaL9g/132";
  "unionID" = "o2t87wKAR1pNRZR0cnReBT608mok";
  "userID" = "11703346";
  "userName" = "贺建奎";
}
//Model
//.h中
#import <YYModel.h>
@interface MyFansModel : NSObject <YYModel>
@property (nonatomic, strong) NSString *avatarUrl;
@property (nonatomic, strong) NSString *wxNickName;
@property (nonatomic, strong) NSString *accountId;
@property (nonatomic, strong) NSString *unionId;
@property (nonatomic, strong) NSString *userid;
@end
//.m中
+ (nullable NSDictionary<NSString *, id> *)modelCustomPropertyMapper
{
    return @{@"avatarUrl" : @"avatar",
             @"wxNickName" : @"userName",
             @"accountId" : @"merchantId",
             @"unionId" : @"unionID",
             @"userid":@"userID",
             };
}
MyFansModel *fansModel = [MyFansModel yy_modelWithJSON:dic];
MyFansModel *fansModel = [MyFansModel yy_modelWithDictionary:dic];
  • 模型套模型的例子
//JSON
{
    citys =   (
                {
            area = "<null>";
            areaId = "<null>";
            areas =             (
                                {
                    area = "\U4e1c\U57ce\U533a";
                    cityid = 110100;
                    id = 110101;
                    status = 1;
                },
                                {
                    area = "\U897f\U57ce\U533a";
                    cityid = 110100;
                    id = 110102;
                    status = 1;
                },
                                {
                    area = "\U5d07\U6587\U533a";
                    cityid = 110100;
                    id = 110103;
                    status = 1;
                },
                                {
                    area = "\U5ba3\U6b66\U533a";
                    cityid = 110100;
                    id = 110104;
                    status = 1;
                },
                                {
                    area = "\U671d\U9633\U533a";
                    cityid = 110100;
                    id = 110105;
                    status = 1;
                },
                                {
                    area = "\U4e30\U53f0\U533a";
                    cityid = 110100;
                    id = 110106;
                    status = 1;
                },
                                {
                    area = "\U77f3\U666f\U5c71\U533a";
                    cityid = 110100;
                    id = 110107;
                    status = 1;
                },
                                {
                    area = "\U6d77\U6dc0\U533a";
                    cityid = 110100;
                    id = 110108;
                    status = 1;
                },
                                {
                    area = "\U95e8\U5934\U6c9f\U533a";
                    cityid = 110100;
                    id = 110109;
                    status = 1;
                },
                                {
                    area = "\U623f\U5c71\U533a";
                    cityid = 110100;
                    id = 110111;
                    status = 1;
                },
                                {
                    area = "\U901a\U5dde\U533a";
                    cityid = 110100;
                    id = 110112;
                    status = 1;
                },
                                {
                    area = "\U987a\U4e49\U533a";
                    cityid = 110100;
                    id = 110113;
                    status = 1;
                },
                                {
                    area = "\U660c\U5e73\U533a";
                    cityid = 110100;
                    id = 110114;
                    status = 1;
                },
                                {
                    area = "\U5927\U5174\U533a";
                    cityid = 110100;
                    id = 110115;
                    status = 1;
                },
                                {
                    area = "\U6000\U67d4\U533a";
                    cityid = 110100;
                    id = 110116;
                    status = 1;
                },
                                {
                    area = "\U5e73\U8c37\U533a";
                    cityid = 110100;
                    id = 110117;
                    status = 1;
                }
            );
            city = "\U5e02\U8f96\U533a";
            cityId = "<null>";
            id = 110100;
            province = "<null>";
            provinceid = 110000;
            status = 1;
        },
                {
            area = "<null>";
            areaId = "<null>";
            areas =             (
                                {
                    area = "\U5bc6\U4e91\U53bf";
                    cityid = 110200;
                    id = 110228;
                    status = 1;
                },
                                {
                    area = "\U5ef6\U5e86\U53bf";
                    cityid = 110200;
                    id = 110229;
                    status = 1;
                }
            );
            city = "\U53bf";
            cityId = "<null>";
            id = 110200;
            province = "<null>";
            provinceid = 110000;
            status = 1;
        }
    );
    id = 110000;
    province = "\U5317\U4eac\U5e02";
    status = 1;
}
//Model
//.h
//BaseModel 只是为了将id映射为_id 
#import <YYModel.h>
NS_ASSUME_NONNULL_BEGIN

@interface BaseModel : NSObject <YYModel>

/// id 映射为 _id
@property (nonatomic, copy) NSString *_id;

@end
//.m
+(NSDictionary<NSString *,id> *)modelCustomPropertyMapper
{
    return @{@"_id": @"id"};
}
//真正使用的模型的.h文件
@interface AreaModel : BaseModel
@property (nonatomic, copy) NSString *area;
@property (nonatomic, copy) NSString *cityid;
@property (nonatomic, copy) NSString *status;
@end

@interface CityModel : BaseModel
@property (nonatomic, copy) NSString *city;
@property (nonatomic, copy) NSString *provinceid;
@property (nonatomic, copy) NSString *status;
@property (nonatomic, strong) NSArray *areas;
@end

@interface ProvinceModel : BaseModel

@property (nonatomic, copy) NSString *province;
@property (nonatomic, copy) NSString *status;
@property (nonatomic, strong) NSArray *citys;

@end
//.m 文件
@implementation AreaModel

@end

@implementation CityModel
+ (NSDictionary *)modelContainerPropertyGenericClass {
    return @{@"areas" : [AreaModel class]};
}
@end

@implementation ProvinceModel

+ (NSDictionary *)modelContainerPropertyGenericClass {
    return @{@"citys" : [CityModel class]};
}
@end

//将JSON转换为模型
ProvinceModel *provinceModel = [ProvinceModel yy_modelWithJSON:dic];
CityModel *cityModel = provinceModel.citys[0];
AreaModel *areaModel = cityModel.areas[0];
  • 数组里面存放字典类型转换为模型的例子
//JSON
(
{
"accountId" = "<null>";
"avatarUrl" = "http://thirdwx.qlogo.cn/mmopen/vi_32/sqicFCgiaheqCFbjrYgTmwXUQOB5l5Iyo47cVVp2cLlHARck6XgXscqicJ2ZVibicCbGH4iaVcQz8ptXqbV6n9ic5iaL9g/132";
"unionId" = "o2t87wKAR1pNRZR0cnReBT608mok";
"userid" = "11703346",
"wxNickName" = "贺建奎"
},
{
"accountId" = "<null>";
"avatarUrl" = "http://thirdwx.qlogo.cn/mmopen/vi_32/sqicFCgiaheqCFbjrYgTmwXUQOB5l5Iyo47cVVp2cLlHARck6XgXscqicJ2ZVibicCbGH4iaVcQz8ptXqbV6n9ic5iaL9g/132";
"unionId" = "o2t87wKAR1pNRZR0cnReBT608mok";
"userid" = "11293020";
"wxNickName" = "撒撒";
}
);
//Model
@interface MyFansModel : NSObject
@property (nonatomic, strong) NSString *avatarUrl;
@property (nonatomic, strong) NSString *wxNickName;
@property (nonatomic, strong) NSString *accountId;
@property (nonatomic, strong) NSString *unionId;
@property (nonatomic, strong) NSString *userid;
@end
//转换为模型
NSArray<MyFansModel *> *myFansModelArray = [NSArray yy_modelArrayWithClass:[MyFansModel class] json:array];
  • 容器类属性
//JSON
{
"schoolName" = "张三";
"teachers" =  (
      {"teacherName"= "Sndday","teacherAge" = 50};
      {"teacherName" = "Ssasas","teacherAge" = 70};
      {"teacherName" = "Snddasa","teacherAge"= 30)}
      );
};
//Model
//.h
#import <YYModel.h>


@interface SchoolModel : NSObject <YYModel>

@property (nonatomic, copy) NSString *schoolName;
@property (nonatomic, copy) NSArray *teachers;

@end
//.m
#import "TeacherModel.h"

@implementation SchoolModel

+ (nullable NSDictionary<NSString *, id> *)modelContainerPropertyGenericClass
{
    return @{@"teachers":[TeacherModel class]};
}

@end
//TeacherModel

@interface TeacherModel : NSObject

@property (nonatomic, copy) NSString *teacherName;
@property (nonatomic, assign) NSInteger teacherAge;

@end

//转换为模型
NSDictionary *dic = @{
  @"schoolName":@"张三",
  @"teachers":@[
          @{@"teacherName":@"Sndday",@"teacherAge":@(50)},
          @{@"teacherName":@"Ssasas",@"teacherAge":@(70)},
          @{@"teacherName":@"Snddasa",@"teacherAge":@(30)}
          ],
  };

SchoolModel *model = [SchoolModel yy_modelWithJSON:dic];

TeacherModel *teacherModel = model.teachers[0];

  • 黑名单,即加入黑名单的字段会被忽略不会转换
//JSON
{
    accountId = "<null>";
    avatarUrl = "http://thirdwx.qlogo.cn/mmopen/vi_32/sqicFCgiaheqCFbjrYgTmwXUQOB5l5Iyo47cVVp2cLlHARck6XgXscqicJ2ZVibicCbGH4iaVcQz8ptXqbV6n9ic5iaL9g/132";
    unionId = o2t87wKAR1pNRZR0cnReBT608mok;
    userid = 11703346;
    wxNickName = "\U90a3\U5496";
}
//Model
//.h
#import <YYModel.h>
@interface MyFansModel : NSObject <YYModel>
@property (nonatomic, strong) NSString *avatarUrl;
@property (nonatomic, strong) NSString *wxNickName;
@property (nonatomic, strong) NSString *accountId;
@property (nonatomic, strong) NSString *unionId;
@property (nonatomic, strong) NSString *userid;
@end
//.m
+ (NSArray *)modelPropertyBlacklist 
{
    return @[@"avatarUrl", @"accountId"];
}
//将JSON转换为模型,转换出来的模型中的```avatarUrl```和```accountId```的值为```nil```
MyFansModel *fansModel = [MyFansModel yy_modelWithJSON:dic];
  • 白名单 即只处理加入白名单的字段,其余字段忽略掉
//JSON
{
    accountId = "<null>";
    avatarUrl = "http://thirdwx.qlogo.cn/mmopen/vi_32/sqicFCgiaheqCFbjrYgTmwXUQOB5l5Iyo47cVVp2cLlHARck6XgXscqicJ2ZVibicCbGH4iaVcQz8ptXqbV6n9ic5iaL9g/132";
    unionId = o2t87wKAR1pNRZR0cnReBT608mok;
    userid = 11703346;
    wxNickName = "\U90a3\U5496";
}
//Model
//.h
#import <YYModel.h>
@interface MyFansModel : NSObject <YYModel>
@property (nonatomic, strong) NSString *avatarUrl;
@property (nonatomic, strong) NSString *wxNickName;
@property (nonatomic, strong) NSString *accountId;
@property (nonatomic, strong) NSString *unionId;
@property (nonatomic, strong) NSString *userid;
@end
//.m
+ (NSArray *)modelPropertyWhitelist 
{
    return @[@"avatarUrl", @"accountId"];
}
//将JSON转换为模型,转换出来的模型中的```avatarUrl```和```accountId```的值为```nil```
MyFansModel *fansModel = [MyFansModel yy_modelWithJSON:dic];
  • 数据校验与自定义转化
{
    accountId = "<null>";
    avatarUrl = "http://thirdwx.qlogo.cn/mmopen/vi_32/sqicFCgiaheqCFbjrYgTmwXUQOB5l5Iyo47cVVp2cLlHARck6XgXscqicJ2ZVibicCbGH4iaVcQz8ptXqbV6n9ic5iaL9g/132";
    unionId = o2t87wKAR1pNRZR0cnReBT608mok;
    userid = 11703346;
    wxNickName = "\U90a3\U5496";
}
#import <YYModel.h>
@interface MyFansModel : NSObject <YYModel>
@property (nonatomic, strong) NSString *avatarUrl;
@property (nonatomic, strong) NSString *wxNickName;
@property (nonatomic, strong) NSString *accountId;
@property (nonatomic, strong) NSString *unionId;
@property (nonatomic, strong) NSString *userid;
@property (nonatomic, strong) NSString *resultStr;
@end
//.m
- (BOOL)modelCustomTransformFromDictionary:(NSDictionary *)dic {
    NSString *timestamp = dic[@"accountId"];
    if ([timestamp isEqualToString:@"<null>"]) return NO;
    _resultStr = [NSString stringWithFormat:@"那撒上%@",timestamp];
    return YES;
}
//将JSON转换为模型
    MyFansModel *fansModel = [MyFansModel yy_modelWithJSON:dic];

上述例子由于对accountId做了校验,所以如果accountId不符合要求,该JSON将不会被解析,当然你也可以在这里做一些自动转换不能完成的工作,比如将后端返回的时间戳转换为时间字符串等自定义的操作。

 

 

标签:

未经允许不得转载:作者:SheaYang, 转载或复制请以 超链接形式 并注明出处 技术Dog|博客
原文地址:《iOS YYModel的使用》 发布于2019-10-05

分享到:
赞(0) 打赏

评论 抢沙发

3 + 6 =


iOS YYModel的使用

长按图片转发给朋友

觉得文章有用就打赏一下文章作者

支付宝扫一扫打赏

微信扫一扫打赏

Vieu4.0主题
专业打造轻量级个人企业风格博客主题!专注于前端开发,全站响应式布局自适应模板。

登录

忘记密码 ?