Swift編程語言中文教程（二十二）：Swift泛型

---

本頁包含內容：

• 泛型所解決的問題
• 泛型函數
• 類型參數
• 命名類型參數
• 泛型類型
• 類型約束
• 關聯類型
• Where語句

泛型代碼可以讓你寫出根據自我需求定義、適用于任何類型的，靈活且可重用的函數和類型。它的可以讓你避免重復的代碼，用一種清晰和抽象的方式來表達代碼的意圖。

泛型是 Swift 強大特征中的其中一個，許多 Swift 標準庫是通過泛型代碼構建出來的。事實上，泛型的使用貫穿了整本語言手冊，只是你沒有發現而已。例如，Swift 的數組和字典類型都是泛型集。你可以創建一個Int數組，也可創建一個String數組，或者甚至于可以是任何其他 Swift 的類型數據數組。同樣的，你也可以創建存儲任何指定類型的字典（dictionary），而且這些類型可以是沒有限制的。

泛型所解決的問題

這里是一個標準的，非泛型函數swapTwoInts,用來交換兩個Int值：

func swapTwoInts(inout a: Int, inout b: Int)
  let temporaryA = a
  a = b
  b = temporaryA
}

這個函數使用寫入讀出（in-out）參數來交換a和b的值，請參考寫入讀出參數。

swapTwoInts函數可以交換b的原始值到a，也可以交換a的原始值到b，你可以調用這個函數交換兩個Int變量值：

var someInt = 3
var anotherInt = 107
swapTwoInts(&someInt, &anotherInt)
println("someInt is now \(someInt), and anotherInt is now \(anotherInt)")
// 輸出 "someInt is now 107, and anotherInt is now 3"

swapTwoInts函數是非常有用的，但是它只能交換Int值，如果你想要交換兩個String或者Double，就不得不寫更多的函數，如 swapTwoStrings和swapTwoDoublesfunctions，如同如下所示：

func swapTwoStrings(inout a: String, inout b: String) {
    let temporaryA = a
    a = b
    b = temporaryA
}

func swapTwoDoubles(inout a: Double, inout b: Double) {
    let temporaryA = a
    a = b
    b = temporaryA
}

你可能注意到 swapTwoInts、 swapTwoStrings和swapTwoDoubles函數功能都是相同的，唯一不同之處就在于傳入的變量類型不同，分別是Int、String和Double。

但實際應用中通常需要一個用處更強大并且盡可能的考慮到更多的靈活性單個函數，可以用來交換兩個任何類型值，很幸運的是，泛型代碼幫你解決了這種問題。（一個這種泛型函數后面已經定義好了。）

注意：
 在所有三個函數中，a和b的類型是一樣的。如果a和b不是相同的類型，那它們倆就不能互換值。Swift 是類型安全的語言，所以它不允許一個String類型的變量和一個Double類型的變量互相交換值。如果一定要做，Swift 將報編譯錯誤。

泛型函數

泛型函數可以工作于任何類型，這里是一個上面swapTwoInts函數的泛型版本，用于交換兩個值：

func swapTwoValues<T>(inout a: T, inout b: T) {
    let temporaryA = a
    a = b
    b = temporaryA
}

swapTwoValues函數主體和swapTwoInts函數是一樣的，它只在第一行稍微有那么一點點不同于swapTwoInts，如下所示：

func swapTwoInts(inout a: Int, inout b: Int)
func swapTwoValues<T>(inout a: T, inout b: T)

這個函數的泛型版本使用了占位類型名字（通常此情況下用字母T來表示）來代替實際類型名（如In、String或Doubl）。占位類型名沒有提示T必須是什么類型，但是它提示了a和b必須是同一類型T，而不管T表示什么類型。只有swapTwoValues函數在每次調用時所傳入的實際類型才能決定T所代表的類型。

另外一個不同之處在于這個泛型函數名后面跟著的展位類型名字（T）是用尖括號括起來的（<T>）。這個尖括號告訴 Swift 那個T是swapTwoValues函數所定義的一個類型。因為T是一個占位命名類型，Swift 不會去查找命名為T的實際類型。

swapTwoValues函數除了要求傳入的兩個任何類型值是同一類型外，也可以作為swapTwoInts函數被調用。每次swapTwoValues被調用，T所代表的類型值都會傳給函數。

在下面的兩個例子中,T分別代表Int和String：

var someInt = 3
var anotherInt = 107
swapTwoValues(&someInt, &anotherInt)
// someInt is now 107, and anotherInt is now 3

var someString = "hello"
var anotherString = "world"
swapTwoValues(&someString, &anotherString)
// someString is now "world", and anotherString is now "hello"

注意
 上面定義的函數swapTwoValues是受swap函數啟發而實現的。swap函數存在于 Swift 標準庫，并可以在其它類中任意使用。如果你在自己代碼中需要類似swapTwoValues函數的功能，你可以使用已存在的交換函數swap函數。

類型參數

在上面的swapTwoValues例子中，占位類型T是一種類型參數的示例。類型參數指定并命名為一個占位類型，并且緊隨在函數名后面，使用一對尖括號括起來（如<T>）。

一旦一個類型參數被指定，那么其可以被使用來定義一個函數的參數類型（如swapTwoValues函數中的參數a和b），或作為一個函數返回類型，或用作函數主體中的注釋類型。在這種情況下，被類型參數所代表的占位類型不管函數任何時候被調用，都會被實際類型所替換（在上面swapTwoValues例子中，當函數第一次被調用時，T被Int替換，第二次調用時，被String替換。）。

你可支持多個類型參數，命名在尖括號中，用逗號分開。

命名類型參數

在簡單的情況下，泛型函數或泛型類型需要指定一個占位類型（如上面的swapTwoValues泛型函數，或一個存儲單一類型的泛型集，如數組），通常用一單個字母T來命名類型參數。不過，你可以使用任何有效的標識符來作為類型參數名。

如果你使用多個參數定義更復雜的泛型函數或泛型類型，那么使用更多的描述類型參數是非常有用的。例如，Swift 字典（Dictionary）類型有兩個類型參數，一個是鍵，另外一個是值。如果你自己寫字典，你或許會定義這兩個類型參數為KeyType和ValueType，用來記住它們在你的泛型代碼中的作用。

注意
 請始終使用大寫字母開頭的駝峰式命名法（例如T和KeyType）來給類型參數命名，以表明它們是類型的占位符，而非類型值。

泛型類型

通常在泛型函數中，Swift 允許你定義你自己的泛型類型。這些自定義類、結構體和枚舉作用于任何類型，如同Array和Dictionary的用法。

這部分向你展示如何寫一個泛型集類型--Stack（棧）。一個棧是一系列值域的集合，和Array（數組）類似，但其是一個比 Swift 的Array類型更多限制的集合。一個數組可以允許其里面任何位置的插入/刪除操作，而棧，只允許在集合的末端添加新的項（如同push一個新值進棧）。同樣的一個棧也只能從末端移除項（如同pop一個值出棧）。

注意
 棧的概念已被UINavigationController類使用來模擬試圖控制器的導航結構。你通過調用UINavigationController的pushViewController:animated:方法來為導航棧添加（add）新的試圖控制器；而通過popViewControllerAnimated:的方法來從導航棧中移除（pop）某個試圖控制器。每當你需要一個嚴格的后進先出方式來管理集合，堆棧都是最實用的模型。

下圖展示了一個棧的壓棧(push)/出棧(pop)的行為：

1. 現在有三個值在棧中；
2. 第四個值“pushed”到棧的頂部；
3. 現在有四個值在棧中，最近的那個在頂部；
4. 棧中最頂部的那個項被移除，或稱之為“popped”；
5. 移除掉一個值后，現在棧又重新只有三個值。

這里展示了如何寫一個非泛型版本的棧，Int值型的棧：

struct IntStack {
    var items = Int[]()
    mutating func push(item: Int) {
        items.append(item)
    }
    mutating func pop() -> Int {
        return items.removeLast()
    }
}

這個結構體在棧中使用一個Array性質的items存儲值。Stack提供兩個方法：push和pop，從棧中壓進一個值和移除一個值。這些方法標記為可變的，因為它們需要修改（或轉換）結構體的items數組。

上面所展現的IntStack類型只能用于Int值，不過，其對于定義一個泛型Stack類（可以處理任何類型值的棧）是非常有用的。

這里是一個相同代碼的泛型版本：

struct Stack<T> {
    var items = T[]()
    mutating func push(item: T) {
        items.append(item)
    }
    mutating func pop() -> T {
        return items.removeLast()
    }
}

注意到Stack的泛型版本基本上和非泛型版本相同，但是泛型版本的占位類型參數為T代替了實際Int類型。這種類型參數包含在一對尖括號里（<T>），緊隨在結構體名字后面。

T定義了一個名為“某種類型T”的節點提供給后來用。這種將來類型可以在結構體的定義里任何地方表示為“T”。在這種情況下，T在如下三個地方被用作節點：

• 創建一個名為items的屬性，使用空的T類型值數組對其進行初始化；
• 指定一個包含一個參數名為item的push方法，該參數必須是T類型；
• 指定一個pop方法的返回值，該返回值將是一個T類型值。

當創建一個新單例并初始化時， 通過用一對緊隨在類型名后的尖括號里寫出實際指定棧用到類型，創建一個Stack實例，同創建Array和Dictionary一樣：

var stackOfStrings = Stack<String>()
stackOfStrings.push("uno")
stackOfStrings.push("dos")
stackOfStrings.push("tres")
stackOfStrings.push("cuatro")
// 現在棧已經有4個string了

下圖將展示stackOfStrings如何push這四個值進棧的過程：

從棧中pop并移除值"cuatro"：

let fromTheTop = stackOfStrings.pop()
// fromTheTop is equal to "cuatro", and the stack now contains 3 strings

下圖展示了如何從棧中pop一個值的過程：

由于Stack是泛型類型，所以在 Swift 中其可以用來創建任何有效類型的棧，這種方式如同Array和Dictionary。

類型約束

swapTwoValues函數和Stack類型可以作用于任何類型，不過，有的時候對使用在泛型函數和泛型類型上的類型強制約束為某種特定類型是非常有用的。類型約束指定了一個必須繼承自指定類的類型參數，或者遵循一個特定的協議或協議構成。

例如，Swift 的Dictionary類型對作用于其鍵的類型做了些限制。在字典的描述中，字典的鍵類型必須是可哈希，也就是說，必須有一種方法可以使其被唯一的表示。Dictionary之所以需要其鍵是可哈希是為了以便于其檢查其是否已經包含某個特定鍵的值。如無此需求，Dictionary既不會告訴是否插入或者替換了某個特定鍵的值，也不能查找到已經存儲在字典里面的給定鍵值。

這個需求強制加上一個類型約束作用于Dictionary的鍵上，當然其鍵類型必須遵循Hashable協議（Swift 標準庫中定義的一個特定協議）。所有的 Swift 基本類型（如String，Int， Double和 Bool）默認都是可哈希。

當你創建自定義泛型類型時，你可以定義你自己的類型約束，當然，這些約束要支持泛型編程的強力特征中的多數。抽象概念如可哈希具有的類型特征是根據它們概念特征來界定的，而不是它們的直接類型特征。

類型約束語法

你可以寫一個在一個類型參數名后面的類型約束，通過冒號分割，來作為類型參數鏈的一部分。這種作用于泛型函數的類型約束的基礎語法如下所示（和泛型類型的語法相同）：

func someFunction<T: SomeClass, U: SomeProtocol>(someT: T, someU: U) {
    // function body goes here
}

上面這個假定函數有兩個類型參數。第一個類型參數T，有一個需要T必須是SomeClass子類的類型約束；第二個類型參數U，有一個需要U必須遵循SomeProtocol協議的類型約束。

類型約束行為

這里有個名為findStringIndex的非泛型函數，該函數功能是去查找包含一給定String值的數組。若查找到匹配的字符串，findStringIndex函數返回該字符串在數組中的索引值（Int），反之則返回nil：

func findStringIndex(array: String[], valueToFind: String) -> Int? {
    for (index, value) in enumerate(array) {
        if value == valueToFind {
            return index
        }
    }
    return nil
}

findStringIndex函數可以作用于查找一字符串數組中的某個字符串:

let strings = ["cat", "dog", "llama", "parakeet", "terrapin"]
if let foundIndex = findStringIndex(strings, "llama") {
    println("The index of llama is \(foundIndex)")
}
// 輸出 "The index of llama is 2"

如果只是針對字符串而言查找在數組中的某個值的索引，用處不是很大，不過，你可以寫出相同功能的泛型函數findIndex，用某個類型T值替換掉提到的字符串。

這里展示如何寫一個你或許期望的findStringIndex的泛型版本findIndex。請注意這個函數仍然返回Int，是不是有點迷惑呢，而不是泛型類型?那是因為函數返回的是一個可選的索引數，而不是從數組中得到的一個可選值。需要提醒的是，這個函數不會編譯，原因在例子后面會說明：

func findIndex<T>(array: T[], valueToFind: T) -> Int? {
    for (index, value) in enumerate(array) {
        if value == valueToFind {
            return index
        }
    }
    return nil
}

上面所寫的函數不會編譯。這個問題的位置在等式的檢查上，“if value == valueToFind”。不是所有的 Swift 中的類型都可以用等式符（==）進行比較。例如，如果你創建一個你自己的類或結構體來表示一個復雜的數據模型，那么 Swift 沒法猜到對于這個類或結構體而言“等于”的意思。正因如此，這部分代碼不能可能保證工作于每個可能的類型T，當你試圖編譯這部分代碼時估計會出現相應的錯誤。

不過，所有的這些并不會讓我們無從下手。Swift 標準庫中定義了一個Equatable協議，該協議要求任何遵循的類型實現等式符（==）和不等符（!=）對任何兩個該類型進行比較。所有的 Swift 標準類型自動支持Equatable協議。

任何Equatable類型都可以安全的使用在findIndex函數中，因為其保證支持等式操作。為了說明這個事實，當你定義一個函數時，你可以寫一個Equatable類型約束作為類型參數定義的一部分：

func findIndex<T: Equatable>(array: T[], valueToFind: T) -> Int? {
    for (index, value) in enumerate(array) {
        if value == valueToFind {
            return index
        }
    }
    return nil
}

findIndex中這個單個類型參數寫做：T: Equatable，也就意味著“任何T類型都遵循Equatable協議”。

findIndex函數現在則可以成功的編譯過，并且作用于任何遵循Equatable的類型，如Double或String:

let doubleIndex = findIndex([3.14159, 0.1, 0.25], 9.3)
// doubleIndex is an optional Int with no value, because 9.3 is not in the array
let stringIndex = findIndex(["Mike", "Malcolm", "Andrea"], "Andrea")
// stringIndex is an optional Int containing a value of 2

關聯類型

當定義一個協議時，有的時候聲明一個或多個關聯類型作為協議定義的一部分是非常有用的。一個關聯類型給定作用于協議部分的類型一個節點名（或別名）。作用于關聯類型上實際類型是不需要指定的，直到該協議接受。關聯類型被指定為typealias關鍵字。

關聯類型行為

這里是一個Container協議的例子，定義了一個ItemType關聯類型：

protocol Container {
    typealias ItemType
    mutating func append(item: ItemType)
    var count: Int { get }
    subscript(i: Int) -> ItemType { get }
}

Container協議定義了三個任何容器必須支持的兼容要求：

• 必須可能通過append方法添加一個新item到容器里；
• 必須可能通過使用count屬性獲取容器里items的數量，并返回一個Int值；
• 必須可能通過容器的Int索引值下標可以檢索到每一個item。

這個協議沒有指定容器里item是如何存儲的或何種類型是允許的。這個協議只指定三個任何遵循Container類型所必須支持的功能點。一個遵循的類型也可以提供其他額外的功能，只要滿足這三個條件。

任何遵循Container協議的類型必須指定存儲在其里面的值類型，必須保證只有正確類型的items可以加進容器里，必須明確可以通過其下標返回item類型。

為了定義這三個條件，Container協議需要一個方法指定容器里的元素將會保留，而不需要知道特定容器的類型。Container協議需要指定任何通過append方法添加到容器里的值和容器里元素是相同類型，并且通過容器下標返回的容器元素類型的值的類型是相同類型。

為了達到此目的，Container協議聲明了一個ItemType的關聯類型，寫作typealias ItemType。這個協議不會定義ItemType是什么的別名，這個信息留給了任何遵循協議的類型來提供。盡管如此，ItemType別名支持一種方法識別在一個容器里的items類型，以及定義一種使用在append方法和下標中的類型，以便保證任何期望的Container的行為是強制性的。

這里是一個早前IntStack類型的非泛型版本，適用于遵循Container協議：

struct IntStack: Container {
    // original IntStack implementation
    var items = Int[]()
    mutating func push(item: Int) {
        items.append(item)
    }
    mutating func pop() -> Int {
        return items.removeLast()
    }
    // conformance to the Container protocol
    typealias ItemType = Int
    mutating func append(item: Int) {
        self.push(item)
    }
    var count: Int {
    return items.count
    }
    subscript(i: Int) -> Int {
        return items[i]
    }
}

IntStack類型實現了Container協議的所有三個要求，在IntStack類型的每個包含部分的功能都滿足這些要求。

此外，IntStack指定了Container的實現，適用的ItemType被用作Int類型。對于這個Container協議實現而言，定義 typealias ItemType = Int，將抽象的ItemType類型轉換為具體的Int類型。

感謝Swift類型參考，你不用在IntStack定義部分聲明一個具體的Int的ItemType。由于IntStack遵循Container協議的所有要求，只要通過簡單的查找append方法的item參數類型和下標返回的類型，Swift就可以推斷出合適的ItemType來使用。確實，如果上面的代碼中你刪除了 typealias ItemType = Int這一行，一切仍舊可以工作，因為它清楚的知道ItemType使用的是何種類型。

你也可以生成遵循Container協議的泛型Stack類型：

struct Stack<T>: Container {
    // original Stack<T> implementation
    var items = T[]()
    mutating func push(item: T) {
        items.append(item)
    }
    mutating func pop() -> T {
        return items.removeLast()
    }
    // conformance to the Container protocol
    mutating func append(item: T) {
        self.push(item)
    }
    var count: Int {
    return items.count
    }
    subscript(i: Int) -> T {
        return items[i]
    }
}

這個時候，占位類型參數T被用作append方法的item參數和下標的返回類型。Swift 因此可以推斷出被用作這個特定容器的ItemType的T的合適類型。

擴展一個存在的類型為一指定關聯類型

在使用擴展來添加協議兼容性中有描述擴展一個存在的類型添加遵循一個協議。這個類型包含一個關聯類型的協議。

Swift的Array已經提供append方法，一個count屬性和通過下標來查找一個自己的元素。這三個功能都達到Container協議的要求。也就意味著你可以擴展Array去遵循Container協議，只要通過簡單聲明Array適用于該協議而已。如何實踐這樣一個空擴展，在使用擴展來聲明協議的采納中有描述這樣一個實現一個空擴展的行為：

extension Array: Container {}

如同上面的泛型Stack類型一樣，Array的append方法和下標保證Swift可以推斷出ItemType所使用的適用的類型。定義了這個擴展后，你可以將任何Array當作Container來使用。

Where 語句

類型約束中描述的類型約束確保你定義關于類型參數的需求和一泛型函數或類型有關聯。

對于關聯類型的定義需求也是非常有用的。你可以通過這樣去定義where語句作為一個類型參數隊列的一部分。一個where語句使你能夠要求一個關聯類型遵循一個特定的協議，以及（或）那個特定的類型參數和關聯類型可以是相同的。你可寫一個where語句，通過緊隨放置where關鍵字在類型參數隊列后面，其后跟著一個或者多個針對關聯類型的約束，以及（或）一個或多個類型和關聯類型的等于關系。

下面的列子定義了一個名為allItemsMatch的泛型函數，用來檢查是否兩個Container單例包含具有相同順序的相同元素。如果匹配到所有的元素，那么返回一個為true的Boolean值，反之，則相反。

這兩個容器可以被檢查出是否是相同類型的容器（雖然它們可以是），但它們確實擁有相同類型的元素。這個需求通過一個類型約束和where語句結合來表示：

func allItemsMatch<
    C1: Container, C2: Container
    where C1.ItemType == C2.ItemType, C1.ItemType: Equatable>
    (someContainer: C1, anotherContainer: C2) -> Bool {

        // check that both containers contain the same number of items
        if someContainer.count != anotherContainer.count {
            return false
        }

        // check each pair of items to see if they are equivalent
        for i in 0..someContainer.count {
            if someContainer[i] != anotherContainer[i] {
                return false
            }
        }

        // all items match, so return true
        return true

}

這個函數用了兩個參數：someContainer和anotherContainer。someContainer參數是類型C1，anotherContainer參數是類型C2。C1和C2是容器的兩個占位類型參數，決定了這個函數何時被調用。

這個函數的類型參數列緊隨在兩個類型參數需求的后面：

• C1必須遵循Container協議 (寫作 C1: Container)。
• C2必須遵循Container協議 (寫作 C2: Container)。
• C1的ItemType同樣是C2的ItemType（寫作 C1.ItemType == C2.ItemType）。
• C1的ItemType必須遵循Equatable協議 (寫作 C1.ItemType: Equatable)。

第三個和第四個要求被定義為一個where語句的一部分，寫在關鍵字where后面，作為函數類型參數鏈的一部分。

這些要求意思是：

someContainer是一個C1類型的容器。 anotherContainer是一個C2類型的容器。someContainer和anotherContainer包含相同的元素類型。 someContainer中的元素可以通過不等于操作(!=)來檢查它們是否彼此不同。

第三個和第四個要求結合起來的意思是anotherContainer中的元素也可以通過 != 操作來檢查，因為它們在someContainer中元素確實是相同的類型。

這些要求能夠使allItemsMatch函數比較兩個容器，即便它們是不同的容器類型。

allItemsMatch首先檢查兩個容器是否擁有同樣數目的items，如果它們的元素數目不同，沒有辦法進行匹配，函數就會false。

檢查完之后，函數通過for-in循環和半閉區間操作（..）來迭代someContainer中的所有元素。對于每個元素，函數檢查是否someContainer中的元素不等于對應的anotherContainer中的元素，如果這兩個元素不等，則這兩個容器不匹配，返回false。

如果循環體結束后未發現沒有任何的不匹配，那表明兩個容器匹配，函數返回true。

這里演示了allItemsMatch函數運算的過程：

var stackOfStrings = Stack<String>()
stackOfStrings.push("uno")
stackOfStrings.push("dos")
stackOfStrings.push("tres")

var arrayOfStrings = ["uno", "dos", "tres"]

if allItemsMatch(stackOfStrings, arrayOfStrings) {
    println("All items match.")
} else {
    println("Not all items match.")
}
// 輸出 "All items match."

上面的例子創建一個Stack單例來存儲String，然后壓了三個字符串進棧。這個例子也創建了一個Array單例，并初始化包含三個同棧里一樣的原始字符串。即便棧和數組否是不同的類型，但它們都遵循Container協議，而且它們都包含同樣的類型值。你因此可以調用allItemsMatch函數，用這兩個容器作為它的參數。在上面的例子中，allItemsMatch函數正確的顯示了所有的這兩個容器的items匹配。