YYModel的使用

其他 2019-02-18 09:01:07 阅读次数: 0

在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将不会被解析，当然你也可以在这里做一些自动转换不能完成的工作，比如将后端返回的时间戳转换为时间字符串等自定义的操作。

至此，关于YYModel的相关用法已经全部说完了，如果由哪些说的不对的地方，欢迎指正。如果喜欢，欢迎点赞关注!!!

猜你喜欢

转载自blog.csdn.net/weixin_33947521/article/details/87502151
今日推荐
《美国对全球网络空间安全与发展的威胁和破坏》报告发布
火速冲上 GitHub 热榜 —— 开源编程语言、框架哪有这么可爱？
北京人形机器人创新中心发布全球首个纯电驱拟人奔跑的全尺寸人形机器人“天工”
LFOSSA 源来如此公开课 | 掌握云原生未来：CNCF 认证全面攻略与备考秘籍
周排行
让自己的头脑极度开放
CentOS 6.5(x64) 和Redhat6.5操作系误删libc
高可用注册中心
【日记】12.28/【题解】AtCoder AGC041
XML（5）_XML 约束_DTD
Java集合Map（四）
树梅派安装桌面环境教程
pipenv 的 使用和安装
小程序白屏问题和内存研究
C语言简单选择排序
每日归档
更多
2024-05-02(0)
2024-05-01(4)
2024-04-30(1)
2024-04-29(40)
2024-04-28(0)
2024-04-27(56)
2024-04-26(39)
2024-04-25(22)
2024-04-24(36)
2024-04-23(26)

代码天地 © 2018 codetd.com

境外服务器   最新电视剧2022