Skip to content

Swift 扩展

扩展可以向现有的类、结构体、枚举或协议类型添加新的功能。这包括向你无法访问原始源代码的类型进行扩展的能力(这种扩展称为反向建模)。扩展类似于 Objective-C 中的类别。(与 Objective-C 类别不同,Swift 扩展没有名称。)

扩展的功能

Swift 中的扩展可以:

  • 添加计算实例属性和计算类型属性
  • 定义实例方法和类型方法
  • 提供新的初始化器
  • 定义下标
  • 定义并使用新的嵌套类型
  • 使现有类型符合某个协议

在 Swift 中,你可以扩展一个协议以提供其实现或添加额外的功能,使遵循该协议的类型能够利用这些功能。更多信息,请参阅协议扩展。

注意

扩展可以向类型添加新功能,但不能覆盖现有功能。

扩展语法

使用 extension 关键字声明扩展:

swift
extension SomeType {
    // new functionality to add to SomeType goes here
}

扩展可以扩展现有类型,使其采用一个或多个协议。要添加协议遵循,您可以用与为类或结构编写协议名称相同的方式编写:

swift
extension SomeType: SomeProtocol, AnotherProtocol {
    // implementation of protocol requirements goes here
}

以这种方式添加协议遵循在 Adding Protocol Conformance with an Extension 中有描述。

扩展可以用于扩展现有的泛型类型,如在 Extending a Generic Type 中所述。您还可以扩展泛型类型以有条件地添加功能,如在 Extensions with a Generic Where Clause 中所述。

注意

如果您定义一个扩展以向现有类型添加新功能,则该新功能将可用于该类型的全部现有实例,即使它们在扩展定义之前就已经创建。

计算属性

扩展可以向现有类型添加计算实例属性和计算类型属性。此示例向 Swift 内置的 Double 类型添加了五个计算实例属性,以提供基本支持用于处理距离单位:

swift
extension Double {
    var km: Double { return self * 1_000.0 }
    var m: Double { return self }
    var cm: Double { return self / 100.0 }
    var mm: Double { return self / 1_000.0 }
    var ft: Double { return self / 3.28084 }
}
let oneInch = 25.4.mm
print("One inch is \(oneInch) meters")
// Prints "One inch is 0.0254 meters"
let threeFeet = 3.ft
print("Three feet is \(threeFeet) meters")
// Prints "Three feet is 0.914399970739201 meters"

这些计算属性表示一个 Double 值应该被视为某种长度单位。尽管它们是作为计算属性实现的,但这些属性的名称可以通过点语法附加到浮点字面量值之后,作为一种使用该字面量值执行距离转换的方法。

在此示例中,一个 Double1.0 被视为"一米"。这就是为什么 m 计算属性返回 self 的原因——表达式 1.m 被视为计算一个 Double1.0

其他单位需要进行一些转换才能以米为单位表示数值。1 千米等于 1,000 米,因此 km 计算属性将该值乘以 1_000.00 以转换为以米为单位的数值。同样,1 米中有 3.28084 英尺,因此 ft 计算属性将底层 Double 值除以 3.28084 ,以将该值从英尺转换为米。

这些属性是只读的计算属性,因此它们不使用 get 关键字,以简洁起见。它们的返回值类型为 Double ,并且可以在接受 Double 的任何数学计算中使用:

swift
let aMarathon = 42.km + 195.m
print("A marathon is \(aMarathon) meters long")
// Prints "A marathon is 42195.0 meters long"

注意

扩展可以添加新的计算属性,但不能添加存储属性,也不能为现有属性添加属性观察器。

初始化器

扩展可以为现有类型添加新的初始化器。这使您可以扩展其他类型以接受您自己的自定义类型作为初始化参数,或者提供在该类型原始实现中未包含的其他初始化选项。

扩展可以向类添加新的方便初始化器,但不能向类添加新的指定初始化器或反初始化器。指定初始化器和反初始化器必须始终由原始类实现提供。

如果您使用扩展向提供所有存储属性默认值且未定义任何自定义初始化器的值类型添加初始化器,您可以在扩展的初始化器中调用该值类型的默认初始化器和成员初始化器。如果像在值类型原始实现中那样编写初始化器,则情况并非如此,详情请参阅值类型中的初始化器委托。

如果您使用扩展向另一个模块中声明的结构添加初始化器,新的初始化器在调用定义模块中的初始化器之前无法访问 self

下面的示例定义了一个自定义的 Rect 结构来表示一个几何矩形。示例还定义了两个支持结构,分别称为 SizePoint ,这两个结构的所有属性都提供了默认值 0.0

swift
struct Size {
    var width = 0.0, height = 0.0
}
struct Point {
    var x = 0.0, y = 0.0
}
struct Rect {
    var origin = Point()
    var size = Size()
}

因为 Rect 结构为其所有属性提供了默认值,因此会自动接收默认初始化器和成员初始化器,如《默认初始化器》中所述。这些初始化器可以用于创建新的 Rect 实例:

swift
let defaultRect = Rect()
let memberwiseRect = Rect(origin: Point(x: 2.0, y: 2.0),
    size: Size(width: 5.0, height: 5.0))

你可以扩展 Rect 结构以提供一个额外的初始化器,该初始化器接受特定的中心点和大小:

swift
extension Rect {
    init(center: Point, size: Size) {
        let originX = center.x - (size.width / 2)
        let originY = center.y - (size.height / 2)
        self.init(origin: Point(x: originX, y: originY), size: size)
    }
}

此新的初始化器首先根据提供的 center 点和 size 值计算一个适当的基础点。然后,初始化器调用结构的自动成员初始化器 init(origin:size:) ,将新的基础点和大小值存储在适当的位置:

swift
let centerRect = Rect(center: Point(x: 4.0, y: 4.0),
    size: Size(width: 3.0, height: 3.0))
// centerRect's origin is (2.5, 2.5) and its size is (3.0, 3.0)

注意

如果您提供了一个带有扩展的新初始化器,您仍然需要确保在初始化器完成时每个实例都被完全初始化。

方法

扩展可以向现有类型添加新的实例方法和类型方法。以下示例向 Int 类型添加了一个名为 repetitions 的新实例方法:

swift
extension Int {
    func repetitions(task: () -> Void) {
        for _ in 0..<self {
            task()
        }
    }
}

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

在定义此扩展后,您可以对任何整数调用 repetitions(task:) 方法,使其执行该次数的任务:

swift
3.repetitions {
    print("Hello!")
}
// Hello!
// Hello!
// Hello!

可变实例方法

使用扩展添加的实例方法也可以修改(或突变)该实例本身。修改 self 或其属性的结构和枚举方法必须将实例方法标记为 mutating ,就像原始实现中的突变方法一样。

以下示例向 Swift 的 Int 类型添加了一个名为 square 的新可变方法,该方法将原始值平方。

swift
extension Int {
    mutating func square() {
        self = self * self
    }
}
var someInt = 3
someInt.square()
// someInt is now 9

下标

扩展可以在现有类型上添加新的下标。此示例向 Swift 内置的 Int 类型添加了一个整数下标。此下标 [n] 返回数字右侧 n 位处的十进制数字:

  • 123456789[0] 返回 9
  • 123456789[1] 返回 8
  • ...并且依次:
swift
extension Int {
    subscript(digitIndex: Int) -> Int {
        var decimalBase = 1
        for _ in 0..<digitIndex {
            decimalBase *= 10
        }
        return (self / decimalBase) % 10
    }
}
746381295[0]
// returns 5
746381295[1]
// returns 9
746381295[2]
// returns 2
746381295[8]
// returns 7

如果 Int 值的位数不足以满足请求的索引,下标实现将返回 0 ,就好像该数字已经向左填充了足够的零:

swift
746381295[9]
// returns 0, as if you had requested:
0746381295[9]

嵌套类型

扩展可以向现有的类、结构体和枚举类型添加新的嵌套类型:

swift
extension Int {
    enum Kind {
        case negative, zero, positive
    }
    var kind: Kind {
        switch self {
        case 0:
            return .zero
        case let x where x > 0:
            return .positive
        default:
            return .negative
        }
    }
}

此示例向 Int 添加了一个新的嵌套枚举。此枚举称为 Kind ,表示特定整数所代表的数字类型。具体而言,它表示该数字是负数、零还是正数。

这个示例还向 Int 添加了一个新的计算实例属性,称为 kind ,该属性返回该整数对应的 Kind 枚举情况。

现在可以使用任何 Int 值的嵌套枚举:

swift
func printIntegerKinds(_ numbers: [Int]) {
    for number in numbers {
        switch number.kind {
        case .negative:
            print("- ", terminator: "")
        case .zero:
            print("0 ", terminator: "")
        case .positive:
            print("+ ", terminator: "")
        }
    }
    print("")
}
printIntegerKinds([3, 19, -27, 0, -6, 0, 7])
// Prints "+ + - 0 - 0 + "

此函数 printIntegerKinds(_:) 接收一个包含 Int 个值的输入数组,并依次迭代这些值。对于数组中的每个整数,该函数会考虑该整数的 kind 计算属性,并打印一个合适的描述。

注意

number.kind 已经知道是 Int.Kind 类型。由于这一点, Int.Kind 情况的所有值都可以在 switch 语句中使用简写形式,例如 .negative 而不是 Int.Kind.negative