概述

我們平時也使用了很多的xcode插件,雖然官方對于插件制作沒有提供任何支持,但是加載三方的插件,默認還是被允許的.第三方的插件,需要存放在 ~/Library/Application Support/Developer/Shared/Xcode/Plug-ins文件夾中,后綴名必須是.xcplugin (不過其實際上是一種bundle).
所以我們創建一個插件工程,直接創建bundle工程即可,然后通過修改后綴名為.xcplugin,將其放到~/Library/Application Support/Developer/Shared/Xcode/Plug-ins目錄中就可以了

第一個demo插件功能:在xcode的edit菜單中加入一個叫做 測試菜單 的項目,當點擊的時候,彈出一個警告框,顯示一句話,完整的工程放在TestPluginBundle

詳細過程

創建Bundle工程 TestPluginBundle

工程名稱就是 TestPluginBundle

工程設置

插件工程和普通的bundle工程還是有區別的,所以需要進行特殊的設置

首先是工程的plist文件

添加 三項
XCPluginHasUI = NO
XC4Compatible = YES
DVTPlugInCompatibilityUUIDs 這是一個數組.數組內容字符串,指示了該插件兼容的xcode版本,只有對應版本的xcode的UIID加入這個數組了,插件才能被加載,否則,即使你將插件放入xcode的插件文件夾,插件也不會被加載的
那么怎么獲取你當前版本的xcode的UUID呢?在terminal中輸入 defaults read /Applications/Xcode.app/Contents/Info DVTPlugInCompatibilityUUID ，terminal會返回一串字符串給你，這就是你的Xcode的DVTPlugInCompatibilityUUID.

接下來是 Build Setting了

Installation Build Products Location 設置為 ${HOME} [顯示的時候,顯示的是你的用戶目錄],這個是products的根目錄

Installation Directory 設置為 /Library/Application Support/Developer/Shared/Xcode/Plug-ins,這個是指定你的插件安裝的目錄. 注意,這里填入的其實是相對目錄,插件的絕對目錄是這樣的,例如 /Users/yohunl/Library/Application\ Support/Developer/Shared/Xcode/Plug-ins/Alcatraz.xcplugin ,最后的絕對目錄是 Installation Build Products Location和Installation Directory的結合,這也是為什么兩者都要設置的原因

Deployment Location 設置為 YES,這個是指示該工程不使用設置里的build location，而是用Installation Directory來確定build后放哪兒

我們默認工程生成的相關文件放在哪.都是 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

ctrl+B來Build工程,查看路徑下/Library/Application Support/Developer/Shared/Xcode/Plug-ins,可以看到我們的插件TestPluginBundle.xcplugin存在了,接下來,重啟xcode

點擊 測試菜單

將Options下面的Core Location,XPC Services,View Debugging前面的勾都去掉,否則,你調試的時候,可能會直接crash

說了這么多,其實只是想讓你明白一個插件的初始化的配置,調試等

上面的過程,已經有國外大神制作成了一個 工程模板了,https://github.com/kattrali/Xcode-Plugin-Template 其支持OC和Swift,當你安裝它后,會在新建工程時候,看到 Xcode Plugin模板,使用這個模板創建一個新工程,以上的配置等,就都設置好了,直接運行就是一個demo了.

參考文章

1. 喵神的xcode4插件制作入門,文章中部分內容已經過期,不再適用,但主體是通用的,并且文章后面的后記也非常實用的干貨
2. Xcode 6 插件開發入門：添加自己的想法和功能