Xcode扩展 初偿 — Source Editor Extensions

自从 Xcode 8 采用了系统完整性保护功能（SIP，System Integrity Protection），这意味着要将代码注入到 Xcode 进程已经不可能，Alcatraz 业务也关闭了 ，现在敲码都敲到手酸的 ( ´▽｀)，幸而苹果爸爸提供了自家的 Xcode Source Editor Extension开发插件

接下来捏，我们就实现一个简单在光标位置插入属性前缀的插件呗

一、创建插件

• 创建一个 macOS 下的 Coaoa App，作为容器 App

• 设置工程参数：名为 LY_PropertyPrefix，语言 Objective_C

• 添加扩展 Target
  选择 Editor -> add a new Target，选择 Xcode Source Editor Extension 并创建

设置 Target 参数：名为 LY_PropertyPrefix_Extension
NOTE：这一步要注意的是 Team 要跟刚才创建的容器 App 的 Team 一致，当然也可以稍后再修改使得两个 Target ( LY_PropertyPrefix LY_PropertyPrefix_Extension)的签名配置一致（General -> Signing）,要不然插件测试运行时找不到菜单按钮 ╮(￣▽￣"")╭

二、插件的基础与实现

• 文件结构

  • Info.plist
    Command 的静态配置信息，某个插件的菜单名称、标识符、命令触发时回调的类（NSExtension -> XCSourceEditorCommandDefinitions -> Item 某个 Item 对应一个 Command 的3个基本信息：XCSourceEditorExtensionPrincipalClass、XCSourceEditorCommandIdentifier、XCSourceEditorCommandClassName）

  • SourceEditorExtension

    1. SourceEditorExtension 管理插件的生命周期及对 Command 的动态配置（对应Info.plist里的静态配置），其实就是实现 XCSourceEditorExtension 协议的两个方法，默认注释了
    2. extensionDidFinishLaunching 插件启动时执行的方法，有想插件启动时做的工作可以放这里
    3. commandDefinitions 返回字典数组，相当于动态配置 Command
       其中有3个可配置的内容：XCSourceEditorCommandIdentifierKey ，XCSourceEditorCommandNameKey，XCSourceEditorCommandClassNameKey

  • SourceEditorCommand

    1. SourceEditorCommand 是一个实现了 XCSourceEditorCommand 协议的核心类，当插件被触发时，回调代理方法 performCommandWithInvocation: completionHandler: 并从中获取 XCSourceEditorCommandInvocation 这个消息所携带的环境信息，并根据消息内容进行响应处理，同时将结果通过 completionHandler block 告知Xcode即可
    2. XCSourceEditorCommandInvocation 命令消息所携带的环境信息，主要是 命令标识 commandIdentifier 和 命令可以操作的源文本缓冲区buffer，我们根据 commandIdentifier 判断目前所要进行的指令，即Info.plist里的XCSourceEditorCommandIdentifier
    3. XCSourceTextBuffer 源文本缓冲区的信息

/*
内容统一标识符
public.c-header 表示来自.h文件
public.objective-c-source 表示来自.m文件
public.swift-source 表示来自.swift文件，可以根据这个标识判断是否是swift    
*/
@property (readonly, copy) NSString *contentUTI;

//缩进字符个数，可以根据此来调整光标位置，减少操作    
@property (readonly) NSInteger tabWidth;

//最最最核心的信息 — 当前编辑文件的所有文本行，可直接操作插入删除替换
@property (readonly, strong) NSMutableArray  *lines;

//缓冲区中的文本选中区域，可修改选中区域或者光标位置
@property (readonly, strong) NSMutableArray  *selections;

• 扩展过程
  从上面可以看到，实现扩展的过程还是比较简单清晰的：

  1. 启动扩展，回调 SourceEditorExtension 的 extensionDidFinishLaunching
  2. 菜单或快捷键触发 Command，回调 SourceEditorCommand 的
     performCommandWithInvocation 拦截环境信息
  3. 获取当前环境信息 XCSourceEditorCommandInvocation，从 invocation 获取缓冲区信息 buffer，根据当前选中区域从 buffer 中获取到你要的数据
  4. 处理（删除、替换、添加）并回塞数据到 buffer，刷新Xcode环境

• 属性前缀插入实现
  初步尝试选择在光标位置插入属性前缀相对比较简单，但是工作中又相当实用，这里暂只针对 Objective-C ,一般就4种

  
  
  
  1. 获取当前选中行或光标位置

   NSInteger startLine = invocation.buffer.selections.count ? invocation.buffer.selections.firstObject.start.line : -1;
   if (startLine >= invocation.buffer.lines.count) {
       startLine = invocation.buffer.lines.count - 1;
   }
  

  2. 在光标位置根据命令插入对应前缀，若是光标所在行没有其它内容，直接替换当前内容，若已有内容，则插入下一行

    NSString *propertyPrefix = @"";
    NSString *commandIdentifier = invocation.commandIdentifier;
    if ([commandIdentifier hasSuffix:@"LYPropertyPrefixForAssign"]) {
        propertyPrefix = @"@property (nonatomic, assign) ;";
    } else if ([commandIdentifier hasSuffix:@"LYPropertyPrefixForWeak"]) {
        propertyPrefix = @"@property (nonatomic, weak) ;";
    } else if ([commandIdentifier hasSuffix:@"LYPropertyPrefixForCopy"]) {
        propertyPrefix = @"@property (nonatomic, copy) ;";
    } else if ([commandIdentifier hasSuffix:@"LYPropertyPrefixForStrong"]) {
        propertyPrefix = @"@property (nonatomic, strong) ;";
    }
    NSString *line = [invocation.buffer.lines[startLine] stringByTrimmingCharactersInSet:[NSCharacterSet whitespaceAndNewlineCharacterSet]];;
    if (line.length > 0) {
        [invocation.buffer.lines insertObject:propertyPrefix atIndex:startLine + 1];
    } else {
        [invocation.buffer.lines replaceObjectAtIndex:startLine withObject:propertyPrefix];
    }
  

  3. 重新设置光标位置

  [invocation.buffer.selections removeAllObjects];
  XCSourceTextRange *range = [[XCSourceTextRange alloc] init];
  range.start = (XCSourceTextPosition){startLine, propertyPrefix.length - 1};
  range.end = range.start;
  [invocation.buffer.selections addObject:range];
  

  最后不要忘了completionHandler(nil);

三、插件运行与调试

至此属性前缀插入的插件开发已经完成，最后把插件编译运行到 Xcode 上面（选择实现扩展的 Target LY_PropertyPrefix_Extension 运行），会出现一个被调试的灰黑色 Xcode，随意选择一个项目，即可在菜单Editor中看到插件二级菜单啦

接下来就是通过 Xcode -> Xcode Server... -> Key Bindings 为自己的插件添加快捷键
运行效果如下：

四、插件的安装

插件开发完成了，怎么常驻 Xcode 供大家使用呢

1. Products 文件夹下生成的 LY_PropertyPrefix.app 文件，并右键进入 app 所在位置
   
   
2. 将 1 中的 app 拷贝放至 应用程序 中，双击 app 启动即可（系统偏好设置中的扩展默认选中扩展，无需再次进行选中操作，不过可以在这里取消扩展插件）
   
   

总结

毕竟是官方的，所以它可以上架 Mac App Store，但是功能略显单薄，目前也仅仅只能文本编辑上进行一些操作，跟以往第三方插件有很大的差距，不过即使这样，还是保持微笑，心存感激！