為便於下文討論,提前創建父類 Biology 與子類 Person。
Biology:
@interface Biology : NSObject {
NSInteger *_hairCountInBiology;
}
@property (nonatomic, copy) NSString *introInBiology;
@end
@implementation Biology
@end
Person:
#import <Foundation/Foundation.h>
#import "Biology.h"
#import <objc/runtime.h>
@interface Person : Biology {
NSString *_father;
}
@property (nonatomic, copy) NSString *name;
@property (nonatomic, assign) NSInteger age;
@end
@implementation Person
@end
補充說明
凡是在父類中定義的屬性或變量,末尾都帶有 InBiology 標誌;反之也成立。
在 iOS 中,一個自定義對象是無法直接寫入文件的,必須先轉化成二進制流。從對象到二進制數據的過程稱為序列化(Serialization),也叫歸檔(Archive);反之則稱為反序列化或反歸檔。
序列化不可避免地要實現 NSCoding 協議的兩個方法(NSCopying 視情況而定):
- (id)initWithCoder:(NSCoder *)coder;
- (void)encodeWithCoder:(NSCoder *)coder;
- (id)copyWithZone:(NSZone *)zone;
假設現在要對直接繼承自 NSObject 的 Person 類做序列化,代碼通常長這樣:
//對變量編碼
- (void)encodeWithCoder:(NSCoder *)coder {
[coder encodeObject:self.name forKey:@"name"];
[coder encodeObject:@(self.age) forKey:@"age"];
[coder encodeObject:_father forKey:@"_father"];
//... ... other instance variables
}
//對變量解碼
- (id)initWithCoder:(NSCoder *)coder {
self.name = [coder decodeObjectForKey:@"name"];
self.age = [[coder decodeObjectForKey:@"age"] integerValue];
_father = [coder decodeObjectForKey:@"_father"];
//... ... other instance variables
看起來 so easy?至少到目前為止是這樣。但請考慮以下三個問題:
碰到以上情況,傳統寫法會暴露兩個缺陷:
有沒有更優雅的方案?必須有。下面我們一起探討如何用 runtime 實現一套接口簡潔、通用性極強的序列化方案。
觀察上面的 initWithCoder: 可以發現,序列化與反序列化中最關鍵的環節是遍歷類的變量,保證不遺漏。
這裡需要特別注意的是:編解碼的範圍不能僅僅是自身類的變量,還應當把除 NSObject 外的所有層級父類的屬性變量也納入編解碼!
也就是說,這幾乎是個純體力活。而 runtime 恰好在「遍歷變量」這件事上特別擅長:我們可以在運行時獲取自身類的所有變量進行編解碼,然後對父類遞歸,逐層取到每個父類的屬性再做一遍。
獲取某類的所有變量(屬性變量 + 實例變量):
Ivar *class_copyIvarList(Class cls, unsigned int *outCount)
獲取某類的所有屬性變量:
objc_property_t *class_copyPropertyList(Class cls, unsigned int *outCount)
runtime 的所有開放 API 都放在 objc/runtime.h 中。先簡單介紹兩個核心數據類型。
Ivar 是 runtime 對變量的定義,本質是一個結構體:
struct objc_ivar {
char *ivar_name;
char *ivar_type;
int ivar_offset;
#ifdef __LP64__
int space;
#endif
}
typedef struct objc_ivar *Ivar;
const char *ivar_getName(Ivar v) 獲取;@ 表示 id 類型、i 表示 int 類型。可用 const char *ivar_getTypeEncoding(Ivar v) 獲取;獲取所有變量的代碼通常長這樣:
unsigned int numIvars; //成員變量個數
Ivar *vars = class_copyIvarList(NSClassFromString(@"UIView"), &numIvars);
NSString *key = nil;
for (int i = 0; i < numIvars; i++) {
Ivar thisIvar = vars[i];
key = [NSString stringWithUTF8String:ivar_getName(thisIvar)];
//獲取成員變量的名字
NSLog(@"variable name :%@", key);
key = [NSString stringWithUTF8String:ivar_getTypeEncoding(thisIvar)];
//獲取成員變量的數據類型
NSLog(@"variable type :%@", key);
}
free(vars);//記得釋放掉
objc_property_t 是 runtime 對屬性變量的定義,本質上也是一個結構體(OC 是對 C 的封裝,大多數類型的本質都是 C 結構體)。頭文件中只有 typedef struct objc_property *objc_property_t,沒有更詳細的結構介紹。這不影響我們今天的主題。與 Ivar 同理,獲取類的屬性變量:
unsigned int outCount, i;
objc_property_t *properties = class_copyPropertyList([self class], &outCount);
for (i = 0; i < outCount; i++) {
objc_property_t property = properties[i];
NSString *propertyName = [NSString stringWithUTF8String:property_getName(property)];
NSLog(@"property name:%@", propertyName);
}
free(properties);
有了前面的鋪墊,這裡就水到渠成了。我們在 initWithCoder: 與 encodeWithCoder: 中遍歷類的所有變量,取變量名作為 KEY,最後用 KVC 強制讀取或寫入。
@implementation Person
//解碼
- (id)initWithCoder:(NSCoder *)coder {
unsigned int iVarCount = 0;
Ivar *iVarList = class_copyIvarList([self class], &iVarCount);
//取得變量列表,[self class]表示對自身類進行操作
for (int i = 0; i < iVarCount; i++) {
Ivar var = *(iVarList + i);
const char *varName = ivar_getName(var);//取得變量名字,將作為key
NSString *key = [NSString stringWithUTF8String:varName];
id value = [coder decodeObjectForKey:key];//解碼
if (value) {
[self setValue:value forKey:key];//使用KVC強制寫入到對象中
}
}
free(iVarList);//記得釋放內存
return self;
}
//編碼
- (void)encodeWithCoder:(NSCoder *)coder {
unsigned int varCount = 0;
Ivar *ivarList = class_copyIvarList([self class], &varCount);
for (int i = 0; i < varCount; i++) {
Ivar var = *(ivarList + i);
const char *varName = ivar_getName(var);
NSString *key = [NSString stringWithUTF8String:varName];
id varValue = [self valueForKey:key];//使用KVC獲取key對應的變量值
if (varValue) {
[coder encodeObject:varValue forKey:key];
}
}
free(ivarList);
}
上面代碼有個明顯缺陷:獲取變量時寫死了 [self class]。當你的 Model 並不是直接繼承自 NSObject 時,父類的屬性就會被漏掉。請牢記 3.1 節的提醒:
編解碼的範圍不能僅僅是自身類的變量,還應當把除 NSObject 外的所有層級父類的屬性變量也進行編解碼!
因此我們需要設一個指針,先指向本身類,處理完指向 SuperClass,再指向 SuperClass 的 SuperClass……以 encodeWithCoder: 為例:
- (void)encodeWithCoder:(NSCoder *)coder {
Class cls = [self class];
while (cls != [NSObject class]) {//對NSObject的變量不做處理
unsigned int iVarCount = 0;
Ivar *ivarList = class_copyIvarList(cls, &iVarCount);
/*變量列表,含屬性以及私有變量*/
for (int i = 0; i < iVarCount; i++) {
const char *varName = ivar_getName(*(ivarList + i));
NSString *key = [NSString stringWithUTF8String:varName];
/*valueForKey只能獲取本類所有變量以及所有層級父類的屬性,
不包含任何父類的私有變量(會崩潰)*/
id varValue = [self valueForKey:key];
if (varValue) {
[coder encodeObject:varValue forKey:key];
}
}
free(ivarList);
cls = class_getSuperclass(cls);//指針指向當前類的父類
}
}
這樣真的結束了嗎?不是的。跑上面的代碼,程序很可能在 [self valueForKey:key] 這一行 crash。原因是 KVC 無法讀取父類的私有變量(純 ivar)。
所以處理父類時不能粗暴地用 class_copyIvarList,而只能取父類的屬性變量——這時候 3.2 節提到的 class_copyPropertyList 就派上用場了。
最終代碼如下:
- (id)initWithCoder:(NSCoder *)coder {
NSLog(@"%s", __func__);
Class cls = [self class];
while (cls != [NSObject class]) {
/*判斷是自身類還是父類*/
BOOL bIsSelfClass = (cls == [self class]);
unsigned int iVarCount = 0;
unsigned int propVarCount = 0;
unsigned int sharedVarCount = 0;
Ivar *ivarList = bIsSelfClass ? class_copyIvarList(cls, &iVarCount) : NULL;
/*變量列表,含屬性以及私有變量*/
objc_property_t *propList = bIsSelfClass ? NULL : class_copyPropertyList(cls, &propVarCount);
/*屬性列表*/
sharedVarCount = bIsSelfClass ? iVarCount : propVarCount;
for (int i = 0; i < sharedVarCount; i++) {
const char *varName = bIsSelfClass
? ivar_getName(*(ivarList + i))
: property_getName(*(propList + i));
NSString *key = [NSString stringWithUTF8String:varName];
id varValue = [coder decodeObjectForKey:key];
if (varValue) {
[self setValue:varValue forKey:key];
}
}
free(ivarList);
free(propList);
cls = class_getSuperclass(cls);
}
return self;
}
- (void)encodeWithCoder:(NSCoder *)coder {
NSLog(@"%s", __func__);
Class cls = [self class];
while (cls != [NSObject class]) {
/*判斷是自身類還是父類*/
BOOL bIsSelfClass = (cls == [self class]);
unsigned int iVarCount = 0;
unsigned int propVarCount = 0;
unsigned int sharedVarCount = 0;
Ivar *ivarList = bIsSelfClass ? class_copyIvarList(cls, &iVarCount) : NULL;
/*變量列表,含屬性以及私有變量*/
objc_property_t *propList = bIsSelfClass ? NULL : class_copyPropertyList(cls, &propVarCount);
/*屬性列表*/
sharedVarCount = bIsSelfClass ? iVarCount : propVarCount;
for (int i = 0; i < sharedVarCount; i++) {
const char *varName = bIsSelfClass
? ivar_getName(*(ivarList + i))
: property_getName(*(propList + i));
NSString *key = [NSString stringWithUTF8String:varName];
/*valueForKey只能獲取本類所有變量以及所有層級父類的屬性,
不包含任何父類的私有變量(會崩潰)*/
id varValue = [self valueForKey:key];
if (varValue) {
[coder encodeObject:varValue forKey:key];
}
}
free(ivarList);
free(propList);
cls = class_getSuperclass(cls);
}
}
邏輯上,上面的代碼已經是一套比較完美的自動序列化方案了。即使某個類繼承深度極深、變量極多,序列化代碼也就這麼多。
但回到第二節的場景假設:如果工程裡有很多類都要序列化,難道每個類都抄一遍?這顯然造成了新的冗餘。那就再封裝一層!這裡用宏的方式把上述代碼濃縮成一行,放進 WZLSerializeKit.h:
#define WZLSERIALIZE_CODER_DECODER() \
- (id)initWithCoder:(NSCoder *)coder { \
NSLog(@"%s", __func__); \
Class cls = [self class]; \
while (cls != [NSObject class]) { \
/*判斷是自身類還是父類*/ \
BOOL bIsSelfClass = (cls == [self class]); \
unsigned int iVarCount = 0; \
unsigned int propVarCount = 0; \
unsigned int sharedVarCount = 0; \
Ivar *ivarList = bIsSelfClass ? class_copyIvarList(cls, &iVarCount) : NULL; \
objc_property_t *propList = bIsSelfClass ? NULL : class_copyPropertyList(cls, &propVarCount); \
sharedVarCount = bIsSelfClass ? iVarCount : propVarCount; \
for (int i = 0; i < sharedVarCount; i++) { \
const char *varName = bIsSelfClass \
? ivar_getName(*(ivarList + i)) \
: property_getName(*(propList + i)); \
NSString *key = [NSString stringWithUTF8String:varName]; \
id varValue = [coder decodeObjectForKey:key]; \
if (varValue) { \
[self setValue:varValue forKey:key]; \
} \
} \
free(ivarList); \
free(propList); \
cls = class_getSuperclass(cls); \
} \
return self; \
} \
\
- (void)encodeWithCoder:(NSCoder *)coder { \
NSLog(@"%s", __func__); \
Class cls = [self class]; \
while (cls != [NSObject class]) { \
BOOL bIsSelfClass = (cls == [self class]); \
unsigned int iVarCount = 0; \
unsigned int propVarCount = 0; \
unsigned int sharedVarCount = 0; \
Ivar *ivarList = bIsSelfClass ? class_copyIvarList(cls, &iVarCount) : NULL; \
objc_property_t *propList = bIsSelfClass ? NULL : class_copyPropertyList(cls, &propVarCount); \
sharedVarCount = bIsSelfClass ? iVarCount : propVarCount; \
for (int i = 0; i < sharedVarCount; i++) { \
const char *varName = bIsSelfClass \
? ivar_getName(*(ivarList + i)) \
: property_getName(*(propList + i)); \
NSString *key = [NSString stringWithUTF8String:varName]; \
id varValue = [self valueForKey:key]; \
if (varValue) { \
[coder encodeObject:varValue forKey:key]; \
} \
} \
free(ivarList); \
free(propList); \
cls = class_getSuperclass(cls); \
} \
}
之後需要序列化的地方只要兩步:
#import "WZLSerializeKit.h"WZLSERIALIZE_CODER_DECODER();兩個字:清爽。
此外,copyWithZone 中同樣可以用相同原理實現自動化 copy,也能用一個宏封裝掉,這裡不再贅述。
值得一提的是,以上代碼已開源並提供 CocoaPods 支持,使用時只需 pod 'WZLSerializeKit'。
1. 宏封裝的代價
用宏把這麼大一坨代碼塞進每個類,編譯產物會相應膨脹。更現代的替代方案是繼承一個 BaseModel 基類,把序列化邏輯寫在基類裡,子類直接繼承即可,可讀性和可維護性都更好。宏的優勢主要在於不改變原有繼承鏈。
2. KVC 的類型問題
這套方案對所有屬性統一用 decodeObjectForKey: 處理,對 int、CGFloat 等基本類型其實並不嚴謹(雖然 @(self.age) 這類装箱在實踐中往往能僥倖工作)。嚴謹的做法是先用 ivar_getTypeEncoding 判斷類型編碼,再決定調用 decodeIntForKey:、decodeFloatForKey: 還是 decodeObjectForKey:。
3. 集合類屬性的歸檔
如果屬性是 NSArray、NSDictionary 且裡面裝的是自定義對象,那些自定義對象也必須實現 NSCoding,否則歸檔時會拋出 NSInvalidArgumentException。
4. 性能考量
runtime 遍歷 + KVC 的開銷大於直接屬性訪問。歸檔通常發生在頁面退出或進入後台時,數據量不大時無需擔心;但如果要歸檔上萬條記錄,建議先做性能測試,必要時改用 NSKeyedArchiver 的 outputFormat 調整或改用 SQLite / Core Data 存儲。
5. 更快的現代替代
iOS 11 之後,蘋果推出了 NSCoding 的便捷實現 NSSecureCoding 與 Codable 協議(Swift)。新項目若使用 Swift,直接用 Codable + JSONEncoder / PropertyListEncoder 即可,編譯器會自動合成實現,既安全又高效。runtime 方案在 Objective-C 存量項目、或需要兼容舊系統時仍有價值。