Xcode 提供了建立 App 所需的一切,但因為它並未開源、也沒有官方的插件開發文件,當我們想加入自己的巧思時就顯得缺乏彈性。所幸我們仍能透過一些非官方途徑擴充 Xcode,並把成果分享出去。
可能性非常多。例如自動產生程式碼註解(VVDocumenter)、在編輯器中直接預覽 UIColor 的實際色彩(ColorSense-for-Xcode)、直接顯示 UIImage 圖檔(KSImageNamed-Xcode),甚至調整控制台配色、修改程式碼風格等等。
此外還可以用 Alcatraz 來管理插件,非常方便。
所有 Xcode 插件都放在這個目錄下:
~/Library/Application Support/Developer/Shared/Xcode/Plug-ins
並以 .xcplugin 作為副檔名。
準備工作
~/Library/Developer/Xcode/Templates/Project Templates/Application Plug-in/Xcode5 Plugin.xctemplate,若缺少對應目錄就自行建立。
開始開發
用這個模板建立專案後,會發現它已經幫你產生了不少程式碼。先看你專案同名檔案的 initWithBundle 方法:模板在 Edit 選單中加了一個 Do Action 的項目,點擊後會回呼 doMenuAction。
直接執行專案,你會看到一個新的 Xcode 被啟動——畢竟我們做的是 Xcode 插件,用 Xcode 來開發 Xcode 的程式碼,本身就挺有意思。試著點一下新 Xcode 的 Edit 選單裡的 Do Action,並在回呼方法上打中斷點,看看是否真的進入。
你很可能會發現回呼根本沒被觸發。原因是你的插件不認識目前這個 Xcode 版本,只要把版本資訊告訴它就行了。
defaults read /Applications/Xcode.app/Contents/Info DVTPlugInCompatibilityUUID,會回傳一串字串,那就是你目前 Xcode 的 UUID,把它補進 DVTPlugInCompatibilityUUIDs。由於 Apple 至今未公開 Xcode 插件文件,我們得換個思路摸索——例如監聽操作 Xcode 時它發出的各種通知。
[[NSNotificationCenter defaultCenter] addObserver:self selector:@selector(notificationLog:) name:nil object:nil];
- (void)notificationLog:(NSNotification *)notify {
NSLog(@"%@", notify.name);
}
把這兩段加進初始化流程,執行後你會看到 Xcode 的通知如雪片般飛來,這些都是理解 Xcode 行為的線索。
需求
在 Xcode 的檔案導航區,若想得知某檔案在 Finder 中的位置,得在檔案上按右鍵再選 Show in Finder,而這個項目還沒有快捷鍵。若能一鍵完成,效率會好很多。
思路
程式碼
第一步,攔截通知並保存路徑。從先前監听到的通知清單中,可以發現名為 transition from one file to another 的通知,正是我們要的:
- (void)notificationLog:(NSNotification *)notify {
if ([notify.name isEqualToString:@"transition from one file to another"]) {
NSURL *originURL = [[notify.object valueForKey:@"next"] valueForKey:@"documentURL"];
if (originURL != nil && [originURL absoluteString].length >= 7) {
self.url = [originURL.absoluteString substringFromIndex:7];
}
}
}
這裡之所以要 substringFromIndex:7,是因為取到的 URL 形如 file:///User...,而我們需要的是 /User... 的格式。
第二步,建立選單項並綁快捷鍵。改寫模板產生的那幾行即可:
NSMenuItem *menuItem = [[NSApp mainMenu] itemWithTitle:@"Edit"];
if (menuItem) {
[[menuItem submenu] addItem:[NSMenuItem separatorItem]];
NSMenuItem *actionMenuItem = [[NSMenuItem alloc] initWithTitle:@"Do action" action:@selector(doMenuAction) keyEquivalent:@"F"];
[actionMenuItem setKeyEquivalentModifierMask:NSShiftKeyMask];
[actionMenuItem setTarget:self];
[[menuItem submenu] addItem:actionMenuItem];
}
關鍵在最後幾行:keyEquivalent 設為 F,修飾鍵設為 Shift,於是快捷鍵就是 Shift + F,你可以依喜好調整。
第三步,按下快捷鍵時定位檔案:
- (void)doMenuAction {
self.url = [self.url stringByURLDecodingStringParameter];
[[NSWorkspace sharedWorkspace] selectFile:self.url inFileViewerRootedAtPath:nil];
}
把第一步保存的 URL 傳進去即可,但要記得做一次 URL 解碼,因為 Xcode 給我們的是編碼過的字串。
Xcode 插件開發並不新鮮,因此已有不少開發者 dump 出了 Xcode 的私有 API,可以依需要放進自己的專案。
操作專案檔案:XcodeEditor 提供了一組強大的專案檔操作 API,例如讀取 header、列出 frameworks、加入類別等。要對專案檔做處理時別忘了它。
NSTask:功能等同在終端機執行命令,非常實用。
Cocoa:注意是 Cocoa 而不是 Cocoa Touch,因為 Xcode 是跑在 macOS 上的 App,寫插件時會大量用到 Cocoa API,需要具備 Cocoa 開發基礎。