当前位置: 首页 > article >正文

【iOS】YYModel初学习

前言

YYModel是一个OC的开源库,用于处理json数据和iOS应用中的数据的相互转换,在使用场景中非常的实用。

常用方法

// 字典转模型
+ (nullable instancetype)yy_modelWithDictionary:(NSDictionary *)dictionary;
// json转模型
+ (nullable instancetype)yy_modelWithJSON:(id)json;
// 模型转NSObject
- (nullable id)yy_modelToJSONObject;
// 模型转NSData
- (nullable NSData *)yy_modelToJSONData;
// 模型转json字符串
- (nullable NSString *)yy_modelToJSONString;
// 模型深拷贝
- (nullable id)yy_modelCopy;
// 判断模型是否相等
- (BOOL)yy_modelIsEqual:(id)model;
// 属性数据映射,用来定义多样化数据时转换声明
+ (nullable NSDictionary<NSString *, id> *)yy_modelCustomPropertyMapper;
// 属性自定义类映射,用来实现自定义类的转换声明
+ (nullable NSDictionary<NSString *, id> *)yy_modelContainerPropertyGenericClass;
// 属性黑名单,该名单属性不转换为model
+ (nullable NSArray<NSString *> *)yy_modelPropertyBlacklist;
// 属性白名单,只有该名单的属性转换为model
+ (nullable NSArray<NSString *> *)yy_modelPropertyWhitelist;
// JSON 转为 Model 完成后,该方法会被调用,返回false该model会被忽略
// 同时可以在该model中做一些,转换不能实现的操作,如NSDate类型转换
- (BOOL)yy_modelCustomTransformFromDictionary:(NSDictionary *)dic;
// Model 转为 JSON 完成后,该方法会被调用,返回false该model会被忽略
// 同时可以在该model中做一些,转换不能实现的操作,如NSDate类型转换
- (BOOL)yy_modelCustomTransformToDictionary:(NSMutableDictionary *)dic

基本的使用方法

数据交换

NSDictionary *dic = @{
                  @"name":@"张三",
                  @"age":@(12),
                  @"sex":@"男"
                    };
// 将数据转模型
YYPersonModel *model = [YYPersonModel yy_modelWithDictionary:dic];
// 将模型转数据
NSDictionary *dics = [model yy_modelToJSONObject];

多样化的数据类型交换

YYModel支持自定义的属性名进行映射,也就是说数据的key和属性名可以是不相同。那么怎么才知道你自定义的属性名对应的是数据的哪个key呢?那就需要对自定义属性的映射进行映射声明。

@interface TestYYModel : NSObject

@property (strong, nonatomic) NSNumber *personId;
@property (copy,   nonatomic) NSString *name;
@property (assign, nonatomic) int age;
@property (copy,   nonatomic) NSString *sex;

@end

在YYPersonModel.m 重写YYModel的方法yy_modelCustomPropertyMapper,返回设定的映射值,并且YYModel提供多个字段的映射。(笔者本人并未搞懂这里的用法,在YYModel源码中并未找到)

+ (NSDictionary *)yy_modelCustomPropertyMapper {
   // 将personId映射到key为id的数据字段
    return @{@"personId":@"id"};
   // 映射可以设定多个映射字段
   //  return @{@"personId":@[@"id",@"uid",@"ID"]};
}

最后依然通过像原来的数据那样,直接通过字典的方式进行模型转换,当key为id时,会自动给personId赋值,达到我们需要的效果。

// ViewController.m
NSDictionary *dic = @{
                        @"id":@"123",
                        @"name":@"lisi",
                        @"age":@(20),
                        @"sex":@"man"
                        };
    TestYYModel *model = [TestYYModel yy_modelWithDictionary:dic];
    NSLog(@"ID: %@",model.personId);
    NSDictionary *dics = [model yy_modelToJSONObject];
    NSLog(@"ID: %@", dics);

自定义属性映射数据交换

YYModel支持多样化的数据类型,甚至字典,数组等数据,如果不存在,则该model会自动设置为null,该例子提出使用NSArray和NSDictionary作为数据,效果依然一样。


@interface TestYYModel : NSObject

@property (strong, nonatomic) NSNumber *personId;
@property (copy,   nonatomic) NSString *name;
@property (assign, nonatomic) int age;
@property (copy,   nonatomic) NSString *sex;
@property (strong, nonatomic) NSArray *languages;
@property (strong, nonatomic) NSDictionary *job;

@end

在数据中依然可以找到NSArray和NSDictionary和sexDic下的sex字段并转化为模型:

// ViewController.m
NSDictionary *dic = @{
                  @"id":@"123",
                  @"name":@"张三",
                  @"age":@(12),
                  @"sexDic":@{@"sex":@"男"},
                  @"languages":@[
                          @"汉语",@"英语",@"法语"
                          ],
                  @"job":@{
                          @"work":@"iOS",
                          @"eveDay":@"10小时",
                          @"site":@"CSDN"
                          }
                  };
YYPersonModel *model = [YYPersonModel yy_modelWithDictionary:dic];

自定义类数据转换(多个model嵌套)

这里我们并不需要做什么,只需要将一个model设置成另一个model的属性就可以了。

// JSON
{
    "author":{
        "name":"J.K.Rowling",
        "birthday":"1965-07-31T00:00:00+0000"
    },
    "name":"Harry Potter",
    "pages":256
}

// Model: 什么都不用做,转换会自动完成
@interface Author : NSObject
@property NSString *name;
@property NSDate *birthday;
@end
@implementation Author
@end
	
@interface Book : NSObject
@property NSString *name;
@property NSUInteger pages;
@property Author *author; //Book 包含 Author 属性
@end
@implementation Book
@end


http://www.kler.cn/a/372809.html

相关文章:

  • 算法工程师重生之第三十九天(不同的子序列 两个字符串的删除操作 编辑距离 编辑距离总结篇 )
  • Android 10.0 根据包名禁用某个app的home事件
  • 【python】OpenCV—findContours(4.4)
  • 【OpenSearch】机器学习(Machine Learning)神经搜索教程
  • 算法:排序
  • MFC图形函数学习04——画矩形函数
  • ssm014基于JSP的乡镇自来水收费系统+jsp(论文+源码)_kaic
  • 图书管理系统汇报
  • 全面掌握数据库性能监控:策略、工具与实践
  • C语言中有哪些函数可以用来处理二进制和十六进制数字
  • 人工智能算法之粒子群优化算法
  • Yii2 init 初始化脚本分析
  • 无人机遗传算法详解!
  • Virtual Private Network (VPN) Lab
  • 在MacOS玩RPG游戏 - RPGViewerPlus
  • 【论文笔记】xGen-MM (BLIP-3): A Family of Open Large Multimodal Models
  • 【Android】Kotlin教程(5)
  • react基础之redux快速上手环境准备
  • 【Docker知识】Docker进阶-容器镜像深度解读
  • SQL 高级技巧
  • BERT的中文问答系统23
  • 使用Virtual Audio Cable捕获系统音频输出并使用Python处理
  • pc电脑屏幕分辨率尺寸
  • MetaArena推出《Final Glory》:引领Web3游戏技术新风向
  • Flutter鸿蒙next 封装对话框详解
  • 实现链式结构的二叉树