详解一步步实现Xcode 8 插件——Source Editor Extensions

O. 背景

Xcode 8前，开发者可以通过运行时注入代码来实现添加插件，甚至在著名的插件管理工具Alcatraz上提交和分发插件。但是，Xcode 8成为这种开始方式的终结者，因为它提供了自家的Xcode Source Editor Extension方式开发插件。
接下来，你将了解到:

• 如何创建Xcode Source Editor Extension(插件)
• 如何测试插件
• 如何快速进行插件开发
• 开发完成后如何让小伙伴们使用
• 插件的优势和局限

一. 着手创建插件

1. 首先，创建一个macOS下的Cocoa Application工程，作为插件的母体:

2. 设置工程参数，完成工程创建。

这里工程名: SourceEditorExtensionDemo 语言: Swift

3. 添加Target

选择Xcode Souce Editor Extension:

配置Target名称等信息，Finish完成设置:

此时弹出是否启用此Target的Scheme对话框，点击Activate按钮启用:

4. 文件结构

二. 测试插件

1. 配置签名(不配置的后果是，测试时不显示插件按钮)

配置好签名后，两个Target: SourceEditorExtensionDemo 和 MyPlugin 的签名(Siging)要一致，如图:

2. 运行插件

点击左侧运行按钮 或者 Command + R运行插件，弹出下面的对话框，选择Xcode(如果有多个Xcode，选择Xcode 8以上的版本)，并点击Run按钮:

然后Dock中出现一个黑色的东东，没错，黑色的Xcode:

双击右侧的一个工程，就可以假装把插件安装到Xcode里，进行插件调试了(插件按钮放在Editor最下面):

(关于插件，因为我们啥都没写，所以点击插件按钮暂时啥也没有 = =)

三. 认识并开发插件

1. 插件相关文件

• SourceEditorExtension.swift 和插件的生命周期和配置有关，实现了XCSourceEditorExtension协议中的一个方法extensionDidFinishLaunching() 和一个变量commandDefinitions，默认是被注释掉的。

• 方法extensionDidFinishLaunching()是指刚刚加载好插件但还未点击插件按钮时，可以执行某些准备工作。

• 变量commandDefinitions返回字典类型的数组，可以为每个插件重写名字、标识符和自定义类名等信息，相当于设置后面要介绍的的Info.plist文件中对应的XCSourceEditorCommandName、XCSourceEditorCommandIdentifier和XCSourceEditorCommandClassName信息。
  

  

  SourceEditorExtension.swift

• SourceEditorCommand.swift 实现了XCSourceEditorCommand协议中的perform方法，点击插件按钮所执行的具体逻辑就是在这个方法中完成的，因此是实现插件功能的核心。
  

  

  SourceEditorCommand.swift

• Info.plist 其中，每个插件的名字、标识符和自定义类名分别对应XCSourceEditorCommandName、XCSourceEditorCommandIdentifier和XCSourceEditorCommandClassName信息。 XCSourceEditorExtensionPrincipalClass对应插件的默认实现类:SourceEditorExtension.swift。
  

  

  Info.plist

2. 制作一个简单的插件

在SourceEditorCommand.swift文件中书写如下代码:

class SourceEditorCommand: NSObject, XCSourceEditorCommand {
    
    func perform(with invocation: XCSourceEditorCommandInvocation, completionHandler: @escaping (Error?) -> Void ) -> Void {
        // Implement your command here, invoking the completion handler when done. Pass it nil on success, and an NSError on failure.
        
        // 第一个选中区域
        let firstSelectObject: XCSourceTextRange = invocation.buffer.selections.firstObject as! XCSourceTextRange
        // 开始删除的位置
        let start = firstSelectObject.start.line
        // 要删除的行数
        let end = firstSelectObject.end.line
        // 设置删除的范围
        let deleteRange = IndexSet(integersIn: start...end)
        // 删除对应行的代码
        invocation.buffer.lines.removeObjects(at: deleteRange)
        
        completionHandler(nil)
    }
}

然后运行插件，即可通过插件按钮实现对选中的代码进行整行删除。

原理分析:

• 插件一旦运行起来 -> 立即调用SourceEditorExtension.swift中的 extensionDidFinishLaunching() 方法做准备工作 -> 同时检查是否自定义 commandDefinitions 变量，以确定实现插件的类名、插件名字和唯一标识符信息 -> 如果没有自定义此变量，直接读取 Info.plist 文件中的配置。
• 点击插件中的按钮 -> 直接执行我们自定义的或者 Info.plist 中 XCSourceEditorCommandClassName 对应的类文件中的 perform 方法，该方法中的参数invocation为XCSourceEditorCommandInvocation类型，包含我们点击的插件的唯一标识符属性，以及我们在点击插件前光标选中的区域等信息。
• XCSourceEditorCommandInvocation有个XCSourceTextBuffer类型的buffer属性，此类型有两个比较常用的属性lines和selections，分别代表我们点击插件前光标所在文件的所有行 和 光标选中的区域。
• 多个插件可以对应一个类实现文件，在代码中，用唯一标识符来区分不同的插件。

四. 让插件及时传播给小伙伴们使用

开发时，插件只要运行起来，我们就可以在Xcode菜单栏中的Editor最下面看到插件名字和使用，但一旦停止运行，插件并不会常驻Xcode供我们使用。
但是，我们可以这样做: 找到Products文件夹下生成的的.app文件

右键点击此文件 -> “在Finder中显示” -> 将这个.app文件拷贝到你或者小伙伴电脑上的"应用程序"里 :

在“应用程序”中双击.app文件运行。然后，打开“系统偏好设置” -> "扩展" -> "Xcode Source Editor" -> 确认插件名字前已打钩 -> 此时Xcode中菜单栏Editor下的插件虽然显示，但是为灰色，无法点按，所以要 -> 重启Xcode -> 大功告成！

我们也可以为插件添加快捷键: Xcode -> "Preferences" -> "Key Bindings" -> 搜索插件名字 -> 添加对应的快捷键:

五. 优缺点总结

优:

• 支持上架到Mac App Store
• 每个Extension运行在独立的进程，如果它出了事故，不会引起Xcode的崩溃
• 可以分配快捷键

缺:

• 无UI相关接口
• 只能做文本相关处理

总之: 第一版插件 too young too simple，但我们要对苹果心怀期待，假装未来很美好~