您现在的位置: IOS教程網 >> IOS系統 >  >> iOS 程式開發 >> iOS 開發基礎

Xcode7 插件開發入門:從零打造你的第一個擴展

編輯:iOS 開發基礎

概述

我們日常已經用到了不少 Xcode 插件。儘管官方並未為插件開發提供任何支持,但加載第三方插件在默認情況下仍是被允許的。這類插件需要放到 ~/Library/Application Support/Developer/Shared/Xcode/Plug-ins 目錄下,後綴名必須是 .xcplugin(本質上它其實是一個 bundle)。

因此,創建插件工程時直接新建一個 Bundle 工程即可,之後把後綴名改為 .xcplugin,再放進上述目錄就完成了。

本文的第一個示例插件功能是:在 Xcode 的 Edit 菜單裡加入一個名為「測試菜單」的選項,點擊後彈出一個警告框並顯示一句話。完整工程名為 TestPluginBundle。

詳細步驟

首先創建 Bundle 工程 TestPluginBundle。

工程名即為 TestPluginBundle。

工程設置

插件工程與普通 Bundle 工程有區別,需要進行幾項特殊配置。

先修改 Info.plist

需要添加三項配置:
XCPluginHasUI = NO
XC4Compatible = YES
DVTPlugInCompatibilityUUIDs —— 這是一個數組,其中的字符串標明了該插件所兼容的 Xcode 版本。只有把對應版本 Xcode 的 UUID 加入這個數組,插件才能被加載;否則即便你把插件放進插件目錄,它也不會生效。

那麼如何獲取當前 Xcode 的 UUID 呢?在終端輸入 defaults read /Applications/Xcode.app/Contents/Info DVTPlugInCompatibilityUUID,返回的那串字符串就是你的 Xcode DVTPlugInCompatibilityUUID。

接著配置 Build Settings

將 Installation Build Products Location 設為 ${HOME}(顯示時即為你的用戶目錄),它是產品的根目錄。

將 Installation Directory 設為 /Library/Application Support/Developer/Shared/Xcode/Plug-ins,用來指定插件的安裝位置。注意這裡填的是相對路徑,最終的絕對路徑是把兩者拼接起來的結果,例如 /Users/yohunl/Library/Application Support/Developer/Shared/Xcode/Plug-ins/Alcatraz.xcplugin。這也是為什麼兩項都要設置的原因。

將 Deployment Location 設為 YES,表示不使用默認的 build 位置,而是採用 Installation Directory 來決定構建產物的存放路徑。

默認情況下工程產物放在哪裡由 Build Locations 決定;把 Deployment Location 設為 YES,就是告訴工程我們要用自定義路徑而非默認值。

將 Wrapper extension 設為 xcplugin,後綴必須是 xcplugin,否則不會被加載。

實現插件邏輯

在工程中新建一個文件(名稱任意,此處用 TestPluginBundle),寫入以下代碼:

@implementation TestPluginBundle
+(void)pluginDidLoad:(NSBundle *)plugin {
    NSLog(@"插件運行了!");
    [TestPluginBundle sharedInstance];
}
- (instancetype)init {
    self = [super init];
    if (self) {
        [[NSNotificationCenter defaultCenter] addObserver:self
                                             selector:@selector(didApplicationFinishLaunchingNotification:)
                                                 name:NSApplicationDidFinishLaunchingNotification
                                               object:nil];
    }
    return self;
}
- (void)didApplicationFinishLaunchingNotification:(NSNotification*)noti {
    [[NSNotificationCenter defaultCenter] removeObserver:self
                                                    name:NSApplicationDidFinishLaunchingNotification
                                                  object:nil];
    NSMenuItem *menuItem = [[NSApp mainMenu] itemWithTitle:@"Edit"];
    if (menuItem) {
        [[menuItem submenu] addItem:[NSMenuItem separatorItem]];
        NSMenuItem *actionMenuItem = [[NSMenuItem alloc] initWithTitle:@"測試菜單"
                                                               action:@selector(doMenuAction)
                                                        keyEquivalent:@""];
        [actionMenuItem setTarget:self];
        [[menuItem submenu] addItem:actionMenuItem];
    }
}
- (void)doMenuAction {
    NSAlert *alert = [[NSAlert alloc] init];
    [alert setMessageText:@"測試菜單運行"];
    [alert runModal];
}
- (void)dealloc {
    [[NSNotificationCenter defaultCenter] removeObserver:self];
}
+(instancetype)sharedInstance {
    static id instance;
    static dispatch_once_t onceToken;
    dispatch_once(&onceToken, ^{
        instance = [[self alloc] init];
    });
    return instance;
}
@end

按 Cmd+B 構建工程,前往 /Library/Application Support/Developer/Shared/Xcode/Plug-ins 可以看到 TestPluginBundle.xcplugin 已經生成,接著重啟 Xcode。

點擊「測試菜單」。

你也許會問:這樣雖然生效了,難道開發插件就不能單步調試嗎?當然不是。編輯工程的 scheme,把 Executable 設為 Xcode.app,讓工程調試時掛載到 Xcode 進程中。

再把 Options 下的 Core Location、XPC Services、View Debugging 前的勾選去掉,否則調試時可能直接崩潰。

配置完成後,scheme 的圖標會從 bundle 圖標變成 Xcode 的圖標。

再次運行(注意是運行而非僅編譯),不出意外的話會啟動另一個 Xcode 實例,此後的調試體驗就和你平時調試普通工程別無二致了。

講了這麼多,核心就是想讓你理清插件初始化、配置與調試的完整流程。

好消息是,國外已有大神把上述過程做成了一個工程模板:Xcode-Plugin-Template,同時支持 OC 和 Swift。安裝後,新建工程時就會多出 Xcode Plugin 模板,用它創建新工程,以上配置全部就緒,直接運行就是一個可跑的 demo。

參考文章

  1. 喵神的 Xcode4 插件製作入門。文中部分內容雖已過時,但主體思路通用,結尾的後記也很有乾貨價值。

  2. Xcode 6 插件開發入門:添加自己的想法和功能。

  1. 上一篇文章:
  2. 下一篇文章:
蘋果刷機越獄教程| IOS教程問題解答| IOS技巧綜合| IOS7技巧| IOS8教程
Copyright © IOS教程網 All Rights Reserved