如果你已經動手寫過Swift的程序,相信你已經了解了Swift語言的知識,比如如何寫類(class)和結構體(struct)。但Swift可沒這么簡單,呵呵呵。這篇教程主要講述Swift的一個強力的特性:泛型。這個特性在很多程序設計語言里都非常受歡迎。
對于類型安全(type-safe)語言,一個常見的問題就是如何編寫適用于多種類型輸入的程序。想象一下,兩個整型數相加和兩個浮點數相加的程序看起來應該非常類似,甚至一模一樣才對。唯一的區別就是變量的類型不同。
在強類型語言中,你需要去定義諸如addInts, addFloats, addDoubles 等方法來正確地處理參數及返回值。
許多編程語言已經解決了這個問題。例如,在C++中,使用Template來解決。而Swift,Java和C#則采用了泛型來解決這個問題。泛型,也是這篇文章要重點介紹的。
在這篇文章中,你將會學到Swift中如何使用泛型,也許你已經接觸過,也許沒有,不過沒關系,我們會來一一探索。然后,我們會創建一個Flicker圖片搜索應用,這個應用使用了自定義的泛型數據結構來保存用戶搜索的內容。
備注:本文假設你已經對Swift有基本的了解或者有過Swift開發經驗。如果你第一次接觸Swift或者對Swift不是太了解,建議你首先閱讀下other Swift tutorials。
泛型介紹
也許你不知道這個術語,但相信你已經在Swift中見到它了。Swift中的數組和字典類型就是使用泛型的經典例子。
Object-C開發者已經習慣使用數組和字典去保存多種數據類型。這種方式提供了很大的靈活性,但是誰又能知道一個API返回的數組里面到底是啥(數據類型)呢?你唯一能做的就是查看文檔或者查看(方法的)變量命令(這也是另外一種文檔喲!)。即使你查看了文檔,你也不能保證程序在運行期不產生bug或者其他異常。
相比Object-C,Swift中的數組和字典都是類型安全的。一個Int型數組只可以保存Int而不可以保存String。這意味著你不用再查看文檔啦,編譯器就可以幫你做類型檢查,然后你就就快可以愉快地coding了!
例如,在Object-C的UIKit中, 在自定義的View里面處理觸摸事件可以這么寫:
上述方法里面的set只可以保存UITouch實例, 因為文檔里面就是這么說的。由于這個集合里面可以放任何對象,所以你需要在代碼里面進行類型轉換,也就是說把touches里面的對象轉為UITouch對象。
當前Swift的標準庫里面沒有定義集合對象,但是你可以使用數組來代替集合對象,你可以用swift重寫上面的代碼:
上面的代碼明確告訴你 touches數組只可以包含 UITouch實例, 否則編譯器就會報異常。這樣一來,你就再不用去做那煩人的類型轉換了,因為編譯器給你做了類型安全檢查,保證數組里面只允許有 UITouch對象。
簡要說來,泛型為類提供了一個類型參數。所有的數組都有相同的作用,即按順序儲存變量的數值,泛型數組除了多了一個類型參數之外,沒有其他的不同之處?;蛟S這樣想更容易理解:你將要應用在數組上的各種算法和儲存的數值類型無關,因此這些算法對于泛型數組和非泛型數組都適用。
既然你已經明白了泛型的基礎知識和用法,那我們就開始把它應用在一個具體的例子上吧。
泛型實例
為了測試泛型,你將會編寫一個在Flickr上搜索圖片的應用。
首先請下載這個程序雛形,并盡快熟悉里面主要的類。其中Flickr類用于和Flickr的API交互。請注意這個類里面包含了一個API key(通常用于用戶授權—譯者注),但如果你想要擴展這個應用的話可能需要用自己的key,注冊請點我。
構造并運行這個應用,你會看到這個:
好像什么都沒有?別急,用不了多久你就可以讓它幫你抓取可愛的喵圖了!
有序字典(原文Ordered Dictionaries)
你的應用會根據每個用戶的查詢情況下載圖片,按照圖片被搜索到的頻率由高到低排序并顯示。
但如果用戶對同樣的關鍵字搜索了兩次會怎樣?如果這個應用能顯示上次搜索的結果就好了。
或許用數組來實現這個功能也行得通,但為了學習泛型,你將會使用一個全新的數據結構:有序字典。
和數組不同的是,包括Swift在內地很多編程語言和框架都不保證集合(sets)和字典(dictionaries)的數據存儲順序。有序字典和普通的字典類似,不同之處在于它的key是有序的。你將會用這個特性,根據搜索關鍵字按順序存儲搜索結果。這樣存儲的好處是可以快速查詢并更新圖片列表。
一個草率的想法是自定義一個數據結構處理有序字典。但是你需要更加有前瞻性才行!你必須考慮到如何讓你的應用在未來幾年內都能正常工作!因此在這里使用泛型再合適不過了。
初始數據結構
點擊“文件/新建/文件...”新建一個文件,并選擇“IOS/Source/Swift File”。點擊“下一步”并把這個文件命名為“OrderedDictionary”。最后,點擊“創建”。
你會得到一個空的Swift文件,加這樣一段代碼進去:
到現在為止應該都沒有什么問題。通過語義可以看出這個對象是一個結構體。
注意:總之,值的語義可以想象為“復制、粘貼的行為”,而不是“分享、參考的行為”。值的語義帶來一系列的好處,例如不用擔心一段代碼無意地修改你的數據。了解更多,點擊"Swift by Tutorials"的第三章節:類和結構體。
現在你需要將其一般化,以便它能夠裝載你需要的任何類型的數據。通過下列改變你對Swift中“結構”的定義:
在尖括弧中的元素是通用類型的參數。KeyType和ValueType不是他們自身的類型,而是你可以使用在結構里定義取代的類型?,F在就簡潔清新許多了!
最簡單的實現一個有順序的字典是保持一個數組和一個字典。字典中將會裝載衍射,而數組將裝載keys的順序。
在結構體內部的定義中,加入以下的代碼:
這樣聲明有兩個目的,就像上例描述的,有兩種類型的用于給已經存在的類型的取新的名稱的別名。在這,你將分別地為后面的數組和字典賦值了別名。聲明別名是將復雜類型定義為更短名稱的類型的一種非常有效的方式。
你將注意怎么樣從結構體中定義用“KeyType”和“ValueType”的參數類型中替換類型。上例的"KeyTypes"是數組類型的。當然這是沒有這樣的類型的“KeyType”;當在一般的實例化時,將替代Swift像對OrderedDictionary的類型的一切類型通過。
就因為這樣,你將會注意到編譯錯誤:
或許你會詫異怎么會這樣?請再觀察下Dictionary的繼承者:
除了在KeyType之后的HashTable, 其他的都和OrderedDictionary的定義特別的相似。在分號后面為KeyType聲明的Hashable,一定符合Hashable的協議。這是因為字典需要為hash key實現。
用這種方式約束泛型參數是非常常見的。例如,你想要依據你的應用使用參數做什么,來約束值的類型以,確保相等性、可打印性協議。
打開OrderedDictionary.Swift,用下例來取代你對結構體的定義:
這樣為OrderedDictionary聲明KeyType,必須符合Hashable。這就意味著,無論KeyType變成什么類型,都可以接受為沒有聲明的字典的KEY。
這樣,文件再次編譯,將不會報錯!
Keys, Values 和所有的這些趣事
如果不能為字典添加值,那么字典有什么作用了?打開OrderedDictionary.swift,在你的結構體定義中添加以下函數:
var adjustedIndex = index
// 2
let existingValue = self.dictionary[key]
if existingValue != nil {
// 3
let existingIndex = find(self.array, key)! // 4
if existingIndex < index {
adjustedIndex--
}
self.array.removeAtIndex(existingIndex)
} // 5
self.array.insert(key, atIndex:adjustedIndex)
self.dictionary[key] = value
// 6
return existingValue}
下面介紹一些新的特性。讓我們一步一步來介紹:
- 插入一個新對象的方法,insert(_:forKey:atIndex),需要三個參數:一個特別的key的值,插入一對key-value的索引。這是你之前沒有注意到的一個關鍵字:改變。
- 結構體的設計是默認不變的,這意味著通常你在實例化的方法中,不能改變結構的成員變量。這十分有限,你能添加改變的關鍵字,并告訴編譯器這個方式在結構體中是允許改變的。這將幫助編譯器做出決定什么時候復制結構體(他們是寫時復制的),也有助于API的編檔。
- 你為字典的索引器輸入一個如果已經存在,那么返回已存在的值的key,這個插入方法模擬字典更新值相同的行為,因此為這個值保持已經存在的值。
- 如果這有一個已經存在的值,只有這樣函數才能為這個值在數組里找出索引。
- 如果這個已經存在的key在插入索引的之前,這時你需要調整插入的索引,因為你需要移除已經存在的key。
- 你將適當地更新數組和字典。
- 最后,你返回已存在的值,當這或許沒有已存在的值,這個函數返回一個可選的值!
現在你可以為字典添加移除值?
像下列對OrderedDictionary結構體的定義的函數:
// 2
precondition(index < self.array.count, "Index out-of-bounds") // 3
let key = self.array.removeAtIndex(index) // 4
let value = self.dictionary.removeValueForKey(key)! // 5
return (key, value)}
現在再讓我們一步一步分析:
1.這是改變結構體狀態的函數,removeAtIndex的名稱需要和數組的方法匹配。恰當的時候,考慮使用鏡像系統庫中API是不錯的選擇。這樣幫助開發者在他們的工作平臺里,非常容易地使用你的API。
2.首先,你需要檢查索引,觀察他們是否是在大量的數組里。嘗試著從未聲明的數組中移除越位的元素,將會導致超時錯誤,所有在這時檢查將會更早符合這樣的情況。你或許在Objective-C中使用斷言函數;在Swift中斷言也是可使用的。但是前提是在釋放的工程中是活動的,否則你運行的應用的將會終止。
3.接著,當同時從數組中移除值時,你在給定的索引中數組中獲得值。
4.然后,你從字典中為這個key移除的值,同時也會返回這個值?;蛟S在給出的key中,字典也沒有相應的值,所以removeValueForKey返回一個可選的。這種情況下,你知道字典將會為給出的key,包含一個值,因為這是唯一的自己給字典添加值的方法--insert(_:forKey:atIndex:),這時你可以選擇使用“!”,表明這將會有正義感值。
5.最后,你在一個元組返回的key和value。數組的removeAtIndex和字典的removeValueForKey是一樣的返回已存在的值功能。
值的讀取跟寫入
把值寫入字典(dictionary)是沒問題了, 可是這樣還不夠! 你還需要實現一個方法(method) 從字典中讀出相應的值.
打開 OrderedDictionary.swift 文件, 然后把下列代碼添加到結構定義(struct definition)當中, , 就放在 thearrayanddictionaryvariable 聲明的下面:
return self.array.count}
這個常用的屬性, 用來算出字典里面有幾條記錄. 只要返回數組的 count 屬性的中值就可以了!
接下來, 就是如何訪問(Access)字典中的記錄了(Element). 我們可以通過下標(Subscript)來訪問, 代碼如下:
下標的語法我們會用了, 但是如果是我們自己定義的類那該怎么用呢? 好在 Swift 支持在自定義類里頭添加這項功能. 而且實現起來也不復雜.
把下列代碼添加到結構定義的底部:
subscript(key: KeyType) -> ValueType? {
// 2(a)
get {
// 3
return self.dictionary[key]
}
// 2(b)
set {
// 4
if let index = find(self.array, key) {
} else {
self.array.append(key)
} // 5
self.dictionary[key] = newValue
}
}
我們詳細解釋下這段代碼:
- 上面代碼注釋中標有 1 的那一段:跟 func 和 var 類似, subscript 也是個關鍵字, 通過它定義下標. 參數 key 是出現在中括號中的那個對象.
- 注釋中標有 2 的那一段: 下標由 setter 跟 getter 兩部分組成. 本例同時定義了 setter (代碼中的 set ) 跟 getter (代碼中的 get ). 當然, 不是每個下標都要同時定義 setter 跟 getter.
- 注釋中標有 3 的那一段: getter 比較簡單, 只要通過參數 key, 在字典中找到相應的值即可. 字典返回的是可選值(optinal), 如果 key 不存在, 該值為 nil.
- 注釋中標有 4 的那一段: setter 就復雜些. 首先要檢測這個 key 在有序字典里面是不是已經存在. 如果不存在, 則把 key 添加到數組中. 由于我們需要把 key 添加到數組的尾部, 所以這里調用的是 append 方法.
- 注釋中標有 5 的那一段: 把值添加到字典中. 這里用隱性命名的變量 newValue 獲取傳遞過來的值.
就像用 Swift 自帶的字典類的下標那樣去, 你可以通過 key 來查找某個值. 可是如果我們需要像訪問數組那樣, 用下標索引(index)訪問某個值, 該怎么辦呢? 既然是有序字典, 沒有道理不能通過下標索引一個一個的按順序訪問.
結構體跟類可以定義多個參數類型不同的下標(subscript). 把下列代碼添加到結構定義的底部:
// 1
get {
// 2
precondition(index < self.array.count,
"Index out-of-bounds") // 3
let key = self.array[index] // 4
let value = self.dictionary[key]! // 5
return (key, value)
}}
這段代碼跟前面那段類似, 不同的是參數類型變成了 Int. 因為我們現在要實的功能是現像數組那樣, 使用下標索引訪問有序字典. 不過這次返回的是由 key 跟 value 組成的一個元組(tuple). 因為有序字典就是由這樣一個一個的元組構成的.
下面具體解釋下這段代碼:
- 這個下標只定義了 getter. 當然你也可以把 setter 加上. 不過要注意先檢查 index 會不會越界.
- index 的值不能超出數組的界限, 也就是字典元組的個數. 我們可以利用 precondition 提示開發人員, 程序出現越界訪問.
- 用 index 從數組中讀出 key.
- 再用 key 從字典中讀取 value. 需要注意的是, 由于數組中的每一個 key 跟字典的 value 是一一對應的, 所以這里使用符號 ! (unwrapped) 對讀出來的 value 拆包.
- 最后, 返回一個包含 key 和 value 的元組.
挑戰: 為上面那個下標實現 setter . 可以參考前面的例子.
提示 1
注意, newValue 是個包含 key 跟 value 的元組.
提示 2
下列代碼可以將值從元組中提取出來:
也許你會好奇, 如果 KeyType 是 Int 型的, 會出現什么問題? 使用泛型的好處是, 不管是什么類型, 只要能算出哈希值(hashable)的就行, 所以 Int 當然也能用. 問題是, 當 key 也是 Int 型的時候, 這倆個下標該怎么區分呢?
這就需要我們給編譯器提供更多的類型信息. 讓它知道在什么時調用哪個下標. 比如我們定義的這兩個下標, 返回的類型不一樣. 如果你用 key-value 類型的元組給它賦值, 編譯器就會自動調用那個數組式(array-style )的下標.
在項目中測試
讓我們在實際項目中,實驗編譯推斷使用的下標函數,以及一般情況下,OrderedDictionary是怎么工作的。
通過點擊"文件"、"創建"、"文件",新建一個項目,依次選擇"IOS"、"Source"、"Playground",再點擊下一步。然后點擊創建。
你必須得這樣操作:復制和粘貼OrderedDictionary.swift整體到新建的項目中。因為不能在寫教程時你的應用模型中”看見”代碼
注意:這有一個解決方法,可以取代復制、粘貼的方式。如果你需要將你應用的代碼加入到一個框架中,你的項目將接受的你代碼,就像Corrine Krych指出的這樣。
現在,在你的項目底部加入下列的代碼:
+ " : "
+ dict.dictionary.description) var byIndex: (Int, String) = dict[0]println(byIndex) var byKey: String? = dict[2]println(byKey)
在側欄中(或者通過視圖/助理編輯/顯示助理編輯/),你將可以看到println()函數輸出的內容:
在這個例子中,字典有一個整數型的key,所以編譯器會審查被使用分配決定使用哪個下標變量的類型。如果被使用的下標是一個(Int, String)的byIndex,編譯器會匹配期望的返回值類型,使用數組類型的索引的下標。
如果你想從一個 byIndex 或者 byKey的變量中,移除類型的定義。編譯器將會報錯,表明編譯器不知道使用哪一個下標。
小貼士:由于編譯器是按照類型推理來工作的,所以需要明確地表示出類型。當存在多個有相同的爭議的返回值類型的函數時,調用者需要具體化。需要注意:Swift中函數,可以“建-破”改變。
通過在項目中,對有順序的字典的實驗中,你可以發現他的工作原理。在重返app之前,嘗試從中添加、移除、以及改變key和value的類型。現在,你可以在你的順序字典中讀、寫操作!但要小心你的數據結構。現在你可以通過app來感受其中的樂趣了!
添加圖片查找
現在是時候讓你回過頭來注意手中的app了。打開 MasterViewController.swift。在兩個@IBOutlets 的下面,添加下列變量的定義:
你或許在困惑,為什么Flickr.Photo的類型中有個句號。那是因為Photo是在Flickr類的內部定義的類。在Swift中,這樣的層次結構是非常有利的。它將有助于類的名稱簡短化。在Flickr的內部,你可以單獨使用Photo類,因為上下文關系告訴了編譯器這是什么。這是順序化字典查詢用戶訂閱的Flickr的功能。真像你看到的,包含查詢的字符串,和Flickr.Photo數組,或是從Flickr API 中返回的照片。注意,你在尖括號里給出的key和value,將成為在具體實現中KeyType和ValueType的參數類型。
接下來,找到表格視圖數據源的tableView(_:numberOfRowsInSection:)方法,然后把它改為如下所示:
numberOfRowsInSection section: Int) -> Int{
return self.searches.count}
這個方法使用有序字典來告訴表格視圖有多少行。接著,找到表格視圖數據源的tableView(_:cellForRowAtIndexPath:)方法并把它改為如下所示:
func tableView(tableView: UITableView,
cellForRowAtIndexPath indexPath: NSIndexPath)
-> UITableViewCell{
// 1
let cell =
tableView.dequeueReusableCellWithIdentifier("Cell",
forIndexPath: indexPath) as UITableViewCell // 2
let (term, photos) = self.searches[indexPath.row] // 3
if let textLabel = cell.textLabel {
textLabel.text = "/(term) (/(photos.count))"
}
return cell}
這是你在這個方法中所做的:
1. 首先,從UITableView中挪出一個單元格。你需要把它直接轉換為UITableViewCell,因為dequeueReusableCellWithIdentifier仍舊返回AnyObject(id in Objective-C),而不是UITableViewCell。或許在將來,蘋果公司會利用泛型重寫這部分API。
2. 接著,用你給的下標索引從指定的行獲取Key和Value,
3. 最后,適當地設置單元格的文本標簽并且返回當前單元格。
現在讓我們嘗嘗鮮。找到UISearchBarDelegate 的拓展,就像下列的代碼一樣,改變單例方法。
func searchBarSearchButtonClicked(searchBar: UISearchBar!) {
// 1
searchBar.resignFirstResponder() // 2
let searchTerm = searchBar.text
Flickr.search(searchTerm) {
switch ($0) {
case .Error:
// 3
break case .Results(let results):
// 4
self.searches.insert(results,
forKey: searchTerm,
atIndex: 0) // 5
self.tableView.reloadData()
}
}}
當用戶點擊查詢按鈕時,這個方法將會被調用。下列就是在這個方法中,你正做的事:
1.你第一反應是放棄使用查詢框以及鍵盤。
2.然后,你又會使用搜索框查詢你輸入的文字,為查詢的文字而使用Flickr類來尋找。Flickr的查詢方法是:查詢術語,關閉執行查詢成功或者失敗。通過參數關閉:要不是錯誤,那就是結果。
3.在錯誤的情況下,不會發生任何事。但是你可以通過使用警報來提示錯誤,但是現在我們可以簡化這樣的操作。代碼需要在這時暫停會兒,告訴Swfit編譯器你的錯誤沒有任何反應的動機。
4.如果查詢有效,將會在查詢結果中顯示相關的值。你將查詢的術語作為key加入到順序字典中。如果已經在字典中存在了,將會把他放入到list的頂部,然后用最后的結果更新整個字典。
5.最終,由于你有新的數據,將再次加載table view。
哇!你的app將可以用于查詢圖片了!
構建并運行app,做幾次查詢。你將會看到下面這樣的一些東西:
現在再用與之前搜索詞不同的另外一個進行查詢. 你將會看到它跳到了頂部:
選擇一個查詢結果點擊去,你會發現它并沒有顯示照片。現在是時候修復這個問題了!
給我看照片!
打開MasterViewController.swift 并找到 prepareForSegue. 將它修改成下面這樣:
override func prepareForSegue(segue: UIStoryboardSegue,
sender: AnyObject?){
if segue.identifier == "showDetail" {
if let indexPath = self.tableView.indexPathForSelectedRow()
{
let (_, photos) = self.searches[indexPath.row]
(segue.destinationViewController as DetailViewController).photos = photos }
}}
這是用了同創建單元項時訪問被排好序的查詢結果字典一樣的方法. 盡管沒有使用關鍵詞(檢索詞), 你也可以用下劃線來顯示出元組的這個部分不需要被綁定到一個本地變量.
構建并運行app,做一次查詢然后點進去。你會看到像下面這樣的東西:
你好,小貓貓! 你有沒有想要發出快樂的呼聲呢? :]