Swift 代碼規范

Swift,蘋果于2014年WWDC蘋果開發者大會發布的新開發語言,可與Objective-C共同運行于macOS和iOS平臺,用于搭建基于蘋果平臺的應用程序。
Swift是一款易學易用的編程語言,而且它還是第一套具有與腳本語言同樣的表現力和趣味性的系統編程語言。Swift的設計以安全為出發點,以避免各種常見的編程錯誤類別。
2015年12月4日,蘋果公司宣布其Swift編程語言開放源代碼。長600多頁的The Swift Programming Language 可以在線免費下載。

一. 命名

  1. 類型
  • 類型名稱(如 struct, enum, class, typedef, associatedtype, protocol 等)使用大駝峰命名法命名。
  • 變量和常量則以小駝峰命名法命名。
enum GenderType {
    
    case male
    case female
}

struct Person {
    
    var gender: GenderType?
}

  1. 協議
  • 根據蘋果接口設計指導準則,協議名稱用來描述一些東西是什么的時候是名詞,例如:Collection, WidgetFactory。若協議名稱用來描述能力應該以 -ing, -able, 或 -ible 結尾,例如:Equatable, Resizing

  1. 類前綴
  • Swift中類別(類,結構體)在編譯時會把模塊設置為默認的命名空間,所以不用為了區分類別而添加前綴,比如RW。
  • 如果擔心來自不同模塊的兩個名稱發生沖突,可以在使用時添加模塊名稱來區分。注意不要濫用模塊名稱,僅在有可能發生沖突或疑惑的場景下使用。如:
import ToolsModule 
let myClass = ToolsModule.UsefulClass()

  1. 參數命名
  • Delegate
    在定義代理方法時,第一個未命名參數應是代理數據源。

正確代碼:

func namePickerView(_ namePickerView: NamePickerView, didSelectName name: String)
func namePickerViewShouldReload(_ namePickerView: NamePickerView) -> Bool

錯誤代碼:

func didSelectName(namePicker: NamePickerViewController, name: String)
func namePickerShouldReload() -> Bool
  • 泛型
    泛型類參數應具有描述性,遵守“大駱駝命名法”。如果一個參數名沒有具體的含義,可以使用傳統單大寫字符,如T, U, 或V等。

正確代碼:

struct Stack<Element>{ ... }
func writeTo <Target: OutputStream>(to Target: inout Target)
func swap(_ a: inout T, _ b: inout T) 

錯誤代碼:

struct Stack<T>{ ... }
func write<target: OutputStream> (to target: inout target)
func swap<Thing>(_ a: inout Thing, _ b: inout Thing)

二. 代碼邏輯

  1. 類型推斷
  • 盡量使用類型推斷以減少多余的冗余類型信息,例如:

正確代碼:

let currentLocation = Location()

錯誤代碼:

let currentLocation: Location = Location()

  1. self推斷
  • 讓編譯器在所有允許的地方推斷 self
  • 在 init 中設置參數時顯性地使用 self
  • 在 non-escaping closures 中顯性地使用 self
  • 在避免命名沖突時使用 self
    例如:
class BoardLocation  {
    let row: Int
    let column: Int
    init(row: Int, column: Int)  {
        self.row = row
        self.column = column
        let closure = {
            print(self.row)    
         }  
    }
}

  1. 常量
  • 類常量應該在類型里聲明為static。使用static修飾常量可以允許他們在被引用的時候不需要實例化類型。
  • 除了單例以外,應盡量避免生成全局常量。
  • 定義常量使用 let 關鍵字,定義變量使用 var 關鍵字, 如果變量的值未來不會發生變化要使用常量。
struct PhysicsModel {
    static var speedOfLightInAVacuum = 300
}
 
class Spaceship {
    static let topSpeed = PhysicsModel.speedOfLightInAVacuum
    var speed: Double?
    func fullSpeedAhead() {
        speed = Spaceship.topSpeed
    }
}

  1. 計算型類型屬性
  • 當只需要繼承 getter 方法時,返回簡單的 Computed 屬性即可。

正確代碼:

class Example {
    var age: UInt32 {
        return arc4random()
    }
}

錯誤代碼:

class Example {
    var age: UInt32 {
        get {
            return arc4random()
        }
    }
}
  • 如果你在屬性中添加了 set 或者 didSet ,那么你應該顯示地提供 get 方法。
class Person {
    var age: Int {
        get {
            return Int(arc4random())
        }
        set {
            print("That's not your age.")
        }
    }
}

  1. 單例
  • Swift中單例很簡單,Swift 的 runtime 會保證單例的創建并且采用線程安全的方式訪問:
class ControversyManager {
    static let shared = ControversyManager()
}
  • 單例通常只需要訪問"shared"的靜態屬性,除非你有不得已的原因去重命名它。注意,不要用靜態函數或者全局函數去訪問你的單例。

  1. 錯誤處理
  • 可以使用do/try/catch機制,避免使用try!和try?

  1. 可選值
  • 聲明一個函數的某個參數可以為 nil 時,用?
  • 當你確定某個變量在使用時已經確定不是 nil 時,在后面加!

  1. 擴展聲明周期
  • 用 [weak self] 和 guard let strongSelf = self else { return } 模式擴展生命周期。用 [weak self] 比 [unowned self] 更好。

正確代碼:

resource.request().onComplete { [weak self] response in
  guard let strongSelf = self else { return }
  let model = strongSelf.updateModel(response)
  strongSelf.updateUI(model)
}

錯誤代碼:

// might crash if self is released before response returns
resource.request().onComplete { [unowned self] response in
  let model = self.updateModel(response)
  self.updateUI(model)
}
// deallocate could happen between updating the model and updating UI
resource.request().onComplete { [weak self] response in
  let model = self?.updateModel(response)
  self?.updateUI(model)
}

三. 代碼結構

  1. 注釋
  • 使用Xcode8自帶的注釋功能,快捷鍵Option+Command+/
  • 使用// MARK:分隔代碼(類似于OC中的#pragma mark)

  1. 縮進
  • 遵守Xcode內置的縮進格式

  1. 類型
  • 優先使用Swift原生類型,可以根據需要使用Objective-C提供的方法,因為Swift提供了到Objective-C的橋接 。

正確代碼:

let width = 120.0  // Double
let widthString = (width as NSNumber).stringValue // String

錯誤代碼:

let width: NSNumber = 120.0 // NSNumber
let widthString: NSString = width.stringValue  // NSString

  1. 協議一致性
  • 當一個對象要實現協議一致性時,推薦使用 extension 隔離協議中的方法集,這樣讓相關方法和協議集中顯示在一起,也簡化了類支持一個協議和實現相關方法的流程。

正確代碼:

class ViewController: UIViewController {
      // 方法
} 

extension ViewController: UITableViewDataSource {
      // UITableViewDataSource 方法
}

extension ViewController: UIScrollViewDelegate {
      // UIScrollViewDelegate 方法
} 

錯誤代碼:

class ViewController: UIViewController, UITableViewDataSource, UIScrollViewDelegate {
      // 所有方法
} 

  1. 良好的定義
  • 屬性,變量,常量和參數等在聲明定義時,其中: 符號后有空格,而: 符號前沒有空格,比如x: Int, 和Circle: Shape
  • 定義多個變量/數據結構時,出于相同的目的和上下文,可以定義在同一行。
  • 縮進 getter,setter 的定義和屬性觀察器的定義。
  • 不需要添加internal這樣的默認的修飾符。也不需要在重寫一個方法時添加訪問修飾符。
  • 給那些不打算被繼承的類使用final修飾符
final class Circle: Shape {
  var x: Int
  var y: Int
  var radius: Double
  var diameter: Double {
      get {
        returnradius * 2
     } 
     set {      
        radius=newValue/2
    }  
  }
  init(x: Int, y: Int, radius: Double) {
      self.x = x
      self.y = y
      self.radius = radius  
  }

  convenience init(x: Int, y: Int, diameter: Double) {
     self.init(x: x, y: y, radius: diameter/2)  
  }

  func describe() -> String{
    return"I am a circle at\(centerString())with an area of\(computeArea())"
  }
  override func computeArea() -> Double{
    return M_PI * radius * radius  
  }

  private func centerString()->String{
    return "(\(x),\(y))"
  }
}

  1. 控制流程
  • 循環使用for-in表達式,而不使用 while 表達式。

正確代碼:

for _ in 0..<3 {
  print("Hello three times")
}
for(index, person) in attendeeList.enumerate() {
    print("\(person)is at position #\(index)")
}
for index in 0.stride(from: 0, to: items.count, by: 2) {
  print(index)
}
for index in (0...3).reverse() {
    print(index)
}

錯誤代碼:

var i=0 
while i<3 {
  print("Hello three times") 
  i+=1
}
var i=0
while i<3 {
  let person = attendeeList[i]
  print("\(person)is at position #\(i)")  
  i+=1
}
  • Switch 模塊中不用顯式使用break。

  1. 黃金路徑
  • 當編碼遇到條件判斷時,左邊的距離是黃金路徑或幸福路徑,因為路徑越短,速度越快。不要嵌套if循環,多個返回語句是可以的。guard 就為此而生的。

正確代碼:

func computeFFT(context: Context?, inputData: InputData?)  throws -> Frequencies {
    guard let context = context else {throwFFTError.NoContext }

   guard let inputData = inputData else { throwFFTError.NoInputData }

  //計算frequencies
  return frequencies
}

錯誤代碼:

func computeFFT(context: Context?, inputData: InputData?) throws -> Frequencies {
if let context = context {
    if let inputData = inputData {
           // 計算frequencies
          return frequencies    
    } else {
         throwFFTError.NoInputData    
     }  
   } else {
      throwFFTError.NoContext  
   }
}
  • 當有多個條件需要用 guard 或 if let 解包,可用復合語句避免嵌套。
guard let number1=number1, number2=number2, number3=number3 else{
    fatalError("impossible") 
}
// 處理number

  1. 語法糖
//對空的數據和字典,使用類型注解
var names:  [String] = []
var lookup:  [String: Int] = [:]

var deviceModels: [String]
var employees: [Int : String]
var faxNumber: Int?

  1. 函數
  • 自由函數不依附于任何類或類型,應該節制地使用。

正確代碼:

let sorted = items.mergeSort() // 易發現性
rocket.launch()  // 可讀性

錯誤代碼:

let sorted = mergeSort(items)// 不易被發現
launch(&rocket)

天然的自由函數:

let value = max(x,y,z)  // another free function that feels natural

?著作權歸作者所有,轉載或內容合作請聯系作者
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 227,572評論 6 531
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 98,071評論 3 414
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 175,409評論 0 373
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 62,569評論 1 307
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 71,360評論 6 404
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 54,895評論 1 321
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 42,979評論 3 440
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 42,123評論 0 286
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 48,643評論 1 333
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 40,559評論 3 354
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 42,742評論 1 369
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,250評論 5 356
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 43,981評論 3 346
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,363評論 0 25
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 35,622評論 1 280
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 51,354評論 3 390
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 47,707評論 2 370

推薦閱讀更多精彩內容