Xcode Source Editor Extension 创建入门

鉴于 Xcode Source Editor Extension 网上调试问题资料比较少，在这里汇总下创建一个 extension 项目中遇到的问题。

本文目录：
一、完整创建一个extension工程
二、运行时候的坑
三、运行效果
四、其他问题
五、其他

一、完整创建一个extension工程

• 1.1创建app
  首先需要创建一个基于macOS的app

  
  
  73823247.png

这里我们选择object-C语言，注意，如果是新的xcode，默认都的interface 是 Swift-UI，是没办法创建OC项目的，所以我们需要改为Storyboard。

74035084.png

• 1.2 添加一个extension
  Xcode菜单选择 File -- New -- Target，选择macOS，创建Xcode Source Editor Extension

74246123.png

74296178.png

• 1.3 更改二级菜单名字
  将来运行时候，在editor中一级菜单展示的是“HelloWorldExtension” 这个target的名字，而二级菜单就是我们下面箭头指向的名字了。
  如果这个项目有多个插件，那么需要再plist文件的XCSourceEditorCommandDefinitions 里面添加多个item，每个小组件将以不同的XCSourceEditorCommandIdentifier进行区分，所以这里除了更改XCSourceEditorCommandName值，也可以修改identifier的值。当然如果你只有一个小组件那就不用更改identifier的值了。

75060039.png

二、运行时候的坑

• 2.1 问题：
  运行后只展示一个view，没有黑色xcode可以调试。如下图：

  
  
  74637025.png

解决办法：这个是由于我们在运行时候选错了target的缘故，需要把上图红色箭头处的target更改为“HelloWorldExtension”，如下图

74807168.png

• 2.2 问题：
  运行后在editor里面没有出现调试的菜单项
  解决办法：
  第一步，确定上文中1.3是否已经配置XCSourceEditorCommandName的值。
  第二步，看下运行程序后，在选择黑色Xcode里的项目前，是否有打印报错

IDEExtensionManager: Xcode Extension does not incorporate XcodeKit: come.lxl.HelloWorld.HelloWorldExtension

如果有的话，那就是 项目中的XcodeKit.framework导入有问题。找到下图的位置，删掉，重新添加就好了（最好两个都删掉，重新导入）

75677105.png

75712238.png

三、运行效果

75871881.png

四、其他问题：

1、运行的时候，xcode 不停的报错，代码如下：

Error Domain=DVTPortalServiceErrorDomain Code=1100 "Your session has expired. Please log in." UserInfo={payload={
creationTimestamp = "2020-12-19T09:51:30Z";
httpCode = 200;
protocolVersion = QH65B2;
requestUrl = "[https://developerservices2.apple.com/services/QH65B2/viewDeveloper.action"](https://developerservices2.apple.com/services/QH65B2/viewDeveloper.action%22);;
responseId = "937f0446-732b-4c67-b36c-6a41ce7066bf";
resultCode = 1100;
resultString = "Your session has expired. Please log in.";
userLocale = "en_US";
userString = "Your session has expired. Please log in.";
}, NSLocalizedDescription=Your session has expired. Please log in.}

1a159539-17eb-4e7e-992f-f05d3e36b212.png

解决办法：
看意思是需要重新登录。虽说平时跑其他项目没一点问题，而且当前项目也在登录状态没有影响运行，但是就是不停的报这个错。
后来解决办法是，把本地在xcode里面记录的用户 全部删除！全部删除！！（删除完，最好重启下xcode）
为了运行项目，再登录一个你需要的账户，这个bug就消失了。

2、可以用kill -9 processID来杀死当前的进程。或者重启下xcode。
查看proessId的地方如下

76492867.png

3、如果你遇到了和我一样的xcode一直闪退的问题，那么,重装xcode的链接如下：
1、如何完全卸载xcode
2、下载xcode的链接
注意，最好手动下载一个xcode版本，这样后续再崩溃了，就不用再去App Store上再下载再装了。

其他注意点：黑色xcode调试的时候，最好打开的是xcodeproj 工程，不要打开pod安装的xcworkspace工程，我自己测的时候xcworkspace经常会崩溃。

五、其他

分析XAlign的demo：https://github.com/AnArrayOfStarts/XAlignNew

其他大佬的链接：
1、swift写的插件:https://www.jianshu.com/p/06f495aaf973
2、wwdc2016官方视频：https://developer.apple.com/videos/play/wwdc2016/414/
3、国内优酷标清视频地址：https://v.youku.com/v_show/id_XMjkzMzYzMTI4OA==.html?spm=a2h0c.8214523.PhoneSokuUgc_1.dscreenshot
4、XAlign的git地址：https://github.com/qfish/XAlign