引例
假設(shè)有這么一個類
@protocol JKTestProtocol<NSObject>
- (void)just4Test;
@end
@interface ViewController ()
@property (nonatomic, strong) NSObject<JKTestProtocol> *test;
@end
如何動態(tài)獲取ViewController中的property不用多說,直接利用runtime
來做渐夸。同樣弓乙,獲取property的類型及修飾符也是通過runtime
搞定(類型對應(yīng)Objective-C type encodings
郊酒,修飾符對應(yīng)property type encodings
,這就是所謂的類型編碼)
熟悉這些知識點的童鞋需五,可以跳過引例直接閱讀正文部分的YYModel類型編碼解析
先上代碼
- (void)viewDidLoad {
[super viewDidLoad];
objc_property_t property = class_getProperty([self class], "test");
NSLog(@"property name:%s", property_getName(property));
unsigned int outCount = 0;
objc_property_attribute_t *attrs = property_copyAttributeList(property, &outCount);
for (unsigned int i = 0; i < outCount; i++) {
NSLog(@"attribute name:%s attribute value:%s", attrs[i].name, attrs[i].value);
}
free(attrs);
}
說明:由于ViewController中只有一個屬性,這里使用class_getProperty轧坎,一般使用class_copyPropertyList獲取屬性列表
控制臺輸出如下:
objc_property_attribute_t是什么:
/// Defines a property attribute
typedef struct {
const char * _Nonnull name; /**< The name of the attribute */
const char * _Nonnull value; /**< The value of the attribute (usually empty) */
} objc_property_attribute_t;
一個最簡單的結(jié)構(gòu)體宏邮,內(nèi)部存著兩個字符串,value后的注釋寫著usually empty缸血。通過console可以看到蜜氨,name為T
和V
時,value有值捎泻,其余為空(事實上飒炎,T對應(yīng)的value一定有之,G笆豁、S郎汪、V對應(yīng)的value可能有值,其余對應(yīng)的value都沒值)
console中attribute name 就是property type encodings
渔呵。T怒竿、&、N扩氢、V具體表示什么耕驰?戳這里查看官方文檔
簡單解讀:
以T
打頭,以V
結(jié)尾录豺。T對應(yīng)的value中以字符串形式存著屬性類型和遵守的協(xié)議朦肘,V對應(yīng)的value如果有值饭弓,以字符串形式存著ivar∶娇伲回到聲明
@interface ViewController ()
@property (nonatomic, strong) NSObject<JKTestProtocol> *test;
@end
文檔中弟断,&對應(yīng)retain,這里是strong(ARC與MRC歷史遺留)趴生,N對應(yīng)nonatomic阀趴,這里也是nonatomic。OK都能對得上
如何獲取property的類型苍匆?最先想到的可能是@encode(<#type-name#>)刘急,type-name可以直接從T對應(yīng)的value中截取,那么@encode又是如何工作的浸踩?
Objective-C
中提供了另一套編碼Type Encodings 戳這里查看官方文檔
注意:可以看到文檔中說明叔汁,@encode不支持long double類型,long double與double類型編碼后的結(jié)果都是d
所以检碗,想獲取long double類型還需自定義据块。YYModel將long double 類型編碼自定義為D
case 'D': return YYEncodingTypeLongDouble | qualifier;
有了以上知識儲備,YYModel源碼走你
正文
了解runtime的童鞋應(yīng)該都知道Objective-C底層是一堆結(jié)構(gòu)體折剃,通過自定義結(jié)構(gòu)體封裝Class另假,結(jié)構(gòu)體內(nèi)部再包含其他結(jié)構(gòu)體,諸如此類
#if !__OBJC2__
Class _Nullable super_class OBJC2_UNAVAILABLE;
const char * _Nonnull name OBJC2_UNAVAILABLE;
long version OBJC2_UNAVAILABLE;
long info OBJC2_UNAVAILABLE;
long instance_size OBJC2_UNAVAILABLE;
struct objc_ivar_list * _Nullable ivars OBJC2_UNAVAILABLE;
struct objc_method_list * _Nullable * _Nullable methodLists OBJC2_UNAVAILABLE;
struct objc_cache * _Nonnull cache OBJC2_UNAVAILABLE;
struct objc_protocol_list * _Nullable protocols OBJC2_UNAVAILABLE;
#endif
} OBJC2_UNAVAILABLE;
/* Use `Class` instead of `struct objc_class *` */
#endif
這里不做進(jìn)一步數(shù)據(jù)結(jié)構(gòu)分析微驶,只是借此和YYModel做簡單對比浪谴。為了更好的OOP,YYModel將Objective-C底層結(jié)構(gòu)體包含的信息以NSObject為基類重新構(gòu)建成類因苹,在這些重定義類的基礎(chǔ)上獲取信息
源碼伺候(含注釋)
@implementation YYClassPropertyInfo
- (instancetype)initWithProperty:(objc_property_t)property {
if (!property) return nil;
self = [super init];
_property = property;
const char *name = property_getName(property);
if (name) {
_name = [NSString stringWithUTF8String:name];
}
YYEncodingType type = 0;
unsigned int attrCount;
// 獲取property屬性列表
objc_property_attribute_t *attrs = property_copyAttributeList(property, &attrCount);
for (unsigned int i = 0; i < attrCount; i++) {
switch (attrs[i].name[0]) {
case 'T': { // Type encoding
if (attrs[i].value) {
_typeEncoding = [NSString stringWithUTF8String:attrs[i].value];
// 獲取編碼類型(后文會有這個函數(shù))
type = YYEncodingGetType(attrs[i].value);
if ((type & YYEncodingTypeMask) == YYEncodingTypeObject && _typeEncoding.length) {
NSScanner *scanner = [NSScanner scannerWithString:_typeEncoding];
// 掃描scanner string中的 @\ 將字符串定位到 @\ 后一個字符
// 此時 scanLocation = 2
if (![scanner scanString:@"@\"" intoString:NULL]) continue;
NSString *clsName = nil;
// 掃描之后字符串中 " 或者 < 字符苟耻,將截取的字符串存入clsName中,將字符串定位到 " 或者 < 后一個字符
// 因為string 不確定屬性是否遵守某協(xié)議扶檐,所以可能還有 < 凶杖,如@"NSObject<JKTestProtocol>",也可能不含 < 款筑,如@"NSObject"
if ([scanner scanUpToCharactersFromSet: [NSCharacterSet characterSetWithCharactersInString:@"\"<"] intoString:&clsName]) {
if (clsName.length) _cls = objc_getClass(clsName.UTF8String);
}
NSMutableArray *protocols = nil;
// 掃描之后字符串 中的 < 智蝠,將字符串定位到 < 后一個字符
// 屬性有可能遵循多個協(xié)議,包含多個 < 奈梳,如@"NSObject<JKTestProtocol0><JKTestProtocol1>"杈湾,所以此處用while循環(huán)
while ([scanner scanString:@"<" intoString:NULL]) {
NSString* protocol = nil;
// 掃描之后字符串中 < ,將截取的字符串存入protocol中攘须,如@"NSObject<JKTestProtocol>"漆撞,此時剛好截取到 JKTestProtocol
if ([scanner scanUpToString:@">" intoString: &protocol]) {
if (protocol.length) {
if (!protocols) protocols = [NSMutableArray new];
[protocols addObject:protocol];
}
}
// 掃描之后字符串中 > ,將字符串定位到 > 后一個字符
[scanner scanString:@">" intoString:NULL];
}
_protocols = protocols;
}
}
} break;
// ivar
case 'V': { // Instance variable
// 如果value有值回去ivar的name
if (attrs[i].value) {
_ivarName = [NSString stringWithUTF8String:attrs[i].value];
}
} break;
case 'R': {
type |= YYEncodingTypePropertyReadonly;
} break;
case 'C': {
type |= YYEncodingTypePropertyCopy;
} break;
case '&': {
type |= YYEncodingTypePropertyRetain;
} break;
case 'N': {
type |= YYEncodingTypePropertyNonatomic;
} break;
case 'D': {
type |= YYEncodingTypePropertyDynamic;
} break;
case 'W': {
type |= YYEncodingTypePropertyWeak;
} break;
// 自定義屬性getter
case 'G': {
type |= YYEncodingTypePropertyCustomGetter;
if (attrs[i].value) {
_getter = NSSelectorFromString([NSString stringWithUTF8String:attrs[i].value]);
}
} break;
// 自定義屬性setter
case 'S': {
type |= YYEncodingTypePropertyCustomSetter;
if (attrs[i].value) {
_setter = NSSelectorFromString([NSString stringWithUTF8String:attrs[i].value]);
}
} // break; commented for code coverage in next line
default: break;
}
}
if (attrs) {
free(attrs);
attrs = NULL;
}
_type = type;
if (_name.length) {
// 如果沒有自定義getter,獲取getter的name
if (!_getter) {
_getter = NSSelectorFromString(_name);
}
// 如果沒有自定義setter浮驳,獲取setter的name
if (!_setter) {
_setter = NSSelectorFromString([NSString stringWithFormat:@"set%@%@:", [_name substringToIndex:1].uppercaseString, [_name substringFromIndex:1]]);
}
}
return self;
}
@end
從源碼來看悍汛,initWithProperty:無非是在通過attribute做字符串的截取,然后放到Y(jié)YClassPropertyInfo生成對象對應(yīng)的屬性中
再看另一個關(guān)鍵函數(shù)YYEncodingGetType
YYEncodingType YYEncodingGetType(const char *typeEncoding) {
char *type = (char *)typeEncoding;
if (!type) return YYEncodingTypeUnknown;
size_t len = strlen(type);
if (len == 0) return YYEncodingTypeUnknown;
YYEncodingType qualifier = 0;
bool prefix = true;
// 獲取method編碼類型
// 可能不止一個字符至会,所以通過while循環(huán)离咐、"++"操作,來移動指針指向
while (prefix) {
switch (*type) {
case 'r': {
qualifier |= YYEncodingTypeQualifierConst;
type++;
} break;
case 'n': {
qualifier |= YYEncodingTypeQualifierIn;
type++;
} break;
case 'N': {
qualifier |= YYEncodingTypeQualifierInout;
type++;
} break;
case 'o': {
qualifier |= YYEncodingTypeQualifierOut;
type++;
} break;
case 'O': {
qualifier |= YYEncodingTypeQualifierBycopy;
type++;
} break;
case 'R': {
qualifier |= YYEncodingTypeQualifierByref;
type++;
} break;
case 'V': {
qualifier |= YYEncodingTypeQualifierOneway;
type++;
} break;
default: { prefix = false; } break;
}
}
len = strlen(type);
if (len == 0) return YYEncodingTypeUnknown | qualifier;
// 獲取object編碼類型
switch (*type) {
case 'v': return YYEncodingTypeVoid | qualifier;
case 'B': return YYEncodingTypeBool | qualifier;
case 'c': return YYEncodingTypeInt8 | qualifier;
case 'C': return YYEncodingTypeUInt8 | qualifier;
case 's': return YYEncodingTypeInt16 | qualifier;
case 'S': return YYEncodingTypeUInt16 | qualifier;
case 'i': return YYEncodingTypeInt32 | qualifier;
case 'I': return YYEncodingTypeUInt32 | qualifier;
case 'l': return YYEncodingTypeInt32 | qualifier;
case 'L': return YYEncodingTypeUInt32 | qualifier;
case 'q': return YYEncodingTypeInt64 | qualifier;
case 'Q': return YYEncodingTypeUInt64 | qualifier;
case 'f': return YYEncodingTypeFloat | qualifier;
case 'd': return YYEncodingTypeDouble | qualifier;
case 'D': return YYEncodingTypeLongDouble | qualifier;
case '#': return YYEncodingTypeClass | qualifier;
case ':': return YYEncodingTypeSEL | qualifier;
case '*': return YYEncodingTypeCString | qualifier;
case '^': return YYEncodingTypePointer | qualifier;
case '[': return YYEncodingTypeCArray | qualifier;
case '(': return YYEncodingTypeUnion | qualifier;
case '{': return YYEncodingTypeStruct | qualifier;
case '@': {
if (len == 2 && *(type + 1) == '?')
return YYEncodingTypeBlock | qualifier;
else
return YYEncodingTypeObject | qualifier;
}
default: return YYEncodingTypeUnknown | qualifier;
}
}
YYEncodingGetType其實就是獲取method和object的編碼類型
最后再看YYEncodingType是如何定義的
typedef NS_OPTIONS(NSUInteger, YYEncodingType) {
YYEncodingTypeMask = 0xFF, ///< mask of type value
YYEncodingTypeUnknown = 0, ///< unknown
// ...此處省略多種類型
YYEncodingTypeCArray = 22, ///< char[10] (for example)
YYEncodingTypeQualifierMask = 0xFF00, ///< mask of qualifier
YYEncodingTypeQualifierConst = 1 << 8, ///< const
// ...此處省略多種類型
YYEncodingTypeQualifierOneway = 1 << 14, ///< oneway
YYEncodingTypePropertyMask = 0xFF0000, ///< mask of property
YYEncodingTypePropertyReadonly = 1 << 16, ///< readonly
// ...此處省略多種類型
YYEncodingTypePropertyDynamic = 1 << 23, ///< @dynamic
};
很簡單奉件,C語言的基礎(chǔ)知識宵蛀,通過Mask做與或運算即可得到定義的類型
通過Type Encoding可以做一些crazy things,畢竟越接近底層自由度就越大