原文:How To Create an Xcode Plugin: Part 1/3
原作者:Derek Selander
譯者:@yohunl
譯者注:原文使用的是xcode6.3.2,我翻譯的時候,使用的是xcode7.2.1,經過驗證,文章中說說的依然是有效的。在文中你可以學習到一系列的技能,非常值得一看。
蘋果的"一個足以應付所有"策略使得它的產品越來越像一個難以下咽的藥丸。盡管蘋果已經將一些工作流帶給了iOS/OS X的開發者,我們仍然希望通過插件來使得Xcode更加順手!
雖然蘋果並沒有提供任何的官方文檔來指導我們如何創建一個xcode插件,但是開發者社區做了大量的工作開發了一些非常有用的工具,通過這些工具,可以用來幫助開發者。
從 自動完成圖片名的插件,到 清除緩存的插件 再到 使Xcode變成一個vim編輯器的插件,Xcode的插件社區已經拓展了我們的思維,我們可以讓Xcode變得更加智能。
在這個不算短的三部分教程中,你將創建一個Xcode的插件來娛樂你的同事,其特色莫過於顯示的內容並不是他所期望看到的!盡管這個插件是很輕量級的,你仍然可以學習到很多知識,例如,通過調試Xcode,怎樣找出你感興趣的元素並且修改它,怎樣將系統的功能函數替換為你自己的函數(通過swizzle技術)!
你將會使用 x86匯編知識,代碼定技能以及LLDB調試技能來查閱未公開的私有framework,並且要探索這些私有framework中的私有API,還要使用 method swizzleing來進行代碼的注入。正因為有這麼多內容,所以本教程的講解速度會很快。在繼續之前,請務必確定你已經掌握了相關的 iOS/OS X的開發。
使用Swift來開發插件,還是一個比較復雜的主題,並且Swift的調試工具依然比Objective-C要弱很多。就目前而言,這意味著插件開發的最佳選擇(本教程!)是Objective-C.
開始
為了慶祝 惡作劇你的同事日,你的Xcode插件將會Rayroll你的受害者。等等… 什麼是Rayrolling?它是一個免費和無版權的Rayrolling瑞克搖擺-就是你看到的內容並不是你期望的內容,有點掛羊頭賣狗肉的意思。當你完成了這個系列,你的插件將會更改Xcode顯示的內容:
用Ray's的頭像來替換Xcode的某些警示框(例如, Build成功或者失敗的Xcode提示框)
替換Xcode的標題內容為Ray的熱門歌曲的一句歌詞,Never Gonna Live You Up
替換所有的Xcode中的搜索文檔內容為一個視頻 Rayroll'd video
在教程的第一部分,我們將聚焦於尋找到負責展示"Build成功"警示框的那個類,並且將其圖片改為Ray的頭像這張圖片
安裝插件管理插件 Alcatraz
在開始之前,需要先安裝Alcatraz,它是Xcode插件管理工具。
典型的安裝Alcatraz的方式是通過命令行
curl -fsSL https://raw.github.com/supermarin/Alcatraz/master/Scripts/install.sh | sh
當這條命令結束後,重啟Xcode。你可能會看到一個提示 Alcatraz bundle的警示框;點擊 Load Bundle 繼續,以便xcode能夠加載Alcatraz插件,這樣這個Alcatraz插件才能起作用
注意:如果你一不小心點擊了"skip bundle",你可以通過命令行輸入以下命令來重新顯示它!
defaults delete com.apple.dt.Xcode DVTPlugInManagerNonApplePlugIns-Xcode-7.2.1
以上的Xcode 7.2.1是你機子上的Xcode版本號,如果你的不是7.2.1,改為你的對應的版本號就可以了。
你將會在Xcode的Window菜單下看到一個新的菜單項:Package Manager。創建一個xcode插件,需要你通過設置Build Settings來運行另一個新的Xcode的實例來加載才可以,這是一個枯燥和乏味的過程(如果想知道這個枯燥的過程,可以參考我的文章Xcode7 插件制作入門),幸好,已經有人替你完成了這件事情了,有人開發了一個Xcode的工程模板,可以讓你很方便的創建一個插件工程。
打開Alcatraz(Window->Package Manager)。在Alcatraz的搜索框中輸入Xcode Plugin。務必確保你選中了搜索框中的All和Templates兩個屬性。一旦你搜索到,單擊其左邊的Install來安裝它!!
如果你搜索不到,也沒關系,你可以前往 https://github.com/kattrali/Xcode-Plugin-Template自己下載下來的方式來加載它,具體安裝方式可以見工程的說明。
一旦Alcatraz下載完了Xcode Plugin插件,你就可以創建一個插件工程了(File->New -> Project…),選擇這個新的OS X ->Xcode Plugin ->Xcode Plugin模板,然後點擊下一步。
給工程取名字Rayrolling,組織的標識符為com。raywenderlich(這一步非常重要),選擇Objective-C作為代碼語言。。保存工程到任何一個你想放置的目錄中。
Hello World插件模板
編譯,然後運行這個Rayroll工程,你將會看到一個新的Xcode實例出現。這個Xcode實例在Edit菜單欄下多了一個菜單項Do Action:
選擇這個菜單項,將會出現一個模態的彈出框:
從Xcode5開始,插件都只能運行在特定版本的Xcode中。這也就意味著當新的Xcode更新安裝後,所有的第三方插件都將失效,除非你添加了該版本Xcode的UUID。如果部分模板沒有起作用,你也沒看到一個新的菜單項,可能的原因之一就是因為沒有對應版本的UUID,你需要添加對應該版本Xcode的支持。
為了添加UUID,首先是在命令行中運行以下命令
defaults read /Applications/Xcode.app/Contents/Info DVTPlugInCompatibilityUUID
這條命令會輸出當前版本xcode的UUID。打開Rayroll工程的Info.plist文件。導航到DVTPlugInCompatibilityUUID,添加它
注意:通過本教程,你會運行和修改已經安裝了的插件。這將會改變Xcode的默認行為,當然,這也可能會導致Xcode crash!!如果你想禁止某個插件,你可以手動的通過終端去刪除它.
cd ~/Library/Application\ Support/Developer/Shared/Xcode/Plug-ins/ rm -r Rayrolling.xcplugin/
然後重啟一下Xcode
找到我們要修改的xcode的某項特性
最直接最有效的得到幕布後發生什麼的方式是 通過注冊一個NSNotification observer 來監聽所有的Xcode事件。通過Xcode和監聽這些消息通知,你將會深入到一些內部類的內部。
打開Rayrollling.m,在類中添加如下的屬性
@property (nonatomic,strong) NSMutableSet *notificationSet;
這個NSMutableSet用來存儲所有的Xcode的控制台打印出來的NSNotification的名字
下一步,在initWithBundle:中,if (self = [super init]) {之後,添加如下代碼
[[NSNotificationCenter defaultCenter] addObserver:self selector:@selector(handleNotification:) name:nil object:nil]; self.notificationSet = [NSMutableSet new];
給name參數傳遞nil指示,偶們需要監聽xcode的所有NSNotification。
現在,實現handleNotification:方法:
- (void)handleNotification:(NSNotification *)notification { if (![self.notificationSet containsObject:notification.name]) { NSLog(@"%@, %@", notification.name, [notification.object class]); [self.notificationSet addObject:notification.name]; } }
handleNotification:檢查獲取到的通知名稱是不是在notificationSet中,如果不是,則在控制台打印出它的通知名和通知多對應的類。然後添加到notificationSet中。通過這種方式,你只會在控制台看到每一種類型的通知一次
下一步,找到添加menu item的聲明,將其替換成下面的代碼
NSMenuItem *actionMenuItem = [[NSMenuItem alloc] initWithTitle:@"Reset Logger" action:@selector(doMenuAction) keyEquivalent:@""];
這段代碼只是簡單的更改了NSMenuItem的標題,以便讓你知道,當你點擊它的時候,它將會重置存放NSNotification 的set對象。
最後,替換doMenuAction的實現代碼為下面的
- (void)doMenuAction { [self.notificationSet removeAllObjects]; }
這個菜單項將會重置所有存放在notificationSet屬性中的通知。這樣做的目的是讓你在控制台中很容易的觀察到你感興趣的通知,而不至於被控制台的重復消息所刷屏。讓你更加專注。
再一次編譯運行,請確認你分清了哪個是你工程的Xcode(也就是父Xcode),哪個是你debug出來的一個Xcode實例(子Xcode),為什麼要分清楚呢?因為我們的每一次改變,當重新debug的時候,debug出來的Xcode中已經起作用了,而父Xcode,只有等到你重啟後,才能看到效果的。
在子Xcode中,隨便點擊點擊按鈕,打開一些窗口,浏覽浏覽程序,你會在父xcode的控制台中看到消息的觸發。
查找和監測編譯的提示框
現在,你已經學會了基本的查看由Xcode本身引起的通知(NSNotification),現在你需要明確的找出來顯示編譯狀態的提示框所關聯的類是哪一個。
運行Xcode插件,在子Xcode中,打開任何一個工程,確保打開了Xcode設置中的bezel notifications,Succeeds和Fails中的bezel notifications都要打開。當然了,請再次確定你操作的是子Xcode實例!
通過你在Xcode的edit菜單中創建的 菜單項Reset Logger來重置notificationSet,然後運行你的子code(上面讓你在子Xcode中打開了任何一個工程,現在你在子Xcode中運行這個打開的工程)
當子Xcode的工程編譯結果出來後(或者成功,或者失敗都沒關系),關注父Xcode中控制台輸出的信息。粗略的浏覽一遍,看是否有能引起你關注的通知。你能夠發現一些值得你進一步關注的notifications麼?下面的這些可能能給你一些幫助(原文中,以下的列表是隱藏的,你可以點擊展示它,作者鼓勵大家自己先找找看,如果找不到,再打開下面的這個提示,由於我使用的markdown編輯器的限制,做不到這點,所以此處直接放出來了)
下面的一些項值得你進一步關注:
NSWindowWillOrderOffScreenNotification, DVTBezelAlertPanel
NSWindowDidOrderOffScreenNotification, DVTBezelAlertPanel
NSWindowDidOrderOffScreenAndFinishAnimatingNotification, DVTBezelAlertPanel
你應該挑其中一個,並進一步探索它,看看是不是可以從中得到一些重要的信息。例如 NSWindowWillOrderOffScreenNotification是干什麼的? 很好,你選擇了進一步探索NSWindowWillOrderOffScreenNotification。
回到父Xcode中的Rayrolled.m文件,定位到handleNotification:方法,添加一個斷點到方法中的第一行,並且按照如下來設置這個斷點:
鼠標停在這個斷點,右擊這個斷點,選擇 Edit Breakpoint
在彈出的斷點編輯框中的condition輸入框中,添加[notification.name isEqualToString:@"NSWindowWillOrderOffScreenNotification"]
在Action部分,添加 po notification.object
如果父xcode已經處在運行狀態了,重新讓它運行debug,然後在生成的子xcode中,再編譯運行一個工程。父xcode中的斷點應該會停在NSWindowWillOrderOffScreenNotification通知。觀察控制台輸出的-[notification object]的值DVTBezelAlertPanel,這也是第一個值得你深入關注的諸多私有類中的一員
你現在知道了有一個類的名字叫DVTBezelAlertPanel,更重要的是,你知道內存中有一個這個類的實例。不過不幸的是,你找到不到任何關於這個類的頭文件能夠告訴你,這個類是否就是展示Xcode的警示框的。
實際上,還是可以獲取到這些信息的。盡管我們沒有關於這個類的頭文件,可是你有一個調試器連接到子Xcode,內存中的信息照樣可以告訴你關於這個類的相關信息,就如同你閱讀其頭文件一樣。
注意:在這個系列的教程中,LLDB的輸出通常是伴隨在標准的控制台輸出中的。任何以(lldb)打頭的行,可以認為是輸入行,在此處你可以輸入一些命令。三個點…輸出在控制台,表示控制台來打印不及,忽略了其中某些。如果在控制台顯示了太多的打印日志,可以直接按 ? + K來清楚當前的輸出,並且重新接受輸出
確保你父Xcode是調試狀態的,程序停在斷點處,輸入以下的lldb命令道父Xcode的lldb控制台:
(lldb) image lookup -rn DVTBezelAlertPanel 17 matches found in /Applications/Xcode.app/Contents/SharedFrameworks/DVTKit.framework/Versions/A/DVTKit: ...(這裡的...是表示省略了上面那句命令的輸出內容,因為實在太多了)
這句命令搜索任何的加載到xcode進程中的frameworks,libraries,plugins,查找名為DVTBezelAlertPanel的類的相關信息,然後輸出查找到的信息。觀察搜索結果列出的方法。你是否已經能夠找到一些方法可以用來關聯DVTBezelAlertPanel類和子Xocde中出現的編譯成功/失敗的警示框?下面我提供了一些方法的列表,這些可以幫助到你。(原文中,以下的列表是隱藏的,你可以點擊展示它,作者鼓勵大家自己先找找看,如果找不到,再打開下面的這個提示,由於我使用的Markdown編輯器的限制,做不到這點,所以此處直接放出來了).
有幫助的方法
以下列出的DVTBezelAlertPanel類的方法,值得你進一步探索:
initWithIcon:message:parentWindow:duration
initWithIcon:message:controlView:duration:
controlView
以上的兩個初始話方法中的任何一個,基本上就可以幫助你驗證是否關聯了類DVTBezelAlertPanel和出現的提示框中的內容了
注意:LLDB的image lookup命令只列出在內存中實現了的方法。當你使用這個查找某些類時候,它並不包含那些繼承於父類,但是子類並沒有重載的方法,也就是說它只列出自己實現了的方法。
確保依然停留在父Xcode的斷點出,在父類的LLDB控制台中輸入以下命令來 檢測contentView
(lldb) po [notification.object controlView] [nil](此處尖括號替換為方括號) (這個是上句輸出的結果,yohunl注)
控制台輸出的是nil.(⊙o⊙)…,可能是因為這個contentView在這個時候還沒有被初始化吧。沒關系,我們嘗試下一個:initWithIcon:message:parentWindow:duration和initWithIcon:message:controlView:duration: ,因為你已經了解,內存中已經存在DVTBezelAlertPanel類的實例了,這意味著這兩個初始化方法,已經被調用過了。你需要給這兩個方法添加調試斷點,因為我們沒有它的實現文件,所以這裡我們用LLDB控制台來添加斷點。然後再次觸發這個類的初始化。
父Xcode依然停留在斷點出,輸入以下命令
(lldb) rb 'DVTBezelAlertPanel\ initWithIcon:message:' Breakpoint 1: 2 locations. (lldb) br l ...
yohunl備注:在xcode7.2.1中,顯示的是
(lldb) rb 'DVTBezelAlertPanel\ initWithIcon:message:' Breakpoint 2: 4 locations. (lldb) br l ........
這個正則表達式形式的斷點將會給上面的兩個初始化方法都添加一個斷點,這是因為兩個方法都有一個相同的起始字符,正則表達式將匹配它們兩個。別忘記上面正則表達式中空格前的\符號,還有就是用單引號'來包含整個表達式,這樣LLDB才知道怎麼解析它
切換到子Xcode,重新編譯子工程(ctrl+B)。父Xcode將會命中initWithIcon:message:parentWindow:duration斷點
如果沒有命中斷點,檢查一下,是不是將斷點設在父Xcode中(假如你設在子xcode中,當然不起作用呀),是不是在子Xcode中編譯了一個工程。,因為找不到相應的源碼文件,Xcode將會斷點在方法的匯編代碼中。
現在,你在沒有源代碼的情況下,斷點進入了一個方法。你需要一個方式來打印出傳遞給該方法的參數。是時候讓我們談一談。。匯編了…:]
匯編之旅
當你面對私有API的時候,你要做的往往是分析寄存器(registers ),而不是像在擁有源碼情況下的調試一樣使用調試符號(debug symbols )。了解寄存器(registers)在x86-64架構下的行為,將會給你提供很多的幫助.
盡管不是一篇必讀文章,這篇文章是一篇非常好的關於x86 Mach-0 匯編的文章。在本教程的第三部分,你將會通過方法的部分反匯編代碼去了解方法到底是做什麼的。不過現在,你需要的只是簡單的了解。
以下的寄存器和其是怎樣工作的,值得你關注:
$rdi:這個寄存器代表傳遞給方法的參數self,這也是第一個傳遞的參數。
$rsi:表示Selector,這是傳遞給的第二個參數
$rdx:傳遞給函數的第三個參數,也是我們看到的Objective-C的第一個參數(因為self和Selector是隱含的參數)
$rcx:傳遞給函數的第四個參數,也是我們看到的Objective-C的第2個參數(因為self和Selector是隱含的參數)
$r8:傳遞給函數的第五個參數。如果需要傳遞更多的參數,$r9將會作為跟隨之後的第6個參數的棧幀
$rax:函數的返回值存放在此寄存器中。例如,當我們執行完方法-[aClass description],$rax將會存放aClass對象的描述NSString。
注意:以上描述的不是絕對的。在某些二進制中,會使用不同的寄存器來存放不同類型的參數,例如:doubles使用$xmm寄存器組。上面的只是作為一個快速的參考!
下面我們采用以下的方法,來將上述的理論運用到實踐中來
@interface aClass : NSObject - (NSString *)aMethodWithMessage:(NSString *)message; @end @implementation aClass - (NSString *)aMethodWithMessage:(NSString *)message { return [NSString stringWithFormat:@"Hey the message is: %@", message]; } @end
使用如下的代碼來執行它:
aClass *aClassInstance = [[aClass alloc] init]; [aClassInstance aMethodWithMessage:@"Hello World"];
編譯後,對方法aMethodWithMessage的調用將會由Runtime層准換為對objc_msgSend的調用,基本上類似於如下:
objc_msgSend(aClassInstance, @selector(aMethodWithMessage:), @"Hello World")
aClass的方法aMethodWithMessage調用,會使得一些寄存機的內容被改變:
調用方法aMethodWithMessage前
$rdi: 存放aClass類型的一個實例變量
$rsi:存放SEL類型的aMethodWithMessage:,實際上它是一個chra * 類型的字符串(可以通過在lldb中 輸入 po (SEL)$rsi來驗證)
$rdx:包含傳遞給方法的message,此處,是一個字符串 @"Hello World"
當調用方法結束後
$rax:存放方法執行後的返回值,在此處是一個NSString。在這個特定的例子中,存放的是字符串@"Hey the message is: Hello World"
x86寄存器
通過以上的內容,你已經有了一份寄存器指南了,是時候重新審視DVTBezelAlertPanel的初始化方法initWithIcon:message:parentWindow:duration:了。希望你的父Xcode的斷點還停留在此方法處。當然,如果不是,也沒關系,重新運行子Xcode,再次停留在父類的斷點initWithIcon:message:parentWindow:duration:處。記住,你是在尋找將類DVTBezelAlertPanel和顯示Xcode的編譯成功/失敗提示框之間的線索。
當程序斷點在initWithIcon:message:parentWindow:duration處,在LLDB控制台輸入以下內容
(lldb) re re
這條命令是register read的縮寫,它是用來輸出當前你機器上可見的重要寄存器內容的命令。
運用你所學到的關於x86寄存器的知識,去查看哪個寄存器是用來存放message參數的和objc_msgSend方法的第四個參數。是否這個內容就是我們所希望得到的警示框的提示內容呢?(原文中,以下的列表是隱藏的,你可以點擊展示它,作者鼓勵大家自己先找找看,如果找不到,再打開下面的這個提示,由於我使用的markdown編輯器的限制,做不到這點,所以此處直接放出來了)
是的,你應該查看寄存器$rcx,你將會看到,它的內容就是message參數的內容,也就是顯示在xcode的編譯提示框中的提示信息
輸入以下命令來進一步深入了解:
(lldb) po $rcx Build Failed
注意:Xcode輸出寄存器內容是采用默認的AT&T匯編格式的,在這種格式中,源操作符和目標操作符的位置是交換過的,意思是AT&T語法第一個為源操作數,第二個為目的操作數,方向從左到右,這個同Intel的匯編格式是相反的。(譯者注:關於AT&T匯編,可以參考http://blog.csdn.net/bigloomy/article/details/6581754)
看起來這個就是我們要找的寄存器呀!
試著更改$rcx的內容為一個新的字符串,看看是不是警示框的內容改變了:
(lldb) po [$rcx class] __NSCFConstantString//我的xcode7.2.1上輸出顯示的是 __NSCFString (lldb) po id $a = @"Womp womp!"; (lldb) p/x $a (id) $a = 0x000061800203faa0 //yohunl備注,這裡是上一句p/x $a的輸出,在我的xcode7.2.1上,輸出的是(__NSCFString *) $a = 0x00006080026379c0 @"Womp womp!",在你的機子上輸出的地址也很可能是不一樣的,下一句中的地址要換成你機子上本處顯示的地址值 (lldb) re w $rcx 0x000061800203faa0 (lldb) c
應用程序將恢復運行。注意觀察顯示的編譯成功/失敗的提示框的內容是不是變成了我們修改的字符串。你將會看到,它的確是變成了我們設置的新字符串,這也驗證了我們的假定- DVTBezelAlertPanel就是用來顯示這個提示信息的。
代碼注入(Injection)
你已經找到了你所需要的類,是時候,我們通過代碼注入來擴展DVTBezelAlertPanel的行為,在編譯提示框中展示lovely Rayrolling(人名)的頭像。
我們采用的是 metthod swizzling技術。
你可能要swizzle來自很多不同的類的大量的方法,所以最佳建議是創建一個NSObject的category,在其中提供一個便捷的方法,來建立所有的swizzle邏輯。
在Xocde中,選擇File\New\File…,然後選擇 OS X\Source\Objective-C File,建立名稱為MethodSwizzler的文件,確保它的形式是NSObject的category。
打開NSObject+MethodSwizzler.m,將其替換成如下的代碼:
#import "NSObject+MethodSwizzler.h" // 1 #import @implementation NSObject (MethodSwizzler) + (void)swizzleWithOriginalSelector:(SEL)originalSelector swizzledSelector:(SEL) swizzledSelector isClassMethod:(BOOL)isClassMethod { Class cls = [self class]; Method originalMethod; Method swizzledMethod; // 2 if (isClassMethod) { originalMethod = class_getClassMethod(cls, originalSelector); swizzledMethod = class_getClassMethod(cls, swizzledSelector); } else { originalMethod = class_getInstanceMethod(cls, originalSelector); swizzledMethod = class_getInstanceMethod(cls, swizzledSelector); } // 3 if (!originalMethod) { NSLog(@"Error: originalMethod is nil, did you spell it incorrectly? %@", originalMethod); return; } // 4 method_exchangeImplementations(originalMethod, swizzledMethod); } @end
其中的關鍵代碼都加了序號,下面一一解釋:
這是使用method swizzle所需要的頭文件
isClassMethod指示,這個方法是實例方法還是類方法
如果不借助於編譯器的方法提示,那很容易拼錯上述的方法。這段代碼是用來檢查的,確保你的拼寫是正確的
這個是關鍵函數,用來交換方法的實現的
在頭文件NSObject+MethodSwizzler。h中添加方法swizzleWithOriginalSelector:swizzledSelector:isClassMethod的聲明,如下所示:
#import @interface NSObject (MethodSwizzler) + (void)swizzleWithOriginalSelector:(SEL)originalSelector swizzledSelector:(SEL) swizzledSelector isClassMethod:(BOOL)isClassMethod; @end
接下來,就可以完成實際的swizzle了。創建一個新的名為Rayrolling_DVTBezelAlertPanel的category,這個category同樣是NSObject的category。
替換創建的NSObject+Rayrolling_DVTBezelAlertPanel。m的代碼為如下代碼
#import // 2 @interface NSObject () // 3 - (id)initWithIcon:(id)arg1 message:(id)arg2 parentWindow:(id)arg3 duration:(double)arg4; @end // 4 @implementation NSObject (Rayrolling_DVTBezelAlertPanel) // 5 + (void)load { static dispatch_once_t onceToken; // 6 dispatch_once(&onceToken, ^{ // 7 [NSClassFromString(@"DVTBezelAlertPanel") swizzleWithOriginalSelector:@selector(initWithIcon:message:parentWindow:duration:) swizzledSelector:@selector(Rayrolling_initWithIcon:message:parentWindow:duration:) isClassMethod:NO]; }); } // 8 - (id)Rayrolling_initWithIcon:(id)icon message:(id)message parentWindow:(id)window duration:(double)duration { // 9 NSLog(@"Swizzle success! %@", self); // 10 return [self Rayrolling_initWithIcon:icon message:message parentWindow:window duration:duration]; } @end
上面的代碼比較簡單,我們來分析:
引入用來swizzling的頭文件
前向聲明所有你打算使用到的方法。雖然這不是必須的,但是這個使得編譯器能夠智能感知完成你的代碼,另外,這也消除了編譯器提示的找不到方法聲明的警告
這是你實際上需要swizzle的方法
因為我們不想重新聲明一個私有類,替代的方式是聲明一個category。
這個方法是觸發代碼注入的地方。你應該將代碼注入都放到load中。這個load是唯一的一個"一對多關系"的方法,也就是說,多個category都有load方法,那麼所有的category的load方法都能夠得到執行
因為load可能會被多次執行,所以,使用dispatch_once確保只執行一次
swizzle前面聲明的方法為你自己的實現。當然了,其中使用了NSClassFromString來動態的獲取內存中的類!
這是你寫的用來取代原來的方法的方法,建議是它采用獨特的命令方式,這樣從名字立馬知道它是做什麼的
輸出一下,確保swizzle成功了
因為你已經swizzle了原始的方法,那麼你調用swizzled後的方法(此處是[self Rayrolling_initWithIcon:icon message:message parentWindow:window duration:duration];),它將會調用的是原來的方法。這意味著你在原來的方法執行之前或者之後,添加任何你想要的代碼,甚至是更改傳遞給原始方法的參數…當然了,這裡你已經在這麼做了
祝賀你,你已經成功的注入代碼到一個私有類的私有方法中了!編譯父xcode,然後在子xcode中編譯運行一個工程,查看父xcode的控制台輸出,看是不是成功的wswizzled了。
Swizzle success! [DVTBezelAlertPanel: 0x11e42d300](由於識別問題,此處將尖括號替換為方括號)
接下來,你就可以替換編譯成功/失敗的提示框上的圖標為Rayrolling頭像啦。從這裡下載頭像資源Crispy from here,然後添加到工程中來,確保選擇了 Copy Items if Needed。
現在,導航到方法Rayrolling_initWithIcon:message:parentWindow:duration,將其代碼改為:
- (id)Rayrolling_initWithIcon:(id)arg1 message:(id)arg2 parentWindow:(id)arg3 duration:(double)arg4 { if (arg1) { NSBundle *bundle = [NSBundle bundleWithIdentifier:@"com.raywenderlich.Rayrolling"]; NSImage *newImage = [bundle imageForResource:@"IDEAlertBezel_Generic_Rayrolling.pdf"]; return [self Rayrolling_initWithIcon:newImage message:arg2 parentWindow:arg3 duration:arg4]; } return [self Rayrolling_initWithIcon:arg1 message:arg2 parentWindow:arg3 duration:arg4]; }
這個方法首先檢查是否一個圖片參數被傳遞給了原方法,然後將其替換成我們自定義的圖片。注意:此處你是使用[NSBundle bundleWithIdentifier:@"com。raywenderlich。Rayrolling"];來加載圖片的,這是因為xcode的MainBundle並不包含我們的資源。
重新編譯父Xcode,然後在子Xcode中編譯一個工程,你會看到
添加一個開關和持久化
設計這個plugin是用來娛樂用的,所以你肯定需要一個開關,讓它起作用或者不起作用。我們通過NSUserDefaults來持久化存放使它起作用或者不起作用的變量.
導航到Rayrolling.h ,添加如下代碼
+ (BOOL)isEnabled;
在Rayrolling.m文件中添加
+ (BOOL)isEnabled { return [[NSUserDefaults standardUserDefaults] boolForKey:@"com.raywenderlich.Rayrolling.shouldbeEnable"]; } + (void)setIsEnabled:(BOOL)shouldBeEnabled { [[NSUserDefaults standardUserDefaults] setBool:shouldBeEnabled forKey:@"com.raywenderlich.Rayrolling.shouldbeEnable"]; }
你已經有了持久化你的選擇的邏輯,下面是將它關聯到GUI上去
回到Rayrolling.m中,修改-(void)doMenuAction的代碼為下面的:
- (void)doMenuAction:(NSMenuItem *)menuItem { [Rayrolling setIsEnabled:![Rayrolling isEnabled]]; menuItem.title = [Rayrolling isEnabled] ? @"Disable Rayrolling" : @"Enable Rayrolling"; }
這是個用來切換的bool值,啟用或者禁用Rayrolling
最後,更改在didApplicationFinishLaunchingNotification:中的菜單項的初始化代碼,改為如下:
NSMenuItem *menuItem = [[NSApp mainMenu] itemWithTitle:@"Edit"]; if (menuItem) { [[menuItem submenu] addItem:[NSMenuItem separatorItem]]; NSString *title = [Rayrolling isEnabled] ? @"Disable Rayrolling" : @"Enable Rayrolling"; NSMenuItem *actionMenuItem = [[NSMenuItem alloc] initWithTitle:title action:@selector(doMenuAction:) keyEquivalent:@""]; [actionMenuItem setTarget:self]; [[menuItem submenu] addItem:actionMenuItem]; }
這個菜單項將會保留你選擇的是否啟用的邏輯,即使Xcode重啟後也沒關系,因為你的選擇已經持久化存儲了。
導航到文件NSObject+Rayrolling_DVTBezelAlertPanel.m,添加一行頭文件
#import "Rayrolling.h"
最後,打開方法Rayrolling_initWithIcon:message:parentWindow:duration:,將
if (arg1) {
替換為
if ([Rayrolling isEnabled] && arg1) {
構建並運行程序,以便更改插件的行為。
現在,你創建了一個可以用來改變xcode編譯成功/失敗提示框圖標和內容的插件,並且它還是能夠被選擇是否打開。這一天的工作成果相當不錯,難道不是嗎???
接下來做什麼?
你可以從這裡 下載完整的demo工程。
你已經取得了很大的進步,但是依然有很多事情要做!在本教程的第二部分,你將會學習到DTrace基本知識,並且深入到一些LLDB的高級特性,諸如查找正在運行的進程,比如正在運行的xcode進程。
如果你想更進一步,那麼在你前往教程3之前,你還有一些工作要做。在教程3中,你將會看到大量的匯編代碼。確保在這之前,你已經開始了解了相關的x86_64匯編知識,這裡有2篇Mike Ash的介紹分析匯編的系列文章 文章1,文章2,可以給你提供相關的幫助。