iOS Xcode插件(Xcode8) 编写一个插件自动为属性生成getter方法.

编写这个插件的原因

最近项目比较忙. 新项目时间催的很紧. 用产品的话来讲, 这个新项目就是把四个app合并成一个.o(╯□╰)o

大多数的界面比较复杂, 控件位置经常变化. 在不同屏幕上尺寸都不一样, 还要求动画效果绚一点... 思来想去, 界面部分还是使用少量的storyboard配合大量的代码来实现.

控件太多控制器中就会有大量的类似于 [[UIView alloc] init] view.backgroundColor = [UIColor whiteColor]; 这样的垃圾代码.
这些代码在调试的时候大多没什么用. bug一般不会出现在这种代码里.

对于这样的代码我一般会复写这个属性的get方法. 将这个UI控件的颜色, 字体, 这样的代码放进getter里面.(懒加载...)(虽然它叫懒加载, 但是我一般在viewDidLoad中将所有控件addSubViews到父view上. 其实并没有起到"懒"的作用.) 但是这样可以将代码分块. 让这个控制器类看起来非常清爽.

我在连续写了几十个getter之后, 实在是受不了了. 这样的重复, 垃圾, 没营养的代码应该自动生成!!!
想起来以前使用Eclipse的时候, Eclipse能够自动生成属性的set和get的代码.
我问了问同事们有没有见过这样的Xcode插件.他们表示似乎没有.

而且升级Xcode8之后以前的插件都不能用了.但是苹果提供了官方的编写Xcode插件的方法.它叫做<h4>Xcode Source Editor Extension</h4>

Xcode Source Editor Extension

先说说Xcode8中如何编写插件吧.

1.打开Xcode8.

xcode.png

2.创建一个macOS Application(mac系统桌面应用程序)

macOSApplication.png

3.创建一个Target

newTarget1.png

4.创建Xcode Source Editor Extension

extension.png

5.这样工程就创建好了. 接下来, 编码.

commandClass.png

我们主要在红圈中的类中工作.
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插件的按钮之后会执行的方法.
恩....这里插入一点. Xcode插件编写好了之后其实就是在Xcode-->>Editor这个菜单中多了一行. 点击你编写的按钮, 上面的方法就会被调用.

createGetter.png

只有一个方法, 两个参数, 很清爽, 很简单. 但是也意味着我们能做的操作并不多.

重点就是对invocation 对象做操作. 这个对象中包含了当前文档编辑器中的所有内容.
通过这个对象, 你能过拿到当前打开的编辑器中的所有代码(文本), 包括每行代码所在的行数等等. 更多信息可以调试的时候打印这个对象查看.
修改invocation 对象之后调用completionHander(nil); 表示插件内容执行完毕.

6.运行编写好的插件.
选择插件所在的target. 运行.

xcode1.png blackXcode.png

在这个黑色的Xcode中打开一个 代码文件例如ViewController.m文件 此时点击Editor菜单就能看到我们编写的插件的按钮. 按钮的文字可以通过修改info.plist文件修改.

存在的坑及解决方案.

如果一切都像上面的一样顺利. 那么恭喜你运气太好了, 应该去买彩票庆祝一下.

Xcode插件功能还不完善, 不稳定. 但是已经能凑合用了.

我在编写过程中遇到的问题和解决方案列举在这里, 希望能给你一些帮助.

• 1.在灰色的Xcode里面Editor菜单中没有出现新的选项.
  请检查插件是否运行起来了.(点的过快有可能有问题, 请慢一点操作).
  出现下面的界面表示插件运行成功.

debugger.png

如果一直没有出现上图, 并且提示Waiting to Attach字样.
请在命令行中输入 sudo /usr/libexec/xpccachectl
重启电脑再做尝试.
如果还是不行, 请google吧. 过了这么多天, google可能能够找到新的帖子解决这个问题.

• 2.运行出现灰黑色的Xcode的时候Editor菜单中有我们编写的内容. 但是停止调试之后我们编写好的内容就消失了...
  
  这是个令人沮丧的情况. WWDC中苹果表示新的Xcode插件未来可以提交到Mac App Store中. 使用Mac App Store 开发人员可以共享插件, 但是现在我并没有找到将插件发布出去的方法.
  
  也就是, 我现在没有找到方法将插件编译打包. 分享给别人.
  
  如果有人找到打包插件的方法, 请一定告诉我.谢谢.

• 3.我们开发的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类型的枚举创建UIButton

这些功能有时间再去编写.

结尾再次附上代码链接
https://github.com/ddyd369/CreateGetterMethod.git

我的理解有什么错漏之处还请指出谢谢