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回调通知

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 215,634评论 6 497
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,951评论 3 391
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 161,427评论 0 351
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,770评论 1 290
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,835评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,799评论 1 294
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,768评论 3 416
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,544评论 0 271
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,979评论 1 308
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,271评论 2 331
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,427评论 1 345
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,121评论 5 340
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,756评论 3 324
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,375评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,579评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,410评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,315评论 2 352

推荐阅读更多精彩内容

  • 太阳爬到天空正中的时候,阳光洒满大地,一片一片的金黄,看不见地面上,房屋的影子。一缕一缕的阳光照射进毛孔里,滚烫,...
    鹅掌女王烤肉店阅读 269评论 0 0
  • “大语文作文”(3) “大语文作文”教学观的产生及特点 “问他往何处去?言者回答说:‘我不...
    大语文作文阅读 206评论 0 0
  • 夜啦个帮黑,爷儿爷儿汉挺高,老西个麻楞绕着院子飞来飞去,江擦儿上大家也各多了,杭么丫地,雨奏下起来了。你肯定在想:...
    东方君阅读 401评论 0 0