OptionSetType

来源：互联网发布：阿里云点击挂载不行编辑：程序博客网时间：2024/06/09 14:22

引言

先来看看一个UIView动画在Objective-C和Swift里面分别是怎么写的。

[UIView animateWithDuration:0.3 delay:0 options:UIViewAnimationOptionCurveEaseInOut|UIViewAnimationOptionAllowUserInteraction animations:^{    // ... Animations} completion: nil];

UIView.animateWithDuration(0.3, delay: 0, options: [.CurveEaseInOut,.AllowUserInteraction], animations: { () -> Void in    // ... Animations}, completion: nil)

我们可以发现，在Objective-C中传入的options是UIViewAnimationOptionCurveEaseInOut|UIViewAnimationOptionAllowUserInteractio，是用的传统的|(或)操作；而Swift里是[.CurveEaseInOut,.AllowUserInteraction]，这个乍看之下很像Array的东西又是什么呢？

OptionSetType

UIViewAnimationOptions的声明是这样的:

@available(iOS 4.0, *)public struct UIViewAnimationOptions : OptionSetType {    public init(rawValue: UInt)    public static var LayoutSubviews: UIViewAnimationOptions { get }    public static var AllowUserInteraction: UIViewAnimationOptions { get } // turn on user interaction while animating    public static var BeginFromCurrentState: UIViewAnimationOptions { get } // start all views from current value, not initial value    //...... 还有很多属性}

UIViewAnimationOptions是实现OptionSetType Protocol的struct。是OptionSetType这个协议赋予了其这样的特征表现。那么我们来看看OptionSetType的结构。

OptionSetType 树

图里的每个方框都是协议，虚线代表协议的继承关系。
下面我们来一个个介绍它们

Equatable Protocol

实现Equatable可以通过重载==，!=操作符来判断相等关系。

ArrayLiteralConvertible Protocol

实现此协议的类型能够通过类似于[value1,value2]这种声明Array的方式来进行声明。
例如：

struct Poker : ArrayLiteralConvertible, CustomStringConvertible {    var cards = [String]()    // ArrayLiteralConvertible 的构造器接口    init(arrayLiteral elements: String...) {        for card in elements {            cards.append(card)        }    }    var description: String {        var content = "My cards are "        for card in self.cards {            content += card        }        return content    }}// How to uselet myPocker:Poker = ["2","4","3","J","A"]print(myPocker)       // 输出：My  cards are 243JA

通过实现ArrayLiteralConvertible协议，然后重写init(arrayLiteral elements: Element...)构造器，就能够像创建数组一样来创建这个被我称为Poker的结构体了。

UIViewAnimationOptions正是因为OptionSetType的继承树里有ArrayLiteralConvertible协议，才使我们能够像创建数组一样来创建它。

另外，还有Swift还提供了几个类似ArrayLiteralConvertible的接口：

BooleanLiteralConvertible
DictionaryLiteralConvertible
ExtendedGraphemeClusterLiteralConvertible
FloatLiteralConvertible
NilLiteralConvertible
IntegerLiteralConvertible
StringLiteralConvertible
UnicodeScalarLiteralConvertible

SetAlgebraType Protocol

为了支持类NS_OPTIONS的枚举，Swift 2.0中定义了OptionSetType协议【在Swift 1.2中是使用RawOptionSetType，相比较而言已经改进了不少】。

SetAlgebraType为实现该协议的类型提供代数操作(交集，并集，异或，插入，删除等)。

OptionSetType在confirm SetAlgebraType协议后，就直接通过extension扩展实现了相对的功能，因此在真实的使用场景中，我们只需要调用代数操作结果，而不用关心具体实现。

RawRepresentable Protocol

这个协议很简单，只有几句代码：

public protocol RawRepresentable {    typealias RawValue    public init?(rawValue: Self.RawValue)    public var rawValue: Self.RawValue { get }}

要求实现RawRepresentable的类型要有一个rawValue，然后还有给出对应的构造器，就OK了。

应用 `OptionSetType`

到实战部分了，现在有三种求救方式分别为打110，119和120，当我们求救时，可以打任意打三个电话的任何一个或多个。下面是代码

struct HelpOptions : OptionSetType {    var rawValue = 0  // 因为RawRepresentable的要求    static var Call110 = HelpOptions(rawValue: 1 << 0)    static var Call119 = HelpOptions(rawValue: 1 << 1)    static var Call120 = HelpOptions(rawValue: 1 << 2)}// How to uselet fireNeedHelp: HelpOptions = [HelpOptions.Call120,HelpOptions.Call119]//   let killNeedHelp: HelpOptions = [HelpOptions.Call120,HelpOptions.Call110]if fireNeedHelp.contains(.Call110) {  print("警察叔叔来啦")  }if fireNeedHelp.contains(.Call119) {  print("消防员叔叔来啦")  }if fireNeedHelp.contains(.Call120) {  print("护士姐姐来啦")  }

HelpOptions的结构很清晰易懂，每个不同的的选项都是HelpOptions的一个静态属性，并且都有一个rawValue来对应值。
我们只用通过contains等代数操作来判断就知道到底需要打电话给谁了。

而所有代数相关的逻辑操作和判断都由OptionSetType的extension做了，而我们什么都不用管。真是感叹OptionSetType真是个好人啊！

从字面上来理解，OptionSetType是选项集合类型，它定义了一些基本操作，包括集合操作(union, intersect, exclusiveOr)、成员管理(contains, insert, remove)、位操作(unionInPlace, intersectInPlace, exclusiveOrInPlace)以及其它的一些基本操作。

作为示例，我们来定义一个表示方向的选项集合，通常我们是定义一个实现OptionSetType协议的结构体，如下所示：

1
2
3
4
5
6
7
8
9
10
struct Directions: OptionSetType {
    var rawValue:Int
    init(rawValue: Int) {
        self.rawValue = rawValue
    }
    static let Up: Directions = Directions(rawValue: 1 << 0)
    static let Down: Directions = Directions(rawValue: 1 << 1)
    static let Left: Directions = Directions(rawValue: 1 << 2)
    static let Right: Directions = Directions(rawValue: 1 << 3)
}

所需要做的基本上就是这些。然后我们就可以创建Directions的实例了，如下所示：

1
2
3
4
let direction: Directions = Directions.Left
if direction == Directions.Left {
    // ...
}

如果想同时支持两个方向，则可以如上处理：

1
2
3
4
let leftUp: Directions = [Directions.Left, Directions.Up]
if leftUp.contains(Directions.Left) && leftUp.contains(Directions.Up) {
    // ...
}

如果leftUp同时包含Directions.Left和Directions.Up，则返回true。

这里还有另外一种方法来达到这个目的，就是我们在Directions结构体中直接声明声明Left和Up的静态常量，如下所示：

1
2
3
4
5
6
struct Directions: OptionSetType {
    // ...
    static let LeftUp: Directions = [Directions.Left, Directions.Up]
    static let RightUp: Directions = [Directions.Right, Directions.Up]
    // ...
}

这样，我们就可以以如下方式来执行上面的操作：

1
2
3
if leftUp == Directions.LeftUp {
    // ...
}

当然，如果单一选项较多，而要去组合所有的情况，这种方法就显示笨拙了，这种情况下还是推荐使用contains方法。

总体来说，Swift中的对选项的支持没有Objective-C中的NS_OPTIONS来得简洁方便。而且在Swift 1.2的时候，我们还是可以使用”&“和”|”操作符的。下面这段代码在Swift 1.2上是OK的：

1
2
3
UIView.animateWithDuration(0.3, delay: 1.0, options: UIViewAnimationOptions.CurveEaseIn | UIViewAnimationOptions.CurveEaseOut, animations: { () -> Void in
    // ...
}, completion: nil)

但到了Swift 2.0时，OptionSetType已经不再支持”&“和”|”操作了，因此，上面这段代码需要修改成：

1
2
3
UIView.animateWithDuration(0.3, delay: 1.0, options: [UIViewAnimationOptions.CurveEaseIn, UIViewAnimationOptions.CurveEaseInOut], animations: { () -> Void in
        // ...
}, completion: nil)

不过，慢慢习惯就好。

总结

今天很认真的看了OptionSetType相关的结构和使用方法，真心发现Swift的编程范式和Objective-C 还是蛮大。
我发现的一点是，OptionSetType继承了SetAlgebraType(protocol 的继承)。然后直接通过extension OptionSetType把SetAlgebraType的接口实现了。这样当我的HelpOptions实现OptionSetType时，调用SetAlgebraType协议的方法就行了，而不用自己的去实现。这是以前没有想到的地方。

参考：

http://www.jianshu.com/p/9a1fcfb7e3ee

http://www.cocoachina.com/swift/20150825/13079.html?utm_source=tuicool&utm_medium=referral

《100个Swift开发必备Tip》Options