下标可以定义在类、结构体和枚举中,是访问集合、列表或序列中元素的快捷方式。可以使用下标的索引,设置和获取值,而不需要再调用对应的存取方法。举例来说,用下标访问一个 Array
实例中的元素可以写作 someArray[index]
,访问 Dictionary
实例中的元素可以写作 someDictionary[key]
。
一个类型可以定义多个下标,通过不同索引类型进行对应的重载。下标不限于一维,你可以定义具有多个入参的下标满足自定义类型的需求。
下标语法
下标允许你通过在实例名称后面的方括号中传入一个或者多个索引值来对实例进行查询。它的语法类似于实例方法语法和计算型属性语法。定义下标使用 subscript
关键字,与定义实例方法类似,都是指定一个或多个输入参数和一个返回类型。与实例方法不同的是,下标可以设定为读写或只读。这种行为由 getter
和 setter
实现,类似计算型属性:
subscript(index: Int) -> Int { get { // 返回一个适当的 Int 类型的值 } set(newValue) { // 执行适当的赋值操作 } }
newValue
的类型和下标操作的返回类型相同。如同计算型属性,可以不指定 setter
的参数(newValue
)。如果不指定参数,setter
会提供一个名为 newValue
的默认参数。
如同只读计算型属性,对于只读下标的声明,你可以通过省略 get
关键字和对应的大括号组来进行简写:
subscript(index: Int) -> Int { // 返回一个适当的 Int 类型的值 }
下面代码演示了只读下标的实现,这里定义了一个 TimesTable
结构体,用来表示对应整数的乘法表:
struct TimesTable { let multiplier: Int subscript(index: Int) -> Int { return multiplier * index } } let threeTimesTable = TimesTable(multiplier: 3) print("six times three is \(threeTimesTable[6])") // 打印“six times three is 18”
在上例中,创建了一个 TimesTable
实例,用来表示整数 3 的乘法表。数值 3 被传递给结构体的构造函数,作为实例成员 multiplier
的值。
你可以通过下标访问 threeTimesTable
实例,例如上面演示的 threeTimesTable[6]
。这条语句查询了乘法表中 3 的第六个元素,返回 3 的 6 倍即 18。
注意
TimesTable 例子基于一个固定的数学公式,对 threeTimesTable[someIndex] 进行赋值操作并不合适,因此下标定义为只读的。
下标用法
“下标”的确切含义取决于使用场景。下标通常作为访问集合,列表或序列中元素的快捷方式。你可以针对自己特定的类或结构体功能来以最恰当的方式实现下标。
例如,Swift 的 Dictionary
类型实现下标用于对实例中储存的值进行存取操作。为字典设值时,在下标中使用和字典的键类型相同的键,并把一个和字典的值类型相同的值赋给这个下标:
var numberOfLegs = ["spider": 8, "ant": 6, "cat": 4] numberOfLegs["bird"] = 2
上例定义一个名为 numberOfLegs
的变量,并用一个包含三对键值的字典字面量初始化它。numberOfLegs
字典的类型被推断为 [String: Int]
。字典创建完成后,该例子通过下标将 String
类型的键 bird
和 Int
类型的值 2
添加到字典中。
更多关于 Dictionary
下标的信息请参考 读取和修改字典。
注意
Swift 的
Dictionary
类型的下标接受并返回可选类型的值。上例中的numberOfLegs
字典通过下标返回的是一个Int?
或者说“可选的 int”。Dictionary
类型之所以如此实现下标,是因为不是每个键都有对应的值,同时这也提供了一种通过键删除对应值的方式,只需将键对应的值赋值为nil
即可。