Swift 5.x - 扩展(中文文档)

856 阅读8分钟

引言

继续学习Swift文档,从上一章节:嵌套类型,我们学习了Swift嵌套类型相关的内容,主要是说明了枚举、结构体、类之间可以任意的嵌套,方便复杂的类型中使用。现在,我们学习Swift扩展的相关内容。由于篇幅较长,这里分篇来记录,接下来,开始吧!

扩展

扩展向现有的类、结构、枚举或协议类型添加新功能。这包括扩展不能访问原始源代码的类型(称为追溯建模)。扩展与Objective-C中的类别类似。(与Objective-C类别不同的是,Swift扩展没有名称)

在Swift中,扩展可以:

  • 新增计算实例属性个计算类属性
  • 定义实例方法和类方法
  • 提供新的初始化方法
  • 定义subscripts
  • 定义和使用新的嵌套类型
  • 使现有类型符合协议

在Swift中,甚至可以扩展一个协议来提供其需求的实现,或者添加一致性类型可以利用的附加功能。有关更多详细信息,请参阅协议扩展

注意
扩展可以向类型添加新功能,但不能重写现有功能。

1 扩展语法

使用extension关键词声明扩展

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

扩展可以扩展现有类型,使其采用一个或多个协议。要添加协议一致性,请按照为类或结构体编写协议名称的方式编写协议名称:

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

以这种方式添加协议一致性在使用扩展添加协议一致性中进行了描述

扩展可用于扩展现有泛型类型,如扩展泛型类型中所述。还可以扩展泛型类型以有条件地添加功能,如使用泛型Where子句的扩展中所述。

注意
如果定义扩展以向现有类型添加新功能,则新功能将可用于该类型的所有现有实例,即使它们是在定义扩展之前创建的。

2 计算属性

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

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"

这些计算出的属性表示双精度值应被视为某个长度单位。尽管这些属性是作为计算属性实现的,但是这些属性的名称可以用点语法附加到浮点文本值,作为使用该文本值执行距离转换的一种方式。 在本例中,双精度值1.0被认为代表“一米”。这就是m computed属性返回self表达式1.m被认为是计算1.0的双精度值的原因。 其他单位需要一些换算,以米表示。一公里等于1000米,因此“公里计算”特性将该值乘以1_000.00,以转换为以米表示的数字。类似地,米中有3.28084英尺,因此ft计算属性将基本的双精度值除以3.28084,将其从英尺转换为米。 这些属性是只读计算属性,因此为了简洁起见,它们不使用get关键字来表示。它们的返回值类型为Double,并且可以在接受Double的情况下用于数学计算:

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

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

3 初始化

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

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

如果使用扩展将初始值设定项添加到为其所有存储属性提供默认值且未定义任何自定义初始值设定项的值类型,则可以从扩展的初始值设定项中调用该值类型的默认初始值设定项和成员级初始值设定项。如果您将初始值设定项编写为值类型原始实现的一部分,则不会出现这种情况,如值类型的初始值设定项委派中所述。

如果初始值设定项不能从另一个模块中调用初始值设定项,则在该初始值设定项不能从另一个模块中调用该初始值设定项时,才能使用它。 下面的示例定义了一个自定义矩形结构体来表示一个几何矩形。该示例还定义了两个称为Size和Point的支持结构体,它们都为它们的所有属性提供默认值0.0:

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实例:

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

可以扩展Rect结构体以提供附加的初始值设定项,该初始值设定项具有特定的中心点和大小:

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)
    }
}

这个新的初始值设定项首先根据提供的中心点和大小值计算适当的原点。然后初始化器调用结构的自动成员初始化init(origin:size:),它将新的原点和大小值存储在相应的属性中:

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)

注意
如果您提供了一个带有扩展的新初始值设定项,那么您仍然有责任确保在初始值设定项完成后每个实例都已完全初始化。

4 方法

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

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

repetitions(task:)方法接受一个类型为()->Void的参数,它表示一个没有参数且不返回值的函数。 定义此扩展之后,可以对任意整数调用repetitions(task:)方法来执行多次的任务:

3.repetitions {
    print("Hello!")
}
// Hello!
// Hello!
// Hello!
4.1 可变实例方法

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

下面的示例向Swift的Int类型添加了一个名为square的新的可变方法,该方法对原始值进行平方运算:

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

5 Subscripts(下标)

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

  • 123456789[0] returns 9
  • 123456789[1] returns 8

还可以:

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,就好像该数字在左边用零填充一样:

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

6 嵌套类型

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

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,它返回该整数的相应种类枚举case。

嵌套枚举现在可以与任何Int值一起使用:

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值的输入数组,然后依次迭代这些值。对于数组中的每个整数,函数将考虑该整数的计算属性种类,并打印适当的描述。

注意
number.kind已经知道是类型Int.Kind. 因为这个,所有的Int.Kind case值可以在switch语句中以速记形式写入,例如.negative而不是Int.Kind.negative。

参考文档:Swift - Extensions