协议
协议 定义了一个蓝图,规定了用来实现某一特定任务或者功能的方法、属性,以及其他需要的东西。类、结构体或枚举都可以遵循协议,并为协议定义的这些要求提供具体实现。某个类型能够满足某个协议的要求,就可以说该类型遵循这个协议。
除了遵循协议的类型必须实现的要求外,还可以对协议进行扩展,通过扩展来实现一部分要求或者实现一些附加功能,这样遵循协议的类型就能够使用这些功能。
协议语法
协议的定义方式与类、结构体和枚举的定义非常相似:
protocolSomeProtocol { // 这里是协议的定义部分 }
要让自定义类型遵循某个协议,在定义类型时,需要在类型名称后加上协议名称,中间以冒号(:
)分隔。遵循多个协议时,各协议之间用逗号(,
)分隔:
structSomeStructure:FirstProtocol, AnotherProtocol { // 这里是结构体的定义部分 }
若是一个类拥有父类,应该将父类名放在遵循的协议名之前,以逗号分隔:
classSomeClass:SomeSuperClass, FirstProtocol, AnotherProtocol { // 这里是类的定义部分 }
属性要求
协议可以要求遵循协议的类型提供特定名称和类型的实例属性或类型属性。协议不指定属性是存储属性还是计算属性,它只指定属性的名称和类型。此外,协议还指定属性是可读的还是 可读可写的 。
如果协议要求属性是可读可写的,那么该属性不能是常量属性或只读的计算型属性。如果协议只要求属性是可读的,那么该属性不仅可以是可读的,如果代码需要的话,还可以是可写的。
协议总是用 var
关键字来声明变量属性,在类型声明后加上 { set get }
来表示属性是可读可写的,可读属性则用 { get }
来表示:
protocolSomeProtocol { var mustBeSettable: Int { getset } var doesNotNeedToBeSettable: Int { get } }
在协议中定义类型属性时,总是使用 static
关键字作为前缀。当类类型遵循协议时,除了 static
关键字,还可以使用 class
关键字来声明类型属性:
protocolAnotherProtocol { staticvar someTypeProperty: Int { getset } }
如下所示,这是一个只含有一个实例属性要求的协议:
protocolFullyNamed { var fullName: String { get } }
FullyNamed
协议除了要求遵循协议的类型提供 fullName
属性外,并没有其他特别的要求。这个协议表示,任何遵循 FullyNamed
的类型,都必须有一个可读的 String
类型的实例属性 fullName
。
下面是一个遵循 FullyNamed
协议的简单结构体:
structPerson:FullyNamed { var fullName: String } let john =Person(fullName:"John Appleseed") // john.fullName 为 "John Appleseed"
这个例子中定义了一个叫做 Person
的结构体,用来表示一个具有名字的人。从第一行代码可以看出,它遵循了 FullyNamed
协议。
Person
结构体的每一个实例都有一个 String
类型的存储型属性 fullName
。这正好满足了 FullyNamed
协议的要求,也就意味着 Person
结构体正确地遵循了协议。(如果协议要求未被完全满足,在编译时会报错。)
下面是一个更为复杂的类,它采纳并遵循了 FullyNamed
协议:
classStarship:FullyNamed { var prefix: String? var name: String init(name: String, prefix: String?=nil) { self.name = name self.prefix =prefix } var fullName: String { return(prefix!=nil?prefix!+" ":"")+ name } } var ncc1701 =Starship(name:"Enterprise", prefix:"USS") // ncc1701.fullName 为 "USS Enterprise"
Starship
类把 fullName
作为只读的计算属性来实现。每一个 Starship
类的实例都有一个名为 name
的非可选属性和一个名为 prefix
的可选属性。 当 prefix
存在时,计算属性 fullName
会将 prefix
插入到 name
之前,从而得到一个带有 prefix
的 fullName
。
方法要求
协议可以要求遵循协议的类型实现某些指定的实例方法或类方法。这些方法作为协议的一部分,像普通方法一样放在协议的定义中,但是不需要大括号和方法体。可以在协议中定义具有可变参数的方法,和普通方法的定义方式相同。但是,不支持为协议中的方法提供默认参数。
正如属性要求中所述,在协议中定义类方法的时候,总是使用 static
关键字作为前缀。即使在类实现时,类方法要求使用 class
或 static
作为关键字前缀,前面的规则仍然适用:
protocolSomeProtocol { staticfuncsomeTypeMethod() }
下面的例子定义了一个只含有一个实例方法的协议:
protocolRandomNumberGenerator { funcrandom() ->Double }
RandomNumberGenerator
协议要求遵循协议的类型必须拥有一个名为 random
, 返回值类型为 Double
的实例方法。尽管这里并未指明,但是我们假设返回值是从 0.0
到(但不包括)1.0
。
RandomNumberGenerator
协议并不关心每一个随机数是怎样生成的,它只要求必须提供一个随机数生成器。
如下所示,下边是一个遵循并符合 RandomNumberGenerator
协议的类。该类实现了一个叫做 线性同余生成器(linear congruential generator) 的伪随机数算法。
classLinearCongruentialGenerator:RandomNumberGenerator { var lastRandom =42.0 let m =139968.0 let a =3877.0 let c =29573.0 funcrandom() ->Double { lastRandom = ((lastRandom * a + c).truncatingRemainder(dividingBy:m)) return lastRandom / m } } let generator =LinearCongruentialGenerator() print("Here's a random number: \(generator.random())") // 打印 “Here's a random number: 0.37464991998171” print("And another one: \(generator.random())") // 打印 “And another one: 0.729023776863283”
异变方法要求
有时需要在方法中改变(或 异变 )方法所属的实例。例如,在值类型(即结构体和枚举)的实例方法中,将 mutating
关键字作为方法的前缀,写在 func
关键字之前,表示可以在该方法中修改它所属的实例以及实例的任意属性的值。这一过程在 在实例方法中修改值类型 章节中有详细描述。
如果你在协议中定义了一个实例方法,该方法会改变遵循该协议的类型的实例,那么在定义协议时需要在方法前加 mutating
关键字。这使得结构体和枚举能够遵循此协议并满足此方法要求。
注意
实现协议中的
mutating
方法时,若是类类型,则不用写mutating
关键字。而对于结构体和枚举,则必须写mutating
关键字。
如下所示,Togglable
协议只定义了一个名为 toggle
的实例方法。顾名思义,toggle()
方法将改变实例属性,从而切换遵循该协议类型的实例的状态。
toggle()
方法在定义的时候,使用 mutating
关键字标记,这表明当它被调用时,该方法将会改变遵循协议的类型的实例:
protocolTogglable { mutatingfunctoggle() }
当使用枚举或结构体来实现 Togglable
协议时,需要提供一个带有 mutating
前缀的 toggle()
方法。
下面定义了一个名为 OnOffSwitch
的枚举。这个枚举在两种状态之间进行切换,用枚举成员 On
和 Off
表示。枚举的 toggle()
方法被标记为 mutating
,以满足 Togglable
协议的要求:
enumOnOffSwitch:Togglable { case off, on mutatingfunctoggle() { switch self { case .off: self = .on case .on: self = .off } } } var lightSwitch = OnOffSwitch.off lightSwitch.toggle() // lightSwitch 现在的值为 .on
构造器要求
协议可以要求遵循协议的类型实现指定的构造器。你可以像编写普通构造器那样,在协议的定义里写下构造器的声明,但不需要写花括号和构造器的实体:
protocolSomeProtocol { init(someParameter: Int) }
协议构造器要求的类实现
你可以在遵循协议的类中实现构造器,无论是作为指定构造器,还是作为便利构造器。无论哪种情况,你都必须为构造器实现标上 required
修饰符:
classSomeClass:SomeProtocol { requiredinit(someParameter: Int) { // 这里是构造器的实现部分 } }
使用 required
修饰符可以确保所有子类也必须提供此构造器实现,从而也能遵循协议。
关于 required
构造器的更多内容,请参考 必要构造器。
注意
如果类已经被标记为
final
,那么不需要在协议构造器的实现中使用required
修饰符,因为final
类不能有子类。关于final
修饰符的更多内容,请参见 防止重写。
如果一个子类重写了父类的指定构造器,并且该构造器满足了某个协议的要求,那么该构造器的实现需要同时标注 required
和 override
修饰符:
protocolSomeProtocol { init() } classSomeSuperClass { init() { // 这里是构造器的实现部分 } } classSomeSubClass:SomeSuperClass, SomeProtocol { // 因为遵循协议,需要加上 required // 因为继承自父类,需要加上 override requiredoverrideinit() { // 这里是构造器的实现部分 } }
可失败构造器要求
协议还可以为遵循协议的类型定义可失败构造器要求,详见 可失败构造器。
遵循协议的类型可以通过可失败构造器(init?
)或非可失败构造器(init
)来满足协议中定义的可失败构造器要求。协议中定义的非可失败构造器要求可以通过非可失败构造器(init
)或隐式解包可失败构造器(init!
)来满足。
协议作为类型
尽管协议本身并未实现任何功能,但是协议可以被当做一个功能完备的类型来使用。协议作为类型使用,有时被称作「存在类型」,这个名词来自「存在着一个类型 T,该类型遵循协议 T」。
协议可以像其他普通类型一样使用,使用场景如下:
- 作为函数、方法或构造器中的参数类型或返回值类型
- 作为常量、变量或属性的类型
- 作为数组、字典或其他容器中的元素类型
注意
协议是一种类型,因此协议类型的名称应与其他类型(例如
Int
,Double
,String
)的写法相同,使用大写字母开头的驼峰式写法,例如(FullyNamed
和RandomNumberGenerator
)。
下面是将协议作为类型使用的例子:
classDice { let sides: Int let generator: RandomNumberGenerator init(sides: Int, generator: RandomNumberGenerator) { self.sides = sides self.generator = generator } funcroll() ->Int { returnInt(generator.random()*Double(sides))+1 } }
例子中定义了一个 Dice
类,用来代表桌游中拥有 N 个面的骰子。Dice
的实例含有 sides
和 generator
两个属性,前者是整型,用来表示骰子有几个面,后者为骰子提供一个随机数生成器,从而生成随机点数。
generator
属性的类型为 RandomNumberGenerator
,因此任何遵循了 RandomNumberGenerator
协议的类型的实例都可以赋值给 generator
,除此之外并无其他要求。并且由于其类型是 RandomNumberGenerator
,所以在 Dice
类中与 generator
交互的代码,必须适用于所有遵循该协议的 generator
实例。这意味着不能使用由 generator
的底层类型定义的任何方法或属性。但是,你可以从协议类型转换成底层实现类型,就像从父类向下转型为子类一样。请参考 向下转型。
Dice
类还有一个构造器,用来设置初始状态。构造器有一个名为 generator
,类型为 RandomNumberGenerator
的形参。在调用构造方法创建 Dice
的实例时,可以传入任何遵循 RandomNumberGenerator
协议的实例给 generator
。
Dice
类提供了一个名为 roll
的实例方法,用来模拟骰子的面值。它先调用 generator
的 random()
方法来生成一个 [0.0,1.0)
区间内的随机数,然后使用这个随机数生成正确的骰子面值。因为 generator
遵循了 RandomNumberGenerator
协议,可以确保它有个 random()
方法可供调用。
下面的例子展示了如何使用 LinearCongruentialGenerator
的实例作为随机数生成器来创建一个六面骰子:
var d6 =Dice(sides:6, generator: LinearCongruentialGenerator()) for_in1...5 { print("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
委托
委托是一种设计模式,它允许类或结构体将一些需要它们负责的功能委托给其他类型的实例。委托模式的实现很简单:定义协议来封装那些需要被委托的功能,这样就能确保遵循协议的类型能提供这些功能。委托模式可以用来响应特定的动作,或者接收外部数据源提供的数据,而无需关心外部数据源的类型。
下面的例子定义了两个基于骰子游戏的协议:
protocolDiceGame { var dice: Dice { get } funcplay() } protocolDiceGameDelegate { funcgameDidStart(_game: DiceGame) funcgame(_game: DiceGame, didStartNewTurnWithDiceRolldiceRoll: Int) funcgameDidEnd(_game: DiceGame) }
DiceGame
协议可以被任意涉及骰子的游戏遵循。
DiceGameDelegate
协议可以被任意类型遵循,用来追踪 DiceGame
的游戏过程。为了防止强引用导致的循环引用问题,可以把协议声明为弱引用,更多相关的知识请看 类实例之间的循环强引用,当协议标记为类专属可以使 SnakesAndLadders
类在声明协议时强制要使用弱引用。若要声明类专属的协议就必须继承于 AnyObject
,更多请看 类专属的协议。
如下所示,SnakesAndLadders
是 控制流 章节引入的蛇梯棋游戏的新版本。新版本使用 Dice
实例作为骰子,并且实现了 DiceGame
和 DiceGameDelegate
协议,后者用来记录游戏的过程:
classSnakesAndLadders:DiceGame { let finalSquare =25 let dice =Dice(sides:6, generator: LinearCongruentialGenerator()) var square =0 var board: [Int] init() { board =Array(repeating:0, count: finalSquare +1) board[03]=+08; board[06]=+11; board[09]=+09; board[10]=+02 board[14]=-10; board[19]=-11; board[22]=-02; board[24]=-08 } var delegate: DiceGameDelegate? funcplay() { 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 caselet newSquare where newSquare > finalSquare: continue gameLoop default: square += diceRoll square += board[square] } } delegate?.gameDidEnd(self) } }
关于这个蛇梯棋游戏的详细描述请参阅 中断(Break)。
这个版本的游戏封装到了 SnakesAndLadders
类中,该类遵循了 DiceGame
协议,并且提供了相应的可读的 dice
属性和 play()
方法。( dice
属性在构造之后就不再改变,且协议只要求 dice
为可读的,因此将 dice
声明为常量属性。)
游戏使用 SnakesAndLadders
类的 init()
构造器来初始化游戏。所有的游戏逻辑被转移到了协议中的 play()
方法,play()
方法使用协议要求的 dice
属性提供骰子摇出的值。
注意,delegate
并不是游戏的必备条件,因此 delegate
被定义为 DiceGameDelegate
类型的可选属性。因为 delegate
是可选值,因此会被自动赋予初始值 nil
。随后,可以在游戏中为 delegate
设置适当的值。因为 DiceGameDelegate
协议是类专属的,可以将 delegate
声明为 weak
,从而避免循环引用。
DicegameDelegate
协议提供了三个方法用来追踪游戏过程。这三个方法被放置于游戏的逻辑中,即 play()
方法内。分别在游戏开始时,新一轮开始时,以及游戏结束时被调用。
因为 delegate
是一个 DiceGameDelegate
类型的可选属性,因此在 play()
方法中通过可选链式调用来调用它的方法。若 delegate
属性为 nil
,则调用方法会优雅地失败,并不会产生错误。若 delegate
不为 nil
,则方法能够被调用,并传递 SnakesAndLadders
实例作为参数。
如下示例定义了 DiceGameTracker
类,它遵循了 DiceGameDelegate
协议:
classDiceGameTracker:DiceGameDelegate { var numberOfTurns =0 funcgameDidStart(_game: DiceGame) { numberOfTurns =0 if game is SnakesAndLadders { print("Started a new game of Snakes and Ladders") } print("The game is using a \(game.dice.sides)-sided dice") } funcgame(_game: DiceGame, didStartNewTurnWithDiceRolldiceRoll: Int) { numberOfTurns +=1 print("Rolled a \(diceRoll)") } funcgameDidEnd(_game: DiceGame) { print("The game lasted for \(numberOfTurns) turns") } }
DiceGameTracker
实现了 DiceGameDelegate
协议要求的三个方法,用来记录游戏已经进行的轮数。当游戏开始时,numberOfTurns
属性被赋值为 0
,然后在每新一轮中递增,游戏结束后,打印游戏的总轮数。
gameDidStart(_:)
方法从 game
参数获取游戏信息并打印。game
参数是 DiceGame
类型而不是 SnakeAndLadders
类型,所以在 gameDidStart(_:)
方法中只能访问 DiceGame
协议中的内容。当然了,SnakeAndLadders
的方法也可以在类型转换之后调用。在上例代码中,通过 is
操作符检查 game
是否为 SnakesAndLadders
类型的实例,如果是,则打印出相应的消息。
无论当前进行的是何种游戏,由于 game
遵循 DiceGame
协议,可以确保 game
含有 dice
属性。因此在 gameDidStart(_:)
方法中可以通过传入的 game
参数来访问 dice
属性,进而打印出 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