近期在學(xué)習(xí)公司源碼時(shí)栅炒,遇到clang attribute實(shí)現(xiàn)的代碼注解绍傲,summy的這篇文章已經(jīng)有些年頭了势誊,結(jié)合實(shí)際代碼學(xué)習(xí)才能深入理解粗井。
Clang Attributes 黑魔法小記
Clang Attributes 是 Clang 提供的一種源碼注解舔糖,方便開發(fā)者向編譯器表達(dá)某種要求娱两,參與控制如 Static Analyzer、Name Mangling金吗、Code Generation 等過程十兢,一般以 __attribute__(xxx)
的形式出現(xiàn)在代碼中;為方便使用摇庙,一些常用屬性也被 Cocoa 定義成宏旱物,比如在系統(tǒng)頭文件中經(jīng)常出現(xiàn)的 NS_CLASS_AVAILABLE_IOS(9_0)
就是 __attribute__(availability(...))
這個(gè)屬性的簡(jiǎn)單寫法。
常見屬性的介紹卫袒,可以看 NSHipster 的介紹文章 和的 twitter 的介紹文章宵呛。本文還會(huì)介紹幾個(gè)有意思的 “黑魔法” Attribute,說(shuō)不定在某些場(chǎng)景下會(huì)起到意想不到的效果哦~
以下測(cè)試都以 Xcode 7.3 ( Clang 3.8 ) 為準(zhǔn)
objc_subclassing_restricted
使用這個(gè)屬性可以定義一個(gè) Final Class
夕凝,也就是說(shuō)宝穗,一個(gè)不可被繼承的類,假設(shè)我們有個(gè)名叫 Eunuch(太監(jiān))
的類码秉,但并不希望有人可以繼承自它:
@interface Eunuch : NSObject
@end
@interface Child : Eunuch // 太監(jiān)不能夠有孩砸
@end
只要在 @interface 前面加上 objc_subclassing_restricted
這個(gè)屬性即可:
__attribute__((objc_subclassing_restricted))
@interface Eunuch : NSObject
@end
@interface Child : Eunuch // <--- Compile Error
@end
objc_requires_super
aka: NS_REQUIRES_SUPER
逮矛,標(biāo)志子類繼承這個(gè)方法時(shí)需要調(diào)用 super
,否則給出編譯警告:
@interface Father : NSObject
- (void)hailHydra __attribute__((objc_requires_super));
@end
@implementation Father
- (void)hailHydra {
NSLog(@"hail hydra!");
}
@end
@interface Son : Father
@end
@implementation Son
- (void)hailHydra {
} // <--- Warning missing [super hailHydra]
@end
objc_boxable
Objective-C 中的 @(...)
語(yǔ)法糖可以將基本數(shù)據(jù)類型 box 成 NSNumber
對(duì)象转砖,假如想 box 一個(gè) struct
類型或是 union
類型成 NSValue
對(duì)象须鼎,可以使用這個(gè)屬性:
typedef struct __attribute__((objc_boxable)) {
CGFloat x, y, width, height;
} XXRect;
這樣一來(lái),XXRect
就具備被 box 的能力:
CGRect rect1 = {1, 2, 3, 4};
NSValue *value1 = @(rect1); // <--- Compile Error
XXRect rect2 = {1, 2, 3, 4};
NSValue *value2 = @(rect2); // √
constructor / destructor
顧名思義,構(gòu)造器和析構(gòu)器晋控,加上這兩個(gè)屬性的函數(shù)會(huì)在分別在可執(zhí)行文件(或 shared library)load 和 unload 時(shí)被調(diào)用汞窗,可以理解為在 main()
函數(shù)調(diào)用前和 return 后執(zhí)行:
__attribute__((constructor))
static void beforeMain(void) {
NSLog(@"beforeMain");
}
__attribute__((destructor))
static void afterMain(void) {
NSLog(@"afterMain");
}
int main(int argc, const char * argv[]) {
NSLog(@"main");
return 0;
}
// Console:
// "beforeMain" -> "main" -> "afterMain"
constructor 和 +load
都是在 main 函數(shù)執(zhí)行前調(diào)用,但 +load
比 constructor 更加早一丟丟赡译,因?yàn)?dyld(動(dòng)態(tài)鏈接器仲吏,程序的最初起點(diǎn))在加載 image(可以理解成 Mach-O 文件)時(shí)會(huì)先通知 objc runtime
去加載其中所有的類,每加載一個(gè)類時(shí)捶朵,它的 +load
隨之調(diào)用蜘矢,全部加載完成后,dyld 才會(huì)調(diào)用這個(gè) image 中所有的 constructor 方法综看。
所以 constructor 是一個(gè)干壞事的絕佳時(shí)機(jī):
- 所有 Class 都已經(jīng)加載完成
- main 函數(shù)還未執(zhí)行
- 無(wú)需像 +load 還得掛載在一個(gè) Class 中
FDStackView
的 FDStackViewPatchEntry 方法便是使用的這個(gè)時(shí)機(jī)來(lái)實(shí)現(xiàn)偷天換日的伎倆品腹。
PS:若有多個(gè) constructor 且想控制優(yōu)先級(jí)的話,可以寫成
__attribute__((constructor(101)))
红碑,里面的數(shù)字越小優(yōu)先級(jí)越高舞吭,1 ~ 100 為系統(tǒng)保留。
enable_if
這個(gè)屬性只能用在 C 函數(shù)上析珊,可以用來(lái)實(shí)現(xiàn)參數(shù)的靜態(tài)檢查:
static void printValidAge(int age)
__attribute__((enable_if(age > 0 && age < 120, "你丫火星人羡鸥?"))) {
printf("%d", age);
}
它表示調(diào)用這個(gè)函數(shù)時(shí)必須滿足 age > 0 && age < 120
才被允許,于是乎:
printValidAge(26); // √
printValidAge(150); // <--- Compile Error
printValidAge(-1); // <--- Compile Error
cleanup
聲明到一個(gè)變量上忠寻,當(dāng)這個(gè)變量作用域結(jié)束時(shí)惧浴,調(diào)用指定的一個(gè)函數(shù),Reactive Cocoa 用這個(gè)特性實(shí)現(xiàn)了神奇的 @onExit
奕剃,關(guān)于這個(gè) attribute衷旅,在之前的文章中有介紹,傳送門纵朋。
overloadable
用于 C 函數(shù)柿顶,可以定義若干個(gè)函數(shù)名相同,但參數(shù)不同的方法操软,調(diào)用時(shí)編譯器會(huì)自動(dòng)根據(jù)參數(shù)選擇函數(shù)原型:
__attribute__((overloadable)) void logAnything(id obj) {
NSLog(@"%@", obj);
}
__attribute__((overloadable)) void logAnything(int number) {
NSLog(@"%@", @(number));
}
__attribute__((overloadable)) void logAnything(CGRect rect) {
NSLog(@"%@", NSStringFromCGRect(rect));
}
// Tests
logAnything(@[@"1", @"2"]);
logAnything(233);
logAnything(CGRectMake(1, 2, 3, 4));
objc_runtime_name
用于 @interface
或 @protocol
嘁锯,將類或協(xié)議的名字在編譯時(shí)指定成另一個(gè):
__attribute__((objc_runtime_name("SarkGay")))
@interface Sark : NSObject
@end
NSLog(@"%@", NSStringFromClass([Sark class])); // "SarkGay"
所有直接使用這個(gè)類名的地方都會(huì)被替換(唯一要注意的是這時(shí)用反射就不對(duì)了),最簡(jiǎn)單粗暴的用處就是去做個(gè)類名混淆:
__attribute__((objc_runtime_name("40ea43d7629d01e4b8d6289a132482d0dd5df4fa")))
@interface SecretClass : NSObject
@end
還能用數(shù)字開頭聂薪,怕不怕 - -家乘,假如寫個(gè)腳本把每個(gè)類前加個(gè)隨機(jī)生成的 objc_runtime_name
,豈不是最最精簡(jiǎn)版的代碼混淆就完成了呢…
它是我所了解的唯一一個(gè)對(duì) objc 運(yùn)行時(shí)類結(jié)構(gòu)有影響的 attribute藏澳,通過編碼類名可以在編譯時(shí)注入一些信息仁锯,被帶到運(yùn)行時(shí)之后,再反解出來(lái)笆载,這就相當(dāng)于開設(shè)了一條秘密通道扑馁,打通了寫碼時(shí)和運(yùn)行時(shí)。腦洞一下凉驻,假如把這個(gè) attribute 定義成宏腻要,以 annotation
的形式完成某些功能,比如:
// @singleton 包裹了 __attribute__((objc_runtime_name(...)))
// 將類名改名成 "SINGLETON_Sark_sharedInstance"
@singleton(Sark, sharedInstance)
@interface Sark : NSObject
+ (instancetype)sharedInstance;
@end
在運(yùn)行時(shí)用 __attribute__((constructor))
獲取入口時(shí)機(jī)涝登,用 runtime 找到這個(gè)類雄家,反解出 “sharedInstance” 這個(gè) selector 信息,動(dòng)態(tài)將 + alloc
胀滚,- init
等方法替換趟济,返回 + sharedInstance
單例。
References
http://llvm.org/releases/3.8.0/tools/clang/docs/AttributeReference.html
http://clang-analyzer.llvm.org/annotations.html