Xcode擴展初償 — Source Editor Extensions

自從 Xcode 8 采用了系統(tǒng)完整性保護功能（SIP持隧，System Integrity Protection）桑涎，這意味著要將代碼注入到 Xcode 進程已經不可能??彬向，Alcatraz 業(yè)務也關閉了，現在敲碼都敲到手酸的 ( ′▽｀)攻冷，幸而蘋果爸爸提供了自家的 Xcode Source Editor Extension開發(fā)插件

接下來捏娃胆，我們就實現一個簡單在光標位置插入屬性前綴的插件唄

一、創(chuàng)建插件

創(chuàng)建一個 macOS 下的 Coaoa App等曼，作為容器 App

設置工程參數：名為 LY_PropertyPrefix里烦，語言 Objective_C

添加擴展 Target
選擇 Editor -> add a new Target，選擇 Xcode Source Editor Extension 并創(chuàng)建

設置 Target 參數：名為 LY_PropertyPrefix_Extension
NOTE：這一步要注意的是 Team 要跟剛才創(chuàng)建的容器 App 的 Team 一致禁谦，當然也可以稍后再修改使得兩個 Target (LY_PropertyPrefix LY_PropertyPrefix_Extension)的簽名配置一致（General -> Signing）,要不然插件測試運行時找不到菜單按鈕 ╮(￣▽￣"")╭

二胁黑、插件的基礎與實現

文件結構
- Info.plist
  Command 的靜態(tài)配置信息，某個插件的菜單名稱州泊、標識符丧蘸、命令觸發(fā)時回調的類（NSExtension -> XCSourceEditorCommandDefinitions -> Item 某個 Item 對應一個 Command 的3個基本信息：XCSourceEditorExtensionPrincipalClass、XCSourceEditorCommandIdentifier遥皂、XCSourceEditorCommandClassName）
- SourceEditorExtension
  1. SourceEditorExtension 管理插件的生命周期及對 Command 的動態(tài)配置（對應Info.plist里的靜態(tài)配置）触趴，其實就是實現 XCSourceEditorExtension 協議的兩個方法，默認注釋了
  2. extensionDidFinishLaunching 插件啟動時執(zhí)行的方法渴肉，有想插件啟動時做的工作可以放這里
  3. commandDefinitions 返回字典數組，相當于動態(tài)配置 Command
    其中有3個可配置的內容：XCSourceEditorCommandIdentifierKey 爽冕，XCSourceEditorCommandNameKey仇祭，XCSourceEditorCommandClassNameKey
- SourceEditorCommand
  1. SourceEditorCommand 是一個實現了 XCSourceEditorCommand 協議的核心類，當插件被觸發(fā)時颈畸，回調代理方法 performCommandWithInvocation: completionHandler: 并從中獲取 XCSourceEditorCommandInvocation 這個消息所攜帶的環(huán)境信息乌奇，并根據消息內容進行響應處理，同時將結果通過 completionHandler block 告知Xcode即可
  2. XCSourceEditorCommandInvocation 命令消息所攜帶的環(huán)境信息眯娱，主要是命令標識 commandIdentifier 和命令可以操作的源文本緩沖區(qū)buffer礁苗，我們根據 commandIdentifier 判斷目前所要進行的指令，即Info.plist里的XCSourceEditorCommandIdentifier
  3. XCSourceTextBuffer 源文本緩沖區(qū)的信息

/*
內容統(tǒng)一標識符
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 <NSString *> *lines;

//緩沖區(qū)中的文本選中區(qū)域，可修改選中區(qū)域或者光標位置
@property (readonly, strong) NSMutableArray <XCSourceTextRange *> *selections;

擴展過程
從上面可以看到，實現擴展的過程還是比較簡單清晰的：
1. 啟動擴展夺脾，回調 SourceEditorExtension 的 extensionDidFinishLaunching
2. 菜單或快捷鍵觸發(fā) Command，回調 SourceEditorCommand 的
  performCommandWithInvocation 攔截環(huán)境信息
3. 獲取當前環(huán)境信息 XCSourceEditorCommandInvocation搏讶，從 invocation 獲取緩沖區(qū)信息 buffer民逼，根據當前選中區(qū)域從 buffer 中獲取到你要的數據
4. 處理（刪除、替換秀又、添加）并回塞數據到 buffer单寂，刷新Xcode環(huán)境

屬性前綴插入實現
初步嘗試選擇在光標位置插入屬性前綴相對比較簡單，但是工作中又相當實用吐辙，這里暫只針對 Objective-C ,一般就4種

獲取當前選中行或光標位置

 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;
 }

在光標位置根據命令插入對應前綴宣决，若是光標所在行沒有其它內容，直接替換當前內容袱讹，若已有內容疲扎，則插入下一行

  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];
  }

重新設置光標位置

[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);

三、插件運行與調試

至此屬性前綴插入的插件開發(fā)已經完成捷雕，最后把插件編譯運行到 Xcode 上面（選擇實現擴展的 Target LY_PropertyPrefix_Extension 運行）椒丧，會出現一個被調試的灰黑色 Xcode，隨意選擇一個項目救巷，即可在菜單Editor中看到插件二級菜單啦

接下來就是通過 Xcode -> Xcode Server... -> Key Bindings 為自己的插件添加快捷鍵
運行效果如下：

四壶熏、插件的安裝

插件開發(fā)完成了，怎么常駐 Xcode 供大家使用呢

Products 文件夾下生成的 LY_PropertyPrefix.app 文件浦译，并右鍵進入 app 所在位置
將 1 中的 app 拷貝放至 應用程序 中棒假，雙擊 app 啟動即可（系統(tǒng)偏好設置中的擴展默認選中擴展，無需再次進行選中操作精盅，不過可以在這里取消擴展插件）

總結

畢竟是官方的帽哑，所以它可以上架 Mac App Store，但是功能略顯單薄叹俏，目前也僅僅只能文本編輯上進行一些操作妻枕，跟以往第三方插件有很大的差距，不過即使這樣粘驰，還是保持微笑??屡谐，心存感激！

Xcode擴展 初償 — Source Editor Extensions

一、創(chuàng)建插件

二胁黑、插件的基礎與實現

三、插件運行與調試

四壶熏、插件的安裝

總結

Xcode擴展初償 — Source Editor Extensions