數(shù)據(jù)模型解析工具源碼分析
Mantle
Mantle 是由 Github 開發(fā)的一款模型框架,是一個用于簡化應(yīng)用程序中model層的第三方庫。通常我們的應(yīng)該中都會定義大量的model來表示各種數(shù)據(jù)結(jié)構(gòu)宝与,而這些model的初始化和編碼解碼都需要寫大量的代碼。而Mantle的優(yōu)點在于能夠大大地簡化這些代碼将宪。本文主要介紹 Mantle 中最常使用的功能:字典轉(zhuǎn)模型胧谈。
Mantle源碼中最主要的內(nèi)容包括:
- MTLJSONSerializing協(xié)議:需要與JSON字典進行相互轉(zhuǎn)換的MTLModel的子類都需要實現(xiàn)該協(xié)議,以方便MTLJSONApadter對象進行轉(zhuǎn)換室梅。
- MTLModel類:通常是作為我們的Model的基類戏仓,該類提供了一些默認的行為來處理對象的初始化和歸檔操作,同時可以獲取到對象所有屬性的鍵值集合亡鼠。
- MTLJSONAdapter類:用于在MTLModel對象和JSON字典之間進行相互轉(zhuǎn)換赏殃,相當于是一個適配器。
MTLJSONSerializing
如果MTLModel的子類希望可以使用MTLJSONAdapter類做 Model 類與 JSON 字典間的轉(zhuǎn)換间涵,則必須實現(xiàn)MTLJSONSerializing協(xié)議
@required
+ (NSDictionary *)JSONKeyPathsByPropertyKey;
@optional
+ (NSValueTransformer *)JSONTransformerForKey:(NSString *)key;
+ (Class)classForParsingJSONDictionary:(NSDictionary *)JSONDictionary;
+ (NSDictionary *)JSONKeyPathsByPropertyKey
此方法必須實現(xiàn)仁热。這個方法返回的字典,定義了 Model 類的屬性名與 JSON 字典鍵的映射勾哩,在這個返回的字典中抗蠢,Model 類的屬性名作為鍵,JSON 字典的鍵作為值思劳。(當你的 Model 里的所有屬性的名字和 JSON 里的所有 key 的名字完全相同的時候迅矛,你就可以用[NSDictionary mtl_identityPropertyMapWithModel:]
這個方法直接生成一個 NSDictionary, 直接返回潜叛。)
+ (NSValueTransformer *)JSONTransformerForKey:(NSString *)key
這個方法返回一個NSValueTransformer對象秽褒,可以實現(xiàn) Model 類與 JSON 字典間互相轉(zhuǎn)換時,改變原始數(shù)據(jù)類型钠导。例如震嫉,代表 JSON 字典中用戶信息類的值一般為字典,而在 Model 類中對應(yīng)的 property 一般為 OC 對象牡属,此時就可以在該方法中實現(xiàn)轉(zhuǎn)換的邏輯票堵。該方法傳入的參數(shù) key,為 Model 類的屬性名逮栅,而不是 JSON 字典的鍵值悴势。如果 Model 類實現(xiàn)了+<key>JSONTransformer
方法(key為 Model 類的屬性名),則該方法會替代+ JSONTransformerForKey:
方法被調(diào)用措伐。
+ (Class)classForParsingJSONDictionary:(NSDictionary *)JSONDictionary
如果有一個類簇特纤,基類或抽象類可以實現(xiàn)方法+ classForParsingJSONDictionary:
,根據(jù)傳入的需要轉(zhuǎn)換的 JSON 字典侥加,可以指定生成具體的對應(yīng) Model 子類捧存。
Mantle的核心操作步驟
- 獲取 model 的屬性--> JSONKeyPath 映射字典
- 獲取 model 的屬性列表
- 根據(jù) model 的方法給網(wǎng)絡(luò)請求中返回的 JSON 字典中的 value 做值類型轉(zhuǎn)化操作
- 使用 KVC 把值賦給 model 的屬性,完成操作
Matnle的類的組織架構(gòu)
按照文件的方式,
MTLJSONAdapter.h,定義了協(xié)議MTLJSONSerializing和適配器類MTLJSONAdapter,這兩個協(xié)議/類定義了接口來實現(xiàn)JSON-MTLModel的轉(zhuǎn)換昔穴。
MTLModel.h镰官,定義了協(xié)議MTLModel和基類MTLModel,基類MTLModel實現(xiàn)了isEqual,NSCopying和hash幾個方法吗货。
MTLModel+NSCoding.h,MTLModel的類別泳唠,讓其支持NSCoding協(xié)議
MTLValueTransformer.h,NSValueTransformer的子類宙搬,定義了將一個value轉(zhuǎn)變成另一個value的接口笨腥。例如,返回的一個2020-01-01T15:33:30字符串勇垛,利用轉(zhuǎn)換block轉(zhuǎn)換成NSDate
其它的都是工具類脖母,提供工具方法,不全列出來了窥摄。
Mantle除了提供JSON和對象的相互轉(zhuǎn)化镶奉,繼承自MTLModel的對象還自動實現(xiàn)了
NSCopying
NSCoding
isEqual
hash
等幾個工具方法础淤。
技術(shù)點總結(jié)
Mantle的功能主要是進行對象間數(shù)據(jù)的轉(zhuǎn)換:即如何在一個MTLModel和一個JSON字典中進行數(shù)據(jù)的轉(zhuǎn)換崭放。因此,所使用的技術(shù)大都是Cocoa Foundation提供的功能鸽凶。除了對于Core Data的處理之外币砂,主要用到的技術(shù)的有如下幾條:
1 KVC的應(yīng)用:這主要體現(xiàn)在對MTLModel子類的屬性賦值中,通過KVC機制來驗證值的有效性并為屬性賦值玻侥。
2 NSValueTransform:這主要用于對JSON值轉(zhuǎn)換為屬性值的處理决摧,我們可以自定義轉(zhuǎn)換器來滿足我們自己的轉(zhuǎn)換需求。
3 NSInvocation:這主要用于統(tǒng)一處理針對特定key值的一些方法的調(diào)用凑兰。比如-merge<Key>FromModel:這一類方法掌桩。
4 Run time函數(shù)的使用:這主要用于對從一個字符串中獲取到方法對應(yīng)的字符串,然后通過sel_registerName函數(shù)來注冊一個selector姑食。