iOS Xcode插件(Xcode8) 編寫一個插件自動為屬性生成getter方法.
編寫這個插件的原因
最近項目比較忙. 新項目時間催的很緊. 用產品的話來講, 這個新項目就是把四個app合并成一個.o(╯□╰)o
大多數的界面比較復雜, 控件位置經常變化. 在不同屏幕上尺寸都不一樣, 還要求動畫效果絢一點... 思來想去, 界面部分還是使用少量的storyboard配合大量的代碼來實現.
控件太多控制器中就會有大量的類似于 [[UIView alloc] init] view.backgroundColor = [UIColor whiteColor]; 這樣的垃圾代碼.
這些代碼在調試的時候大多沒什么用. bug一般不會出現在這種代碼里.
對于這樣的代碼我一般會復寫這個屬性的get方法. 將這個UI控件的顏色, 字體, 這樣的代碼放進getter里面.(懶加載...)(雖然它叫懶加載, 但是我一般在viewDidLoad中將所有控件addSubViews到父view上. 其實并沒有起到"懶"的作用.) 但是這樣可以將代碼分塊. 讓這個控制器類看起來非常清爽.
我在連續(xù)寫了幾十個getter之后, 實在是受不了了. 這樣的重復, 垃圾, 沒營養(yǎng)的代碼應該自動生成!!!
想起來以前使用Eclipse的時候, Eclipse能夠自動生成屬性的set和get的代碼.
我問了問同事們有沒有見過這樣的Xcode插件.他們表示似乎沒有.
而且升級Xcode8之后以前的插件都不能用了.但是蘋果提供了官方的編寫Xcode插件的方法.它叫做<h4>Xcode Source Editor Extension</h4>
Xcode Source Editor Extension
先說說Xcode8中如何編寫插件吧.
1.打開Xcode8.
2.創(chuàng)建一個macOS Application(mac系統(tǒng)桌面應用程序)
3.創(chuàng)建一個Target
4.創(chuàng)建Xcode Source Editor Extension
5.這樣工程就創(chuàng)建好了. 接下來, 編碼.
我們主要在紅圈中的類中工作.
SourceEditorExtension.h/.m ->> 這個類可以類比于iOS中的AppDelegate.其實就是一些生命周期的回調方法.
SourceEditorCommand.h/./m ->> 這個類中默認有下面這一個方法.
- (void)performCommandWithInvocation:(XCSourceEditorCommandInvocation *)invocation completionHandler:(void (^)(NSError * _Nullable nilOrError))completionHandler
{
// Implement your command here, invoking the completion handler when done. Pass it nil on success, and an NSError on failure.
completionHandler(nil);
}
這個方法就是點擊你編寫的Xcode插件的按鈕之后會執(zhí)行的方法.
恩....這里插入一點. Xcode插件編寫好了之后其實就是在Xcode-->>Editor這個菜單中多了一行. 點擊你編寫的按鈕, 上面的方法就會被調用.
只有一個方法, 兩個參數, 很清爽, 很簡單. 但是也意味著我們能做的操作并不多.
重點就是對invocation 對象做操作. 這個對象中包含了當前文檔編輯器中的所有內容.
通過這個對象, 你能過拿到當前打開的編輯器中的所有代碼(文本), 包括每行代碼所在的行數等等. 更多信息可以調試的時候打印這個對象查看.
修改invocation 對象之后調用completionHander(nil); 表示插件內容執(zhí)行完畢.
6.運行編寫好的插件.
選擇插件所在的target. 運行.
在這個黑色的Xcode中打開一個 代碼文件例如ViewController.m文件 此時點擊Editor菜單就能看到我們編寫的插件的按鈕. 按鈕的文字可以通過修改info.plist文件修改.
存在的坑及解決方案.
如果一切都像上面的一樣順利. 那么恭喜你運氣太好了, 應該去買彩票慶祝一下.
Xcode插件功能還不完善, 不穩(wěn)定. 但是已經能湊合用了.
我在編寫過程中遇到的問題和解決方案列舉在這里, 希望能給你一些幫助.
- 1.在灰色的Xcode里面Editor菜單中沒有出現新的選項.
請檢查插件是否運行起來了.(點的過快有可能有問題, 請慢一點操作).
出現下面的界面表示插件運行成功.
如果一直沒有出現上圖, 并且提示Waiting to Attach字樣.
請在命令行中輸入 sudo /usr/libexec/xpccachectl
重啟電腦再做嘗試.
如果還是不行, 請google吧. 過了這么多天, google可能能夠找到新的帖子解決這個問題.
2.運行出現灰黑色的Xcode的時候Editor菜單中有我們編寫的內容. 但是停止調試之后我們編寫好的內容就消失了...
這是個令人沮喪的情況. WWDC中蘋果表示新的Xcode插件未來可以提交到Mac App Store中. 使用Mac App Store 開發(fā)人員可以共享插件, 但是現在我并沒有找到將插件發(fā)布出去的方法.
也就是, 我現在沒有找到方法將插件編譯打包. 分享給別人.
如果有人找到打包插件的方法, 請一定告訴我.謝謝.3.我們開發(fā)的Xcode插件崩潰會不會對Xcode產生影響?
答曰: 不會產生影響, 插件運行在一個單獨的線程, 崩潰不會影響Xcode.
再次啟動Xcode, 插件又會被重新啟動.
為屬性生成getter方法的代碼.
其實這個才是重點!
我用了大概3個小時寫了150行代碼, 為文件中的@property屬性生成簡單的getter方法.代碼很簡陋, 但是對我來所湊合夠用了.
https://github.com/ddyd369/CreateGetterMethod.git
我僅僅編寫了最基本的功能. 注釋, block, IBOutLet不會被生成getter方法.
其余沒有做處理.
接下來有時間需要添加
1.已經有getter方法的屬性不要被重復生成getter方法.
2.插入代碼的位置. 從@end所在行的上方. 修改為光標所在行.
3.哪些屬性需要被生成getter方法. 哪些不需要. 這個可以由用戶指定.例如加注釋標記. 或者仿照解釋型語言的方式,在上面一行加裝飾器
4.生成的代碼可以是多樣性的. 例如UIView自動帶上背景色的代碼. UIButton不使用alloc init 使用system類型的枚舉創(chuàng)建UIButton
這些功能有時間再去編寫.
結尾再次附上代碼鏈接
https://github.com/ddyd369/CreateGetterMethod.git
