您现在的位置: IOS教程網 >> IOS系統 >  >> iOS 程式開發 >> iOS 開發基礎

Mantle 源碼閱讀筆記(一):JSON 與 Model 雙向轉換、NSCoding 的完整實現路徑

編輯:iOS 開發基礎

作者:李富強 Jason,授權本站轉載。

最近項目需要持久化一些對象。數據比較簡單,用 NSUserDefaults 存就夠了。之前我實現過一個比較簡陋的自動 archive / unarchive:遍歷 NSObject 的 property list,然後通過 valueForKey: 和 setValue:forKey: 逐個取值賦值。

原理不難,但它滿足不了新需求——這次要支持 property 本身是其他類型對象的情況。再加上 JSON 解析的工作量,直接硬編碼會產生一大堆冗餘代碼;而自己實現一套自動化的 archive / unarchive 工作量也不小。於是順手翻了翻 Mantle 的源碼,發現它在這方面的處理相當合理,就直接用了。

Mantle 解析 JSON 或做 NSCoding,我認為都可以拆成兩大步來讀:Transform 和賦值。它的源碼量不大,但代碼乾淨、註釋完善。

按這兩步,我把全部文件分了類:

1. Transform 相關:

MTLJSONAdapter
MTLManagedObjectAdapter
MTLValueTransformer
NSValueTransformer+MTLInversionAdditions
NSValueTransformer+MTLPredefinedTransformerAdditions
MTLModel+NSCoding

2. 賦值相關:

MTLModel

3. 工具類:

MTLReflection
NSArray+MTLManipulationAdditions
NSDictionary+MTLManipulationAdditions
NSError+MTLModelException
NSObject+MTLComparisonAdditions

4. extobjc:

MTLEXTKeyPathCoding
MTLEXTRuntimeExtension
MTLEXTScope
metamacros

從 NSDictionary 到 Model

把 JSON 解析為 Model 只需要兩行:

Transform 過程

入口是 MTLJSONAdapter 的 modelOfClass:fromJSONDictionary:error:,核心邏輯在 - (id)initWithJSONDictionary:modelClass:error:。方法開頭有兩個 assert:modelClass 必須是 MTLModel 的子類,並且必須實現 MTLJSONSerializing 協議。

這段代碼有個有意思的地方,牽涉到我們經常用卻不太在意的東西——類簇(class cluster)。這個設計模式在 Cocoa 裡應用極廣,最典型的例子就是 NSNumber。關於類簇可以參考:
https://developer.apple.com/library/ios/documentation/General/Conceptual/CocoaEncyclopedia/ClassClusters/ClassClusters.html

這裡我們只需知道:使用 Mantle 時如果要用類簇,實現這個方法並返回具體的 class 類型即可。

接下來處理 JSONKeyPathsByPropertyKey 返回的值——它是 model 的 property 與 JSON 的 key 之間的映射關係,官方示例返回的數據如下:

在把原始 JSON 轉換為 model 需要的 Dictionary 之前,代碼會先對這個映射做校驗,主要兩方面:一是 JSONKeyPathsByPropertyKey 要求的 property 在 modelClass 中是否真的存在;二是它要求的 JSON key 是否合法,必須是 NSString 或 NSNull.null。

其中 NSNull.null 表示忽略 model 中的這個 property、不做賦值(參考:https://stackoverflow.com/questions/18961622/how-to-omit-null-values-in-json-dictionary-using-mantle),這個需求在實戰中經常遇到。

代碼裡的 [self.modelClass propertyKeys] 後文會結合 runtime 再講,這裡只需知道它返回 modelClass 的 property 列表。

校驗完成後,下一步是把 JSON 數據轉換為 model property 所要求的類型。比如 JSON 裡返回的 url 是字符串,而 model 中要求的是 NSURL *,這個轉換就在這一階段完成。

先說 NSValueTransformer。在我用 Mantle 之前對它也沒什麼概念,看完這裡的用法才發現它確實非常方便靈活,與 NSURLProtocol 有幾分相似。常規用法需要 register class,Mantle 則直接獲取 transformer 對象。關於 NSValueTransformer 可參考:https://nshipster.com/nsvaluetransformer/

下面這段代碼遍歷 propertyKeys(通過 MTLModel 的 +propertyKeys 取得),用 propertyKey 換出對應的 JSON key(-JSONKeyPathForPropertyKey:),得到 JSONKeyPath 後校驗 JSONDictionary 中該路徑的 value 是否合法;一旦校驗中拋出異常就 catch 住,返回 nil 並設置 error。

這段代碼裡有兩個細節值得一看:一是 valueForKeyPath: 與 objectForKey: 的區別(https://stackoverflow.com/questions/4489684/what-is-the-difference-between-valueforkey-objectforkey-and-valueforkeypath),對 NSDictionary 來說差異不明顯;二是 NSLog 中 %1$@ 這種帶位置參數的輸出格式(https://stackoverflow.com/questions/19327441/gcc-dollar-sign-in-printf-format-string)。

再往下就是整個 transform 的核心步驟:先獲取一個 NSValueTransformer 對象,再讓它完成類型轉換。

用官方 demo 來看這個 transformer 在 model 中是如何生成的。下面這個靜態方法返回一個 NSValueTransformer,它同時支持 JSON → Model 和 Model → JSON 的逆向轉換,分別對應兩個 block。比如這個例子中,轉成 model 時 JSON 的 string 會變成 NSDate *,反向轉換時 NSDate * 又變回字符串。

adapter 通過 -JSONTransformerForKey: 獲取 transformer,實現如下:先用 MTLSelectorWithKeyPattern 拼出 selector。OC 的方法簽名比較靈活,這裡的規則就是把屬性名 xxx 與 JSONTransformer 做字符串拼接。OC 的動態特性讓我們可以通過字符串直接發消息,後文會詳細解析。除了按規則拼接 selector 之外,最後還會調用 model 的 +JSONTransformerForKey:——這個用的比較少,畢竟寫一大堆 if/else 讀起來遠不夠乾淨。

拿到 transformer 之後,關鍵代碼其實非常好讀:直接調用 -transformedValue: 把 JSON 中的 value 轉成我們需要的類型。這裡也能看到 Mantle 對 NSNull.null 的處理——不用擔心 JSON 裡的 null 讓程序崩潰。轉換後的結果會先存進一個臨時字典 dictionaryValue,等所有數據都轉完,就得到了一份類型正確的 dictionary,供後面的賦值階段使用。同時注意這裡對 try/catch 和 NSError 的用法:模式很簡單,但日常開發中經常被忽略,而在商業代碼裡這種技巧很有必要。

得到轉換後的數據,就進入了賦值階段。

賦值過程

這段邏輯讀起來同樣簡潔:從轉換完的 dictionary 中取出 value,賦給對象的 property。除了對 NSNull.null 的額外處理,核心都在 MTLValidateAndSetValue() 函數裡。我一開始以為這個過程會直接操作 OC 的 property、應該挺複雜,看完才發現——感謝 KVC,整個流程非常簡單卻又很實用。

先用 validateValue:forKey:error: 校驗賦值的合法性,通過之後直接 setValue:forKey: 即可,KVC 讓整個流程變得極為簡潔。

這裡有個需要注意的地方:如果 transformer 轉換後的任意一個 value 與 model 的 property 不匹配,整個 model 的轉換過程就會失敗,而不只是這一個 property 失敗。

從 Model 到 NSDictionary

把 Model 序列化為 JSON,同樣只需兩行:

入口是 MTLJSONAdapter 的 JSONDictionaryFromModel:error:,細節在 -initWithModel: 和 -JSONDictionary 中實現。前者要求傳入的 model 繼承自 MTLModel 並 conforms to MTLJSONSerializing;真正的轉換和賦值都在 JSONDictionary 裡。這個方法不算長,直接貼出來解析:

第一行 self.model.dictionaryValue 返回一個包含 model 所有 property 及其 value 的字典。我原本以為這得靠 runtime 實現,看完才發現要再次感謝 KVC——用極簡單的代碼就實現了很強大的功能。self.class.propertyKeys 前面說過了,這裡更有意思的是 dictionaryWithValuesForKeys:,它也屬於 NSKeyValueCoding 協議。

看一下頭文件裡 dictionaryWithValuesForKeys: 的說明,會發現自己以前對 KVC 的利用實在太淺了。

後面的邏輯與 NSDictionary → Model 類似:創建臨時 NSMutableDictionary,通過 NSValueTransformer 的 reverseTransformedValue: 把 property 轉成 JSON 支持的類型以便序列化。JSONKeyPathForPropertyKey: 與 JSONTransformerForKey: 前面講過,分別負責校驗 keypath 和獲取對應的 transformer。同樣對 NSNull.null 做了特殊處理,可見 Mantle 對 JSON 開發中常見的 null 問題處理得相當乾淨。

把轉換後的數據寫入臨時 Dictionary 時,如果 JSONKeyPath 是多級路徑,處理方式頗有意思:

理解了 JSON → Model,這部分 Model → JSON 就非常容易讀了。可以看到,得益於 KVC,我們不用直接操作 runtime 就能靈活實現很多功能,把複雜的部分交給 API、交給框架。

NSCoding

Mantle 對 NSCoding 的支持主要在 MTLModel+NSCoding 文件中。但除了與 NSCoder API 交互的部分,核心邏輯與前面看過的幾乎一致,尤其是 Transform 部分——這樣就避免了業務層重複造輪子。

與 NSCoding 相關的主要是 model 需要 override 的兩個方法:-initWithCoder: 和 -encodeWithCoder:,而 MTLModel+NSCoding 已經默認幫我們實現了。這部分真正的冗餘代碼在於 secure coding 與老版本兼容,剝掉這些之後,日常用到的核心代碼其實非常少,但很完整。

思路上它與前面 JSON 轉換的過程極其相似,唯一的區別在 transform:JSON 與 Model 之間用的是 NSValueTransformer,而 NSCoding 依賴的是 property 自身實現 NSCoding。

encode

encoderWithCoder: 的邏輯如上圖。第一行 coderRequireSecureCoding 用來檢驗 NSCoder 是否支持 NSSecureCoding 安全措施。關於 NSSecureCoding,我找了很久才在 NSHipster 上發現一篇短文介紹,它主要是為了解決 substitution attack 的安全問題:https://nshipster.com/nssecurecoding/

接著是 verifyAllowedClassesByPropertyKey,這個與安全相關的校驗函數說實話我沒讀懂,看了幾遍,覺得那個 exception 永遠不可能拋出。

下一行可以看到 Mantle 提供了一個挺有意思的特性——版本號,實用價值不小。model 變化較大時尤其需要注意這方面的問題,有版本號管理起來就方便多了。

後面的代碼相對簡單:用到前面講過的 self.dictionaryValue,再結合 encodingBehaviorsByPropertyKey 調用 coder 的 API 完成編碼。可以看到 self.dictionaryValue 與 Model → JSON 的第一步相同,不同之處在 transform:這裡並沒有使用 NSValueTransformer,而是依賴各個 property 自己實現 NSCoding。這一點來得有點突然,我原以為會複用 NSValueTransformer 那套邏輯。

如果希望 Mantle 不 encode 某個 property,做法很簡單:override encodingBehaviorsByPropertyKey,把要額外處理的 property 與 super 的結果合併即可:

decode

decode 的過程與 JSON → model 比較相似,同樣沒有使用 NSValueTransformer 做值變換,而是調用 NSCoder 的 decode 方法——這與上面的 encode 是對應的,也確實比較合理,充分利用了 API 提供的便利。賦值過程與 JSON → model 也類似,下面的代碼就是主要邏輯:

self.class.propertyKeys 前面已講過,後面的邏輯相對簡單,很容易看明白每一步在做什麼。

  1. 上一篇文章:
  2. 下一篇文章:
蘋果刷機越獄教程| IOS教程問題解答| IOS技巧綜合| IOS7技巧| IOS8教程
Copyright © IOS教程網 All Rights Reserved