Swift中的选项集合

Swift3中的选项集合（Option Set）

作者：Ole Begemann，原文链接，原文日期：2016/09/28

译者：Lanford3_3；校对：saitjr；定稿：CMB

选项集合在OC中的形态

对于位掩码[可以多选的]，Swift 给出的方案是：选项集合（option sets）。在 C 和 Objective-C 中，通常的做法是将一个布尔值选项集合表示为一系列值为 2 的整数次幂的枚举成员。之后就可以使用位掩码来选择想要的选项了。举例来说，NSString 定义了一个名为 NSStringCompareOptions 的枚举以表示字符串比较选项：

typedef enum {
	NSCaseInsensitiveSearch = 1,
	NSLiteralSearch = 2,
	NSBackwardsSearch = 4,
	NSAnchoredSearch = 8,
	NSNumericSearch = 64,
	NSDiacriticInsensitiveSearch = 128,
	NSWidthInsensitiveSearch = 256,
	NSForcedOrderingSearch = 512,
	NSRegularExpressionSearch = 1024
} NSStringCompareOptions;

要同时 使用 case-insensitive，backward search，你可以使用按位或来组合对应的选项：

NSStringCompareOptions options = NSCaseInsensitiveSearch | NSBackwardsSearch;
// → 5 (= 1 + 4)

使用选项集合
Swift 使用结构体（struct）来遵从 OptionSet 协议，以引入选项集合，而非枚举（enum）。为什么这样处理呢？当枚举成员互斥的时候，比如说，一次只有一个选项可以被选择的情况下，枚举是非常好的。但是和 C 不同，在 Swift 中，你无法把多个枚举成员组合成一个值，而 C 中的枚举对编译器来说就是整型，可以接受任意整数值。
和 C 中一样，Swift 中的选项集合结构体使用了高效的位域来表示，但是这个结构体本身表现为一个集合，它的成员则为被选择的选项。这允许你使用标准的集合运算#Basic_operations)来维护位域，比如使用 contains 来检验集合中是否有某个成员，或者是用 union 来组合两个位域。另外，由于 OptionSet 继承于 ExpressibleByArrayLiteral，你可以使用数组字面量来生成一个选项集合。

let options: NSString.CompareOptions = [.caseInsensitive, .backwards]
options.contains(.backwards)          // → true
options.contains(.regularExpression)  // → false
options.union([.diacriticInsensitive]).rawValue  :// → 133 (= 1 + 4 + 128)

遵从 OptionSet
如何创建你自己的选项集合类型呢？仅有的要求是，一个类型为整型的原始值（rawValue）和一个初始化构造器。对于结构体来说，Swift 通常都会自动提供一个逐一成员构造器（memberwise initializer），所以你并不需要自己写一个。rawValue 是位域底层的存储单元。每个选项都应该是静态的常量，并使用适当的值初始化了其位域。

struct Sports: OptionSet {
    let rawValue: Int
    static let running = Sports(rawValue: 1)
    static let cycling = Sports(rawValue: 2)
    static let swimming = Sports(rawValue: 4)
    static let fencing = Sports(rawValue: 8)
    static let shooting = Sports(rawValue: 32)
    static let horseJumping = Sports(rawValue: 512)
}

现在，你可以创建选项集合了，就像这样：

let triathlon: Sports = [.swimming, .cycling, .running]
triathlon.contains(.swimming)  // → true
triathlon.contains(.fencing)   // → false

需要注意的是， 编译器并没有自动把 2 的整数次幂按照升序赋给你的选项——这些工作应该由你来做，你需要正确地赋值，使得每个选项代表 rawValue 中的其中一个位。 如果你给选项赋予了连续的整数（1，2，3，…），就会导致无法分辨出 .swimming（值为 3）和 [.running, .cycling]（值为 1 + 2）
手动赋值的好处有两个：a. 更直观易懂；b. 能够完全掌控每个选项的值。这也允许你提供额外的属性来对常用的选项进行组合：

extension Sports {
    static let modernPentathlon: Sports =
        [.swimming, .fencing, .horseJumping, .shooting, .running]
}
let commonEvents = triathlon.intersection(.modernPentathlon)
commonEvents.contains(.swimming)    // → true
commonEvents.contains(.cycling)     // → false

选项集合并不是集合类型
遵从 OptionSet 并不意味着遵从 Sequence 和 Collection 协议，所以你无法使用 count 来确定集合中有几个元素，也无法使用 for 循环来遍历选择的选项。从根本上说，一个选项集合仅仅是简单的整数值。

原文链接： http://swift.gg/2016/10/25/swift-option-sets/

补充：

1.使用情况

我们常常调用的API方法中含有options的(或者原OC中使用位枚举的)，大部分都是基于OptionSet的，

a.没有值：

let noOptions: ShippingOptions = []

b.单值:

let singleOption: ShippingOptions = .priority

c.多值：

let multipleOptions: ShippingOptions = [.nextDay, .secondDay, .priority]

2.常用实例方法

///根据是否含有该可选集合的元素值，返回一个布尔值，

func contains(self)  //self表示选项集合的属性/或者属性集  self.element表示一个属性值

///删除在给定集合中不存在的这个选项集的所有元素。

func formIntersection

///用一个新的集合替换这个集合，它包含了这个集合或给定集合中包含的所有元素，但是不包含在这两个集合中。

func formSymmetricDifference(Self)

///插入另外的集合元素到该集合

func formUnion

///返回两个集合的公共元素值【交集】

func intersection(self)

///删除给定的元素和包含的所有元素

func remove(Self.Element)

///返回一个新的选项集，其中包含该集合或给定集合中包含的元素，但不包括这两个元素。

func symmetricDifference(Self)

///返回这个集合中包含的元素的一个新的选项集，在给定的集合中，或者在两者中。

func union(Self)

///插入被给元素到集合

func update(with: Self.Element)

其实上面就是几何的基本常规操作：删除、插入、并集、交集、异或等