参考：linkedin/swift-style-guide 因为规范主要参照谷歌的 style guide 执行，所以有一些谷歌没提到的，linkedin 提到的就补充进来。

Code Formatting

如果是多个条件判断语句，提前用变量表示判断条件。最后组合变量组合复合条件判断，而不是在一个语句中引入复杂的条件判断：

  1. ✅
  2. let firstCondition = x == firstReallyReallyLongPredicateFunction()
  3. let secondCondition = y == secondReallyReallyLongPredicateFunction()
  4. let thirdCondition = z == thirdReallyReallyLongPredicateFunction()
  5. if firstCondition && secondCondition && thirdCondition {
  6.     // do something
  7. }
  9. ❌
  10. if x == firstReallyReallyLongPredicateFunction()
  11.     && y == secondReallyReallyLongPredicateFunction()
  12.     && z == thirdReallyReallyLongPredicateFunction() {
  13.     // do something
  14. }

命名

  • 不要像 OC 一样在类的前面添加命名空间前缀。

  • 泛型和协议中的 associatedtype 使用帕斯卡命名方式，如果 associatedtype 是一个常见的类型，在后面加上 “Type” 后缀表示区分。

  1. protocol Modelable {
  2.     associatedtype Model
  3. }
  4. protocol Sequence {
  5.     associatedtype IteratorType: Iterator
  6. }
  • 命名应该要描述出含义，避免歧义。
  1. ✅
  2. class RoundAnimatingButton: UIButton { /* ... */ }
  4. ❌
  5. class CustomButton: UIButton { /* ... */ }
  • 不要使用别人不理解的缩写，或者只有一个字母的名称。
  1. ❌
  2. class RoundAnimating: UIButton {
  3.     let aniDur: NSTimeInterval
  5.     func srtAnmating() {
  6.         let v = subviews.first
  7.     }
  8. }
  • 常量、变量的类型信息如果不明显并且会引起歧义，在名称中加入类型信息。
  1. ✅
  2. class ConnectionTableViewCell: UITableViewCell {
  3.     let personImageView: UIImageView
  5.     let animationDuration: TimeInterval
  7.     // 名字是字符串非常明显，不需要补充类型信息
  8.     let firstName: String
  10.     // 需要让人看出是一个 Controller，至于是不是叫 ViewController 则都可以接受
  11.     let popupController: UIViewController
  12.     let popupViewController: UIViewController
  14.     // 需要显式让调用者知道属性的具体类型时，也把类型信息信息写到命名中
  15.     let popupTableViewController: UITableViewController
  17.     // 应该总是让人看出是一个类型的对象
  18.     @IBOutlet weak var submitButton: UIButton!
  19.     @IBOutlet weak var emailTextField: UITextField!
  20.     @IBOutlet weak var nameLabel: UILabel!
  22. }
  1. ❌
  2. class ConnectionTableViewCell: UITableViewCell {
  3.     // 这样会让人以为是图片，而不是图片控件
  4.     let personImage: UIImageView
  6.     // 这样会让人以为是一个字符串
  7.     let text: UILabel
  9.     // 这个名称会让人不知道应该使用什么赋值，animation 与 interval 完全不相关。
  10.     let animation: TimeInterval
  12.     // 这里是一个需要展示的文本，应该命名为 `transitionText` 或者 `transitionString`
  13.     let transition: String
  15.     // 这会让人误以为是一个 UIView 对象
  16.     let popupView: UIViewController
  18.     // 不要使用缩写，所以缩写成 VC 不好
  19.     let popupVC: UIViewController
  21.     // 显式的让外面知道这是一个 TableViewController
  22.     let popupViewController: UITableViewController
  24.     // 为了保持一致性，所有的类型都写在末尾
  25.     @IBOutlet weak var btnSubmit: UIButton!
  26.     @IBOutlet weak var buttonSubmit: UIButton!
  28.     // outlet 应该总是有类型信息在末尾，这里应该是改成 firstNameLabel
  29.     @IBOutlet weak var firstName: UILabel!
  30. }

Coding Style

常规

  • 灵活运用函数式操作 map, filter, reduce 等。
  1. ✅
  2. let stringOfInts = [1, 2, 3].flatMap { String($0) }
  3. // ["1", "2", "3"]
  5. ❌
  6. var stringOfInts: [String] = []
  7. for integer in [1, 2, 3] {
  8.     stringOfInts.append(String(integer))
  9. }
  11. ✅
  12. let evenNumbers = [4, 8, 15, 16, 23, 42].filter { $0 % 2 == 0 }
  13. // [4, 8, 16, 42]
  15. ❌
  16. var evenNumbers: [Int] = []
  17. for integer in [4, 8, 15, 16, 23, 42] {
  18.     if integer % 2 == 0 {
  19.         evenNumbers.append(integer)
  20.     }
  21. }
  • 如果一个枚举的实参可以被推断，尽量使用缩写。
  1. ✅
  2.  imageView.imageView.setImageWithURLsetImageWithURL(url, type: .person)
  4. ❌
  5.  imageView.imageView.setImageWithURLsetImageWithURL(url, type: AsyncImageView.Type.person)

  • 正常环境下访问实例的成员不要声明 self. 。

  • 如果一个函数没有参数，没有副作用，只返回一个值，推荐使用计算属性。

访问修饰符

  • 访问修饰符写在修饰符的前面，默认不用写 internal。

自定义操作符

优先创建函数而不是自定义操作符。

Switch、Enum

  • Switch 中的 case 语句默认就有 break 的功能，所以不需要特别声明 break。

  • 如果 Enum 关联类型，尽量给关联类型命名带上标签。比如：case hunger(hungerLevel: Int) 比 case hunger(Int) 好。

  • 如果有一个 case 不应该到达，可以在语句中抛出异常。

  1. func handleDigit(_ digit: Int) throws {
  2.     switch digit {
  3.     case 0, 1, 2, 3, 4, 5, 6, 7, 8, 9:
  4.         print("Yes, \(digit) is a digit!")
  5.     default:
  6.         throw Error(message: "The given number was not a digit.")
  7.     }
  8. }

Optional

  • 如果只是判断值是不是为空，使用 != nil 判断。
  1. ✅
  2. if someOptional != nil {
  3.     // do something
  4. }
  5. ❌
  6. if let _ = someOptional {
  7.     // do something
  8. }
  • 解包时推荐使用原有的名字。
  1. ✅
  2. guard let myValue = myValue else { return }

在 Extension 中实现 Protocol 要慎重

选择在 Extension 中实现 Protocol 的方法不能被 override，选择这种方式要考虑到未来是否有被 override 的可能。

Guard

  • 如果解包的值后面的逻辑需要使用，推荐使用 guard 而不是 if。
  1. ✅
  2. guard let monkeyIsland = monkeyIsland else { return }
  3. bookVacation(on: monkeyIsland)
  4. bragAboutVacation(at: monkeyIsland)
  6. ❌
  7. if let monkeyIsland = monkeyIsland {
  8.     bookVacation(on: monkeyIsland)
  9.     bragAboutVacation(at: monkeyIsland)
  10. }
  12. ❌
  13. if monkeyIsland == nil { return }
  14. bookVacation(on: monkeyIsland!)
  15. bragAboutVacation(at: monkeyIsland!)
  • 如果是一个逻辑分支，应该使用 if 。
  1. ✅
  2. if isFriendly {
  3.     print("Hello, nice to meet you!")
  4. } else {
  5.     print("You have the manners of a beggar.")
  6. }
  8. ❌
  9. guard isFriendly else {
  10.     print("You have the manners of a beggar.")
  11.     return
  12. }
  13. print("Hello, nice to meet you!")