YYModle

Posted 2022-11-29 TF_guo

版权声明：本文为博主原创文章,文章均开源于博主对ios的理解。深入浅出，拒绝抽象。

目录(?)[+]

• • 一YYModel的使用场景
    • 简单的 Model 与 JSON 相互转换
    • Model 属性名和 JSON 中的 Key 不相同
    • Model 包含其他 Model
    • 容器类属性
    • 黑名单与白名单
    • 数据校验与自定义转换
    • CodingCopyinghashequaldescription
  • 二ESJsonFormat与YYModel的结合使用

开篇说明： 
虽然网上有很多讲解YYModel使用方法的文章，包括YYModel作者也在github上对其做了使用说明。 
但在我实际使用过程中，依然发现文档的不完善，比如对于复杂的模型（如多层嵌套）讲解的仍不透彻，同时本文也会介绍一神器配合YYModel使用，让你感受分分钟搞定模型创建的酸爽。 
当然为了减少读者的学习成本，本会对YYModel作者的文档进行丰富和扩展。

可在github上下载Demo，以便更直观了解各种使用场景详细代码。 
文章只要包含：

• 1. 详解YYModel的多种使用场景
• 1. 拓展插件，让你一分钟搞定所有的模型的创建和调用。

一、YYModel的使用场景

1.简单的 Model 与 JSON 相互转换

// JSON:

    "uid":123456,
    "name":"Harry",
    "created":"1965-07-31T00:00:00+0000"


// Model:
@interface User : NSObject
@property UInt64 uid;
@property NSString *name;
@property NSDate *created;
@end

@implementation User
@end
    
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
    
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

-

// 将 JSON (NSData,NSString,NSDictionary) 转换为 Model:
User *user = [User yy_modelWithJSON:json];

// 将 Model 转换为 JSON 对象:
NSDictionary *json = [user yy_modelToJSONObject];
    
1
2
3
4
5
    
1
2
3
4
5

当 JSON/Dictionary 中的对象类型与 Model 属性不一致时，YYModel 将会进行如下自动转换。自动转换不支持的值将会被忽略，以避免各种潜在的崩溃问题。

JSON/Dictionary	Model
NSString	NSNumber,NSURL,SEL,Class
NSNumber	NSString
NSString/NSNumber	C number (BOOL,int,float,NSUInteger,UInt64,…) NaN and Inf will be ignored
NSString	NSDate parsed with these formats: yyyy-MM-dd yyyy-MM-dd HH:mm:ss yyyy-MM-dd’T’HH:mm:ss yyyy-MM-dd’T’HH:mm:ssZ EEE MMM dd HH:mm:ss Z yyyy
NSDate	NSString formatted with ISO8601: “YYYY-MM-dd’T’HH:mm:ssZ”
NSValue	struct (CGRect,CGSize,…)
NSNull	nil,0
“no”,”false”,…	@(NO),0
“yes”,”true”,…	@(YES),1

2.Model 属性名和 JSON 中的 Key 不相同

// JSON:

    "n":"Harry Pottery",
    "p": 256,
    "ext" : 
        "desc" : "A book written by J.K.Rowing."
    ,
    "ID" : 100010


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

@end
    
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
    
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26

你可以把一个或一组 json key (key path) 映射到一个或多个属性。如果一个属性没有映射关系，那默认会使用相同属性名作为映射。 
在 json->model 的过程中：如果一个属性对应了多个 json key，那么转换过程会按顺序查找，并使用第一个不为空的值。 
在 model->json 的过程中：如果一个属性对应了多个 json key (key path)，那么转换过程仅会处理第一个 json key (key path)；如果多个属性对应了同一个 json key，则转换过过程会使用其中任意一个不为空的值。

3.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
    
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
    
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25

-

4.容器类属性

@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
    
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
    
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

在实际使用过过程中，[Shadow class]，Border.class，@"Attachment"没有明显的区别。 
这里仅仅是创建作者有说明，实际使用时，需要对其遍历，取出容器中得字典，然后继续字典转模型。（YYModel的核心是通过runtime获取结构体中得Ivars的值，将此值定义为key,然后给key赋value值，所以我们需要自己遍历容器（NSArray，NSSet，NSDictionary），获取每一个值，然后KVC）。

-

• 具体的代码实现如下：

NSDictionary *json =[self getJsonWithJsonName:@"ContainerModel"];
ContainerModel *containModel = [ContainerModel yy_modelWithDictionary:json];
NSDictionary *dataDict = [containModel valueForKey:@"data"];
//定义数组，接受key为list的数组
self.listArray = [dataDict valueForKey:@"list"]; 
 //遍历数组
[self.listArray enumerateObjectsUsingBlock:^(id  _Nonnull obj, NSUInteger idx, BOOL * _Nonnull stop) 
        NSDictionary *listDict = obj;
        //获取数组中得字典
        List *listModel = [List yy_modelWithDictionary:listDict];
        //获取count 和 id
        NSString *count = [listModel valueForKey:@"count"];
        NSString *id = [listModel valueForKey:@"id"];

    
1
2
3
4
5
6
7
8
9
10
11
12
13
14
    
1
2
3
4
5
6
7
8
9
10
11
12
13
14

-

以上是关于YYModle的主要内容，如果未能解决你的问题，请参考以下文章

资源消耗降低2/3，Flink在唯品会实时平台的应用（有彩蛋）

IBM基于Kubernetes的容器云全解析（有彩蛋）

ChatGPT会砸了谷歌的饭碗吗？（附彩蛋）

Docker再发现：实现DevOps的双刃剑！(有彩蛋)

SQLNewSQL和NoSQL融合研究与实践（有彩蛋）

小米开源数据库中间件Gaea实战（有彩蛋）