在 Cocos2d-x 專案裡接入新浪微博這類靜態庫時,照著官方文件加上 -ObjC 往往還是會崩潰,加上 -all_load 則可能導致整個專案連結失敗。正確答案其實是第三個選項。
-force_load path/to/your/libWeiboSDK.a
用 -force_load 直接指定靜態庫路徑,而不是文件裡寫的 -ObjC 或網路上流傳的 -all_load。
路徑怎麼寫?如果 XXX.a 被放在一個名為 aaa 的 group 下,路徑就是 aaa/xxx.a;也可以直接用絕對路徑——在 Xcode 中點選該靜態庫,右側欄就會顯示它的完整路徑,複製過來即可。
環境:Mac OS X 10.10.1、Xcode 6.1.1、Cocos2d-x 3.2、新浪微博 iOS SDK(2015 年 1 月從 GitHub clone 的版本)。
依官方文件接入專案後,在模擬器上執行,一呼叫註冊方法就崩潰:
[WeiboSDK registerApp:@"xxxxxxxx"];
// 崩潰訊息
[__NSDictionaryM weibosdk_WBSDKJSONString]: unrecognized selector sent to instance 0x170255780
官方文件寫的是:引入靜態庫後需要在 Build Settings → Linking → Other Linker Flags 加上 -ObjC,避免靜態庫中的類別載入不全造成崩潰。網上也有人說加 -all_load 也能解決。
有意思的是,打開新浪微博 SDK 附帶的 Demo 專案,它設定的選項是 -all_load,而不是自己文件裡寫的 -ObjC。而且在完全相同的開發環境下,我的 Cocos2d-x 專案會崩潰,官方 Demo 卻能正常執行——看起來這兩個方案應該是對的。
但加上之後重新編譯,卻換成了另一個錯誤:
Undefined symbols for architecture i386:
"_GCControllerDidConnectNotification", referenced from:
-[GCControllerConnectionEventHandler observerConnection:disconnection:]
in libcocos2dx iOS.a(CCController-iOS.o)
"_GCControllerDidDisconnectNotification", referenced from: ...
"_OBJC_CLASS_$_GCController", referenced from: objc-class-ref in ...
不論設成 -ObjC 還是 -all_load,都會收到這組找不到符號的連結錯誤。
一個工程的源代碼最終變成可執行檔、動態庫或靜態庫,會經歷:
源代碼 --[編譯器]--> 彙編碼 --[彙編器]--> 物件檔 --[連結器]--> 可執行檔 / 動態庫 / 靜態庫
所謂「符號」,通俗地講就是我們寫的全域變數名、函式名、類別名在 .o 檔中的呈現形式,它們被記錄在符號表裡。舉例來說,a.c 中定義了 foo(),main.c 中呼叫了它;編譯後 a.o 的符號表裡有 foo(),連結器發現 main.o 引用了這個符號但自己沒有定義,就會去別的 .o 中找,找到 a.o 後把它連結進來。
Unix 的靜態庫沒什麼神秘的,它就是個壓縮包,只是用 ar 這個工具壓的。要解開它:
ar -x libWeiboSDK.a
# ar: libWeiboSDK.a is a fat file (use libtool(1) or lipo(1) and ar(1) on it)
為什麼「胖」?因為模擬器是 i386 / x86_64 架構,真機是 armv7 / arm64 架構,做靜態庫時通常會分別編出兩個版本。為了使用方便,可以用 lipo 把它們合成一個:
lipo -create libXXX.i386_x86_64.a libXXX.armv7_arm64.a -output libXXX.a
這樣得到的通用靜態庫同時支援模擬器與真機,代價是檔案變大——也就是「胖」。驗證一下:
lipo -info libWeiboSDK.a
# Architectures in the fat file: libWeiboSDK.a are: armv7 arm64 i386 x86_64
要解壓就必須先瘦身,抽出一個架構:
lipo -thin i386 libWeiboSDK.a -output libWeiboSDK.i386.a
ar -x libWeiboSDK.i386.a
解完會看到一堆 .o 檔,例如 NSData+WBSDKBase64.o、WBSDKJSONKit.o 等。
把 SDK 引入專案並 Build 的過程,本質上也是一次編譯連結,對靜態庫的處理與上面拆包的步驟類似:依當前平台架構瘦身、解包、把用到的物件檔連結進來。問題就出在最後這一步。
Apple 對此有一段說明:
The dynamic nature of Objective-C complicates things slightly. Because the code that implements a method is not determined until the method is actually called...
Objective-C does not define linker symbols for methods. Linker symbols are only defined for classes.
For example, if main.m includes the code[[FooClass alloc] initWithBar:nil];then main.o will contain an undefined symbol for FooClass, but no linker symbols for the -initWithBar: method will be in main.o
換句話說:Objective-C 有 runtime,方法的實作在執行期才決定,所以連結器只處理類別符號,不處理方法符號。
回頭看崩潰訊息:__NSDictionaryM 是 Foundation 中的類別,而 weibosdk_WBSDKJSONString 是新浪自己加的方法——他們用分類(category)擴充了系統類別。用 nm 驗證:
nm *.o >> libWeiboSDK.symbols.txt
# 在輸出檔中搜尋 weibosdk_WBSDKJSONString
WBSDKJSONKit.o:
00007ba0 t -[NSArray(WBSDKJSONKitSerializing) weibosdk_WBSDKJSONString]
00007de8 t -[NSDictionary(WBSDKJSONKitSerializing) weibosdk_WBSDKJSONString]
000079cd t -[NSString(WBSDKJSONKitSerializing) weibosdk_WBSDKJSONString]
於是真相清楚了:
WBSDKJSONKit.o 引用了 NSArray、NSDictionary、NSString 這三個類別符號,於是從 Foundation 中找到了它們並連結進來。weibosdk_WBSDKJSONString 完全被忽略。WBSDKJSONKit.o 所需的類別符號都能在 Foundation 中找到,這個 .o 自己反而沒有被引用到,連結器就沒有把它包進最終執行檔。WBSDKJSONKit.o 又不在執行檔中,於是崩潰。Passing the -ObjC option to the linker causes it to load all members of static libraries that implement any Objective-C class or category. This will pickup any category method implementations. But it can make the resulting executable larger, and may pickup unnecessary objects. For this reason it is not on by default.
-ObjC 會讓連結器把靜態庫中所有「實作了 Objective-C 類別或分類」的物件檔全部載入,分類方法自然也被包了進來,崩潰就解決了。-all_load 更徹底,它會載入所有物件檔,不論有沒有被引用。兩者的代價都是執行檔變大。
準確地說是「編譯成功、連結失敗」。前面那串錯誤裡的 CCController-iOS.o 對應的源碼是 CCController-iOS.mm,其中定義了一個類別 GCControllerConnectionEventHandler,它的方法引用了 GCControllerDidConnectNotification 與 GCControllerDidDisconnectNotification,而這兩個符號定義在 GameController framework 中。
Cocos2d-x 產生的專案預設並沒有引入 GameController.framework,平時沒事是因為 CCController-iOS.o 沒有被連結進來;一旦用了 -all_load 或 -ObjC,這個物件檔被強制打包,找不到的符號就全部暴露出來了。
你當然可以去 Build Phases → Link Binary With Libraries 中補上 GameController.framework 解決它,但這麼做並不乾淨——你只是為了遷就一個過於粗暴的選項而連帶引入了一堆無關依賴。
-force_load path/to/your/libWeiboSDK.a
-force_load 做的事和 -ObjC、-all_load 本質相同,但它更有針對性:只強制載入你指定的那一支靜態庫,其他庫維持正常的按需連結行為。這樣既解決了分類方法被丟棄的問題,又不會把 Cocos2d-x 自己的物件檔一起拖下水,執行檔也不會無謂膨脹。
這也是個值得記住的通用經驗:第三方 SDK 崩潰在 unrecognized selector 時,先想想對方是不是用了分類;而連結選項能精準指定就別用大掃帚。