泛型

优质

小牛编辑

124浏览

2023-12-01

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

泛型是 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）是用角括號括起來的（）。這個角括號告訴 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是一種型別參數的示例。型別參數指定並命名為一個占位型別，並且緊隨在函式名後面，使用一對角括號括起來（如）。

一旦一個型別參數被指定，那麼其可以被使用來定義一個函式的參數型別（如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)的行為：

此處輸入圖片的描述

現在有三個值在棧中；
第四個值「pushed」到棧的頂部；
現在有四個值在棧中，最近的那個在頂部；
棧中最頂部的那個項被移除，或稱之為「popped」；
移除掉一個值後，現在棧又重新只有三個值。

這裡展示了如何寫一個非泛型版本的棧，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。The protocol does not define what ItemType is an alias for—that information is left for any conforming type to provide（這個協定不會定義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匹配。