Merge pull request #528 from 949478479/gh-pages

校对
This commit is contained in:
overtrue
2015-11-10 17:33:41 +08:00

View File

@ -14,40 +14,38 @@
- [下标脚本用法](#subscript_usage) - [下标脚本用法](#subscript_usage)
- [下标脚本选项](#subscript_options) - [下标脚本选项](#subscript_options)
*下标脚本* 可以定义在类Class、结构体structure和枚举enumeration这些目标中,可以认为是访问集合collection列表list或序列sequence的快捷方式使用下标脚本的索引设置和获取值,不需要再调用实例的特定的赋值和访问方法。举例来说,用下标脚本访问一个数组(Array)实例中的元素可以这样写 `someArray[index]` ,访问字典(Dictionary)实例中的元素可以这样写 `someDictionary[key]` *下标脚本* 可以定义在类Class、结构体structure和枚举enumeration中,是访问集合collection列表list或序列sequence)中元素的快捷方式。可以使用下标脚本的索引设置和获取值,不需要再调用对应的存取方法。举例来说,用下标脚本访问一个`Array`实例中的元素可以写作`someArray[index]`,访问`Dictionary`实例中的元素可以写作`someDictionary[key]`
对于同一个目标可以定义多个下标脚本,通过索引类型的不同来进行重载下标脚本不限于单个纬度,你可以定义多个入参的下标脚本满足自定义类型的需求。 一个类型可以定义多个下标脚本,通过不同索引类型进行重载下标脚本不限于一维,你可以定义具有多个入参的下标脚本满足自定义类型的需求。
> 译者:这里附属脚本重载在本小节中原文并没有任何演示
<a name="subscript_syntax"></a> <a name="subscript_syntax"></a>
## 下标脚本语法 ## 下标脚本语法
下标脚本允许你通过在实例后面的方括号中传入一个或者多个索引值来对实例进行访问和赋值。语法类似于实例方法和计算型属性的混合。与定义实例方法类似,定义下标脚本使用`subscript`关键字,显式声明入参(一个或多个和返回类型。与实例方法不同的是下标脚本可以设定为读写或只读。这种方式又有点像计算型属性的gettersetter 下标脚本允许你通过在实例名称后面的方括号中传入一个或者多个索引值来对实例进行存取。语法类似于实例方法语法和计算型属性语法的混合。与定义实例方法类似,定义下标脚本使用`subscript`关键字,指定一个或多个入参和返回类型。与实例方法不同的是下标脚本可以设定为读写或只读。这种行为由 gettersetter 实现,有点类似计算型属性
```swift ```swift
subscript(index: Int) -> Int { subscript(index: Int) -> Int {
get { get {
// 返回与入参匹配的Int类型的值 // 返回一个适当的 Int 类型的值
} }
set(newValue) { set(newValue) {
// 执行赋值操作 // 执行适当的赋值操作
} }
} }
``` ```
`newValue`的类型必须和下标脚本定义的返回类型相同。计算型属性相同的是set的入参声明`newValue`就算不写在set代码块中依然可以使用默认的`newValue`这个变量来访问新赋的值 `newValue`的类型和下标脚本的返回类型相同。如同计算型属性,可以不指定 setter 的参数(`newValue`。如果不指定参数setter 会提供一个名为`newValue`的默认参数
只读计算型属性一样,可以直接将原本应该写在`get`代码块中的代码写在`subscript` 如同只读计算型属性,可以省略只读下标脚本的`get`关键字
```swift ```swift
subscript(index: Int) -> Int { subscript(index: Int) -> Int {
// 返回与入参匹配的Int类型的值 // 返回一个适当的 Int 类型的值
} }
``` ```
下面代码演示了一个`TimesTable`结构体中使用只读下标脚本的用法,该结构体用来示传入整数的*n*倍。 下面代码演示了只读下标脚本的实现,这里定义了一个`TimesTable`结构体用来示传入整数的乘法表:
```swift ```swift
struct TimesTable { struct TimesTable {
@ -57,44 +55,44 @@ struct TimesTable {
} }
} }
let threeTimesTable = TimesTable(multiplier: 3) let threeTimesTable = TimesTable(multiplier: 3)
print("3的6倍是\(threeTimesTable[6])") print("six times three is \(threeTimesTable[6])")
// 输出 "3的6倍是18" // 输出 "six times three is 18"
``` ```
在上例中,通过`TimesTable`结构体创建了一个用来表示索引值三倍的实例。数值`3`作为结构体`构造函数`入参初始化实例成员`multiplier` 在上例中,创建了一个`TimesTable`实例,用来表示整数`3`的乘法表。数值`3`被传递给结构体构造函数,作为实例成员`multiplier`的值
你可以通过下标脚本来得到结果,比如`threeTimesTable[6]`。这条语句访问了`threeTimesTable`的第六个元素,返回`6``3`倍即`18` 你可以通过下标脚本访问`threeTimesTable`实例,例如上面演示的`threeTimesTable[6]`。这条语句查询了`3`的乘法表中的第六个元素,返回`3``6`倍即`18`
>注意 > 注意
> `TimesTable`例子基于一个固定的数学公式。它并不适合对`threeTimesTable[someIndex]`进行赋值操作,这也是为什么附属脚本定义为只读的原因 > `TimesTable`例子基于一个固定的数学公式对`threeTimesTable[someIndex]`进行赋值操作并不合适,因此下标脚本定义为只读的。
<a name="subscript_usage"></a> <a name="subscript_usage"></a>
## 下标脚本用法 ## 下标脚本用法
根据使用场景不同下标脚本也具有不同的含义。通常下标脚本是用来访问集合collection列表list或序列sequence中元素的快捷方式。你可以在你自己特定的类或结构体中自由的实现下标脚本来提供合适的功能。 下标脚本的确切含义取决于使用场景。下标脚本通常作为访问集合collection列表list或序列sequence中元素的快捷方式。你可以针对自己特定的类或结构体的功能来自由地以最恰当的方式实现下标脚本
例如Swift 的字典(Dictionary)实现了通过下标脚本对其实例中存的值进行存取操作。在下标脚本中使用和字典索引相同类型的值,并把一个字典值类型的值赋给这个下标脚本来为字典设值 例如Swift 的`Dictionary`类型实现下标脚本用于对其实例中存的值进行存取操作。为字典设值时,在下标脚本中使用和字典的键类型相同的键,并把一个字典值类型相同的值赋给这个下标脚本:
```swift ```swift
var numberOfLegs = ["spider": 8, "ant": 6, "cat": 4] var numberOfLegs = ["spider": 8, "ant": 6, "cat": 4]
numberOfLegs["bird"] = 2 numberOfLegs["bird"] = 2
``` ```
上例定义一个名为`numberOfLegs`的变量并用一个字典字面量初始化出了包含三对键值的字典实例`numberOfLegs`字典存放值类型推断为`[String:Int]`。字典实例创建完成后通过下标脚本的方式将整型值`2`赋值到字典实例的索引为`bird`的位置中。 上例定义一个名为`numberOfLegs`的变量并用一个包含三对键值的字典字面量初始化它`numberOfLegs`字典类型推断为`[String: Int]`。字典创建完成后,该例子通过下标脚本`String`类型的键`bird``Int`类型的值`2`添加到字典中。
更多关于字典(Dictionary下标脚本的信息请参考[读取和修改字典](./04_Collection_Types.html#accessing_and_modifying_a_dictionary) 更多关于`Dictionary`下标脚本的信息请参考[读取和修改字典](./04_Collection_Types.html#accessing_and_modifying_a_dictionary)
> 注意 > 注意
> Swift 中字典的附属脚本实现中,在`get`部分返回值是`Int?`上例中的`numberOfLegs`字典通过附属脚本返回的是一个`Int?`或者说“可选的int”,不是每个字典的索引都能得到一个整型值,对于没有设过值的索引的访问返回的结果就是`nil`;同样想要从字典实例中删除某个索引下的值也只需要给这个索引赋值为`nil`即可。 > Swift 的`Dictionary`类型的下标脚本接受并返回可选类型的值。上例中的`numberOfLegs`字典通过下标脚本返回的是一个`Int?`或者说“可选的int”。`Dictionary`类型之所以如此实现下标脚本,是因为不是每个键都有个对应的值,同时这也提供了一种通过键删除对应值的方式,只需将键对应的值赋值为`nil`即可。
<a name="subscript_options"></a> <a name="subscript_options"></a>
## 下标脚本选项 ## 下标脚本选项
下标脚本允许任意数量的入参索引,并且每个入参类型也没有限制。下标脚本的返回值也可以是任类型。下标脚本可以使用变量参数和可变参数,但使用写入读出in-out参数或给参数设置默认值都是不允许的 下标脚本可以接受任意数量的入参,并且这些入参可以是任意类型。下标脚本的返回值也可以是任类型。下标脚本可以使用变量参数和可变参数,但不能使用输入输出参数,也不能给参数设置默认值。
一个类或结构体可以根据自身需要提供多个下标脚本实现,在定义下标脚本时通过入参的类型进行区分,使用下标脚本时会自动匹配合适的下标脚本实现运行,这就是*下标脚本的重载*。 一个类或结构体可以根据自身需要提供多个下标脚本实现,使用下标脚本时通过入参的数量和类型进行区分,自动匹配合适的下标脚本,这就是*下标脚本的重载*。
一个下标脚本入参是最常见的情况,但只要有合适的场景也可以定义多个下标脚本入参。如下例定义了一个`Matrix`结构体,将呈现一个`Double`类型的二维矩阵。`Matrix`结构体的下标脚本需要两个整型参数: 虽然接受单一入参的下标脚本是最常见的,但也可以根据情况定义接受多个入参的下标脚本。如下例定义了一个`Matrix`结构体,用于表示一个`Double`类型的二维矩阵。`Matrix`结构体的下标脚本接受两个整型参数:
```swift ```swift
struct Matrix { struct Matrix {
@ -121,7 +119,7 @@ struct Matrix {
} }
``` ```
`Matrix`提供了一个两个入参的构造方法,入参分别是`rows``columns`,创建了一个足够容纳`rows * columns`数的`Double`类型数组。通过传入数组长度和初始值0.0到数组的一个构造器,将`Matrix`中每个元素初始值0.0。关于数组的构造方法和析构方法请参考[创建一个空数组](./04_Collection_Types.html#creating_an_empty_array)。 `Matrix`提供了一个接受两个入参的构造方法,入参分别是`rows``columns`,创建了一个足够容纳`rows * columns``Double`类型的值的数组。通过传入数组长度和初始值`0.0`到数组的构造器,将矩阵中每个位置的值初始化为`0.0`。关于数组的这种构造方法请参考[创建一个空数组](./04_Collection_Types.html#creating_an_empty_array)。
你可以通过传入合适的`row``column`的数量来构造一个新的`Matrix`实例: 你可以通过传入合适的`row``column`的数量来构造一个新的`Matrix`实例:
@ -129,32 +127,22 @@ struct Matrix {
var matrix = Matrix(rows: 2, columns: 2) var matrix = Matrix(rows: 2, columns: 2)
``` ```
上例中创建了一个新的两行两列的`Matrix`实例。在阅读顺序从左上到右下的`Matrix`实例中的数组实例`grid`是矩阵二维数组的扁平化存储: 上例中创建了一个`Matrix`实例来表示两行两列的矩阵。该`Matrix`实例`grid`数组按照从左上到右下的阅读顺序将矩阵扁平化存储:
```swift ![](https://developer.apple.com/library/prerelease/ios/documentation/Swift/Conceptual/Swift_Programming_Language/Art/subscriptMatrix01_2x.png)
// 示意图
grid = [0.0, 0.0, 0.0, 0.0]
col0 col1 `row``column`的值传入下标脚本来为矩阵设值,下标脚本的入参使用逗号分隔:
row0 [0.0, 0.0,
row1 0.0, 0.0]
```
将值赋给带有`row``column`下标脚本的`matrix`实例表达式可以完成赋值操作,下标脚本入参使用逗号分割
```swift ```swift
matrix[0, 1] = 1.5 matrix[0, 1] = 1.5
matrix[1, 0] = 3.2 matrix[1, 0] = 3.2
``` ```
上面两条语句分别`让matrix`的右上值为 1.5,坐下值为 3.2 上面两条语句分别调用下标脚本的 setter 将矩阵右上角位置(即`row``0``column``1`的位置)的值设置为`1.5`,将矩阵左下角位置(即`row``1``column``0`的位置)的值设置为`3.2`
```swift ![](https://developer.apple.com/library/prerelease/ios/documentation/Swift/Conceptual/Swift_Programming_Language/Art/subscriptMatrix02_2x.png)
[0.0, 1.5,
3.2, 0.0]
```
`Matrix`下标脚本的`getter``setter`中同时调用了下标脚本入参`row``column`是否有效的判断。为了方便进行断言,`Matrix`包含了一个名为`indexIsValidForRow(_:column:)`成员方法,用来确认入参`row``column`值是否会造成数组越界 `Matrix`下标脚本的 gettersetter 中都含有断言,用来检查下标脚本入参`row``column`的值是否有效。为了方便进行断言,`Matrix`包含了一个名为`indexIsValidForRow(_:column:)`便利方法,用来检查入参`row``column`值是否在矩阵范围内
```swift ```swift
func indexIsValidForRow(row: Int, column: Int) -> Bool { func indexIsValidForRow(row: Int, column: Int) -> Bool {
@ -166,5 +154,5 @@ func indexIsValidForRow(row: Int, column: Int) -> Bool {
```swift ```swift
let someValue = matrix[2, 2] let someValue = matrix[2, 2]
// 断言将会触发,因为 [2, 2] 已经超过了matrix的最大长度 // 断言将会触发,因为 [2, 2] 已经超过了 matrix 的范围
``` ```