iOS runtime實戰應用：成員變數和屬性

前言

在開始之前建議先閱讀iOS runtime的基礎理解篇：iOS內功篇：runtime

有筒子在面試的時候，遇到這樣一個問題：“你知道成員變數的本質是什麼嗎？”，筒子立馬懵逼了，成員變數的本質？成員變數就是成員變數啊，平時只管用，還有什麼更深層的含義？本文著重介紹runtime中成員變數和屬性的定義和使用。

名詞解析

成員變數

1、定義：
Ivar: 例項變數型別，是一個指向objc_ivar結構體的指標

typedef struct objc_ivar *Ivar;

2、操作函式：

// 獲取所有成員變數
class_copyIvarList

// 獲取成員變數名
ivar_getName

// 獲取成員變數型別編碼
ivar_getTypeEncoding

// 獲取指定名稱的成員變數
class_getInstanceVariable

// 獲取某個物件成員變數的值
object_getIvar

// 設定某個物件成員變數的值
object_setIvar

3、使用例項：
Model的標頭檔案宣告如下：

    @interface Model : NSObject {
        NSString * _str1;
    }
    @property NSString * str2;
    @property (nonatomic, copy) NSDictionary * dict1;
    @end

獲取其成員變數：

    unsigned int outCount = 0;
    Ivar * ivars = class_copyIvarList([Model class], &outCount);
    for (unsigned int i = 0; i < outCount; i ++) {
        Ivar ivar = ivars[i];
        const char * name = ivar_getName(ivar);
        const char * type = ivar_getTypeEncoding(ivar);
        NSLog(@"型別為 %s 的 %s ",type, name);
    }
    free(ivars);

列印結果：

runtimeIvar[602:16885] 型別為 @"NSString" 的 _str1 
runtimeIvar[602:16885] 型別為 @"NSString" 的 _str2 
runtimeIvar[602:16885] 型別為 @"NSDictionary" 的 _dict1 

屬性

1、定義：
objc_property_t：宣告的屬性的型別，是一個指向objc_property結構體的指標

typedef struct objc_property *objc_property_t;

2、操作函式：

// 獲取所有屬性
class_copyPropertyList

說明：使用class_copyPropertyList並不會獲取無@property宣告的成員變數

// 獲取屬性名
property_getName

// 獲取屬性特性描述字串
property_getAttributes

// 獲取所有屬性特性
property_copyAttributeList

說明：
property_getAttributes函式返回objc_property_attribute_t結構體列表，objc_property_attribute_t結構體包含name和value，常用的屬性如下：

屬性型別  name值：T  value：變化
編碼型別  name值：C(copy) &(strong) W(weak) 空(assign) 等 value：無
非/原子性 name值：空(atomic) N(Nonatomic)  value：無
變數名稱  name值：V  value：變化

使用property_getAttributes獲得的描述是property_copyAttributeList能獲取到的所有的name和value的總體描述，如 T@"NSDictionary",C,N,V_dict1

3、使用例項：

    unsigned int outCount = 0;
    objc_property_t * properties = class_copyPropertyList([Model class], &outCount);
    for (unsigned int i = 0; i < outCount; i ++) {
        objc_property_t property = properties[i];
        //屬性名
        const char * name = property_getName(property);
        //屬性描述
        const char * propertyAttr = property_getAttributes(property);
        NSLog(@"屬性描述為 %s 的 %s ", propertyAttr, name);
        
        //屬性的特性
        unsigned int attrCount = 0;
        objc_property_attribute_t * attrs = property_copyAttributeList(property, &attrCount);
        for (unsigned int j = 0; j < attrCount; j ++) {
            objc_property_attribute_t attr = attrs[j];
            const char * name = attr.name;
            const char * value = attr.value;
            NSLog(@"屬性的描述：%s 值：%s", name, value);
        }
        free(attrs);
        NSLog(@"\n");
    }
    free(properties);

列印結果：

runtimeIvar[661:27041] 屬性描述為 T@"NSString",&,V_str2 的 str2 
runtimeIvar[661:27041] 屬性的描述：T 值：@"NSString"
runtimeIvar[661:27041] 屬性的描述：& 值：
runtimeIvar[661:27041] 屬性的描述：V 值：_str2
runtimeIvar[661:27041] 
runtimeIvar[661:27041] 屬性描述為 T@"NSDictionary",C,N,V_dict1 的 dict1 
runtimeIvar[661:27041] 屬性的描述：T 值：@"NSDictionary"
runtimeIvar[661:27041] 屬性的描述：C 值：
runtimeIvar[661:27041] 屬性的描述：N 值：
runtimeIvar[661:27041] 屬性的描述：V 值：_dict1
runtimeIvar[661:27041] 

應用例項

1、Json到Model的轉化

在開發中相信最常用的就是介面資料需要轉化成Model了（當然如果你是直接從Dict取值的話。。。），很多開發者也都使用著名的第三方庫如JsonModel、Mantle或MJExtension等，如果只用而不知其所以然，那真和“搬磚”沒啥區別了，下面我們使用runtime去解析json來給Model賦值。

原理描述：用runtime提供的函式遍歷Model自身所有屬性，如果屬性在json中有對應的值，則將其賦值。
核心方法：在NSObject的分類中新增方法：

- (instancetype)initWithDict:(NSDictionary *)dict {
    
    if (self = [self init]) {
        //(1)獲取類的屬性及屬性對應的型別
        NSMutableArray * keys = [NSMutableArray array];
        NSMutableArray * attributes = [NSMutableArray array];
        /*
         * 例子
         * name = value3 attribute = T@"NSString",C,N,V_value3
         * name = value4 attribute = T^i,N,V_value4
         */
        unsigned int outCount;
        objc_property_t * properties = class_copyPropertyList([self class], &outCount);
        for (int i = 0; i < outCount; i ++) {
            objc_property_t property = properties[i];
            //通過property_getName函式獲得屬性的名字
            NSString * propertyName = [NSString stringWithCString:property_getName(property) encoding:NSUTF8StringEncoding];
            [keys addObject:propertyName];
            //通過property_getAttributes函式可以獲得屬性的名字和@encode編碼
            NSString * propertyAttribute = [NSString stringWithCString:property_getAttributes(property) encoding:NSUTF8StringEncoding];
            [attributes addObject:propertyAttribute];
        }
        //立即釋放properties指向的記憶體
        free(properties);
        
        //(2)根據型別給屬性賦值
        for (NSString * key in keys) {
            if ([dict valueForKey:key] == nil) continue;
            [self setValue:[dict valueForKey:key] forKey:key];
        }
    }
    return self;

}

讀者可以進一步思考：
1、如何識別基本資料型別的屬性並處理
2、空（nil，null）值的處理
3、json中巢狀json（Dict或Array）的處理
嘗試解決以上問題，你也能寫出屬於自己的功能完備的Json轉Model庫。

2、快速歸檔

有時候我們要對一些資訊進行歸檔，如使用者資訊類UserInfo，這將需要重寫initWithCoder和encodeWithCoder方法，並對每個屬性進行encode和decode操作。那麼問題來了：當屬性只有幾個的時候可以輕鬆寫完，如果有幾十個屬性呢？那不得寫到天荒地老？。。。

原理描述：用runtime提供的函式遍歷Model自身所有屬性，並對屬性進行encode和decode操作。
核心方法：在Model的基類中重寫方法：

- (id)initWithCoder:(NSCoder *)aDecoder {
    if (self = [super init]) {
        unsigned int outCount;
        Ivar * ivars = class_copyIvarList([self class], &outCount);
        for (int i = 0; i < outCount; i ++) {
            Ivar ivar = ivars[i];
            NSString * key = [NSString stringWithUTF8String:ivar_getName(ivar)];
            [self setValue:[aDecoder decodeObjectForKey:key] forKey:key];
        }
    }
    return self;
}

- (void)encodeWithCoder:(NSCoder *)aCoder {
    unsigned int outCount;
    Ivar * ivars = class_copyIvarList([self class], &outCount);
    for (int i = 0; i < outCount; i ++) {
        Ivar ivar = ivars[i];
        NSString * key = [NSString stringWithUTF8String:ivar_getName(ivar)];
        [aCoder encodeObject:[self valueForKey:key] forKey:key];
    }
}

3、訪問私有變數

我們知道，OC中沒有真正意義上的私有變數和方法，要讓成員變數私有，要放在m檔案中宣告，不對外暴露。如果我們知道這個成員變數的名稱，可以通過runtime獲取成員變數，再通過getIvar來獲取它的值。
方法：

    Ivar ivar = class_getInstanceVariable([Model class], "_str1");
    NSString * str1 = object_getIvar(model, ivar);

歡迎大家交流探討。