Clang Attributes 是 Clang 提供的一種源碼注解,方便開發者向編譯器表達某種要求,參與控制如 Static Analyzer、Name Mangling、Code Generation 等過程,一般以 __attribute__(xxx) 的形式出現在代碼中;為方便使用,一些常用屬性也被 Cocoa 定義成宏,比如在系統頭文件中經常出現的 NS_CLASS_AVAILABLE_IOS(9_0) 就是 __attribute__(availability(...)) 這個屬性的簡單寫法。
常見屬性的介紹,可以看 NSHipster 的介紹文章 和的 twitter 的介紹文章。本文還會介紹幾個有意思的 “黑魔法” Attribute,說不定在某些場景下會起到意想不到的效果哦~
以下測試都以 Xcode 7.3 ( Clang 3.8 ) 為准
objc_subclassing_restricted
使用這個屬性可以定義一個 Final Class,也就是說,一個不可被繼承的類,假設我們有個名叫 Eunuch(太監) 的類,但並不希望有人可以繼承自它:
@interface Eunuch : NSObject @end @interface Child : Eunuch // 太監不能夠有孩砸 @end
只要在 @interface 前面加上 objc_subclassing_restricted 這個屬性即可:
__attribute__((objc_subclassing_restricted)) @interface Eunuch : NSObject @end @interface Child : Eunuch // <--- Compile Error @end
objc_requires_super
aka: 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
objc_boxable
Objective-C 中的 @(...) 語法糖可以將基本數據類型 box 成 NSNumber 對象,假如想 box 一個 struct 類型或是 union 類型成 NSValue 對象,可以使用這個屬性:
typedef struct __attribute__((objc_boxable)) { CGFloat x, y, width, height; } XXRect;
這樣一來,XXRect 就具備被 box 的能力:
CGRect rect1 = {1, 2, 3, 4}; NSValue *value1 = @(rect1); // <--- Compile Error XXRect rect2 = {1, 2, 3, 4}; NSValue *value2 = @(rect2); // √
constructor / destructor
顧名思義,構造器和析構器,加上這兩個屬性的函數會在分別在可執行文件(或 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 比 constructor 更加早一丟丟,因為 dyld(動態鏈接器,程序的最初起點)在加載 image(可以理解成 Mach-O 文件)時會先通知 objc runtime 去加載其中所有的類,每加載一個類時,它的 +load 隨之調用,全部加載完成後,dyld 才會調用這個 image 中所有的 constructor 方法。
所以 constructor 是一個干壞事的絕佳時機:
所有 Class 都已經加載完成
main 函數還未執行
無需像 +load 還得掛載在一個 Class 中
FDStackView 的 FDStackViewPatchEntry 方法便是使用的這個時機來實現偷天換日的伎倆。
PS:若有多個 constructor 且想控制優先級的話,可以寫成 __attribute__((constructor(101))),裡面的數字越小優先級越高,1 ~ 100 為系統保留。
enable_if
這個屬性只能用在 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
cleanup
聲明到一個變量上,當這個變量作用域結束時,調用指定的一個函數,Reactive Cocoa 用這個特性實現了神奇的 @onExit,關於這個 attribute,在之前的文章中有介紹,傳送門。
overloadable
用於 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));
objc_runtime_name
用於 @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,豈不是最最精簡版的代碼混淆就完成了呢…
它是我所了解的唯一一個對 objc 運行時類結構有影響的 attribute,通過編碼類名可以在編譯時注入一些信息,被帶到運行時之後,再反解出來,這就相當於開設了一條秘密通道,打通了寫碼時和運行時。腦洞一下,假如把這個 attribute 定義成宏,以 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 等方法替換,返回 + sharedInstance 單例。
References
http://llvm.org/releases/3.8.0/tools/clang/docs/AttributeReference.html
http://clang-analyzer.llvm.org/annotations.html