Xcode插件：编码效率神器 FlyCoding

╰半橙微兮° 2022-03-16 13:13 366阅读 0赞

## [FlyCoding - Xcode版 Emmet][FlyCoding - Xcode_ Emmet] ##

#### ⚠️ 请使用 Swift 4.2 编译 ⚠️ ####

FlyCoding 是一个 Xcode 插件，使用苹果提供的插件机制编写，可以运行在最新的Xcode上， 它提供了类似于前端中 **Emmet** 的功能。你可以通过特殊语法来快速的生成你想要的 **Swfit / Objective-C** 代码，特别是在大量的编写界面 UI 时， 重复的编写 UI 控件和约束是一件非常繁琐和机械的劳动， 但是这又是你不可避免的。 而 FlyCoding 则可以帮助你快速的生成**属性、方法、约束（Masonry / SnapKit）**，目前 FlyCoding 刚刚发布了第一个版本，更多的功能还在构思当中，希望大家提供宝贵的意见和想法。

##### 目前开发进度： #####

*  \[x\] **Objective-C / Swift 属性生成**
 *  \[x\] **Objective-C / Swift 视图的快速创建**
 *  \[x\] **Masonry / SnapKit 约束生成**
 *  \[x\] **快速生成方法**
 *  \[x\] **任何完整操作都可以使用 ' + ' 进行分隔， 使用 '\* N' 进行批量操作**

### 属性生成 ###

#### Swift属性生成 ####

*  **单个属性**

pv.UIImageView
    // pv 是属性控制，p 是 private， v 是 var，具体的列表可以在后文中查看; . 用于区分属性和类名
    private var <#name#>: UIImageView
    复制代码

*  **可选属性**

fv.UILabel?
    // fv 是属性控制， f 是 fileprivate, v 是 var; ？表示属性是可选的
    fileprivate var <#name#>: UILabel?
    复制代码

*  **有默认值的属性**

Pl.UIView{}
    // Pl 是属性控制， P 是 public, l 是 let; {} 表示有默认值
    // 默认值使用 Class() 来生成
    // 如果有默认值，就不会再显示类型，因为 Swift 可以自己推断类型
    public let <#name#> = UIView()
    
    
    Pl.Int{
        100}
    // 如果在 ｛｝ 里面添加默认值，会直接使用此默认值
    public let <#name#> = 100
    复制代码

*  **懒加载属性**

lv.UIButton
    // lv 是属性控制，lv 是一个特殊的组合,分来时 l 表示 let, v 表示 var; 合并在一起时表示 lazy var
    lazy var <#name#>: UIButton = {
        <#code#>
    }()
    复制代码

*  **OC可访问属性**

@Pv.UIImageView
    // 添加 @ 将把属性标记为 @objc
    @objc public var <#name#>: UIImageView
    复制代码

*  **特殊的属性标识**

wv.EatProtocol?
    // 添加 w 将把属性标记为 weak, 除了 w 之外，还有 u/unowned、 c/class 和 s/static
    weak var <#name#>: EatProtocol?
    复制代码

*  **批量生成属性**

pl.UILabel{} *2
    // *2 中间不能有空格， 一般用于编写数据模型，或是编写 UI 时使用
    private let <#name#> = UILabel()
    private let <#name#> = UILabel()
    复制代码

> Tips： 如果属性没有写标记，会自动使用 let 来标记属性

.UIImageView 
    
     let <#name#>: UIImageView
    复制代码

#### Swift 属性标记快速查询表 ####

<table> 
 <thead> 
  <tr> 
   <th style="text-align:center;">符号</th> 
   <th style="text-align:center;">标记</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td style="text-align:center;">l</td> 
   <td style="text-align:center;">Let</td> 
  </tr> 
  <tr> 
   <td style="text-align:center;">v</td> 
   <td style="text-align:center;">var</td> 
  </tr> 
  <tr> 
   <td style="text-align:center;">p</td> 
   <td style="text-align:center;">private</td> 
  </tr> 
  <tr> 
   <td style="text-align:center;">P</td> 
   <td style="text-align:center;">public</td> 
  </tr> 
  <tr> 
   <td style="text-align:center;">o</td> 
   <td style="text-align:center;">open</td> 
  </tr> 
  <tr> 
   <td style="text-align:center;">f</td> 
   <td style="text-align:center;">fileprivate</td> 
  </tr> 
  <tr> 
   <td style="text-align:center;">pl</td> 
   <td style="text-align:center;">private let</td> 
  </tr> 
  <tr> 
   <td style="text-align:center;">pv</td> 
   <td style="text-align:center;">private var</td> 
  </tr> 
  <tr> 
   <td style="text-align:center;">ol</td> 
   <td style="text-align:center;">open let</td> 
  </tr> 
  <tr> 
   <td style="text-align:center;">Ov</td> 
   <td style="text-align:center;">open var</td> 
  </tr> 
  <tr> 
   <td style="text-align:center;">fl</td> 
   <td style="text-align:center;">fileprivate let</td> 
  </tr> 
  <tr> 
   <td style="text-align:center;">fv</td> 
   <td style="text-align:center;">fileprivate var</td> 
  </tr> 
  <tr> 
   <td style="text-align:center;">lv</td> 
   <td style="text-align:center;">Lazy var</td> 
  </tr> 
  <tr> 
   <td style="text-align:center;">--</td> 
   <td style="text-align:center;">--</td> 
  </tr> 
  <tr> 
   <td style="text-align:center;">@</td> 
   <td style="text-align:center;">@objc</td> 
  </tr> 
  <tr> 
   <td style="text-align:center;">u</td> 
   <td style="text-align:center;">unowned</td> 
  </tr> 
  <tr> 
   <td style="text-align:center;">w</td> 
   <td style="text-align:center;">weak</td> 
  </tr> 
  <tr> 
   <td style="text-align:center;">c</td> 
   <td style="text-align:center;">class</td> 
  </tr> 
  <tr> 
   <td style="text-align:center;">s</td> 
   <td style="text-align:center;">static</td> 
  </tr> 
 </tbody> 
</table>

#### Objective-C属性生成 ####

Objective-C 中的使用语法和 Swift 区别不大，主要是关键字和生成的样子不同

*  **单个属性**

.UIImageView *
    // 默认描述就是 nonatomic, strong
    @property (nonatomic, strong) UIImageView *<#name#>
    复制代码

*  **生成完整属性**

c.NSString *name;
    // 如果在末尾添加 ' ; ' 表示 Class 后面已经衔接了属性名， 为了方便快速编码
    @property (nonatomic, copy) NSString *name;
    复制代码

> Tips： class 可以用来标记类属性

#### Objective-C 属性标记快速查询表 ####

<table> 
 <thead> 
  <tr> 
   <th style="text-align:center;">符号</th> 
   <th style="text-align:center;">标记</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td style="text-align:center;">s</td> 
   <td style="text-align:center;">strong</td> 
  </tr> 
  <tr> 
   <td style="text-align:center;">w</td> 
   <td style="text-align:center;">weak</td> 
  </tr> 
  <tr> 
   <td style="text-align:center;">a</td> 
   <td style="text-align:center;">assign</td> 
  </tr> 
  <tr> 
   <td style="text-align:center;">r</td> 
   <td style="text-align:center;">readonly</td> 
  </tr> 
  <tr> 
   <td style="text-align:center;">g</td> 
   <td style="text-align:center;">getter=&lt;#getterName#&gt;</td> 
  </tr> 
  <tr> 
   <td style="text-align:center;">c</td> 
   <td style="text-align:center;">copy</td> 
  </tr> 
  <tr> 
   <td style="text-align:center;">n</td> 
   <td style="text-align:center;">nullable</td> 
  </tr> 
  <tr> 
   <td style="text-align:center;">N</td> 
   <td style="text-align:center;">nonnull</td> 
  </tr> 
  <tr> 
   <td style="text-align:center;">C</td> 
   <td style="text-align:center;">class</td> 
  </tr> 
 </tbody> 
</table>

--------------------

### 生成约束代码 ###

我选取了最常用的两个框架来实现， 在 Objective-C 中使用 Masonry，而在 Swift 当中使用 SnapKit。

#### SnapKit ####

*  **添加布局**

#snpm(iconView, e=self)
     // snpm 就是 makeConstraints， 在 （） 中使用，号来分割各个语句
     // 第一个参数是要添加约束的对象，剩下的都是布局语句
     // 每个语句都分为三个部分，左边是被约束对象的属性，中间是约束方式，
     // 而右边是约束的值或是其它的约束对象
     iconView.snp.makeConstraints {
        $0.edges.equalTo(self)
     }
    复制代码

*  **更新布局**

#snpu(iconView, h=100)
    // snpu 是 updateConstraints
    iconView.snp.updateConstraints {
        $0.height.equalTo(100)
    }
    复制代码

*  **重置布局**

#snprm(iconView, r=self - 20)
    // snprm 是 remakeConstraints
    iconView.snp.remakeConstraints {
        $0.right.equalTo(self).offset(-20)
    }
    复制代码

*  **布局演示 1 (相对距离)**

#snpm(iconView, r=titleLabel.l-20, wh=20)
    // 更加直观的使用 + - 来进行相对距离的设置
    iconView.snp.makeConstraints {
        $0.right.equalTo(titleLabel.snp.left).offset(-20)
        $0.width.height.equalTo(20)
    }
    复制代码

*  **布局演示 2 (+-的作用)**

#snpm(iconView, t=titleLabel.b-superView.height-20, wh=100)
    // 在约束语句中，第一个加减号除了有正负的含义，还是分割前后语句的标记
     iconView.snp.makeConstraints {
        $0.top.equalTo(titleLabel.snp.bottom).offset(-superView.height-20)
        $0.width.height.equalTo(100)
    }
    复制代码

*  **布局演示 3 (比例约束)**

#snpm(iconView, wh=self/2)
    // 进行比例约束也是常用的约束手法
    iconView.snp.makeConstraints {
        $0.width.height.equalTo(self).dividedBy(2)
    }
    
    // 相同作用 
    #snpm(iconView, wh=self*0.5)
    // 使用 * 法当然也是可以的
    iconView.snp.makeConstraints {
        $0.width.height.equalTo(self).multipliedBy(0.5)
    }
    复制代码

*  **布局演示 4 (比较)**

#snpm(titleLabel, tl=self, r<=self - 20)
    // 常用的根据文本的长度自适应宽度
    // 也可以使用 >= 表示大于等于
     titleLabel.snp.makeConstraints {
        $0.top.left.equalTo(self)
        $0.right.lessThanOrEqualTo(self).offset(-20)
    }
    复制代码

*  **布局演示 4 (约束等级)**

#snpm(iconView, l = self, r <= superView~20, r <= titleLabel.l - 20~h)
    // 在约束语句的最后使用 ～ 可以用来设置约束登记
    // 你可以使用数字来表示约束登记，也可以使用 r\h\m\l 来标记
     iconView.snp.makeConstraints {
        $0.left.equalTo(self)
        $0.right.lessThanOrEqualTo(superView).priority(20)
        $0.right.lessThanOrEqualTo(titleLabel.snp.left).offset(-20).priority(.high)
    }
    复制代码

#### SnapKit 属性标记快速查询表 ####

*  属性

<table> 
 <thead> 
  <tr> 
   <th>符号</th> 
   <th>属性</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>l</td> 
   <td>left</td> 
  </tr> 
  <tr> 
   <td>t</td> 
   <td>top</td> 
  </tr> 
  <tr> 
   <td>b</td> 
   <td>bottom</td> 
  </tr> 
  <tr> 
   <td>r</td> 
   <td>right</td> 
  </tr> 
  <tr> 
   <td>w</td> 
   <td>width</td> 
  </tr> 
  <tr> 
   <td>h</td> 
   <td>height</td> 
  </tr> 
  <tr> 
   <td>x</td> 
   <td>centerX</td> 
  </tr> 
  <tr> 
   <td>y</td> 
   <td>centerY</td> 
  </tr> 
  <tr> 
   <td>c</td> 
   <td>center</td> 
  </tr> 
  <tr> 
   <td>s</td> 
   <td>size</td> 
  </tr> 
  <tr> 
   <td>e</td> 
   <td>edges</td> 
  </tr> 
  <tr> 
   <td><strong>---</strong></td> 
   <td><strong>约束等级</strong></td> 
  </tr> 
  <tr> 
   <td>r</td> 
   <td>.required</td> 
  </tr> 
  <tr> 
   <td>h</td> 
   <td>.high</td> 
  </tr> 
  <tr> 
   <td>m</td> 
   <td>.medium</td> 
  </tr> 
  <tr> 
   <td>l</td> 
   <td>.low</td> 
  </tr> 
  <tr> 
   <td><strong>---</strong></td> 
   <td><strong>比较参数</strong></td> 
  </tr> 
  <tr> 
   <td>&gt;=</td> 
   <td>greaterThanOrEqualTo</td> 
  </tr> 
  <tr> 
   <td>&lt;=</td> 
   <td>lessThanOrEqualTo</td> 
  </tr> 
  <tr> 
   <td>=</td> 
   <td>equalTo</td> 
  </tr> 
  <tr> 
   <td><strong>---</strong></td> 
   <td><strong>运算符号</strong></td> 
  </tr> 
  <tr> 
   <td>-</td> 
   <td>Offset(-value)</td> 
  </tr> 
  <tr> 
   <td>+</td> 
   <td>Offset(value)</td> 
  </tr> 
  <tr> 
   <td>*</td> 
   <td>multipliedBy(value)</td> 
  </tr> 
  <tr> 
   <td>/</td> 
   <td>dividedBy(value)</td> 
  </tr> 
 </tbody> 
</table>

#### Masonry ####

主要的用法和 SnapKit 一致， 下面主要说不同点

*  **创建、更新、重置**

@masm(iconView, e=self)   // 创建
    @masu(iconView, e=self)    // 更新
    @masrm(iconView, e=self)  // 重置
    复制代码

> Tips: 在 OC 中可以使用 @ 作为命令的前缀，主要是 \# 在OC文件中会自动变第一列， 影响代码结构

*  **约束中没有 r 这个等级了**
 *  **比较里面新加了 == / >== / <==， 主要是相比少一个 = 的版本，在前面加上了 mas\_**

@masm(iconView, e=self)   // 创建
    @masu(iconView, e=self)    // 更新
    @masrm(iconView, e=self)  // 重置
    复制代码

### 视图的快速创建 ###

这部分使用 Xcode 的代码块也可以实现，但是写代码的时候，打出了对应的短语后还要看一眼和等待Xcode反应实在是令人着急。我们为的就是快！！！并且我们可以直接赋予视图一个变量名，而代码块还是不行的

通过 **\#make** 命令我们可以快速的添加创建一个 View 的代码

**这是目前支持的创建类型**

*  UIView
 *  UILabel
 *  UIButton
 *  UIImageView
 *  UITableView
 *  UICollectionView
 *  
 *  **普通创建 UIImageView**

#make(UIImageView)
    // 生成 Swift 视图
    let <#name#>  = UIImageView()
    <#name#>.backgroundColor = <#color#>
    <#name#>.image = <#image#>
    <#superView#>.addSubview(<#name#>)
    // 生成 OC 视图
    UIImageView *<#name#> = [[UIImageView alloc] init];
    self.<#name#> = <#name#>;
    <#name#>.backgroundColor = <#color#>;
    <#name#>.image = <#image#>;
    [<#superView#> addSubview: <#name#>];
    复制代码

*  **设置属性名创建 UILabel**

@make(UILabel, titleLabel)
    // 生成 Swift 视图
    let titleLabel = UILabel()
    titleLabel.font = <#font#>
    titleLabel.textColor = <#color#>
    titleLabel.text = <#text#>
    titleLabel.backgroundColor = <#color#>
    <#superView#>.addSubview(titleLabel)
    // 生成 OC 视图
    UILabel *titleLabel = [[UILabel alloc] init];
    self.titleLabel = titleLabel;
    titleLabel.font = <#font#>;
    titleLabel.textColor = <#color#>;
    titleLabel.text = <#text#>;
    titleLabel.backgroundColor = <#color#>;
    [<#superView#> addSubview:titleLabel];
    复制代码

### 创建方法 ###

#### Swift ####

*  **创建方法**

#func(eat)
    // 生成一个简单的方法
    func eat() {
        <#code#>
    }
    复制代码

*  **设定权限的方法**

#func(@p.run)
    // 标记和属性一样
    @objc private func run() {
        <#code#>
    }
    复制代码

*  **有参数的方法**

#func(run::)
    // 一个 ： 代表有一个参数
    func run(<#name#>: <#type#>, <#name#>: <#type#>) {
        <#code#>
    }
    复制代码

*  **有返回值的方法**

#func(run>)
    // 一个 > 代表有一个返回值
    func run() -> <#return#> {
        <#code#>
    }
    // 多个返回值会返回元组
    #func(run>>)
    func run() -> (<#return#>, <#return#>) {
        <#code#>
    }
    复制代码

#### Objective-C ####

*  **创建方法**

#func(run)
    // 生成一个简单的方法
    - (void)run {
        <#code#>
    }
    复制代码

*  **有返回值的方法**

#func(run>)
    // 一个 > 代表有一个返回值
    - (<#type#>)run {
        <#code#>
    }
    复制代码

*  **有参数的方法**

#func(run::)
    // 一个 ： 代表有一个参数
    - (void)run:(<#type#>)<#param0#> <#name1#>:(<#type#>)<#param1#> {
        <#code#>
    }
    复制代码

### 通用语法功能 ###

*  **批量处理：** 以上所有的命令都可以通过后接 \***n** 进行批量的生成
 *  **多命令执行：** 你可以通过 **+** 连续的编写多句命令一块生成

> **希望大家提出宝贵的意见和建议, 你可以提出 issue 或是发邮件到 [caishilin@yahoo.com][caishilin_yahoo.com]**

\#End

[FlyCoding - Xcode_ Emmet]: https://link.juejin.im?target=https%3A%2F%2Fgithub.com%2FSSBun%2FFlyCoding
[caishilin_yahoo.com]: https://link.juejin.im?target=mailto%3Acaishilin%40yahoo.com