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

源碼剖析:Mantle 模型轉換庫的實現原理

編輯:iOS 開發基礎

Mantle 是一個用於簡化 Cocoa 或 Cocoa Touch 應用中 model 層的第三方庫。在我們的項目裡通常會定義大量 model 來表示各種數據結構,而這些 model 的初始化與編碼解碼往往需要撰寫大量樣板代碼。Mantle 的價值,正在於能把這些繁瑣代碼大幅精簡。

Mantle 源碼中最核心的內容包括:

  • MTLModel 類:通常作為我們 Model 的基類,提供了一些默認行為來處理物件的初始化與歸檔,並能取得物件所有屬性的鍵值集合。
  • MTLJSONAdapter 類:用於在 MTLModel 物件與 JSON 字典之間相互轉換,相當於一個適配器。
  • MTLJSONSerializing 協議:需要與 JSON 字典相互轉換的 MTLModel 子類都要實作它,以方便 MTLJSONAdapter 進行轉換。

下面就以這三者作為分析切入點。

基類 MTLModel

MTLModel 是一個抽象類,主要提供一些默認行為來處理物件的初始化與歸檔。

初始化

MTLModel 默認的初始化方法 -init 幾乎什麼也沒做,只呼叫了 [super init]。同時,它提供了另一個初始化方法:

- (instancetype)initWithDictionary:(NSDictionary *)dictionaryValue error:(NSError **)error;

參數 dictionaryValue 是一個包含用於初始化物件 key-value 的字典。它的實現要點如下:遍歷字典中的每個 key,把 value 標記為 __autoreleasing(因為 MTLValidateAndSetValue 中可能會返回新物件),若 value 為 NSNull.null 則先轉為 nil,最後透過 MTLValidateAndSetValue 函數利用 KVC 機制驗證 value 對 key 是否有效,若無效則用默認值設置,並藉由 KVC 把 value 賦值給 model 對應屬性。子類可以重寫該方法以在設置屬性後做進一步處理,但記得透過 super 調用父類實現。

取得屬性的鍵與值

MTLModel 提供類方法 +propertyKeys,回傳所有 @property 宣告屬性的名稱集合,但不含只讀屬性與 MTLModel 自身的屬性。它會遍歷 model 的所有屬性,若屬性非只讀且其 ivar 不為 NULL,就把屬性名加入集合,並將結果緩存到關聯物件中。

+ (NSSet *)propertyKeys {     // 1. 如果對象中已有緩存的屬性名的集合,則直接返回緩存。該緩存是放在一個關聯對象中。     NSSet *cachedKeys = objc_getAssociatedObject(self, MTLModelCachedPropertyKeysKey);     if (cachedKeys != nil) return cachedKeys;     NSMutableSet *keys = [NSMutableSet set];     // 2. 遍歷對象所有的屬性     //    enumeratePropertiesUsingBlock方法會沿著superclass鏈一直向上遍歷到MTLModel,     //    查找當前model所對應類的繼承體系中所有的屬性(不包括MTLModel),並對該屬性執行block中的操作。     //    有關enumeratePropertiesUsingBlock的實現可參考源碼,在此不做詳細說明。     [self enumeratePropertiesUsingBlock:^(objc_property_t property, BOOL *stop) {         mtl_propertyAttributes *attributes = mtl_copyPropertyAttributes(property);         @onExit {             free(attributes);         };         // 3. 過濾只讀屬性和ivar為NULL的屬性         if (attributes->readonly && attributes->ivar == NULL) return;         // 4. 獲取屬性名字符串,並存儲到集合中         NSString *key = @(property_getName(property));         [keys addObject:key];     }];     // 5. 將集合緩存到關聯對象中。     objc_setAssociatedObject(self, MTLModelCachedPropertyKeysKey, keys, OBJC_ASSOCIATION_COPY);     return keys; }

有了這個類方法,取得物件所有屬性及其值就容易了。為此 MTLModel 提供只讀屬性 dictionaryValue,回傳一個包含當前 model 所有屬性及其值的字典,屬性值為 nil 時用 NSNull 代替,且該屬性不會為 nil。

@property (nonatomic, copy, readonly) NSDictionary *dictionaryValue; // 實現 - (NSDictionary *)dictionaryValue {     return [self dictionaryWithValuesForKeys:self.class.propertyKeys.allObjects]; }

合併物件

合併物件是指把兩個 MTLModel 物件按自訂規則合併對應屬性值。為此 MTLModel 定義了:

- (void)mergeValueForKey:(NSString *)key fromModel:(MTLModel *)model;

它會把當前物件指定 key 的值與 model 參數對應值按規則合併,規則由自訂的 -mergeFromModel: 決定。若子類實作了 -mergeFromModel: 則呼叫它;若找不到且 model 不為 nil,則用 model 的屬性值替代當前值。它先以 MTLSelectorWithCapitalizedKeyPattern 拼出 "merge...FromModel:" 選擇器,再透過 NSInvocation 調用。此外還有 mergeValuesForKeysFromModel: 可一次合併所有屬性,但要求 model 必須是當前物件所屬類或其子類。

歸檔物件(Archive)

Mantle 把對 MTLModel 的編碼解碼都放在 MTLModel 的 NSCoding 分類中處理(MTLModel+NSCoding 檔案)。為區分不同屬性,它定義了枚舉 MTLModelEncodingBehavior:

typedef enum : NSUInteger {     MTLModelEncodingBehaviorExcluded = 0,            // 屬性絕不應該被編碼     MTLModelEncodingBehaviorUnconditional,          // 屬性總是應該被編碼     MTLModelEncodingBehaviorConditional,             // 對象只有在其它地方被無條件編碼時才應該被編碼。這只適用於對象屬性 } MTLModelEncodingBehavior;

每個屬性的歸檔行為可在 +encodingBehaviorsByPropertyKey 類方法中設置。MTLModel 提供默認實現:遍歷所有屬性鍵,當屬性為 weak 時默認設為 Conditional,否則設為 Unconditional。任何不在回傳字典中的屬性都不會被歸檔,子類可按需覆寫(記得調用 super)。

而為了從歸檔中解碼指定屬性,Mantle 提供了:

- (id)decodeValueForKey:(NSString *)key withCoder:(NSCoder *)coder modelVersion:(NSUInteger)modelVersion;

默認情況下,它會查找類似 -decodeWithCoder:modelVersion: 的方法,若找到便透過 NSInvocation 呼叫並按自訂方式解碼;若沒有自訂方法,則視 coder 是否需要安全編碼:需要時透過 allowedSecureCodingClassesByPropertyKey 取得允許的類並呼叫 decodeObjectOfClasses:forKey:,否則直接呼叫 decodeObjectForKey:。當然,完整的編碼解碼仍得靠我們實作 -initWithCoder: 與 -encodeWithCoder:,並在子類中按需處理特定屬性、調用 super 執行父類操作。

適配器 MTLJSONAdapter

為了便於在 MTLModel 物件與 JSON 字典間相互轉換,Mantle 提供了 MTLJSONAdapter 作為兩者之間的適配器。

MTLJSONSerializing 協議

那些需要與 JSON 字典相互轉換的 MTLModel 子類都要實作 MTLJSONSerializing 協議,其中定義了三個類方法:

@protocol MTLJSONSerializing @required + (NSDictionary *)JSONKeyPathsByPropertyKey; @optional + (NSValueTransformer *)JSONTransformerForKey:(NSString *)key; + (Class)classForParsingJSONDictionary:(NSDictionary *)JSONDictionary; @end

+JSONKeyPathsByPropertyKey 為必選,回傳的字典指定如何把物件屬性映射到 JSON 中不同的 key path;不在字典中的屬性被認為與 JSON 的 key 同名,映射到 NSNull 的屬性則在序列化時被忽略。+JSONTransformerForKey: 指定如何把 JSON 值轉為屬性值(反之亦然),若轉換器實作了 +JSONTransformer 則優先使用它,不需自訂轉換時回傳 nil。重寫 +classForParsingJSONDictionary: 可把當前 Model 解析為不同類,這對類簇非常有用。

初始化

MTLJSONAdapter 有一個只讀屬性 model,即適配器要處理的 MTLModel 物件,且必須是實作了 MTLJSONSerializing 協議的物件,只能透過初始化方法賦值。該類不能透過 -init 初始化(會直接斷言),而是用以下兩個方法:

- (id)initWithJSONDictionary:(NSDictionary *)JSONDictionary modelClass:(Class)modelClass error:(NSError **)error; - (id)initWithModel:(MTLModel*)model;

-initWithJSONDictionary:modelClass:error: 用一個字典與待轉換的類來初始化,字典需符合 NSJSONSerialization 的格式,若為空則返回帶 MTLJSONAdapterErrorInvalidJSONDictionary 碼的 error。其實現會先(若類支持)以 classForParsingJSONDictionary: 決定實際 modelClass,校驗 +JSONKeyPathsByPropertyKey 中每個映射鍵必須是 model 的屬性、值必須是字符串或 NSNull,再遍歷各屬性以 valueForKeyPath: 取值、套用 JSONTransformerForKey: 返回的轉換器,最後組出 dictionaryValue 並呼叫 modelWithDictionary:error: 建立 _model。此外它還提供了幾個便捷類方法:

+ (id)modelOfClass:(Class)modelClass fromJSONDictionary:(NSDictionary *)JSONDictionary error:(NSError **)error; + (NSArray *)modelsOfClass:(Class)modelClass fromJSONArray:(NSArray *)JSONArray error:(NSError **)error; + (NSDictionary *)JSONDictionaryFromModel:(MTLModel*)model;

從物件取得 JSON 數據

這是上述初始化過程的逆過程,由 -JSONDictionary 實現:先取 model.dictionaryValue,遍歷每個屬性鍵,套用支持反向轉換的 transformer(allowsReverseTransformation),再按 key path 逐層組出嵌套字典。

- (NSDictionary *)JSONDictionary {     NSDictionary *dictionaryValue = self.model.dictionaryValue;     NSMutableDictionary *JSONDictionary = [[NSMutableDictionary alloc] initWithCapacity:dictionaryValue.count];     [dictionaryValue enumerateKeysAndObjectsUsingBlock:^(NSString *propertyKey, id value, BOOL *stop) {         NSString *JSONKeyPath = [self JSONKeyPathForPropertyKey:propertyKey];         if (JSONKeyPath == nil) return;         // 1. 獲取屬性的值         NSValueTransformer *transformer = [self JSONTransformerForKey:propertyKey];         if ([transformer.class allowsReverseTransformation]) {             if ([value isEqual:NSNull.null]) value = nil;             value = [transformer reverseTransformedValue:value] ?: NSNull.null;         }         NSArray *keyPathComponents = [JSONKeyPath componentsSeparatedByString:@"."];         // 2. 對於嵌套屬性值的設置,會先從keypath中獲取每一層屬性,         //    如果當前層級的obj中沒有該屬性,則為其設置一個空字典;然後再進入下一層級,依此類推         //    最後設置如下形式的字典: @{@"nested": @{@"name": @"foo"}}         id obj = JSONDictionary;         for (NSString *component in keyPathComponents) {             if ([obj valueForKey:component] == nil) {                [obj setValue:[NSMutableDictionary dictionary] forKey:component];             }         obj = [obj valueForKey:component];         }         [JSONDictionary setValue:value forKeyPath:JSONKeyPath];     }];     return JSONDictionary; }

取得字典後,再將其序列化為 JSON 串便易如反掌。此外 MTLJSONAdapter 也提供了便捷方法 +JSONDictionaryFromModel: 直接從 model 取得 JSON 字典。

MTLManagedObjectAdapter

為適配 Core Data,Mantle 專門定義了 MTLManagedObjectAdapter 類,用作 MTLModel 物件與 NSManagedObject 物件之間的轉換。

技術點總結

Mantle 的核心功能是物件間的數據轉換,即如何在 MTLModel 與 JSON 字典之間轉換數據,因此所用技術大多來自 Cocoa Foundation:

KVC 的應用:主要體現在為 MTLModel 子類屬性賦值時,透過 KVC 驗證值有效性並賦值。

NSValueTransformer:主要用於把 JSON 值轉為屬性值,我們可自訂轉換器滿足自身需求。

NSInvocation:主要用於統一調用針對特定 key 的方法,如 -mergeFromModel: 這類方法。

Run time 函數:主要用於從字符串取得方法對應的選擇器,再透過 sel_registerName 註冊。

當然,Mantle 中還涉及其他技術點,此處不再贅述。

參考

Mantle 工程

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