XCode 插件开发详解

今天想学习下插件开发，从网上查了半天好不容易把插件显示在了xcode的菜单栏上了，网上插件开发的资料太少了，大多数也不详细，因此，特此详细记录下插件开发的具体流程，希望有更多的人开发更好用的插件吧。

必备知识

• 插件路径 ~/Library/Application Support/Developer/Shared/Xcode/Plug-ins( 终端 open ~/Library/Application\ Support/Developer/Shared/Xcode/Plug-ins 可以打开这个路径)
• 文件名字的后缀.xcplugin，否则xcode不认识
• 获取当前xcode支持插件的UUID命令 defaults read /Applications/Xcode.app/Contents/Info DVTPlugInCompatibilityUUID

$ defaults read /Applications/Xcode.app/Contents/Info DVTPlugInCompatibilityUUID
EE23884D-A5C0-4163-94CF-DBBF3A5ED8D6

创建插件工程

其实插件工程是由bundle工程改建而来的，只不过我们需要给这个bundle工程做些修改就可以了。

1.创建bundle工程

点击bundle

生成工程

2.修改 info.plist

新增三条数据

• XCPluginHasUI 类型是boolean ,值是NO
• XC4Compatible 类型是boolean，值是YES

• DVTPlugInCompatibilityUUIDs 类型是Array,值可以是多个，这里是EE23884D-A5C0-4163-94CF-DBBF3A5ED8D6（因为我的xcode支持的这个uuid 是上面这个值）

  
  
  

  增加完毕的info.plist

3.修改build settings

这里我们主要配置下我们build的工程生成文件路径

Deployment Location

• Deployment Location 设置为 YES，这里是告诉编译器用我们指定的路径。

  
  
  

  Installation Build Products Location

• Installation Build Products Location 设置成${HOME},这就是你设置的路径的起始位置。

  
  
  

  Installation Directory

• Installation Directory 必须是/Library/Application Support/Developer/Shared/Xcode/Plug-ins,这是插件所在的位置（只要installation Build Products Location 的路径和Installation Directory的路径组合是 ${HOME}//Library/Application Support/Developer/Shared/Xcode/Plug-ins 即可）
  

  

  image.png

+Wrapper extension 设置为 xcplugin，后缀名必须为xcplugin，xcode 只加载后缀是xcplugin的文件

skip install

• skip install 必须设置为NO，这样我们build的时候就可以将插件直接写入到指定目录。

到此我们的插件工程创建完毕了
我们 run下工程
终端 open ~/Library/Application\ Support/Developer/Shared/Xcode/Plug-ins 这个目录
我们看到我们插件bundle 存在了

image.png

工程的起始文件

我们创建的bundle文件，只有个配置工程，没有起始文件，没有起始函数。这怎么办呢？

加载的起始文件需要再info.plist 文件中配置

• 1.我们随便创建文件，继承NSObject ，命名叫PluginDelegate

• 2.我们在info.plist 中找到Principal class key 将 PluginDelegate 写入

  
  
  

  image.png
• 3 我们在 PluginDelegate.h 中，加入下列函数。工程启动加载的起始函数

//+ (void)pluginDidLoad:(NSBundle *)plugin{

}

到底为止，我们就可以往下开发我们的插件了。

插件调试

我们开发插件总需要调试，如何调试呢？
这里需要我们修改工程几个地方

image.png

• 1.点击edit scheme

  
  
  

  image.png

• 2.点击Run 的info 的executable

  
  
  

  image.png

• 3.选择xcode
  

  

  image.png

• 4 结果显示

  
  
  

  image.png

+5 这个是配置日志的。

image.png

• 6关闭点击run
  这时候就会打开一个新的工程。这个工程就加载了我们插件的最新的代码了

采用插件模板开发工程

插件的安装叫教程有很多就不过多说了
[插件模板下载] (https://link.jianshu.com?t=https://github.com/kattrali/Xcode-Plugin-Template)**

image.png

推荐用Alcatraz安装。
不过自己手动安装的Xcode Plugin Template 生成的工程的info.plist文件的key DVTPlugInCompatibilityUUIDs 缺少你当前xcode 的UUID.将其添加上就可以了。

凤毛菱角的苹果关于插件的文档
开发插件苹果文档
xcode回调通知