首圖震帖

前言

做iOS開發以來，從最開始沒有資料模型，所有資料都靠NSString，NSDictionary，NSArrray等系統基礎的物件儲存，到後來自己開始手動擼資料模型，再然後就開始接觸JSONModel，徹底脫離了枯燥的重複的動作，後來一些國產的一些優秀的資料模型庫也開始嶄露頭角，如MJExtension,如YYModel等。但別人的輪子始終是別人的，要是中途爆了胎還得去人家的店裡(Github)提出問題，等待修復，可是現實中大多數的時候時間都不允許我們這樣慢慢的等待，所以就有了這篇文章。

在這篇文章中，你可以瞭解到一些實用的Runtime技巧，一些面向物件的思想，最重要的是可以自己做出一個可以供自己擴充套件的資料模型輪子。輪子雖小但優點在於方便理解，擴充套件性強。

廢話不多說，直接進入正題。

一張圖說目標功能

想一想別人的輪子

要將資料模型的實現原理，先回想一下我們平時是怎麼用別人的資料模型的。

• 首先我們需要根據服務端返回資料格式在我們一個對應的DataModel裡面將所有的引數名稱定義好，並且定義好對應的型別，如：

  @interface PersonDataModel : NSObject
  
  @property (nonatomic ,assign) NSUInteger age;
  @property (nonatomic ,copy  ) NSString *name;
  @property (nonatomic ,copy  ) NSString
   
   *sex;
  
  @end

• 然後我們傳入一個NSString或者NSData之類的東西，總之最後我們將它轉化為NSDictionary，然後就有了我們需要的一個完整的資料模型。如JSONModel的使用方法：

  PersonDataModel *person = [[PersonDataModel alloc]initWithString:jsonString error:NULL];

所以就有了我們的設計思路

得出設計思路

• 首先我們利用Runtime將PersonDataModel中所有的有用資訊記錄到最重要的ClassPropertyInfo（在下面Lists中會講出有哪些需要記錄的資訊）。
• 從而得到ClassInfo（這裡暫時用不到MethodInfo和IvarInfo）。
• 區分需要轉化的物件是NSDictionary還是NSArray。

• 將NSDictionary中的Key與我們剛才記錄在ClassPropertyInfo中的name進行對比。

  NSArray拆分成多個NSDictionary(或者String)做。

  暫時不支援NSArray中又是NSArray物件。

• 將對比上的Key進行差異化賦值。

下面我們就來實現具體的步驟

Step

• 獲取關鍵的ClassPropertyInfo資訊

  一條比較豐富的屬性長這樣：

  @property (nonatomic, strong ,setter=setGroup: ,getter=group) NSArray<Student> * group;

  可以看出這個地方對我們有用的有setter，getter，NSArray，Student和group，當然其中的nonatomic和strong也是一些有用的資訊，但我們目前姑且不談。

  關於property蘋果在<objc/runtime.h>中給了我們這些Api，如圖
  

  其中name就可以通過下面這個Api得到是group

  /** 
  * Returns the name of a property.
  * 
  * @param property The property you want to inquire about.
  * 
  * @return A C string containing the property's name.
  */
  OBJC_EXPORT const char *property_getName(objc_property_t property) 
  OBJC_AVAILABLE(10.5, 2.0, 9.0, 1.0);

  其它的都可以在蘋果給我們的另外一個Api中全部獲取到

  /** 
   * Returns an array of property attributes for a property. 
   * 
   * @param property The property whose attributes you want copied.
   * @param outCount The number of attributes returned in the array.
   * 
   * @return An array of property attributes; must be free'd() by the caller. 
   */
  OBJC_EXPORT objc_property_attribute_t *property_copyAttributeList(objc_property_t property, unsigned int *outCount)
      OBJC_AVAILABLE(10.7, 4.3, 9.0, 1.0);

  而這個函式取出來的是一個關於objc_property_attribute_t的陣列，而objc_property_attribute_t是一個這樣的結構題：

  /// Defines a property attribute
  typedef struct {
      const char *name;           /**< The name of the attribute */
      const char *value;          /**< The value of the attribute (usually empty) */
  } objc_property_attribute_t;    

  這裡的這裡name和value的定義可以參考：

  name包括N，&，W，R，G，S，V，T。

  這裡面的G，S正好對應getter，setter，這兩個比較好理解，都是對應SEL的name，不過這個這個時候通過value取出來的是一個char型字串，這個要注意一下。比如getter就是"group"，setter就是"setGroup:"。

  T就稍稍複雜一點一些，這裡的T就是@\"NSArray<Student>"\（如果有兩個protocol則是@\"NSArray<Student><Student2>），我們可以將它分為三部分@，NSArray和Student。其中NSArray是這個屬性的Class，Student是對應的protocols，因為protocols可能有多個，所以它是個陣列。同樣的它們也都是char型字串。

  最關鍵的是前面的@它代表這個property是個物件，具體這個char所對應的含義可以參考：

  其實在objc/runtime.h第1560行至1589行中也有對應的描述。我們將@這樣的字串單獨存入一個新定義的屬性type中

  這裡有個Tip可以有效的將@\"NSArray<Student><Student2>分成NSArray，Student，Student2這樣的陣列。

  NSString *type = @"@\"NSArray<Student><Student2>";
  NSMutableArray *values = [type componentsSeparatedByCharactersInSet:[NSCharacterSet characterSetWithCharactersInString:@"@\"<>,"]].mutableCopy;
  [values removeObject:@""];
  // 最終values = @[@"NSArray",@"Student",@"Student2"];

  到這裡關於一條Property最重要的一些資訊我們都得到了：

  • cls：NSArray
  • name：group
  • type：@
  • getterSel：@selector(group)
  • setterSel：@selector(setGroup:)
  • protocols：Student

  然後在補上一些能夠讓我們更方便使用的屬性，比如：

  • property：通過runtime取出的的property本身
  • isCustomPropetry：是否是系統類
  • isMutable：是否是系統類裡面的可變型別
  • superClsInfo：父類ClassInfo，如果父類為nil，則它也是nil

• 獲取關鍵的ClassInfo資訊

  ClassInfo中對於本文的有用資訊不多，目前我們只取：

  • name：類名，如這裡的person
  • cls：類本身，如這裡的PersonDataModel

  • propetryInfos：參考第一步

    獲取關鍵的ClassPropertyInfo資訊

  • superClsInfo：父類的ClassInfo，可用一個遞迴方法實現。

    + (instancetype)classInfoWithClass:(Class)cls{
        if ( !cls ) return nil;
        ...
        if ( !classInfo ) {
            classInfo = [[DBClassInfo alloc] initWithClass:cls];
        }
        return classInfo;
    }
    
    - (instancetype)initWithClass:(Class)cls{
        if ( !cls ) return nil;
        self = [super init];
        if ( self ) {
            ...
            _superCls = class_getSuperclass(cls);
            _superClsInfo = [DBClassInfo classInfoWithClass:_superCls];
            ...
        }
        return self;
    }
    

    由於classInfoWithClass是個類方法，所以這一步一定要確保執行緒安全，具體方式可以見 Demo

• 區分需要轉化的物件是NSDictionary還是NSArray。

  • 一般入參有四種

    1. NSDate
    2. NSString
    3. NSArray
    4. NSDictionary

  • 這裡只詳細介紹NSDictionary的處理方式,因為無論是NSDate還是NSString我們最終都要轉化為NSDictionary或者NSArray，而NSArray通常情況下也是將起轉化為一個個NSDictionary的來進行相應的處理的。

    如果NSArray中是都是NSString那麼就不需要用到資料模型，如果NSArray中也是NSArray，本類暫不支援這樣的JSON格式。在本文也就不做講述

• 將NSDictionary中的Key與我們剛才記錄在ClassPropertyInfo中的name進行對比。對比方式嘛就是輪詢。

  在這一步我們的目的是得到在我們DataModel中的每個ClassPropertyInfo對應的在NSDictionary中object。

  這句話讀起來可能比較繞口：所以我們舉個��：

  還是上文定義的PersonDataModel

  這個時候傳入的NSDictionary是

 { "name": "小明","age": 18,"sex": "男"}

那麼這個時候我們要找到的就是PersonDataModel中name為sex的ClassPropertyInfo和它對應的Value 男

而在這個地方我們就可以做一些比較有意思的事情了，比如白名單黑名單過濾，比如屬性名稱的對映，而這些有意思的方法可以將它都歸為一個Option的協議，並將所有協議單獨歸類出一個檔案DBModelProtocol，這樣方便閱讀，也方便維護。

白名單黑名單比較好理解，就是在對應的Model裡面接受對應的名單實現是否對這個屬性進行賦值或者不賦值。具體使用類似實現以下兩個協議即可

+ (NSArray *)modelPropertyBlackList{
    return @[@"teacher",@"groupCount",@"groupArray"];
}

+ (NSArray *)modelPropertyWhiteList{
    return @[@"teacher",@"groupCount",@"groupArray"];
}

屬性名稱的對映其實就我常用的重新命名，比如伺服器返回了我們一個key為id,但id是一個隱藏的系統關鍵字,我們一個會將它重新命名為personId或者teacherId等更容易理解的屬性名稱

我們重新在PersonDataModel的基礎上定義一個TeacherDataModel的資料模型

@interface TeacherDataModel : PersonDataModel
@property (nonatomic, assign) NSUInteger teacherId;
@end

而服務端返回給我們資料模型卻是

{ "id": "110", "name": "黃衛民", "age": 38, "sex": "男"}

這個時候我們就可以在這一步進行一些差異化的對比了：

首先我們先實現協議：

+ (NSDictionary *)customKeyMapper{
    return @{@"id":@"teacherId"};
}

當我們輪詢到TeacherDataModel的name為teacherId的ClassPropertyInfo時取出的NSDictionary中對應key為id的object。

• 將對比上的name的DBClassPropertyInfo的和object進行差異化賦值。

  這一步是邏輯最簡單，但也是實現起來最繁瑣的一步。

  • DBClassPropertyInfo中的type可以讓我們知道這個property是什麼型別，上文有講述。

  • 將object轉化為對應的property的型別

    這一步我們新建一個新的檔案DBValueTransformer來幫我們做這些資料的處理，並且在這一步我們也可以插入我們的一個協議(NSString->NSDate)

  • 再利用objc_msgSend進行賦值

  進行到這已經完成對一個NSDictionary->DataModel的全過程。

小結

雖然本文只是講述了NSDictionary->DataModel的過程，沒有其他的Model功能那麼完善，如：

• Model->Json
• Model比較
• 深拷貝

但我相信如果能看到這裡的同學對其他功能應該是已經可以手到擒來了。

做事之前先理清楚思路，功能點全部歸好類才能更好幫助我們完成它！

本文所有程式碼可以在這裡找到:Demo

參考