Clang Attributes 是 Clang 提供的一種源碼註解機制,讓開發者能把「要求」直接寫進程式碼裡,交給編譯器去執行,進而參與 Static Analyzer、Name Mangling、Code Generation 等環節。它通常以 __attribute__(xxx) 的形式出現。為了方便使用,Cocoa 把一些常用屬性包成了宏,例如系統標頭檔裡常見的 NS_CLASS_AVAILABLE_IOS(9_0),本質上就是 __attribute__(availability(...)) 的簡寫。
常見屬性在 NSHipster 與相關的 Twitter 串裡都有不錯的整理。本文想聊的是幾個更有意思、也更容易被忽略的「黑魔法」屬性——在某些場景下,它們能解決你原本以為只能靠 runtime hack 才能處理的問題。
以下測試環境為 Xcode 7.3(Clang 3.8)。
加上這個屬性,類別就不允許被繼承。假設有個類叫 Eunuch(太監),而我並不希望任何人繼承它:
@interface Eunuch : NSObject @end @interface Child : Eunuch // 太監不能有孩子 @end
只要在 @interface 前面加上屬性即可:
__attribute__((objc_subclassing_restricted)) @interface Eunuch : NSObject @end @interface Child : Eunuch // <--- Compile Error @end
別名 NS_REQUIRES_SUPER。標記在方法上之後,子類覆寫時若沒有呼叫 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
Objective-C 的 @(...) 可以把基本型別裝箱成 NSNumber。如果想把自訂的 struct 或 union 裝箱成 NSValue,就靠這個屬性:
typedef struct __attribute__((objc_boxable)) {
CGFloat x, y, width, height;
} XXRect;
於是我們自己的矩形結構也具備了被裝箱的能力:
CGRect rect1 = {1, 2, 3, 4};
NSValue *value1 = @(rect1); // <--- Compile Error
XXRect rect2 = {1, 2, 3, 4};
NSValue *value2 = @(rect2); // √
顧名思義,標上這兩個屬性的函式會分別在可執行檔(或 shared library)被 load 與 unload 時呼叫,可以理解為在 main() 執行前與 return 之後各跑一次:
__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 之前被呼叫,但 +load 更早一點點。原因是 dyld(動態連結器,程式最初的起點)在載入 image(可理解成 Mach-O 檔)時,會先通知 Objective-C runtime 去載入其中所有的類,每載入一個類就順手呼叫它的 +load;等到全部類都載入完成,dyld 才回頭呼叫這個 image 裡所有的 constructor 方法。
這個時序讓 constructor 成為「做壞事」的絕佳時機:
+load 那樣必須掛在某個 Class 上FDStackView 的 FDStackViewPatchEntry 就是抓準這個時間點,完成了偷天換日的操作。
補充:若有多個 constructor 且想控制優先順序,可以寫成 __attribute__((constructor(101))),數字越小優先級越高,其中 1 ~ 100 為系統保留。
這個屬性只能用在 C 函式上,可以用來實作參數的靜態檢查:
static void printValidAge(int age)
__attribute__((enable_if(age > 0 && age < 120, "你丫火星人?"))) {
printf("%d", age);
}
也就是說,只有在 age > 0 && age < 120 時才允許呼叫:
printValidAge(26); // √ printValidAge(150); // <--- Compile Error printValidAge(-1); // <--- Compile Error
標記在變數上,當該變數的作用域結束時,自動呼叫指定的函式。Reactive Cocoa 就靠這個特性實作出了神奇的 @onExit。
用於 C 函式,可以定義多個「名稱相同、參數不同」的版本,呼叫時編譯器會依傳入的型別自動挑選對應的原型:
__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));
用於 @interface 或 @protocol,把類別或協議在執行期的名字指定成另一個:
__attribute__((objc_runtime_name("SarkGay")))
@interface Sark : NSObject
@end
NSLog(@"%@", NSStringFromClass([Sark class])); // "SarkGay"
所有直接使用這個類名的地方都會被替換(唯一要注意的是,此時用反射取得名稱就對不上了)。最粗暴的用途就是做類名混淆:
__attribute__((objc_runtime_name("40ea43d7629d01e4b8d6289a132482d0dd5df4fa")))
@interface SecretClass : NSObject
@end
甚至可以拿數字開頭,是不是有點刺激?如果寫個腳本幫每個類前面加上隨機產生的 objc_runtime_name,最精簡版的程式碼混淆大概就完成了。
這是我目前知道的、唯一會直接影響 Objective-C 執行期類結構的屬性。透過編碼類名,等於在編譯期注入了一段資訊,帶到執行期之後再反解出來——這無異於開了一條秘密通道,把「寫程式碼的當下」和「程式跑起來之後」打通了。
腦洞一下:如果把它包成宏,以 annotation 的形式提供某種功能:
// @singleton 包裹了 __attribute__((objc_runtime_name(...))) // 將類名改名成 "SINGLETON_Sark_sharedInstance" @singleton(Sark, sharedInstance) @interface Sark : NSObject + (instancetype)sharedInstance; @end
接著在執行期用 __attribute__((constructor)) 取得入口時機,透過 runtime 找到這個類,反解出 sharedInstance 這個 selector 資訊,動態把 +alloc、-init 等方法換掉,直接回傳單例。聽起來離譜,但技術上完全可行。
https://llvm.org/releases/3.8.0/tools/clang/docs/AttributeReference.html
https://clang-analyzer.llvm.org/annotations.html