扩展（Extensions）

1.0
翻译：lyuka
校对：Hawstein

2.0
翻译+校对：shanks

2.1
校对：shanks

2.2
翻译+校对：SketchK 2016-05-16
3.0.1，shanks，2016-11-13

4.0
校对：kemchenj 2017-09-21

本页包含内容：

扩展 就是为一个已有的类、结构体、枚举类型或者协议类型添加新功能。这包括在没有权限获取原始源代码的情况下扩展类型的能力（即 逆向建模 ）。扩展和 Objective-C 中的分类类似。（与 Objective-C 不同的是，Swift 的扩展没有名字。）

Swift 中的扩展可以：

  • 添加计算型属性和计算型类型属性
  • 定义实例方法和类型方法
  • 提供新的构造器
  • 定义下标
  • 定义和使用新的嵌套类型
  • 使一个已有类型符合某个协议

在 Swift 中，你甚至可以对协议进行扩展，提供协议要求的实现，或者添加额外的功能，从而可以让符合协议的类型拥有这些功能。你可以从协议扩展获取更多的细节。

注意
扩展可以为一个类型添加新的功能，但是不能重写已有的功能。

扩展语法

使用关键字 extension 来声明扩展：

  1. extension SomeType {
  2.     // 为 SomeType 添加的新功能写到这里
  3. }

可以通过扩展来扩展一个已有类型，使其采纳一个或多个协议。在这种情况下，无论是类还是结构体，协议名字的书写方式完全一样：

  1. extension SomeType: SomeProtocol, AnotherProctocol {
  2.     // 协议实现写到这里
  3. }

通过这种方式添加协议一致性的详细描述请参阅利用扩展添加协议一致性。

注意
如果你通过扩展为一个已有类型添加新功能，那么新功能对该类型的所有已有实例都是可用的，即使它们是在这个扩展定义之前创建的。

计算型属性

扩展可以为已有类型添加计算型实例属性和计算型类型属性。下面的例子为 Swift 的内建 Double 类型添加了五个计算型实例属性，从而提供与距离单位协作的基本支持：

  1. extension Double {
  2.     var km: Double { return self * 1_000.0 }
  3.     var m : Double { return self }
  4.     var cm: Double { return self / 100.0 }
  5.     var mm: Double { return self / 1_000.0 }
  6.     var ft: Double { return self / 3.28084 }
  7. }
  8. let oneInch = 25.4.mm
  9. print("One inch is \(oneInch) meters")
  10. // 打印 “One inch is 0.0254 meters”
  11. let threeFeet = 3.ft
  12. print("Three feet is \(threeFeet) meters")
  13. // 打印 “Three feet is 0.914399970739201 meters”

这些计算型属性表达的含义是把一个 Double 值看作是某单位下的长度值。即使它们被实现为计算型属性，但这些属性的名字仍可紧接一个浮点型字面值，从而通过点语法来使用，并以此实现距离转换。

在上述例子中，Double 值 1.0 用来表示“1米”。这就是为什么计算型属性 m 返回 self，即表达式 1.m 被认为是计算 Double 值 1.0。

其它单位则需要一些单位换算。一千米等于 1,000 米，所以计算型属性 km 要把值乘以 1_000.00 来实现千米到米的单位换算。类似地，一米有 3.28024 英尺，所以计算型属性 ft 要把对应的 Double 值除以 3.28024 来实现英尺到米的单位换算。

这些属性是只读的计算型属性，为了更简洁，省略了 get 关键字。它们的返回值是 Double，而且可以用于所有接受 Double 值的数学计算中：

  1. let aMarathon = 42.km + 195.m
  2. print("A marathon is \(aMarathon) meters long")
  3. // 打印 “A marathon is 42195.0 meters long”

注意
扩展可以添加新的计算型属性，但是不可以添加存储型属性，也不可以为已有属性添加属性观察器。

构造器

扩展可以为已有类型添加新的构造器。这可以让你扩展其它类型，将你自己的定制类型作为其构造器参数，或者提供该类型的原始实现中未提供的额外初始化选项。

扩展能为类添加新的便利构造器，但是它们不能为类添加新的指定构造器或析构器。指定构造器和析构器必须总是由原始的类实现来提供。

注意
如果你使用扩展为一个值类型添加构造器，同时该值类型的原始实现中未定义任何定制的构造器且所有存储属性提供了默认值，那么我们就可以在扩展中的构造器里调用默认构造器和逐一成员构造器。
正如在值类型的构造器代理中描述的，如果你把定制的构造器写在值类型的原始实现中，上述规则将不再适用。

下面的例子定义了一个用于描述几何矩形的结构体 Rect。这个例子同时定义了两个辅助结构体 Size 和 Point，它们都把 0.0 作为所有属性的默认值：

  1. struct Size {
  2.     var width = 0.0, height = 0.0
  3. }
  4. struct Point {
  5.     var x = 0.0, y = 0.0
  6. }
  7. struct Rect {
  8.     var origin = Point()
  9.     var size = Size()
  10. }

因为结构体 Rect 未提供定制的构造器，因此它会获得一个逐一成员构造器。又因为它为所有存储型属性提供了默认值，它又会获得一个默认构造器。详情请参阅默认构造器。这些构造器可以用于构造新的 Rect 实例：

  1. let defaultRect = Rect()
  2. let memberwiseRect = Rect(origin: Point(x: 2.0, y: 2.0),
  3.     size: Size(width: 5.0, height: 5.0))

你可以提供一个额外的接受指定中心点和大小的构造器来扩展 Rect 结构体：

  1. extension Rect {
  2.     init(center: Point, size: Size) {
  3.         let originX = center.x - (size.width / 2)
  4.         let originY = center.y - (size.height / 2)
  5.         self.init(origin: Point(x: originX, y: originY), size: size)
  6.     }
  7. }

这个新的构造器首先根据提供的 center 和 size 的值计算一个合适的原点。然后调用该结构体的逐一成员构造器 init(origin:size:)，该构造器将新的原点和大小的值保存到了相应的属性中：

  1. let centerRect = Rect(center: Point(x: 4.0, y: 4.0),
  2.     size: Size(width: 3.0, height: 3.0))
  3. // centerRect 的原点是 (2.5, 2.5)，大小是 (3.0, 3.0)

注意
如果你使用扩展提供了一个新的构造器，你依旧有责任确保构造过程能够让实例完全初始化。

方法

扩展可以为已有类型添加新的实例方法和类型方法。下面的例子为 Int 类型添加了一个名为 repetitions 的实例方法：

  1. extension Int {
  2.     func repetitions(task: () -> Void) {
  3.         for _ in 0..<self {
  4.             task()
  5.         }
  6.     }
  7. }

这个 repetitions(task:) 方法接受一个 () -> Void 类型的单参数，表示没有参数且没有返回值的函数。

定义该扩展之后，你就可以对任意整数调用 repetitions(task:) 方法，将闭包中的任务执行整数对应的次数：

  1. 3.repetitions({
  2.     print("Hello!")
  3. })
  4. // Hello!
  5. // Hello!
  6. // Hello!

可以使用尾随闭包让调用更加简洁：

  1. 3.repetitions {
  2.     print("Goodbye!")
  3. }
  4. // Goodbye!
  5. // Goodbye!
  6. // Goodbye!

可变实例方法

通过扩展添加的实例方法也可以修改该实例本身。结构体和枚举类型中修改 self 或其属性的方法必须将该实例方法标注为 mutating，正如来自原始实现的可变方法一样。

下面的例子为 Swift 的 Int 类型添加了一个名为 square 的可变方法，用于计算原始值的平方值：

  1. extension Int {
  2.     mutating func square() {
  3.         self = self * self
  4.     }
  5. }
  6. var someInt = 3
  7. someInt.square()
  8. // someInt 的值现在是 9

下标

扩展可以为已有类型添加新下标。这个例子为 Swift 内建类型 Int 添加了一个整型下标。该下标 [n] 返回十进制数字从右向左数的第 n 个数字：

  • 123456789[0] 返回 9
  • 123456789[1] 返回 8

……以此类推。

  1. extension Int {
  2.     subscript(digitIndex: Int) -> Int {
  3.         var decimalBase = 1
  4.         for _ in 0..<digitIndex {
  5.             decimalBase *= 10
  6.         }
  7.         return (self / decimalBase) % 10
  8.     }
  9. }
  10. 746381295[0]
  11. // 返回 5
  12. 746381295[1]
  13. // 返回 9
  14. 746381295[2]
  15. // 返回 2
  16. 746381295[8]
  17. // 返回 7

如果该 Int 值没有足够的位数，即下标越界，那么上述下标实现会返回 0，犹如在数字左边自动补 0：

  1. 746381295[9]
  2. // 返回 0，即等同于：
  3. 0746381295[9]

嵌套类型

扩展可以为已有的类、结构体和枚举添加新的嵌套类型：

  1. extension Int {
  2.     enum Kind {
  3.         case Negative, Zero, Positive
  4.     }
  5.     var kind: Kind {
  6.         switch self {
  7.         case 0:
  8.             return .Zero
  9.         case let x where x > 0:
  10.             return .Positive
  11.         default:
  12.             return .Negative
  13.         }
  14.     }
  15. }

该例子为 Int 添加了嵌套枚举。这个名为 Kind 的枚举表示特定整数的类型。具体来说，就是表示整数是正数、零或者负数。

这个例子还为 Int 添加了一个计算型实例属性，即 kind，用来根据整数返回适当的 Kind 枚举成员。

现在，这个嵌套枚举可以和任意 Int 值一起使用了：

  1. func printIntegerKinds(_ numbers: [Int]) {
  2.     for number in numbers {
  3.         switch number.kind {
  4.         case .Negative:
  5.             print("- ", terminator: "")
  6.         case .Zero:
  7.             print("0 ", terminator: "")
  8.         case .Positive:
  9.             print("+ ", terminator: "")
  10.         }
  11.     }
  12.     print("")
  13. }
  14. printIntegerKinds([3, 19, -27, 0, -6, 0, 7])
  15. // 打印 “+ + - 0 - 0 + ”

函数 printIntegerKinds(_:) 接受一个 Int 数组，然后对该数组进行迭代。在每次迭代过程中，对当前整数的计算型属性 kind 的值进行评估，并打印出适当的描述。

注意
由于已知 number.kind 是 Int.Kind 类型，因此在 switch 语句中，Int.Kind 中的所有成员值都可以使用简写形式，例如使用 . Negative 而不是 Int.Kind.Negative。