YYModel 是 iOS 中常見的字典轉模型工具。本文聚焦在容易忽略的協議方法與進階用法,幫助開發者把 JSON 到模型的轉換寫得更穩定。
當 JSON 欄位名稱與模型屬性名稱不一致時,可透過 modelCustomPropertyMapper 建立映射。例如 JSON 中的 n、p、ext、id,分別對應到模型的 name、page、desc、bookID。這樣即使後端欄位較短或較抽象,模型層仍能保持清楚語意。
若模型屬性是陣列、集合或字典,YYModel 無法自動推斷容器內元素的型別。此時可用 modelContainerPropertyGenericClass 指定。例如 authors 是陣列,元素為 YYAuthor,就需要在方法中明確回傳對應類別。字典的情況則是針對 value 的型別進行指定。
modelCustomClassForDictionary 可以在轉換前依字典內容決定實際要建立的類別。例如 Person 是父類,Man 與 Woman 是子類,若字典中的 sex 欄位指出具體型別,就可以回傳對應子類。這其實就是一種多態應用,讓同一份資料能依情境變成不同模型。
modelPropertyBlacklist 用來排除不參與轉換的屬性;modelPropertyWhitelist 則相反,只有白名單中的屬性會參與轉換。一般專案較常使用黑名單,因為白名單會讓模型擴充變得僵硬。
modelCustomWillTransformFromDictionary 發生在字典轉模型之前,適合用來做最後一層資料清洗。例如某些不合法或不需要的資料,可以直接回傳 nil,讓後續轉換停止。
modelCustomTransformFromDictionary 發生在字典轉模型之後。若某些欄位無法直接映射,例如 timestamp 要轉成 NSDate 並賦值給 createdAt,就可以在這裡手動處理。若回傳否,代表轉換失敗。
modelCustomTransformToDictionary 與上一個方法相反,用於模型轉字典或 JSON 前的補充。例如模型有 createdAt,但輸出時希望變成 timestamp,就可以在此手動寫入。若回傳否,代表轉換失敗。
YYModel 也提供 modelArrayWithClass 與 modelDictionaryWithClass,方便一次把多筆資料轉成模型。需要注意的是,modelDictionaryWithClass 主要處理字典的 value,並不會深入解析 key 內再嵌套的字典結構。
YYModel 的強大之處,在於它把繁瑣的字典轉模型流程簡化;但真正讓它變得可靠的,是這些可自訂的協議方法。理解每個方法發生的時機,才能避免資料轉換時出現空值、型別錯誤或漏欄位。