Objective-C 的分類(Category)預設不允許加入實例變數,這是許多人想幫 NSObject 或自訂類別擴充狀態時撞上的牆。解法是 Objective-C Runtime 提供的「關聯物件」(Associated Object)機制——它把額外的資料掛在物件身上,效果等同於多了一個成員變數。
// 增加成員變數 #import <Foundation/Foundation.h> @interface NSObject (AddProperty) @property (nonatomic, strong) NSString *stringProperty; @property (nonatomic, assign) NSInteger integerProperty; @end
實作部分:
#import "NSObject+AddProperty.h"
#import <objc/runtime.h>
// objc_getAssociatedObject 與 objc_setAssociatedObject 都需要一個「固定的位址」
// 作為 key,起到常數的作用。
static const void *StringProperty = &StringProperty;
static const void *IntegerProperty = &IntegerProperty;
@implementation NSObject (AddProperty)
// 分類中宣告的屬性不會自動合成,必須標為 dynamic
@dynamic stringProperty;
- (void)setStringProperty:(NSString *)stringProperty {
// 用靜態常數位址作為 key
objc_setAssociatedObject(self, StringProperty, stringProperty,
OBJC_ASSOCIATION_RETAIN_NONATOMIC);
// 也可以用 property 的 selector 作為 key:
// objc_setAssociatedObject(self, @selector(stringProperty), stringProperty,
// OBJC_ASSOCIATION_RETAIN_NONATOMIC);
}
- (NSString *)stringProperty {
return objc_getAssociatedObject(self, StringProperty);
}
- (void)setIntegerProperty:(NSInteger)integerProperty {
// 關聯物件只能存 OC 物件,基本型別需先包裝成 NSNumber
NSNumber *number = [[NSNumber alloc] initWithInteger:integerProperty];
objc_setAssociatedObject(self, IntegerProperty, number,
OBJC_ASSOCIATION_ASSIGN);
}
- (NSInteger)integerProperty {
return [objc_getAssociatedObject(self, IntegerProperty) integerValue];
}
@end
第一,key 必須唯一且固定。用 static const void * 取自身位址是最常見的做法;用 selector 也可以。千萬不要用字串或暫存變數位址,那會導致取值時找不到同一個 key。
第二,關聯物件只能存物件,不能存基本型別。這正是範例中 NSInteger 必須先包成 NSNumber 的原因。而 policy 參數選 OBJC_ASSOCIATION_ASSIGN 對 NSNumber 而言是可行的(它是暫存物件),但更明確的做法是選 OBJC_ASSOCIATION_RETAIN_NONATOMIC,語義上更清楚。
第三,它是掛在物件上的,不是存在類別裡。因此每個物件各有自己的值,這點與真正的成員變數一致;但代價是每次存取都要走一次 runtime 查表,效能不如直接讀 ivar。此外,關聯物件在物件 dealloc 時會自動釋放,不需手動清理。
Runtime 也提供了列舉屬性的 API,適合用來做字典與模型互轉、自動化日誌、或反射式賦值。
@interface NSObject (Property) - (NSDictionary *)propertyDictionary; + (NSArray *)classPropertyList; @end
#import "NSObject+Property.h"
#import <objc/runtime.h>
@implementation NSObject (Property)
// 取得當前物件所有屬性的名稱與值
- (NSDictionary *)propertyDictionary {
NSMutableDictionary *dict = [NSMutableDictionary dictionary];
unsigned int outCount = 0;
objc_property_t *props = class_copyPropertyList([self class], &outCount);
for (int i = 0; i < outCount; i++) {
objc_property_t prop = props[i];
NSString *propName = [NSString stringWithUTF8String:property_getName(prop)];
id propValue = [self valueForKey:propName];
if (propValue) {
[dict setObject:propValue forKey:propName];
}
}
free(props); // class_copyPropertyList 回傳的記憶體必須自行釋放
return dict;
}
// 只取屬性名稱清單
+ (NSArray *)classPropertyList {
NSMutableArray *allProperties = [NSMutableArray array];
unsigned int outCount = 0;
objc_property_t *props = class_copyPropertyList(self, &outCount);
for (int i = 0; i < outCount; i++) {
objc_property_t prop = props[i];
NSString *propName = [NSString stringWithUTF8String:property_getName(prop)];
[allProperties addObject:propName];
}
free(props);
return allProperties;
}
@end
最後提醒兩點:class_copyPropertyList 遵循 Core Foundation 的「Copy 規則」,回傳的陣列必須自行 free,否則每次呼叫都會洩漏記憶體——原範例正好漏了這一步。另外,propertyDictionary 用 KVC 取值時,若某屬性為 nil 或型別無法放入字典,會出現問題,實務上通常要加上型別判斷與 nil 檢查。這類反射技巧很強大,但也因此在除錯時較不直觀,建議封裝成工具類並寫清楚註解。