枚舉

枚舉為一組相關(guān)的值定義了一個(gè)共同的類型，使你可以在你的代碼中以類型安全的方式來使用這些值。

如果你熟悉 C 語言，你會(huì)知道在 C 語言中，枚舉會(huì)為一組整型值分配相關(guān)聯(lián)的名稱。Swift 中的枚舉更加靈活，不必給每一個(gè)枚舉成員提供一個(gè)值。如果給枚舉成員提供一個(gè)值（稱為原始值），則該值的類型可以是字符串、字符，或是一個(gè)整型值或浮點(diǎn)數(shù)。

此外，枚舉成員可以指定任意類型的關(guān)聯(lián)值存儲(chǔ)到枚舉成員中，就像其他語言中的聯(lián)合體（unions）和變體（variants）。你可以在一個(gè)枚舉中定義一組相關(guān)的枚舉成員，每一個(gè)枚舉成員都可以有適當(dāng)類型的關(guān)聯(lián)值。

在 Swift 中，枚舉類型是一等（first-class）類型。它們采用了很多在傳統(tǒng)上只被類（class）所支持的特性，例如計(jì)算屬性（computed properties），用于提供枚舉值的附加信息，實(shí)例方法（instance methods），用于提供和枚舉值相關(guān)聯(lián)的功能。枚舉也可以定義構(gòu)造函數(shù)（initializers）來提供一個(gè)初始值；可以在原始實(shí)現(xiàn)的基礎(chǔ)上擴(kuò)展它們的功能；還可以遵循協(xié)議（protocols）來提供標(biāo)準(zhǔn)的功能。

想了解更多相關(guān)信息，請參見 屬性，方法，構(gòu)造過程，擴(kuò)展 和 協(xié)議。

枚舉語法

使用 enum 關(guān)鍵詞來創(chuàng)建枚舉并且把它們的整個(gè)定義放在一對大括號(hào)內(nèi)：

enum SomeEnumeration {
    // 枚舉定義放在這里
}

下面是用枚舉表示指南針?biāo)膫€(gè)方向的例子：

enum CompassPoint {
    case north
    case south
    case east
    case west
}

枚舉中定義的值（如 north，south，east 和 west）是這個(gè)枚舉的成員值（或成員）。你可以使用 case 關(guān)鍵字來定義一個(gè)新的枚舉成員值。

注意

與 C 和 Objective-C 不同，Swift 的枚舉成員在被創(chuàng)建時(shí)不會(huì)被賦予一個(gè)默認(rèn)的整型值。在上面的 CompassPoint 例子中，north，south，east 和 west 不會(huì)被隱式地賦值為 0，1，2 和 3。相反，這些枚舉成員本身就是完備的值，這些值的類型是已經(jīng)明確定義好的 CompassPoint 類型。

多個(gè)成員值可以出現(xiàn)在同一行上，用逗號(hào)隔開：

enum Planet {
    case mercury, venus, earth, mars, jupiter, saturn, uranus, neptune
}

每個(gè)枚舉定義了一個(gè)全新的類型。像 Swift 中其他類型一樣，它們的名字（例如 CompassPoint 和 Planet）以一個(gè)大寫字母開頭。給枚舉類型起一個(gè)單數(shù)名字而不是復(fù)數(shù)名字，以便于：

var directionToHead = CompassPoint.west

directionToHead 的類型可以在它被 CompassPoint 的某個(gè)值初始化時(shí)推斷出來。一旦 directionToHead 被聲明為 CompassPoint 類型，你可以使用更簡短的點(diǎn)語法將其設(shè)置為另一個(gè) CompassPoint 的值：

directionToHead = .east

當(dāng) directionToHead 的類型已知時(shí)，再次為其賦值可以省略枚舉類型名。在使用具有顯式類型的枚舉值時(shí)，這種寫法讓代碼具有更好的可讀性。

使用 Switch 語句匹配枚舉值

你可以使用 switch 語句匹配單個(gè)枚舉值：

directionToHead = .south
switch directionToHead {
case .north:
    print("Lots of planets have a north")
case .south:
    print("Watch out for penguins")
case .east:
    print("Where the sun rises")
case .west:
    print("Where the skies are blue")
}
// 打印“Watch out for penguins”

你可以這樣理解這段代碼：

“判斷 directionToHead 的值。當(dāng)它等于 .north，打印 “Lots of planets have a north”。當(dāng)它等于 .south，打印 “Watch out for penguins”。”

……以此類推。

正如在 控制流 中介紹的那樣，在判斷一個(gè)枚舉類型的值時(shí)，switch 語句必須窮舉所有情況。如果忽略了 .west 這種情況，上面那段代碼將無法通過編譯，因?yàn)樗鼪]有考慮到 CompassPoint 的全部成員。強(qiáng)制窮舉確保了枚舉成員不會(huì)被意外遺漏。

當(dāng)不需要匹配每個(gè)枚舉成員的時(shí)候，你可以提供一個(gè) default 分支來涵蓋所有未明確處理的枚舉成員：

let somePlanet = Planet.earth
switch somePlanet {
case .earth:
    print("Mostly harmless")
default:
    print("Not a safe place for humans")
}
// 打印“Mostly harmless”

枚舉成員的遍歷

在一些情況下，你會(huì)需要得到一個(gè)包含枚舉所有成員的集合?？梢酝ㄟ^如下代碼實(shí)現(xiàn)：

令枚舉遵循 CaseIterable 協(xié)議。Swift 會(huì)生成一個(gè) allCases 屬性，用于表示一個(gè)包含枚舉所有成員的集合。下面是一個(gè)例子：

enum Beverage: CaseIterable {
    case coffee, tea, juice
}
let numberOfChoices = Beverage.allCases.count
print("\(numberOfChoices) beverages available")
// 打印“3 beverages available”

在前面的例子中，通過 Beverage.allCases 可以訪問到包含 Beverage 枚舉所有成員的集合。allCases 的使用方法和其它一般集合一樣——集合中的元素是枚舉類型的實(shí)例，所以在上面的情況中，這些元素是 Beverage 值。在前面的例子中，統(tǒng)計(jì)了總共有多少個(gè)枚舉成員。而在下面的例子中，則使用 for 循環(huán)來遍歷所有枚舉成員。

for beverage in Beverage.allCases {
    print(beverage)
}
// coffee
// tea
// juice

在前面的例子中，使用的語法表明這個(gè)枚舉遵循 CaseIterable 協(xié)議。想了解 protocols 相關(guān)信息，請參見 協(xié)議。

關(guān)聯(lián)值

枚舉語法那一小節(jié)的例子演示了如何定義和分類枚舉的成員。你可以為 Planet.earth 設(shè)置一個(gè)常量或者變量，并在賦值之后查看這個(gè)值。然而，有時(shí)候把其他類型的值和成員值一起存儲(chǔ)起來會(huì)很有用。這額外的信息稱為關(guān)聯(lián)值，并且你每次在代碼中使用該枚舉成員時(shí)，還可以修改這個(gè)關(guān)聯(lián)值。

你可以定義 Swift 枚舉來存儲(chǔ)任意類型的關(guān)聯(lián)值，如果需要的話，每個(gè)枚舉成員的關(guān)聯(lián)值類型可以各不相同。枚舉的這種特性跟其他語言中的可識(shí)別聯(lián)合（discriminated unions），標(biāo)簽聯(lián)合（tagged unions），或者變體（variants）相似。

例如，假設(shè)一個(gè)庫存跟蹤系統(tǒng)需要利用兩種不同類型的條形碼來跟蹤商品。有些商品上標(biāo)有使用 0 到 9 的數(shù)字的 UPC 格式的一維條形碼。每一個(gè)條形碼都有一個(gè)代表數(shù)字系統(tǒng)的數(shù)字，該數(shù)字后接五位代表廠商代碼的數(shù)字，接下來是五位代表“產(chǎn)品代碼”的數(shù)字。最后一個(gè)數(shù)字是檢查位，用來驗(yàn)證代碼是否被正確掃描：

其他商品上標(biāo)有 QR 碼格式的二維碼，它可以使用任何 ISO 8859-1 字符，并且可以編碼一個(gè)最多擁有 2,953 個(gè)字符的字符串：

這便于庫存跟蹤系統(tǒng)用包含四個(gè)整型值的元組存儲(chǔ) UPC 碼，以及用任意長度的字符串儲(chǔ)存 QR 碼。

在 Swift 中，使用如下方式定義表示兩種商品條形碼的枚舉：

enum Barcode {
    case upc(Int, Int, Int, Int)
    case qrCode(String)
}

以上代碼可以這么理解：

“定義一個(gè)名為 Barcode 的枚舉類型，它的一個(gè)成員值是具有 (Int，Int，Int，Int) 類型關(guān)聯(lián)值的 upc，另一個(gè)成員值是具有 String 類型關(guān)聯(lián)值的 qrCode。”

這個(gè)定義不提供任何 Int 或 String 類型的關(guān)聯(lián)值，它只是定義了，當(dāng) Barcode 常量和變量等于 Barcode.upc 或 Barcode.qrCode 時(shí)，可以存儲(chǔ)的關(guān)聯(lián)值的類型。

然后你可以使用任意一種條形碼類型創(chuàng)建新的條形碼，例如：

var productBarcode = Barcode.upc(8, 85909, 51226, 3)

上面的例子創(chuàng)建了一個(gè)名為 productBarcode 的變量，并將 Barcode.upc 賦值給它，關(guān)聯(lián)的元組值為 (8, 85909, 51226, 3)。

同一個(gè)商品可以被分配一個(gè)不同類型的條形碼，例如：

productBarcode = .qrCode("ABCDEFGHIJKLMNOP")

這時(shí)，原始的 Barcode.upc 和其整數(shù)關(guān)聯(lián)值被新的 Barcode.qrCode 和其字符串關(guān)聯(lián)值所替代。Barcode 類型的常量和變量可以存儲(chǔ)一個(gè) .upc 或者一個(gè) .qrCode（連同它們的關(guān)聯(lián)值），但是在同一時(shí)間只能存儲(chǔ)這兩個(gè)值中的一個(gè)。

你可以使用一個(gè) switch 語句來檢查不同的條形碼類型，和之前使用 Switch 語句來匹配枚舉值的例子一樣。然而，這一次，關(guān)聯(lián)值可以被提取出來作為 switch 語句的一部分。你可以在 switch 的 case 分支代碼中提取每個(gè)關(guān)聯(lián)值作為一個(gè)常量（用 let 前綴）或者作為一個(gè)變量（用 var 前綴）來使用：

switch productBarcode {
case .upc(let numberSystem, let manufacturer, let product, let check):
    print("UPC: \(numberSystem), \(manufacturer), \(product), \(check).")
case .qrCode(let productCode):
    print("QR code: \(productCode).")
}
// 打印“QR code: ABCDEFGHIJKLMNOP.”

如果一個(gè)枚舉成員的所有關(guān)聯(lián)值都被提取為常量，或者都被提取為變量，為了簡潔，你可以只在成員名稱前標(biāo)注一個(gè) let 或者 var：

switch productBarcode {
case let .upc(numberSystem, manufacturer, product, check):
    print("UPC: \(numberSystem), \(manufacturer), \(product), \(check).")
case let .qrCode(productCode):
    print("QR code: \(productCode).")
}
// 打印“QR code: ABCDEFGHIJKLMNOP.”

原始值

在 關(guān)聯(lián)值 小節(jié)的條形碼例子中，演示了如何聲明存儲(chǔ)不同類型關(guān)聯(lián)值的枚舉成員。作為關(guān)聯(lián)值的替代選擇，枚舉成員可以被默認(rèn)值（稱為原始值）預(yù)填充，這些原始值的類型必須相同。

這是一個(gè)使用 ASCII 碼作為原始值的枚舉：

enum ASCIIControlCharacter: Character {
    case tab = "\t"
    case lineFeed = "\n"
    case carriageReturn = "\r"
}

枚舉類型 ASCIIControlCharacter 的原始值類型被定義為 Character，并設(shè)置了一些比較常見的 ASCII 控制字符。Character 的描述詳見 字符串和字符 部分。

原始值可以是字符串、字符，或者任意整型值或浮點(diǎn)型值。每個(gè)原始值在枚舉聲明中必須是唯一的。

注意

原始值和關(guān)聯(lián)值是不同的。原始值是在定義枚舉時(shí)被預(yù)先填充的值，像上述三個(gè) ASCII 碼。對于一個(gè)特定的枚舉成員，它的原始值始終不變。關(guān)聯(lián)值是創(chuàng)建一個(gè)基于枚舉成員的常量或變量時(shí)才設(shè)置的值，枚舉成員的關(guān)聯(lián)值可以變化。

原始值的隱式賦值

在使用原始值為整數(shù)或者字符串類型的枚舉時(shí)，不需要顯式地為每一個(gè)枚舉成員設(shè)置原始值，Swift 將會(huì)自動(dòng)為你賦值。

例如，當(dāng)使用整數(shù)作為原始值時(shí)，隱式賦值的值依次遞增 1。如果第一個(gè)枚舉成員沒有設(shè)置原始值，其原始值將為 0。

下面的枚舉是對之前 Planet 這個(gè)枚舉的一個(gè)細(xì)化，利用整型的原始值來表示每個(gè)行星在太陽系中的順序：

enum Planet: Int {
    case mercury = 1, venus, earth, mars, jupiter, saturn, uranus, neptune
}

在上面的例子中，Plant.mercury 的顯式原始值為 1，Planet.venus 的隱式原始值為 2，依次類推。

當(dāng)使用字符串作為枚舉類型的原始值時(shí)，每個(gè)枚舉成員的隱式原始值為該枚舉成員的名稱。

下面的例子是 CompassPoint 枚舉的細(xì)化，使用字符串類型的原始值來表示各個(gè)方向的名稱：

enum CompassPoint: String {
    case north, south, east, west
}

上面例子中，CompassPoint.south 擁有隱式原始值 south，依次類推。

使用枚舉成員的 rawValue 屬性可以訪問該枚舉成員的原始值：

let earthsOrder = Planet.earth.rawValue
// earthsOrder 值為 3

let sunsetDirection = CompassPoint.west.rawValue
// sunsetDirection 值為 "west"

使用原始值初始化枚舉實(shí)例

如果在定義枚舉類型的時(shí)候使用了原始值，那么將會(huì)自動(dòng)獲得一個(gè)初始化方法，這個(gè)方法接收一個(gè)叫做 rawValue 的參數(shù)，參數(shù)類型即為原始值類型，返回值則是枚舉成員或 nil。你可以使用這個(gè)初始化方法來創(chuàng)建一個(gè)新的枚舉實(shí)例。

這個(gè)例子利用原始值 7 創(chuàng)建了枚舉成員 Uranus：

let possiblePlanet = Planet(rawValue: 7)
// possiblePlanet 類型為 Planet? 值為 Planet.uranus

然而，并非所有 Int 值都可以找到一個(gè)匹配的行星。因此，原始值構(gòu)造器總是返回一個(gè)可選的枚舉成員。在上面的例子中，possiblePlanet 是 Planet? 類型，或者說“可選的 Planet”。

注意

原始值構(gòu)造器是一個(gè)可失敗構(gòu)造器，因?yàn)椴⒉皇敲恳粋€(gè)原始值都有與之對應(yīng)的枚舉成員。更多信息請參見 可失敗構(gòu)造器。

如果你試圖尋找一個(gè)位置為 11 的行星，通過原始值構(gòu)造器返回的可選 Planet 值將是 nil：

let positionToFind = 11
if let somePlanet = Planet(rawValue: positionToFind) {
    switch somePlanet {
    case .earth:
        print("Mostly harmless")
    default:
        print("Not a safe place for humans")
    }
} else {
    print("There isn't a planet at position \(positionToFind)")
}
// 打印“There isn't a planet at position 11”

這個(gè)例子使用了可選綁定（optional binding），試圖通過原始值 11 來訪問一個(gè)行星。if let somePlanet = Planet(rawValue: 11) 語句創(chuàng)建了一個(gè)可選 Planet，如果可選 Planet 的值存在，就會(huì)賦值給 somePlanet。在這個(gè)例子中，無法檢索到位置為 11 的行星，所以 else 分支被執(zhí)行。

遞歸枚舉

遞歸枚舉是一種枚舉類型，它有一個(gè)或多個(gè)枚舉成員使用該枚舉類型的實(shí)例作為關(guān)聯(lián)值。使用遞歸枚舉時(shí)，編譯器會(huì)插入一個(gè)間接層。你可以在枚舉成員前加上 indirect 來表示該成員可遞歸。

例如，下面的例子中，枚舉類型存儲(chǔ)了簡單的算術(shù)表達(dá)式：

enum ArithmeticExpression {
    case number(Int)
    indirect case addition(ArithmeticExpression, ArithmeticExpression)
    indirect case multiplication(ArithmeticExpression, ArithmeticExpression)
}

你也可以在枚舉類型開頭加上 indirect 關(guān)鍵字來表明它的所有成員都是可遞歸的：

indirect enum ArithmeticExpression {
    case number(Int)
    case addition(ArithmeticExpression, ArithmeticExpression)
    case multiplication(ArithmeticExpression, ArithmeticExpression)
}

上面定義的枚舉類型可以存儲(chǔ)三種算術(shù)表達(dá)式：純數(shù)字、兩個(gè)表達(dá)式相加、兩個(gè)表達(dá)式相乘。枚舉成員 addition 和 multiplication 的關(guān)聯(lián)值也是算術(shù)表達(dá)式——這些關(guān)聯(lián)值使得嵌套表達(dá)式成為可能。例如，表達(dá)式 (5 + 4) * 2，乘號(hào)右邊是一個(gè)數(shù)字，左邊則是另一個(gè)表達(dá)式。因?yàn)閿?shù)據(jù)是嵌套的，因而用來存儲(chǔ)數(shù)據(jù)的枚舉類型也需要支持這種嵌套——這意味著枚舉類型需要支持遞歸。下面的代碼展示了使用 ArithmeticExpression 這個(gè)遞歸枚舉創(chuàng)建表達(dá)式 (5 + 4) * 2

let five = ArithmeticExpression.number(5)
let four = ArithmeticExpression.number(4)
let sum = ArithmeticExpression.addition(five, four)
let product = ArithmeticExpression.multiplication(sum, ArithmeticExpression.number(2))

要操作具有遞歸性質(zhì)的數(shù)據(jù)結(jié)構(gòu)，使用遞歸函數(shù)是一種直截了當(dāng)?shù)姆绞?。例如，下面是一個(gè)對算術(shù)表達(dá)式求值的函數(shù)：

func evaluate(_ expression: ArithmeticExpression) -> Int {
    switch expression {
    case let .number(value):
        return value
    case let .addition(left, right):
        return evaluate(left) + evaluate(right)
    case let .multiplication(left, right):
        return evaluate(left) * evaluate(right)
    }
}

print(evaluate(product))
// 打印“18”

該函數(shù)如果遇到純數(shù)字，就直接返回該數(shù)字的值。如果遇到的是加法或乘法運(yùn)算，則分別計(jì)算左邊表達(dá)式和右邊表達(dá)式的值，然后相加或相乘。