從零開始 編寫一個 XCode Source Extension

先看最終效果圖：

demo-tuya.gif

就像你看到的促煮，這個插件包括兩個模塊，一個是設置頁面我們使用Mac APP 完成(不需要Mac開發(fā)基礎)整袁，另一部分是Xcode source Editor插件菠齿。這兩個模塊我們均用swift進行開發(fā)。

第一步：開始創(chuàng)建項目坐昙，創(chuàng)建一個Mac APP

001.png

002.png

003.png

004.png

@IBAction func modeTypeChange(_ sender: NSButton) {
        [codeableBtn,handyJSONBtn,swiftyJSONBtn].forEach {
            $0?.state = sender.title == $0?.title ? .on : .off
        }
        UserDefaults.modelType = sender.title 
    }

    @IBAction func modeNameStyleChange(_ sender: NSButton) {
        for i in 0..<3 {
            let btn = self.view.viewWithTag(100 + i) as? NSButton
            btn?.state = sender.title == btn?.title ?.on:.off
        }
        UserDefaults.modelStyle = sender.title
    }

這樣我們做好了事件處理和數(shù)據(jù)存儲，這里我們存儲數(shù)據(jù)需要和extension共享為此我們使用APP group進行userdefault 存取众弓。如果使用UserDefaults.standard進行存取我們將無法在extension中獲取到存取的值恩溅。
具體步驟如下：
到開發(fā)者中心創(chuàng)建APP group

005.png

006.png

007.png

extension UserDefaults{
    static var grouped:UserDefaults{
        return UserDefaults(suiteName: "group.com.dkjone.DKJsonExtension") ?? standard
    }
    /// 模型類型
    static var  modelType: String {
        get { return grouped.string(forKey: #function) ?? "HandyJSON" }
        set { grouped.setValue(newValue, forKey: #function) }
    }
    // 命名規(guī)則
    static var modelStyle: String {
        get { return grouped.string(forKey: #function) ?? "駝峰法" }
        set { grouped.setValue(newValue, forKey: #function) }
    }
}

最后一步脚乡，設置頁面加載時，顯示當前存儲的設置數(shù)據(jù)

 override func viewDidLoad() {
        super.viewDidLoad()
        [codeableBtn,handyJSONBtn,swiftyJSONBtn].forEach {
            $0?.state = UserDefaults.modelType == $0?.title ? .on : .off
        }
        for i in 0..<3 {
            let btn = self.view.viewWithTag(100 + i) as? NSButton
            btn?.state = UserDefaults.modelStyle == btn?.title ?.on:.off
        }
    }

到此我們完成了設置應用的全部功能
接下來我們實現(xiàn)source editor extension部分
這部分我們首先創(chuàng)建extension如圖：

008.png

創(chuàng)建完成以后我們項目中多呢以下文件

-- JSONExtension
---- SourceEditorExtension.swift
---- SourceEditorCommand.swift
---- Info.plist

這幾個文件是我們編寫extension的關鍵滨达。我們的 項目 target也會多一個選項,我們使用如下選項運行就會出現(xiàn)一個灰色的xcode 可以讓我們調試奶稠，用灰色xcode 打開文件便會在editor菜單中出現(xiàn)我們添加的插件名稱。

009.png

如果你出現(xiàn)報錯

dyld: Library not loaded: @rpath/XcodeKit.framework/Versions/A/XcodeKit
  Referenced from: 

說明庫連接有問題弦悉，找到這個庫鏈接刪除后按圖添加即可

010.png

出現(xiàn)以下錯誤是賬號問題需要到xcoed->preferencces->account 中窒典，刪除之前的賬號，重新登陸賬號就可以了

"Your session has expired. Please log in."

如果成功運行會出現(xiàn)灰色Xcode

011.png

012.png

class SourceEditorExtension: NSObject, XCSourceEditorExtension {
    var commandDefinitions: [[XCSourceEditorCommandDefinitionKey: Any]] {
        return [[.nameKey: "將JSON文件轉化模型", .identifierKey: "paraseFile", .classNameKey: SourceEditorCommand.className()],
                [.nameKey: "從剪貼板獲取JSON轉化為模型", .identifierKey: "parasePasteboard", .classNameKey: SourceEditorCommand.className()]]
    }
}

要注意的地方：

nameKey: 菜單的名稱
identifierKey: 菜單的標識污秆，可以在處理類中用于判斷點擊了哪一個菜單
classNameKey: 處理此菜單的類名劈猪，這里我們直接使用className()獲取，如果你直接寫字符串記得在類名前加上模塊名良拼。

到此我們直接運行后就是以下的效果了

013.png

最后我們需要處理如何生成代碼了：
打開處理類

class SourceEditorCommand: NSObject, XCSourceEditorCommand {
// 點擊菜單時調用的方法
 func perform(with invocation: XCSourceEditorCommandInvocation, completionHandler: @escaping (Error?) -> Void) {
 }
}

這里方法的參數(shù)invocation就是當前編輯的上下文可以獲取當前菜單的ID和當前文檔類型战得，文檔內容，所在行號等等庸推。
如果需要修改文件內容直接修改invocation.buffer.lines就可以常侦。這是個[Sting]類型的可變數(shù)組浇冰，可以在后面直接加，也可以替換某一行內容聋亡。
為了獲取主程序保存的配置我們也要為這個extension配置相同的APP group肘习，方法同上。也使用相同的userdefault就可以取出主程序存儲的配置了坡倔。

這里具體解析json的邏輯就不仔細說明了漂佩，有興趣的可查看完整的源碼github或者碼云

最后一步發(fā)布我們制作的插件。選擇主項目罪塔，然后xcode->product->archive 接下來和發(fā)布IOS應用一樣可以選擇開發(fā)者簽名或者提交到APP store 或者內部測試投蝉。導出內容如圖:

014.png

015.png