24 KiB
协议
Protocol(协议)定义了用于完成某项任务或功能的方法,属性等,它不具备任何功能的细节实现,只用来统一方法,属性等的名称和其类型.(译者注: 其他语言中也把 Portocol 称为 Interface(接口) ).协议可以被类,枚举,结构体采纳并实现,任意满足了协议要求的类,枚举,结构体被称之为协议遵循者.
协议可以要求其遵循者必须具备的某些特定的属性,方法,操作符,下标.
协议的语法
协议的定义和类,结构体,枚举的定义非常相似:
protocol SomeProtocol {
// 此处书写协议的内容
}
在类型名称后加上协议名称 ,并用冒号:分隔,从而实现协议;当实现多个协议时,各协议之间用逗号,分隔.
struct SomeStructure: FirstProtocol, AnotherProtocol{
// 此处书写结构体的定义
}
当某个类实现了协议,并含有父类时,应当把父类名放在所有的协议名称之前
class SomeClass: SomeSuperClass, FirstProtocol, AnotherProtocol{
// 此处书写类的定义
}
属性要求
协议能够要求其遵循者必须拥有特定名称和类型的实例属性(instance property)或类属性 (type property),也可以指定协议中的属性的settable 和gettable,但它并不要求属性是存储型属性(stored property)还是计算型属性(calculate property).
当协议要求其中的某个属性为gettable时,即使实现了它的setter也不会出错. (译者注:此小节术语较多,可参阅属性章节).
属性通常被声明为变量,通过前置var关键字. 在属性声明后写上{ get set }指定属性为可读写的.{ get }用来描述属性为可读的.
protocol SomeProtocol {
var musBeSettable : Int { get set }
var doesNotNeedToBeSettable: Int { get }
}
当协议用来被类实现时,使用class关键字来说明该属性为类成员 ; 当协议被结构体或枚举实现时,则使用static关键字来说明
protocol AnotherProtocol {
class var someTypeProperty: Int { get set }
}
下边的协议包含了一个实例属性.
protocol FullyNamed {
var fullName: string { get }
}
FullyNamed 定义了一个拥有 fullName 属性的协议. 该协议要求其 遵循者 必须拥有一个名为 fullName, 类型为 String 的可读属性.
下例是一个遵循了 FullyNamed 协议的简单结构体
struct Person: FullyNamed{
var fullName: String
}
let john = Person(fullName: "John Appleseed")
//john.fullName 为 "John Appleseed"
定义一个名为Person并实现了FullyNamed协议的结构体. 每一个Person实例都拥有一个String类型,名为fullName的存储型属性,它满足了FullyNamed协议的要求,也就是说 Person完整的遵循了该协议.(如果协议未被完整遵循,Swift编译时会报出错误).
下例是一个遵循了FullyNamed协议的类:
class Starship: FullyNamed {
var prefix: String?
var name: String
init(name: String, prefix: Stirng? = nil ) {
self.anme = name
self.prefix = prefix
}
var fullName: String {
return (prefix ? prefix ! + " " : " ") + name
}
}
var ncc1701 = Starship(name: "Enterprise", prefix: "USS")
// ncc1701.fullName == "USS Enterprise"
该类将fullName实现为计算型只读属性.它的每一个实例都有一个名为name的必备属性和一个名为prefix的可选属性. 当prefix存在时,将prefix插入到name之前来为Starship构建fullName
方法要求
协议可以要求其遵循者必备某些特定的实例方法和类方法. 这些方法作为协议的一部分,像普通的方法一样写在协议体中,但却不需要方法体.而且,协议中的方法同样支持可变参数.
笔记: 协议中的
方法的语法同普通方法一样,但是不支持默认参数.
在协议中定义类方法与类属性一样,只需在方法前加上class关键字; 当协议用于被枚举或结构体遵循时,类方法的关键字需要换为static:
protocol SomeProtocol {
class func someTypeMethod()
}
下边是拥有一个实例方法的协议的例子
protocol RandomNumberGenerator {
func random() -> Double
}
RandomNumberGenerator 协议要求其遵循者必须拥有一个名为random, 返回值类型为Double 的实例方法. (这里假设随机数在 [0,1] 之间). 该协议只为生成随机数提供了一个统一的函数名称,而不去做具体的实现工作.
这里有一个名为LinearCongruentialGenerator且遵循了RandomNumberGenerator协议的类. 该类实现了名为 linear congruential generator(线性同余生成器) 的假随机数算法
class LinearCongruentialGenerator: RandomNumberGenerator {
var lastRandom = 42.0
let m = 139968.0
let a = 3877.0
let c = 29573.0
func random() -> Double {
lastRandom = ((lastRandom * a + c) % m)
return lastRandom / m
}
}
let generator = LinearCongruentialGenerator()
println("Here's a random number: \(generator.random())")
// 输出 : "Here's a random number: 0.37464991998171"
println("And another one: \(generator.random())")
// 输出 : "And another one: 0.729023776863283"
突变方法要求
有时不得不在方法中改变实例的所属的类型.在基于Value Type的实例方法(译者注:指结构体和枚举中的方法)的func前加上mutating关键字来表明该方法允许改变该实例和其属性的所属类型. 这一突变过程在 Modifyting Value Types from Within Instance Methods 一节中有详细描述.
如果你打算在协议中定义一个能够改变实例所属类型的实例方法,只需要在方法前加上mutating关键字.使得结构体和枚举遵循该协议.(译者注:类中的变量为 Reference Type ,可以轻易的改变实例及其属性的类型 . 而结构体和枚举中的变量都为 Value Type, 因此需要加上mutating关键字才能更改它们的所属类型)
当协议的实例方法标记为
mutating时,在结构体或枚举的实现该方法时中,mutating关键字是不必可少的;当使用类遵循该协议时,则不需要为这个实例方法前加mutating关键字.
下例定义了一个名为Togglable,含有一个toggle方法的协议.通过名称猜测,toggle方法应该是用来 切换或恢复 某个属性的状态使用的.toggle方法前含有mutating关键字,用以标识其可以更改其遵循者的实例及其属性的所属类型.
protocol Togglable {
mutating func toggle()
}
如果你使用枚举或结构体来实现Togglabl协议时,必须在枚举或接头体的toggle方法前加上mutating关键字.
下例定义了一个名为OnOffSwitch的枚举. 这个枚举可以切换On,Off两种状态. 该枚举中的 toggle含有mutating标记,用以匹配Togglable协议的方法要求:
enum OnOffSwitch: Togglable {
case Off, On
mutating func toggle() {
switch self {
case Off:
self = On
case On:
self = Off
}
}
}
var lightSwitch = OnOffSwitch.Off
lightSwitch.toggle()
//lightSwitch 现在的值为 .On
协议作为类型
尽管协议本身不实现任何功能,但你可以将它当做类型来使用.
包括:
- 作为函数,方法或构造器中的参数类型,返回值类型
- 作为常量,变量,属性的类型
- 作为数组,字典或其他容器中的元素类型
Note: 协议是一种类型,因此你应该向其他类型那样(Int,Double,String),使用驼峰式写法来书写协议
这里有一个使用协议类型的例子:
class Dice {
let sides: Int
let generator: RandomNumberGenerator
init(sides: Int, generator: RandomNumberGenerator) {
self.sides = sides
self.generator = generator
}
func roll() -> Int {
return Int(generator.random() * Double(sides)) +1
}
}
这里定义了一个名为 Dice的类,用来代表桌游中的N个面的骰子.
Dice拥有名为sides和generator的两个属性,前者用来表示骰子有几个面,后者用来为骰子提供一个随机数的生成器
generator是一个RandomNumberGenerator协议类型的属性.因此,你可以为它赋值任何遵循该协议的类型.
Dice也拥有一个构造器(initializer)用来设置它的初始状态.构造器中含有一个名为generator,类型为RandomNumberGenerator的形参.你可以在此传入任意遵循RandomNumberGenerator协议的类型.
roll是一个用以返回骰子面值的实例方法.该方法先调用generator的random方法来创建一个 [0-1] 之间的随机数,然后使用这个随机数来生成骰子的面值. 这里的generator 被声明为采纳了RandomNumberGenerator协议,用以确保random方法能够被调用
下例展示了一个使用LinearCongruentialGenerator实例作为随机数生成器的六面骰子
var d6 = Dice(sides: 6,generator: LinearCongruentialGenerator())
for _ in 1...5 {
println("Random dice roll is \(d6.roll())")
}
//输出结果
//Random dice roll is 3
//Random dice roll is 5
//Random dice roll is 4
//Random dice roll is 5
//Random dice roll is 4
委托(代理)
委托是一种设计模式(译者注:想起了那年 UITableViewDelegate 中的奔跑,那是我逝去的Objective-C...),它允许类或结构体将一些需要它们负责的功能或任务交由(委托)给其他的类型.
代理设计模式的实现很简单,首先定义一个协议来封装那些需要被委托的功能的函数和方法, 然后确保其遵循者拥有这些被委托的函数和方法.
委托模式可以用来响应特定的动作,或接收外部数据源提供的数据而无需要知道外部数据源的类型.
下边这个例子展示了两个基于骰子游戏的两个协议:
protocol DiceGame {
var dice: Dice { get }
func play()
}
protocol DiceGameDelegate {
func gameDidStart(game: DiceGame)
func game(game: DiceGame, didStartNewTurnWithDiceRoll diceRoll:Int)
func gameDidEnd(game: DiceGame)
}
DiceGame协议可以被任何包含骰子的游戏采纳.DiceGameDelegate协议可以用来追踪DiceGame的游戏过程
下边是一个 Snakes and Ladders 游戏的新版本(Control Flow含有关于该游戏的介绍).新版本使用Dice中的骰子,实现DiceGame和DiceGameDelegate协议
class SnakesAndLadders: DiceGame {
let finalSquare = 25
let dic = Dice(sides: 6, generator: LinearCongruentialGenerator())
var square = 0
var board: Int[]
init() {
board = Int[](count: finalSquare + 1, repeatedValue: 0)
board[03] = +08; board[06] = +11; borad[09] = +09; board[10] = +02
borad[14] = -10; board[19] = -11; borad[22] = -02; board[24] = -08
}
var delegate: DiceGameDelegate?
func play() {
square = 0
delegate?.gameDidStart(self)
gameLoop: while square != finalSquare {
let diceRoll = dice.roll()
delegate?.game(self,didStartNewTurnWithDiceRoll: diceRoll)
switch square + diceRoll {
case finalSquare:
break gameLoop
case let newSquare where newSquare > finalSquare:
continue gameLoop
default:
square += diceRoll
square += board[square]
}
}
delegate?.gameDIdEnd(self)
}
}
更详细的Shakes and Ladders游戏描述,请在 Control Flow -> Break 章节查看.
这个版本的游戏被包装到了名为SnakeAndLadders并实现了DiceGame协议的类中. 该类含有一个可读的dice属性和一个play方法用来遵循协议.
游戏的初始化设置(setup)被为类的构造器(init())来实现.所有的游戏逻辑被转移到了协议方法play中.
注意:delegate 被定义为遵循DiceGameDelegate协议的可选属性,因为委托并不是该游戏的必备条件.
DicegameDelegate 提供了三个方法用来追踪游戏过程.被放置于游戏的逻辑中,即play()方法内.分别在游戏开始时,新一轮开始时,游戏结束时被调用.
因为delegate是一个遵循DiceGameDelegate的可选属性,因此在play()方法中使用了可选链来调用委托方法. 如果delegate属性为nil, 则委托调用优雅的,不含错误的失败.如果delegate不为nil, 则这些委托方法被调用,并且把SnakesAndLadders的这个实例当做参数一并传递
下边的这个例子展示了一个名为DiceGameTracker,实现DiceGameDelegate协议的类
class DiceGameTracker: DiceGameDelegate {
var numberOfTurns = 0
func gameDidStart(game: DiceGame) {
numberOfTurns = 0
if game is SnakesAndLadders {
println("Started a new game of Snakes and Ladders")
}
println("The game is using a \(game.dice.sides)-sided dice")
}
func game(game: DiceGame, didStartNewTurnWithDiceRoll diceRoll: Int) {
++numberOfTurns
println("Rolled a \(diceRoll)")
}
func gameDidEnd(game: DiceGame) {
println("The game lasted for \(numberOfTurns) turns")
}
}
DiceGameTracker实现了DiceGameDelegate协议中要求的全部方法.用来记录游戏已经进行的轮数. 当游戏开始时,numberOfTurns属性被赋值为0; 在每新一轮中递加; 游戏结束后,输出打印游戏的总轮数.
gameDidStart使用game参数来打印游戏的一些介绍信息.game的类型是DiceGame而不是 SnakeAndLadders, 因此gameDidStart只能访问和使用DiceGame协议中的成员. 但是仍然可以使用类型转换来访问其实例. 在gameDidStart中,当game是SnakesAndLadders的实例时,会打印出适当的信息. 因为game是被视为遵循了DiceGame协议的属性,也就是说它拥有dice属性,所以gameDidStart方法可以访问和打印dice的sides属性,而无需知道这是一场什么游戏....
这是DiceGameTracker的运行实例:
“let tracker = DiceGameTracker()
let game = SnakesAndLadders()
game.delegate = tracker
game.play()
// Started a new game of Snakes and Ladders
// The game is using a 6-sided dice
// Rolled a 3
// Rolled a 5
// Rolled a 4
// Rolled a 5
// The game lasted for 4 turns”
在延展(Extension)中添加协议成员
即使无法修改源代码,依然可以通过延展(Extension)来扩展已存在类型(译者注: 类,结构体,枚举等).延展中可以为已存在的类型添加属性,方法,下标,协议等成员. 详情请在延展章节中查看.
笔记: 通过延展为已存在的类型增加协议时,该类型的实例会自动添加协议中的方法
下例中TextRepresentable协议含有一个asText 方法,可以被任何类型遵循
protocol TextRepresentable {
func asText() -> String
}
通过延展为为上一节中的Dice类实现并遵循TextRepresentable协议
extension Dice: TextRepresentable {
cun asText() -> String {
return "A \(sides)-sided dice"
}
}
Dice类型的实例现在可以被视为TextRepresentable类型:
let d12 = Dice(sides: 12,generator: LinearCongruentialGenerator())
println(d12.asText())
// 输出 "A 12-sided dice"
SnakesAndLadders 类也可通过延展来遵循协议:
extension SnakeAndLadders: TextRepresentable {
func asText() -> String {
return "A game of Snakes and Ladders with \(finalSquare) squares"
}
}
println(game.asText())
// 输出 "A game of Snakes and Ladders with 25 squares"
通过延展声明协议
如果一个类型已经实现了协议中的所有要求,却没有声明时,可以通过声明空延展来采纳协议:
struct Hamster {
var name: String
func asText() -> String {
return "A hamster named \(name)"
}
}
extension Hamster: TextRepresentabl {}
现在开始,Hamster的实例可以被当做TextRepresentable类型使用
let simonTheHamster = Hamster(name: "Simon")
let somethingTextRepresentable: TextRepresentabl = simonTheHamester
println(somethingTextRepresentable.asText())
// 输出 "A hamster named Simon"
注意: 类型不会因为满足了某协议而直接改变,你必须为它做出明显的实现协议声明
集合中的协议类型
协议类型可以被集合使用,表示集合中的元素均为协议类型:
let things: TextRepresentable[] = [game,d12,simoTheHamster]
things数组可以被直接遍历,并调用其中元素的asText()函数:
for thing in things {
println(thing.asText())
}
// A game of Snakes and Ladders with 25 squares
// A 12-sided dice
// A hamster named Simon
上文代码中,thing被认为是TextRepresentable类型而不是Dice,DiceGame,Hamster等类型.因此,可以在循环中调用它们的asText方法
协议的继承
协议可以通过继承一个或多个其他协议.继承协议的语法和继承类的语法相似,多个协议间用逗号,分隔
protocol InheritingProtocol: SomeProtocol, AnotherProtocol {
// 协议定义
}
下边是一个继承了TextRepresentable的协议
protocol PrettyTextRepresentable: TextRepresentable {
func asPrettyText() -> String
}
PrettyTextRepresentable协议继承自TextRepresentable协议.任何实现PrettyTextRepresentable协议的类型,也需要遵循TextRepresentable`协议.
用延展为SnakesAndLadders遵循PrettyTextRepresentable协议:
extension SnakesAndLadders: PrettyTextRepresentable {
func asPrettyText() -> String {
var output = asText() + ":\n"
for index in 1...finalSquare {
switch board[index] {
case let ladder where ladder > 0:
output += "▲ "
case let snake where snake < 0:
output += "▼ "
default:
output += "○ "
}
}
return output
}
}
上边的延展为SnakesAndLadders遵循了PrettyTextRepresentabel协议.在for in中迭代出了board数组中的每一个元素:
- 当数组中元素的值大于0时,用
▲表示 - 当数组中元素的值小于0时,用
▼表示 - 当数组中元素的值等于0时,用
○表示
任意SankesAndLadders的实例都可以使用asPrettyText()方法.
println(game.asPrettyText())
// A game of Snakes and Ladders with 25 squares:
// ○ ○ ▲ ○ ○ ▲ ○ ○ ▲ ▲ ○ ○ ○ ▼ ○ ○ ○ ○ ▼ ○ ○ ▼ ○ ▼ ○
协议合成
一个协议可由多个协议组成,称为协议合成(protocol composition),采用protocol<SomeProtocol, AnotherProtocol>这样的语法.当有多个协议时,中间以,分隔.
举个栗子:
protocol Named {
var name: String { get }
}
protocol Aged {
var age: Int { get }
}
struct Person: Named, Aged {
var name: String
var age: Int
}
func wishHappyBirthday(celebrator: protocol<Named, Aged>) {
println("Happy birthday \(celebrator.name) - you're \(celebrator.age)!")
}
let birthdayPerson = Person(name: "Malcolm", age: 21)
wishHappyBirthday(birthdayPerson)
// 输出 "Happy birthday Malcolm - you're 21!
上例中,Named协议中含有String类型的name属性;Aged协议中含有Int类型的age属性.Person结构体遵循了这两个协议.
此外还定义了wishHappyBirthday函数,该函数的形参celebrator的类型为protocol<Named,Aged>,也就是说可以接受任意遵循了这两个协议的类型.
笔记:
协议合成并不会生成一个新协议,而是将多个协议合成为一个临时的协议.
检验协议的一致性
使用is和as可以检验协议一致性,也可以将协议转换为特定的其他协议类型.检验与转换的语法和之前相同(详情查看Typy Casting章节):
-
is操作符用来检查实例是否遵循了某个协议. -
as?返回一个可选值,当实例遵循协议时,返回该协议类型;否则返回nil -
as可以用来强制向下转型.@objc protocol HasArea { var area: Double { get } }
笔记:
@objc用来表示协议是可选的,也可以用来表示暴露给Objective-C的代码,在*[Using Siwft with Cocoa and Objectivei-c]*(6)一节中有详细介绍.@objc型协议只对类有效,因此只能在类中检查协议的一致性.
class Circle: HasArea {
let pi = 3.1415927
var radius: Double
var area: Double { return pi * radius * radius }
init(radius: Double) { self.radius = radius }
}
class Country: HasArea {
var area: Double
init(area: Double) { self.area = area }
}
Circle和Country都遵循了HasArea协议,前者把area写为计算型属性,后者则把area写为存储型属性
下边是一个没事实现HasArea协议的Animal类:
class Animal {
var legs: Int
init(legs: Int) { self.legs = legs }
}
Circle,Country,Animal并没有一个相同的基础类,可以使用AnyObject类型的数组来装在他们的实例:
let objects: AnyObject[] = [
Circle(radius: 2.0),
Country(area: 243_610),
Animal(legs: 4)
]
在迭代时可以检查object数组的元素是否遵循了HasArea协议:
for object in objects {
if let objectWithArea = object as? HasArea {
println("Area is \(objectWithArea.area)")
} else {
println("Something that doesn't have an area")
}
}
// Area is 12.5663708
// Area is 243610.0
// Something that doesn't have an area
当数组中的元素遵循HasArea协议时,通过as?操作符将其可选绑定(optional binding)到objectWithArea常量上.
objects数组中元素的类型并不会被改变,但是当它们被赋值给objectWithArea时只被视为HasArea类型,并且只有area属性可以被访问.
可选协议要求
可选协议含有可选成员,其遵循者可以选择是否实现这些成员.在协议中使用@optional关键字作为前缀来定义可选成员.
可选协议在调用时使用可选链,详细内容在Optional Chaning章节中查看.
像someOptionalMethod?(someArgument)一样,你可以在可选方法名称后加上?来检查该方法是否被实现.可选方法和可选属性都会返回一个可选值(optional value),当其不可访问时,?之后语句不会执行,并返回nil
笔记: 可选协议只能在含有
@objc前缀的协议中生效.且@objc的协议只能被类遵循
下问定义了整型计数器Counter类,该类使用外部的数据源来提供增量值(increment amount). 数据源定义为CounterDataSource类型的协议,如下所示
@objc protocol CounterDataSource {
@optional func incrementForCount(count: Int) -> Int
@optional var fixedIncrement: Int { get }
}
CounterDataSource含有incrementForCount的可选方法和fiexdIncrement的可选属性.
笔记:
CounterDataSource中的属性和方法都是可选的,因此可以不提供所需要的属性或方法来实现它.尽管技术上允许,但这并不提倡这样用.
Counter类的定义在下边,它含有一个名为dataSource,CounterDataSource?类型的可选属性:
@objc class Counter {
var count = 0
var dataSource: CounterDataSource?
func increment() {
if let amount = dataSource?.incrementForCount?(count) {
count += amount
} else if let amount = dataSource?.fixedIncrement? {
count += amount
}
}
}
count属性用于存储当前的值,increment方法用来为count赋值.
increment方法通过可选链,尝试从两种可选成员中获取count.
- 由于
dataSource可能为nil,因此在dataSource后边加上了?标记来表明只在dataSource非空时才去调用incrementForCount`方法. - 即使
dataSource存在,但是也无法保证其是否实现了incrementForCount方法,因此在incrementForCount方法后边也加有?标记
在调用incrementForCount方法后,Int型可选值通过可选绑定(optional binding)自动拆包并赋值给常量amount.
当incrementForCount不能被调用时,尝试使用可选属性``fixedIncrement来代替.
下边是一个简单的CounterDataSource协议的实现.
class ThreeSource: CounterDataSource {
let fixedIncrement = 3
}
可以使用ThreeSource作为数据源开实例化一个Counter:
var counter = Counter()
counter.dataSource = ThreeSource()
for _ in 1...4 {
counter.increment()
println(counter.count)
}
// 3
// 6
// 9
// 12
下边是一个更为复杂的数据源实现:
class TowardsZeroSource: CounterDataSource {
func incrementForCount(count: Int) -> Int {
if count == 0 {
return 0
} else if count < 0 {
return 1
} else {
return -1
}
}
}
TowardZeroSource类实现了CounterDataSource中可选方法``incrementForCount.
下边是执行的代码:
counter.count = -4
counter.dataSource = TowardsZeroSource()
for _ in 1...5 {
counter.increment()
println(counter.count)
}
// -3
// -2
// -1
// 0
// 0