前言

关于Swift的代码的相关规范，不同的开发者都有自己相应的规范，可能还是很多人根本就没有规范。为了保证同一个公司同一个项目组中代码美观并且一致，这里写下这份Swift编程规范指南。该指南首要目标是让代码紧凑，可读性更高且简洁。

代码格式

使用四个空格进行缩进

每行最多160个字符，这样可以避免一行过长（Xcode->Preferences->Text Editing->Page guide at column: 设置成160即可）
确保每个文件结尾都有空白行

确保每行都不以空白符作为结尾（Xcode->Preferences->Text Editing->Automatically trim trailing whitespace + Including whitespace-only lines）

左大括号不用另起一行

? 1 2 3 4 5 6 7 8 9 10 11 12 class SomeClass { func someMethod() { if x == y { } else if x == z { } else { } } }

要在逗号后面加空格

? 1 let array = [1, 2, 3, 4, 5];

二元运算符（+，==，或>）的前后都需要添加空格，左小括号和右小括号前面不需要空格。

? 1 2 3 4 5 6 7 let value = 20 + (34 / 2) * 3 if 1 + 1 == 2 { //TODO } func pancake -> Pancake { /** do something **/ }

遵守Xcode内置的缩进格式，当声明的一个函数需要跨多行时，推荐使用Xcode默认格式。

? 1 2 3 4 5 6 7 8 9 10 11 12 13 // Xcode针对跨多行函数声明缩进 func myFunctionWithManyParameters(parameterOne: String, parameterTwo: String, parameterThree: String) { // Xcode会自动缩进 print("\(parameterOne) \(parameterTwo) \(parameterThree)") } // Xcode针对多行 if 语句的缩进 if myFirstVariable > (mySecondVariable + myThirdVariable) && myFourthVariable == .SomeEnumValue { // Xcode会自动缩进 print("Hello, World!") }

当调用一个函数有多个参数时，每个参数另起一行，比函数名多一个缩进。

? 1 2 3 4 functionWithArguments( firstArgument: "Hello, I am a string", secondArgument: resultFromSomeFunction() thirdArgument: someOtherLocalVariable)

当遇到需要处理的数组或字典内容较多需要多行显示时，需要把[和]类似方法体里面的括号，方法体里的闭合也要做类似的处理。

? 1 2 3 4 5 6 7 8 9 10 11 12 13 functionWithBunchOfArguments( someStringArgument: "hello I am a string", someArrayArgument: [ "dadada daaaa daaaa dadada daaaa daaaa dadada daaaa daaaa", "string one is crazy - what is it thinking?" ], someDictionaryArgument: [ "dictionary key 1": "some value 1, but also some more text here", "dictionary key 2": "some value 2" ], someClosure: { parameter1 in print(parameter1) })

尽量避免出现多行断言，可使用本地变量或其他策略

? 1 2 3 4 5 6 7 8 9 10 11 12 13 // 推荐 let firstCondition = x == firstReallyReallyLongPredicateFunction() let secondCondition = y == secondReallyReallyLongPredicateFunction() let thirdCondition = z == thirdReallyReallyLongPredicateFunction() if firstCondition && secondCondition && thirdCondition { // 你要干什么 } // 不推荐 if x == firstReallyReallyLongPredicateFunction() && y == secondReallyReallyLongPredicateFunction() && z == thirdReallyReallyLongPredicateFunction() { // 你要干什么 }

命名

使用帕斯卡拼写法（又名大骆驼拼写法，首字母大写）为类型命名（如struct，enum，class，typedef，associatedtype等）。

使用小骆驼拼写法（首字母小写）为函数，方法，常亮，参数等命名。

首字母缩略词在命名中一般来说都是全部大写，例外的情形是如果首字母缩略词是一个命名的开始部分，而这个命名需要小写字母作为开头，这种情形下首字母缩略词全部小写。

? 1 2 3 4 5 6 7 8 // "HTML" 是变量名的开头, 需要全部小写 "html" let htmlBodyContent: String = "<p>Hello, World!</p>" // 推荐使用 ID 而不是 Id let profileID: Int = 1 // 推荐使用 URLFinder 而不是 UrlFinder class URLFinder { }

使用前缀 k + 大骆驼命名法 为所有非单例的静态常量命名。

? 1 2 3 4 5 6 7 8 9 class ClassName { // 基元常量使用 k 作为前缀 static let kSomeConstantHeight: CGFloat = 80.0 // 非基元常量也是用 k 作为前缀 static let kDeleteButtonColor = UIColor.redColor() // 对于单例不要使用k作为前缀 static let sharedInstance = MyClassName() }

命名应该具有描述性个清晰性的。

? 1 2 3 4 // 推荐 class RoundAnimatingButton: UIButton { } // 不推荐 class CustomButton: UIButton { }

不要缩写、简写或单个字母命名。

? 1 2 3 4 5 6 7 8 9 10 11 12 13 14 // 推荐 class RoundAnimatingButton: UIButton { let animationDuration: NSTimeInterval func startAnimating() { let firstSubview = subviews.first } } // 不推荐 class RoundAnimating: UIButton { let aniDur: NSTimeInterval func srtAnmating() { let v = subviews.first } }

如果原有命名不能明显表明类型，则属性命名内要包括类型信息。

? 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 // 推荐 class ConnectionTableViewCell: UITableViewCell { let personImageView: UIImageView let animationDuration: NSTimeInterval // 作为属性名的firstName，很明显是字符串类型，所以不用在命名里不用包含String let firstName: String // 虽然不推荐, 这里用 Controller 代替 ViewController 也可以。 let popupController: UIViewController let popupViewController: UIViewController // 如果需要使用UIViewController的子类，如TableViewController, CollectionViewController, SplitViewController, 等，需要在命名里标名类型。 let popupTableViewController: UITableViewController // 当使用outlets时, 确保命名中标注类型。 @IBOutlet weak var submitButton: UIButton! @IBOutlet weak var emailTextField: UITextField! @IBOutlet weak var nameLabel: UILabel! } // 不推荐 class ConnectionTableViewCell: UITableViewCell { // 这个不是 UIImage, 不应该以Image 为结尾命名。 // 建议使用 personImageView let personImage: UIImageView // 这个不是String，应该命名为 textLabel let text: UILabel // animation 不能清晰表达出时间间隔 // 建议使用 animationDuration 或 animationTimeInterval let animation: NSTimeInterval // transition 不能清晰表达出是String // 建议使用 transitionText 或 transitionString let transition: String // 这个是ViewController，不是View let popupView: UIViewController // 由于不建议使用缩写，这里建议使用 ViewController替换 VC let popupVC: UIViewController // 技术上讲这个变量是 UIViewController, 但应该表达出这个变量是TableViewController let popupViewController: UITableViewController // 为了保持一致性，建议把类型放到变量的结尾，而不是开始，如submitButton @IBOutlet weak var btnSubmit: UIButton! @IBOutlet weak var buttonSubmit: UIButton! // 在使用outlets 时，变量名内应包含类型名。 // 这里建议使用 firstNameLabel @IBOutlet weak var firstName: UILabel! }

当给函数参数命名时，要确保函数能够理解每个参数的目的。

代码风格

综合

尽可能多使用let，少使用var。
当需要遍历一个集合变形成另一个集合时，推荐使用函数flatMap，filter，和reduce。

? 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 // 推荐 let stringOfInts = [1, 2, 3].flatMap { String($0) } // ["1", "2", "3"] // 不推荐 var stringOfInts: [String] = [] for integer in [1, 2, 3] { stringOfInts.append(String(integer)) } // 推荐 let evenNumbers = [4, 8, 15, 16, 23, 42].filter { $0 % 2 == 0 } // [4, 8, 16, 42] // 不推荐 var evenNumbers: [Int] = [] for integer in [4, 8, 15, 16, 23, 42] { if integer % 2 == 0 { evenNumbers(integer) } }

如果变量类型可以依靠判断得出，不建议声明变量时指明类型。

如果一个函数有多个返回值，推荐使用 元组 而不是inout参数，如果这个元组在多个地方都会使用，建议使用typealias来定义这个元组，而如果返回的元组有三个或者三个以上的元素，建议使用结构体或类。

? 1 2 3 4 5 6 func pirateName() -> (firstName: String, lastName: String) { return ("Guybrush", "Threepwood") } let name = pirateName() let firstName = name.firstName let lastName = name.lastName

当使用委托和协议时，请注意避免出现循环引用，基本上是在定义属性的时候使用weak修饰。

在闭包里使用self的时候需要注意避免出现循环引用，使用捕获列表可以避免这一点。

? 1 2 3 4 5 6 7 8 9 functionWithClosure() { [weak self] (error) -> Void in // 方案 1 self?.doSomething() // 或方案 2 guard let strongSelf = self else { return } strongSelf.doSomething() }

switch 模块中不用显式使用break。

断言流程控制的时候不要使用小括号。

? 1 2 3 4 5 6 7 8 // 推荐 if x == y { } // 不推荐 if (x == y) { }

在写枚举类型的时候，尽量简写。

? 1 2 3 4 // 推荐 imageView.setImageWithURL(url, type: .person) // 不推荐 imageView.setImageWithURL(url, type: AsyncImageView.Type.person)

在使用类方法的时候不用简写，因为类方法和枚举类型不一样，不能轻易地推导出上下文。

? 1 2 3 4 // 推荐 imageView.backgroundColor = UIColor.whiteColor() // 不推荐 imageView.backgroundColor = .whiteColor()

不建议使用self，除非必须得要。

在写一个方法的时候，需要衡量这个方法将来是否会被重写，如果不是请用final关键字修饰，这样组织方法被重写。一般来说final修饰符可以优化编译速度，在合适的时候大胆的使用它吧。需要注意的是，在一个公开发布的代码库中使用final和在本地项目中使用final的影响差别很大。

在使用一些语句如else，catch等紧随代码块关键字的时候，确保代码块和关键字在同一行。

? 1 2 3 4 5 6 7 8 9 10 if someBoolean { // 你想要什么 } else { // 你不想做什么 } do { let fileContents = try readFile("filename.txt") } catch { print(error) }

访问控制修饰符

如果需要把访问修饰符放到第一个位置。

? 1 2 3 4 // 推荐 private static let kMyPrivateNumber: Int // 不推荐 static private let kMyPrivateNumber: Int

访问修饰符不应该单独另起一行，应和访问修饰符描述的对象保持在同一行。

? 1 2 3 4 5 6 7 8 9 // 推荐 public class Pirate { } // 不推荐 public class Pirate { }

默认的访问修饰符是internal，可省略不写。

当一个变量需要被单元测试 访问时，需要声明为 internal 类型来使用@testable import {ModuleName}。 如果一个变量实际上是private 类型，而因为单元测试需要被声明为 internal 类型，确定添加合适的注释文档来解释为什么这么做。这里添加注释推荐使用 - warning: 标记语法。

? 1 2 3 4 5 /** 这个变量是private 名字 - warning: 定义为 internal 而不是 private 为了 `@testable`. */ let pirateName = "LeChuck"

自定义操作符

不推荐使用自定义操作符，如果需要创建函数代替。

在重写操作符之前，请慎重考虑是否有充分的理由一定要在全局范围内创建新的操作符，而不是使用其他策略。

你可以重载现有的操作符来支持新的类型（特别是==），但是新定义的必须保留操作符原来的含义，比如==必须用来测试是否相等并返回布尔值。

switch语句和枚举

使用swift语句时，如果选项是有限集合时，不要使用default，相反的，把一些不用的选项放到底部，并用break关键词阻止其执行。

应为swift中的switch选项默认是包含break的，所以不需要使用break关键字。

case 语句 应和 switch 语句左对齐，并在 标准的 default 上面。

当定义的选项有关联值时，确保关联值有恰当的名称，而不只是类型。

? 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 enum Problem { case attitude case hair case hunger(hungerLevel: Int) } func handleProblem(problem: Problem) { switch problem { case .attitude: print("At least I don't have a hair problem.") case .hair: print("Your barber didn't know when to stop.") case .hunger(let hungerLevel): print("The hunger level is \(hungerLevel).") } }

推荐尽可能使用fall through。

如果default 的选项不应该触发，可以抛出错误 或 断言类似的做法。

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

可选类型

唯一使用隐式拆包可选型的场景是结合@IBOutlets，在其他场景使用非可选类型和常规可选类型，即使有的场景你确定有的变量使用的时候永远不会为nil，但这样做可以保持一致性和程序更加健壮。

不要使用as!和try!，除非万不得已。

如果对于一个变量你不打算声明为可选类型，但当需要检查变量值是否为nil，推荐使用当前值和nil直接比较，而不推荐使用if let的语法。并且nil在前变量在后。

? 1 2 3 4 5 6 7 8 // 推荐 if nil != someOptional { // 你要做什么 } // 不推荐 if let _ = someOptional { // 你要做什么 }

不要使用unowned，unowned和weak修饰变量基本上等价，并且都是隐式拆包（unowned在引用计数上有少许性能优化），由于不推荐使用隐式拆包，也不推荐使用unowned变量。

? 1 2 3 4 5 6 7 8 9 // 推荐 weak var parentViewController: UIViewController? // 不推荐 weak var parentViewController: UIViewController! unowned var parentViewController: UIViewController guard let myVariable = myVariable else { return }

协议

在实现协议的时候，有两种方式来组织你的代码：

使用//MAKR:注释来实现分割协议和其他代码。

使用 extension 在 类/结构体已有代码外，但在同一个文件内。

请注意 extension 内的代码不能被子类重写，这也意味着测试很难进行。 如果这是经常发生的情况，为了代码一致性最好统一使用第一种办法。否则使用第二种办法，其可以代码分割更清晰。使用而第二种方法的时候，使用 // MARK: 依然可以让代码在 Xcode 可读性更强。

属性

对于只读属性，提供getter而不是get{}。

? 1 2 3 4 5 6 var computedProperty: String { if someBool { return "I'm a mighty pirate!" } return "I'm selling these fine leather jackets." }

对于属性相关方法 get {}, set {}, willSet, 和 didSet, 确保缩进相关代码块。

对于willSet/didSet 和 set 中的旧值和新值虽然可以自定义名称，但推荐使用默认标准名称 newValue/oldValue。

? 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 var computedProperty: String { get { if someBool { return "I'm a mighty pirate!" } return "I'm selling these fine leather jackets." } set { computedProperty = newValue } willSet { print("will set to \(newValue)") } didSet { print("did set from \(oldValue) to \(newValue)") } }

在创建常量的时候，使用static关键字修饰。

? 1 2 3 4 class MyTableViewCell: UITableViewCell { static let kReuseIdentifier = String(MyTableViewCell) static let kCellHeight: CGFloat = 80.0 }

声明单例属性可以通过下面方式进行：

? 1 2 3 4 class PirateManager { static let sharedInstance = PirateManager() }

闭包

如果参数的类型很明显，可以在函数名里可以省略参数类型, 但明确声明类型也是允许的。 代码的可读性有时候是添加详细的信息，而有时候部分重复，根据你的判断力做出选择吧，但前后要保持一致性。

? 1 2 3 4 5 6 7 8 9 10 // 省略类型 doSomethingWithClosure() { response in print(response) } // 明确指出类型 doSomethingWithClosure() { response: NSURLResponse in print(response) } // map 语句使用简写 [1, 2, 3].flatMap { String($0) }

如果使用捕捉列表 或 有具体的非 Void返回类型，参数列表应该在小括号内， 否则小括号可以省略。

? 1 2 3 4 5 6 7 8 // 因为使用捕捉列表，小括号不能省略。 doSomethingWithClosure() { [weak self] (response: NSURLResponse) in self?.handleResponse(response) } // 因为返回类型，小括号不能省略。 doSomethingWithClosure() { (response: NSURLResponse) -> String in return String(response) }

如果闭包是变量类型，不需把变量值放在括号中，除非需要，如变量类型是可选类型(Optional?)， 或当前闭包在另一个闭包内。确保闭包里的所以参数放在小括号中，这样()表示没有参数，Void 表示不需要返回值。

? 1 2 3 4 5 6 7 let completionBlock: (success: Bool) -> Void = { print("Success? \(success)") } let completionBlock: () -> Void = { print("Completed!") } let completionBlock: (() -> Void)? = nil

数组

基本上不要通过下标直接访问数组内容，如果可能使用.first或.last，因为这些方法是非强制类型并不会奔溃。推荐尽可能使用 for item in items 而不是 for i in 0..n。

不是使用+=或+操作符给数组添加新元素，使用性能较好的.append()或appendContentsOf()，如果需要声明数组基于其他数组并保持不可变类型，使用let myNewArray = [arr1, arr2].flatten()，而不是let myNewArray = arr1 + arr2 。

错误处理

假设一个函数 myFunction 返回类型声明为 String，但是总有可能函数会遇到error，有一种解决方案是返回类型声明为 String?, 当遇到错误的时候返回 nil。

? 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 func readFile(withFilename filename: String) -> String? { guard let file = openFile(filename) else { return nil } let fileContents = file.read() file.close() return fileContents } func printSomeFile() { let filename = "somefile.txt" guard let fileContents = readFile(filename) else { print("不能打开 \(filename).") return } print(fileContents) }

实际上如果预知失败的原因，我们应该使用Swift 中的 try/catch 。

定义 错误对象 结构体如下:

? 1 2 3 4 5 6 7 8 9 10 11 12 struct Error: ErrorType { public let file: StaticString public let function: StaticString public let line: UInt public let message: String public init(message: String, file: StaticString = #file, function: StaticString = #function, line: UInt = #line) { self.file = file self.function = function self.line = line self.message = message } }

使用案例:

? 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 func readFile(withFilename filename: String) throws -> String { guard let file = openFile(filename) else { throw Error(message: “打不开的文件名称 \(filename).") } let fileContents = file.read() file.close() return fileContents } func printSomeFile() { do { let fileContents = try readFile(filename) print(fileContents) } catch { print(error) } }

其实项目中还是有一些场景更适合声明为可选类型，而不是错误捕捉和处理，比如在获取远端数据过程中遇到错误，nil作为返回结果是合理的，也就是声明返回可选类型比错误处理更合理。

整体上说，如果一个方法有可能失败，并且使用可选类型作为返回类型会导致错误原因湮没，不妨考虑抛出错误而不是吃掉它。

使用 guard 语句

总体上，我们推荐使用提前返回的策略，而不是 if 语句的嵌套。使用 guard 语句可以改善代码的可读性。

? 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 // 推荐 func eatDoughnut(atIndex index: Int) { guard index >= 0 && index < doughnuts else { // 如果 index 超出允许范围，提前返回。 return } let doughnut = doughnuts[index] eat(doughnut) } // 不推荐 func eatDoughnuts(atIndex index: Int) { if index >= 0 && index < donuts.count { let doughnut = doughnuts[index] eat(doughnut) } }

在解析可选类型时，推荐使用 guard 语句，而不是 if 语句，因为 guard 语句可以减少不必要的嵌套缩进。

? 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 // 推荐 guard let monkeyIsland = monkeyIsland else { return } bookVacation(onIsland: monkeyIsland) bragAboutVacation(onIsland: monkeyIsland) // 不推荐 if let monkeyIsland = monkeyIsland { bookVacation(onIsland: monkeyIsland) bragAboutVacation(onIsland: monkeyIsland) } // 禁止 if monkeyIsland == nil { return } bookVacation(onIsland: monkeyIsland!) bragAboutVacation(onIsland: monkeyIsland!)

当解析可选类型需要决定在 if 语句 和 guard 语句之间做选择时，最重要的判断标准是是否让代码可读性更强，实际项目中会面临更多的情景，如依赖 2 个不同的布尔值，复杂的逻辑语句会涉及多次比较等，大体上说，根据你的判断力让代码保持一致性和更强可读性， 如果你不确定 if 语句 和 guard 语句哪一个可读性更强，建议使用 guard 。

? 1 2 3 4 5 6 7 8 9 10 11 12 // if 语句更有可读性 if operationFailed { return } // guard 语句这里有更好的可读性 guard isSuccessful else { return } // 双重否定不易被理解 - 不要这么做 guard !operationFailed else { return }

如果需要在2个状态间做出选择，建议使用if 语句，而不是使用 guard 语句。

? 1 2 3 4 5 6 7 8 9 10 11 12 // 推荐 if isFriendly { print("你好, 远路来的朋友！") } else { print(“穷小子，哪儿来的？") } // 不推荐 guard isFriendly else { print("穷小子，哪儿来的？") return } print("你好, 远路来的朋友！")

你只应该在在失败情形下退出当前上下文的场景下使用 guard 语句，下面的例子可以解释 if 语句有时候比 guard 语句更合适 – 我们有两个不相关的条件，不应该相互阻塞。

? 1 2 3 4 5 6 if let monkeyIsland = monkeyIsland { bookVacation(onIsland: monkeyIsland) } if let woodchuck = woodchuck where canChuckWood(woodchuck) { woodchuck.chuckWood() }

我们会经常遇到使用 guard 语句拆包多个可选值，如果所有拆包失败的错误处理都一致可以把拆包组合到一起 (如 return, break, continue,throw 等)。

? 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 // 组合在一起因为可能立即返回 guard let thingOne = thingOne, let thingTwo = thingTwo, let thingThree = thingThree else { return } // 使用独立的语句 因为每个场景返回不同的错误 guard let thingOne = thingOne else { throw Error(message: "Unwrapping thingOne failed.&qu