(Swift) iOS Apps with REST APIs(五) -- 整合REST API和表格視圖

本文將繼續前面的教程,繼續講解如何通過REST API獲取數據列表并解析為Swift對象,然后顯示在表格視圖中。

重要說明: 這是一個系列教程,非本人原創,而是翻譯國外的一個教程。本人也在學習Swift,看到這個教程對開發一個實際的APP非常有幫助,所以翻譯共享給大家。原教程非常長,我會陸續翻譯并發布,歡迎交流與分享。

為什么使用像Alamofire這樣的庫

關于編程中最難的兩件事情有一堆的笑話。有人說最難的事情是命名、評估和off-by-one(譯者注:off-by-one大小差一錯誤是程序設計中常見錯誤,具體可以參考這里off-by-one)錯誤。還有人說是評估和拿到回報。但我認為是固化需求,固化需求可以讓你知道哪些東西需要做,并能夠讓你保持代碼在同一級別上抽象。

那么什么是在同一級別上抽象呢?先讓我們看看一些古老的,讓人迷糊的Objective-C代碼:

NSArray *myGists = [[NSArray alloc]] initWithObjects:
  [NSString stringWithString:@"text of gist 1"],
  [NSString stringWithString:@"text of gist 2"],
  nil];
    
// 使用myGists進行某些處理
 
[myGists release];

這段代碼的核心功能就是想對Gists數組進行某些處理。但是對于程序員來說,這里想的不僅僅是gists,還要考慮內存的管理(如:分配alloc、釋放release)。因此,對于他們來說,在腦中要同時處理2個不同層次的抽象。這些對象不僅是Gists對象,它們還是內存中的塊。

當然,所有的Gists對象都是內存中的塊。而且某個地方的代碼也是這么去處理。但,它還是不應該與gists的業務操作,如收藏、編輯,在同一個地方。這也會把web service的調用混在一起了:

  • 一部分代碼需要知道并處理底層的網絡事務
  • 一部分代碼要處理JSON
  • 還有一部分代碼要處理gists(或你的對象)

這是三個層次的抽象,它們不需要(也不應該)混在一起。在同一層次的抽象上編碼,要比在不同層次上來回切換理解代碼要輕松的多。

你可以不需要像SwiftyJSON、Alamofire這樣的庫。但它們的確能把底層處理封裝的更好。而且一旦它們開源,你還可以在需要的時候對代碼進行調整修改,而你又會失去什么呢?

連接REST API和表格視圖

UITableView控件是iOS應用中常用的控件。結合Web Service,就是很多App的核心業務功能,如:郵件、Twitter及Facebook,甚至蘋果自己的備忘錄,連App Store也是一樣。

接下來我們將新建一個Xcode工程,通過GitHub的gists API獲取數據。然后在表格視圖中顯示公共的gists列表。由此,我們將發起一個GET請求,并將返回的數據解析為JSON格式,然后讓表格視圖顯示這些結果。

本章重點講的是如何把API返回的數據綁定到表格視圖中,不會涉及如何將UITableView控件添加到Swift應用這種基礎知識。如果你對如何使用UITableView控件有困惑,請參考Apple's docs或者這個教程

如果你不想自己敲代碼,請到GitHub下載本章的代碼

1. 創建Swift工程

我們終于可以動手創建GitHub Gists應用了。首先我們需要在Xcode中創建一個工程:

啟動Xcode。

創建一個master-detail類型Swift工程(Devices中你可以選擇universal或者iPhone)。確保在創建工程時選擇使用Swift語言,并且沒有選中Core Data選項。

使用CoclaPods將Alamofire 3.1SwoftyJSON 2.3添加到工程中(如果不知道如何做,請參考這里)。

然后,打開類型為.xcworkspace文件。

由于我們現在還使用不到由Xcode生成的樣板代碼,先不要管它,后面我們涉及到的時候會來解釋。這里你唯一需要注意的是,Xcode創建了兩個視圖控制器:一個表格視圖控制器MasterViewController,和一個detailViewController詳細頁面視圖控制器。而它們正好可以用來顯示我們gists的列表和gist的詳細信息。接下來幾章我們都會與MasterViewController打交道。

創建一個新文件并命名為:GitHubAPIManager.swift。這個類將負責與API之間的處理,也可以稱為API管理器。它可以幫我們把代碼組織的更好,也避免使視圖控制器的代碼變成一個龐大的文件。同時,也方便我們可以在多個視圖控制器之間共享代碼。

在文件的頭部,引入Alamofire和SwiftyJSON:

import Foundation
import Alamofire
import SwiftyJSON
  
class GitHubAPIManager {

}

如果你是使用的是其它API代碼,那么最好這里將名稱更改為合適的名稱,而不是GitHubAPIManager

當你與API打交道的時候,通常我們會得到的是一堆代碼,而不是一個對象。我們需要設置自定義報頭,跟蹤OAuth訪問令牌,處理client secretsclient ID,處理認證或者其它常見的錯誤。為了將這些代碼從App Delegate及我們的模型對象中分離,我們將會把它們統一到GitHubAPIManager中進行管理。

在本教程的實例中我們只與GitHub API打交道,所以這里只有一個API管理器。因此我們在該類中聲明一個sharedInstance變量,這樣其它調用者就可以通過它來獲取GitHubAPIManager的唯一實例:

import Foundation
import Alamofire
import SwiftyJSON
  
class GitHubAPIManager {
  static let sharedInstance = GitHubAPIManager()
} 

接下來我們就可以通過API請求獲取不需認證的公共gists列表了。為了方便我們快速理解,這里當我們獲取API請求結果后先在控制臺打印出來。然后我們再把它和表格視圖集成。

因此,我們先聲明這個簡單的方法:

class GitHubAPIManager {
  ...
  
  func printPublicGists() -> Void {
    // TODO: 待實現
  }
}

接下來讓我們創建Router路由,并把新建的文件命名為:GistRouter.swift。該路由器將負責創建URL請求,從而能夠讓我們的API管理器保持簡單。新建的路由器和前面類似,除了只有一個獲取公共gists的GET調用:

import Foundation
import Alamofire
  
enum GistRouter: URLRequestConvertible {
  static let baseURLString:String = "https://api.github.com"
  case GetPublic() // GET https://api.github.com/gists/public
  var URLRequest: NSMutableURLRequest { 
    var method: Alamofire.Method {
      switch self { 
      case .GetPublic:
        return .GET
      }
    }
      
    let result: (path: String, parameters: [String: AnyObject]?) = { 
      switch self {
      case .GetPublic:
        return ("/gists/public", nil) 
      }
    }()
      
    let URL = NSURL(string: GistRouter.baseURLString)!
    let URLRequest = NSMutableURLRequest(URL: URL.URLByAppendingPathComponent(result.path)) 
      
    let encoding = Alamofire.ParameterEncoding.JSON
    let (encodedRequest, _) = encoding.encode(URLRequest, parameters: result.parameters) 
      
    encodedRequest.HTTPMethod = method.rawValue
      
    return encodedRequest  
  }
}

獲取公共的gists:

func printPublicGists() -> Void { 
  Alamofire.request(GistRouter.GetPublic())
    .responseString { response in
      if let receivedString = response.result.value {
        print(receivedString)
      }
  }
}

為了可以測試該代碼,你需要修改MasterViewControllerviewDidAppear方法。該方法在每次主視圖顯示的時候都會調用:

override func viewDidAppear(animated: Bool) { 
  super.viewDidAppear(animated)
  // 開始測試
  GitHubAPIManager.sharedInstance.printPublicGists() 
  // 結束測試
}

保存并運行。在模擬器或者你的手機上你將看到一個空的表格視圖。但,如果API調用成功,你會在屏幕的底部(控制臺)看到打印出的JSON數據:

"[{\\"url\\":\\"https://api.github.com/gists/35877917945abf44fc7a\\",\\"forks_url\\":\\"https://a\\ pi.github.com/gists/35877917945abf44fc7a/forks\\",\\"commits_url\\":\\"https://api.github.com/\\ gists/35877917945abf44fc7a/commits\\",\\"id\\":\\"35877917945abf44fc7a\\",\\"git_pull_url\\":\\"ht\\ tps://gist.github.com/35877917945abf44fc7a.git\\",\\"git_push_url\\":\\"https://gist.github.co\\ m/35877917945abf44fc7a.git\\",\\"html_url\\":\\ ...

在你的API管理器中添加一個與printPublicGists類似的方法。它將獲取到一個對象數組,并在控制臺中打印。

2. 解析API返回的JSON數據

API調用返回了一個包含gists數組的JSON對象。在API docs for gists中描述了JSON對象的格式,包含了gists的作者信息、所包含的文件信息及歷史版本信息等:

{
  "url": "https://api.github.com/gists/aa5a315d61ae9438b18d",
  "forks_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/forks",
  "commits_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/commits",
  "id": "aa5a315d61ae9438b18d",
  "description": "description of gist",
  "public": true,
  "owner": {
    "login": "octocat",
    "id": 1,
    "avatar_url": "https://github.com/images/error/octocat_happy.gif",
    "gravatar_id": "",
    "url": "https://api.github.com/users/octocat",
    "html_url": "https://github.com/octocat",
    "followers_url": "https://api.github.com/users/octocat/followers",
    "following_url": "https://api.github.com/users/octocat/following{/other_user}",
    "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
    "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
    "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
    "organizations_url": "https://api.github.com/users/octocat/orgs",
    "repos_url": "https://api.github.com/users/octocat/repos",
    "events_url": "https://api.github.com/users/octocat/events{/privacy}",
    "received_events_url": "https://api.github.com/users/octocat/received_events",
    "type": "User",
    "site_admin": false
  },
  "user": null,
  "files": {
    "ring.erl": {
      "size": 932,
      "raw_url": "https://gist.githubusercontent.com/raw/365370/8c4d2d43d178df44f4c03a7f2ac0ff512853564e/ring.erl",
      "type": "text/plain",
      "language": "Erlang",
      "truncated": false,
      "content": "contents of gist"
    }
  },
  "truncated": false,
  "comments": 0,
  "comments_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/comments/",
  "html_url": "https://gist.github.com/aa5a315d61ae9438b18d",
  "git_pull_url": "https://gist.github.com/aa5a315d61ae9438b18d.git",
  "git_push_url": "https://gist.github.com/aa5a315d61ae9438b18d.git",
  "created_at": "2010-04-14T02:15:15Z",
  "updated_at": "2011-06-20T11:34:15Z",
  "forks": [
    {
      "user": {
        "login": "octocat",
        "id": 1,
        "avatar_url": "https://github.com/images/error/octocat_happy.gif",
        "gravatar_id": "",
        "url": "https://api.github.com/users/octocat",
        "html_url": "https://github.com/octocat",
        "followers_url": "https://api.github.com/users/octocat/followers",
        "following_url": "https://api.github.com/users/octocat/following{/other_user}",
        "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
        "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
        "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
        "organizations_url": "https://api.github.com/users/octocat/orgs",
        "repos_url": "https://api.github.com/users/octocat/repos",
        "events_url": "https://api.github.com/users/octocat/events{/privacy}",
        "received_events_url": "https://api.github.com/users/octocat/received_events",
        "type": "User",
        "site_admin": false
      },
      "url": "https://api.github.com/gists/dee9c42e4998ce2ea439",
      "id": "dee9c42e4998ce2ea439",
      "created_at": "2011-04-14T16:00:49Z",
      "updated_at": "2011-04-14T16:00:49Z"
    }
  ],
  "history": [
    {
      "url": "https://api.github.com/gists/aa5a315d61ae9438b18d/57a7f021a713b1c5a6a199b54cc514735d2d462f",
      "version": "57a7f021a713b1c5a6a199b54cc514735d2d462f",
      "user": {
        "login": "octocat",
        "id": 1,
        "avatar_url": "https://github.com/images/error/octocat_happy.gif",
        "gravatar_id": "",
        "url": "https://api.github.com/users/octocat",
        "html_url": "https://github.com/octocat",
        "followers_url": "https://api.github.com/users/octocat/followers",
        "following_url": "https://api.github.com/users/octocat/following{/other_user}",
        "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
        "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
        "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
        "organizations_url": "https://api.github.com/users/octocat/orgs",
        "repos_url": "https://api.github.com/users/octocat/repos",
        "events_url": "https://api.github.com/users/octocat/events{/privacy}",
        "received_events_url": "https://api.github.com/users/octocat/received_events",
        "type": "User",
        "site_admin": false
      },
      "change_status": {
        "deletions": 0,
        "additions": 180,
        "total": 180
      },
      "committed_at": "2010-04-14T02:15:15Z"
    }
  ]
}

接下來我們將把JSON對象轉換為Swift對象。首先先創建Gist類,實體對象,用來負責gists。在Xcode添加一個Swift文件,并命名為Gist。在這個文件中我們定義一個Gist類:

import Foundation

class Gist {
}

查看你的API,并構造一個你希望在表格視圖中顯示需要的對象模型類。

現在來看看我們需要從JSON對象中解析哪些數據。當然,我們也可以解析全部的數據,但這需要耗費很多精力,而且也沒有必要這么做。后面當我們需要的時候,會從JSON中解析更多的數據。

那,我們需要顯示哪些數據呢?表格視圖中的單元格有標題、子標題和圖像,因此,我們可以使用gist的描述、作者的GitHub的ID以及作者的頭像來填充。另外,我們還需要每一個gist的唯一ID和url。所以,我們需要為JSON中的每一個gist解析出這些信息,并創建相應的Gist對象。首先我們在Gist類中添加這些屬性:

class Gist {
  var id: String?
  var description: String?
  var ownerLogin: String?
  var ownerAvatarURL: String?
  var url: String?
}

對于你的模型對象,你需要決定從JSON對象中解析哪些屬性顯示在表格視圖中。然后像Gist一樣添加相應的屬性。

我們希望能夠通過JSON對象創建一個Gist實例,為此我們需要為類增加一個構造函數,該函數使用JSON作為參數。這里還需要引入SwiftyJSON庫。同時會增加一個簡單的構造函數,這樣我們在沒有調用GitHub API的情況下也可以創建:

import SwiftyJSON
  
class Gist {
  var id: String?
  var descripion: String?
  var ownerLogin: String?
  var ownerAvatarURL: String?
  var url: String?
    
  required init(json: JSON) {
    self.description = json["description"].string
    self.id = json["id"].string
    self.ownerLogin = json["owner"].["login"].string
    self.ownerAvatarURL = json["owner"].["avatar_url"].string
    self.url = json["url"].string
  }
    
  required init() {
  }
}     

在你的模型對象類中創建構造函數。如果模型對象中某些屬性不是字符串,請參考前面的章節來解析數字和布爾值。如果有一些屬性是數組(如:gist中的文件Files)或者日期,這些屬性的解析我們將在詳細視圖頁面進行講解。

3. 創建表格視圖

現在,我們可以進行寫代碼了。前面我們使用Xcode創建了一個Master-Detail工程,并默認幫我們創建了一些代碼。下面讓我們快速看一下MasterViewController已經為我們做了哪些事情。首先是:

class MasterViewController: UITableViewController { 
  
  var detailViewController: DetailViewController? = nil
  var objects = [AnyObject]()

MasterViewController中有一個DetailViewController屬性(該屬性是我們在點擊視圖中的行時幫我們導航到詳細頁面),以及一個對象數組。在這里我們首先對象數組更改為Gists數組,這樣我們就可以知道在表格視圖中要展現的是哪些數據了:

class MasterViewController: UITableViewController { 
  
  var detailViewController: DetailViewController? = nil
  var gists = [Gist]()

參考上面將這里的數組更改為與你的App相應的名稱。

接下來是:

override func viewDidLoad() {
  super.viewDidLoad()
  // Do any additional setup after loading the view, typically from a nib. 
  self.navigationItem.leftBarButtonItem = self.editButtonItem()
    
  let addButton = UIBarButtonItem(barButtonSystemItem: .Add, target: self, 
    action: "insertNewObject:")
  self.navigationItem.rightBarButtonItem = addButton 
  if let split = self.splitViewController {
    let controllers = split.viewControllers 
    self.detailViewController = (controllers[controllers.count-1] as!
      UINavigationController).topViewController as? DetailViewController
  }
}

viewDidLoad方法中往導航欄(navigation bar)中增加了兩個按鈕:左邊增加一個編輯按鈕,右邊增加一個新建按鈕。

通過detailViewController屬性,我們就可以在詳情頁面中顯示用戶所選中gist的詳細信息。

然后:

override func viewWillAppear(animated: Bool) { 
  self.clearsSelectionOnViewWillAppear = self.splitViewController!.collapsed 
  super.viewWillAppear(animated)
}

在視圖顯示之前,我們需要調用一下clearsSelectionOnViewWillAppear,這樣就可以在我們打開其它頁面時仍然保持行的選中狀態。這個在iPad的分屏視圖中有用,iPhone由于僅使用表格視圖,所以該方法沒有意義。

在視圖顯示的時候我們需要從GitHub中加載數據。因此,可以在viewDidAppear方法中來實現:

func loadGists() { 
  GitHubAPIManager.sharedInstance.printPublicGists()
}
  
override func viewDidAppear(animated: Bool) { 
  super.viewDidAppear(animated)
  loadGists()
}

通常,我們應當在viewWillAppear中來加載數據,這樣視圖就可以很快的顯示。因為后面我們需要檢查用戶是否已經登錄,如果沒有,那么會彈出一個登錄視圖讓用戶登錄,但是,如果當前視圖沒有顯示完畢,是無法加載另外一個視圖的。因此,這里我們使用viewDidAppear

創建一個類似loadGists的方法來加載你的數據。

后面我們會重構loadGists中的代碼,這樣就可以得到Gist的數組,并顯示到視圖中。

override func didReceiveMemoryWarning() { 
  super.didReceiveMemoryWarning()
  // Dispose of any resources that can be recreated.
}

假如我們有一些很重的資源文件(如:大的圖片)或者一些可重建的對象,那么我們就可以在didReceiveMemoryWarning中銷毀掉它們,從而能夠讓我們很優雅的處理低內存告警。

func insertNewObject(sender: AnyObject) {
  objects.insert(NSDate(), atIndex: 0)
  let indexPath = NSIndexPath(forRow: 0, inSection: 0) 
  self.tableView.insertRowsAtIndexPaths([indexPath], withRowAnimation: .Automatic)
}

新建按鈕將會調用insertNewObject方法。該方法將創建一個新的對象,并把它添加到表格視圖中。這個功能我們要后面很久才會實現,因此這里先彈出一個對話框告訴大家還沒有實現該功能:

func insertNewObject(sender: AnyObject) {
  let alert = UIAlertController(title: "Not Implemented", message:
    "Can't create new gists yet, will implement later",
    preferredStyle: UIAlertControllerStyle.Alert)
  alert.addAction(UIAlertAction(title: "OK", style: UIAlertActionStyle.Default,
    handler: nil))
  self.presentViewController(alert, animated: true, completion: nil)
}

接下來就是prepareForSegue方法,該方法將會跳轉到詳情頁面:

// MARK: - Segues
override func prepareForSegue(segue: UIStoryboardSegue, sender: AnyObject?) { 
  if segue.identifier == "showDetail" {
    if let indexPath = self.tableView.indexPathForSelectedRow { 
      let object = objects[indexPath.row] as! NSDate
      let controller =
        (segue.destinationViewController as!
        UINavigationController).topViewController as! DetailViewController 
      controller.detailItem = object 
      controller.navigationItem.leftBarButtonItem =
        self.splitViewController?.displayModeButtonItem() 
      controller.navigationItem.leftItemsSupplementBackButton = true
    }
  }
}

這里,我們還是要把通用的對象替換為我們的Gists。另外,我們還需要檢查一下轉到的視圖是否是DetailViewConroller

// MARK: - Segues
override func prepareForSegue(segue: UIStoryboardSegue, sender: AnyObject?) { 
  if segue.identifier == "showDetail" {
    if let indexPath = self.tableView.indexPathForSelectedRow {
      let gist = gists[indexPath.row] as Gist
      if let detailViewController = (segue.destinationViewController as!
        UINavigationController).topViewController as? 
        DetailViewController {
        detailViewController.detailItem = gist 
        detailViewController.navigationItem.leftBarButtonItem =
          self.splitViewController?.displayModeButtonItem() 
        detailViewController.navigationItem.leftItemsSupplementBackButton = true
      }
    }
  }
}

后面我們會設置詳情視圖中所要顯示的gists。

接下來的幾個方法是告訴表格視圖如何進行顯示:

// MARK: - Table View
override func numberOfSectionsInTableView(tableView: UITableView) -> Int { 
  return 1
}
  
override func tableView(tableView: UITableView, 
  numberOfRowsInSection section: Int) -> Int { 
  return objects.count
}
  
override func tableView(tableView: UITableView, cellForRowAtIndexPath indexPath:  
  NSIndexPath) -> UITableViewCell {
  let cell = tableView.dequeueReusableCellWithIdentifier("Cell", forIndexPath: indexPath)  
  let object = objects[indexPath.row] as! NSDate 
  cell.textLabel!.text = object.description 
  return cell
}

再一次,我們這里需要將對象轉換為gists,并且把tableView:cellForRowAIndexPath:indexPath:更改為顯示gists的描述和擁有者的ID。后面再來實現如何顯示擁有者的頭像,因為顯示圖像需要額外一些處理,這里我們不想因為這個而停下來。

首先,調整故事板中的表格視圖單元格,因為我們需要在上面顯示兩行文本:

  1. 打開mainStoryboard并選中masterViewController中的Table View
  2. 選擇表格視圖中單元格原型并將類型('Style')屬性更改為Subtitle,這樣我們就會有兩個文本了

<div style="text-align: center">
<img src="http://o6pjjbgcb.bkt.clouddn.com/rest_020.png?imageView2/0/h/640" style="width:600px"/>
</div>

<div style="text-align: center">
<img src="http://o6pjjbgcb.bkt.clouddn.com/rest_030.png?imageView2/0/h/200" style="height:140px"/>
</div>

接下來就可以修改代碼來顯示Gists了:

// MARK: - Table View
override func numberOfSectionsInTableView(tableView: UITableView) -> Int { 
  return 1
}
  
override func tableView(tableView: UITableView, 
  numberOfRowsInSection section: Int) -> Int { 
  return gists.count
}
  
override func tableView(tableView: UITableView, cellForRowAtIndexPath
  indexPath: NSIndexPath) -> UITableViewCell {
  let cell = tableView.dequeueReusableCellWithIdentifier("Cell", forIndexPath: indexPath)
  
  let gist = gists[indexPath.row]
  cell.textLabel!.text = gist.description
  cell.detailTextLabel!.text = gist.ownerLogin
  // TODO: set cell.imageView to display image at gist.ownerAvatarURL
  return cell
}

接下來的代碼就是判斷gists的可編輯性:刪除和創建。現在我們簡化一下,先不允許進行修改:

override func tableView(tableView: UITableView, canEditRowAtIndexPath indexPath:  
  NSIndexPath) -> Bool {
  // Return false if you do not want the specified item to be editable.
  return true
}
  
override func tableView(tableView: UITableView, commitEditingStyle editingStyle: 
  UITableViewCellEditingStyle, forRowAtIndexPath indexPath: NSIndexPath) {
  if editingStyle == .Delete {
    objects.removeAtIndex(indexPath.row)
    tableView.deleteRowsAtIndexPaths([indexPath], withRowAnimation: .Fade) 
  } else if editingStyle == .Insert {
    // Create a new instance of the appropriate class, insert it into the array,
    // and add a new row to the table view.
  }
}

修改為:

override func tableView(tableView: UITableView, canEditRowAtIndexPath indexPath: 
  NSIndexPath) -> Bool {
  // Return false if you do not want the specified item to be editable.
  return false
}
  
override func tableView(tableView: UITableView, commitEditingStyle editingStyle: 
  UITableViewCellEditingStyle, forRowAtIndexPath indexPath: NSIndexPath) {
  if editingStyle == .Delete {
    gists.removeAtIndex(indexPath.row)
    tableView.deleteRowsAtIndexPaths([indexPath], withRowAnimation: .Fade) 
  } else if editingStyle == .Insert {
    // Create a new instance of the appropriate class, insert it into the array,
    // and add a new row to the table view.
  }
}

現在你可以運行,但是你會發現顯示的仍然是一個空白表格視圖。為了測試我們可以構建一些假的本地數據而不是從GitHub上請求。修改loadGists()方法,在方法中創建一個gists數組:

func loadGists() {
  let gist1 = Gist()
  gist1.description = "The first gist" 
  gist1.ownerLogin = "gist1Owner"
  let gist2 = Gist()
  gist2.description = "The second gist" 
  gist2.ownerLogin = "gist2Owner"
  let gist3 = Gist()
  gist3.description = "The third gist" 
  gist3.ownerLogin = "gist3Owner" 
  gists = [gist1, gist2, gist3]
  // Tell the table view to reload
  self.tableView.reloadData() 
}

保存并運行,app界面如下:

<div style="text-align: center">
<img src="http://o6pjjbgcb.bkt.clouddn.com/rest_040.png?imageView2/0/w/400" style="width:320px"/>
</div>

當你點擊增加按鈕時,會彈出一個提示框:

<div style="text-align: center">
<img src="http://o6pjjbgcb.bkt.clouddn.com/rest_050.png?imageView2/0/w/400" style="width:320px"/>
</div>

像上面一樣確保你的對象可以顯示在表格視圖。

現在表格視圖功能應該是沒有問題了,那么下面我們恢復loadGists()函數:

func loadGists() { 
  GitHubAPIManager.sharedInstance.printPublicGists()
}

4. 獲取并解析API的響應

回想一下,我們在前面創建的Alamofire.Request的擴展:

public func responseObject<T: ResponseJSONObjectSerializable>

這個擴展用來處理Alamofire的響應,并將返回來的JSON格式數據轉換為Swift對象(當然,相應類需要實現ResponseJSONObjectSerializable協議中的初始化方法)。現在我們需要實現的與這個很類似,只不過需要將返回的JSON數組轉換為Swift對象數組。因此,我們保留這個協議,并將它添加到工程中。創建一個ResponseJSONObjectSerializable.swift文件,并把協議定義添加進去。在文件中別忘了引入SwiftyJSON庫:

import Foundation
import SwiftyJSON
  
public protocol ResponseJSONObjectSerializable { 
  init?(json: SwiftyJSON.JSON)
}

然后修改Gist類,實現該協議(注意,我們前面已經實現了相應的構造方法):

class Gist: ResponseJSONObjectSerializable { 
  ...
}

我們也把responseObject函數拷貝進來,因為后面會使用到它。創建AlamofireRequest+JSONSerializable.swift文件,因為,它是Alamofire.Request的擴展,并且也承擔了JSON的序列化處理:

public func responseObject<T: ResponseJSONObjectSerializable>(completionHandler: 
  Response<T, NSError> -> Void) -> Self {
  let serializer = ResponseSerializer<T, NSError> { request, response, data, error in
    guard error == nil else { 
      return .Failure(error!)
    }
    guard let responseData = data else {
      let failureReason = "無法進行對象序列化,因為輸入的數據為空。" 
      let error = Error.errorWithCode(.DataSerializationFailed,
        failureReason: failureReason) return .Failure(error)
    }
    
    let JSONResponseSerializer = Request.JSONResponseSerializer(options: .AllowFragments) 
    let result = JSONResponseSerializer.serializeResponse(request, response,
      responseData, error)
      
    switch result {
    case .Success(let value):
      let json = SwiftyJSON.JSON(value) 
      if let object = T(json: json) {
        return .Success(object) 
      } else {
        let failureReason = "無法通過JSON創建對象" 
        let error = Error.errorWithCode(.JSONSerializationFailed,
          failureReason: failureReason)
        return .Failure(error) 
      }
    case .Failure(let error): 
      return .Failure(error)
    }
  }
  return response(responseSerializer: serializer, completionHandler: completionHandler) 
}

我們的需求和這個類似,只不過返回的是[T]對象數組,而不是一個[T]對象:

extension Alamofire.Request {
  public func responseObject<T: ResponseJSONObjectSerializable>(completionHandler:
    Response<T, NSError> -> Void) -> Self {
    let serializer = ResponseSerializer<T, NSError> {
      // ...
    }
        
    return response(responseSerializer: serializer, completionHandler: completionHandler) 
  }
      
  public func responseArray<T: ResponseJSONObjectSerializable>(completionHandler: 
    Response<[T], NSError> -> Void) -> Self {
    let serializer = ResponseSerializer<[T], NSError> {
      // ...
    }
      
    return response(responseSerializer: serializer, completionHandler: completionHandler) 
  }
}

具體實現也很類似:

public func responseArray<T: ResponseJSONObjectSerializable>(
  completionHandler: Response<[T], NSError> -> Void) -> Self {
  let serializer = ResponseSerializer<[T], NSError> { request, response, data, error in 
    guard error == nil else { 
      return .Failure(error!)
    }
    guard let responseData = data else {
      let failureReason = "無法解析為數組,因為輸入的數據為空。" 
      let error = Error.errorWithCode(.DataSerializationFailed,
        failureReason: failureReason) 
      return .Failure(error)
    }
      
    let JSONResponseSerializer = Request.JSONResponseSerializer(options: .AllowFragments) 
    let result = JSONResponseSerializer.serializeResponse(request, response,
      responseData, error)
      
    switch result {
    case .Success(let value):
      let json = SwiftyJSON.JSON(value) 
      var objects: [T] = []
      for (_, item) in json {
        if let object = T(json: item) { 
          objects.append(object)
        }
      }
      return .Success(objects) 
    case .Failure(let error):
      return .Failure(error) 
    }
  }
   
  return response(responseSerializer: serializer, completionHandler: completionHandler) 
}

最大的不同點就是我們循環json中的每個元素for (_, item) in json,并為它創建相應的對象:let object = T(json: item)。如果對象創建成功則把它添加到數組中。

現在,我們需要:

  1. 完成我們的函數使其獲取公共的gists,并把返回值解析為一個數組
  2. 將函數更改為返回gists數組并傳給表格視圖

getPublicGists函數看起來很像之前的printPulicGists

func printPublicGists() -> Void { 
  Alamofire.request(GistRouter.GetPublic())
    .responseString { response in
      if let receivedString = response.result.value {
        print(receivedString)
      }
    }
}

最大的不同就是將打印替換為返回一個數組。因此,我們把responseString替換為responseArray。現在我們可以把這個函數加入到GitHubAPIManager中了:

func getPublicGists() -> Void { 
  Alamofire.request(GistRouter.GetPublic())
    .responseArray {
      ...
  }
}

這看起來有點奇怪。我們前面不是說要返回一個數組么,但這里返回的是Void啊。嗯,是的,這是因為API的調用是異步的,我們發起一個請求,然后當請求處理完畢后我們會收到一個通知。我們可以將這個處理放在完成處理程序中。下面我們來添加一個塊代碼,這樣當請求處理完畢后就可以調用了。我們的完成處理程序需要處理兩種可能:一種情況是正確返回了一個Gists數組,另外一種情況就是返回了一個錯誤。

完成處理程序的簽名是(Result<T>, NSError)。它是Alamofire所創建的一個指定對象,這樣可以讓我們在.Success情況下返回一個Gists數組,在.Failure情況下返回一個錯誤。

因此我們發送請求后,將響應序列化器(response serializer)設置為我們上面所創建的responseArray。然后在調用成功后返回Gists數組,或者失敗時返回一個錯誤:

func getPublicGists(completionHandler: (Result<[Gist], NSError>) -> Void) {
  Alamofire.request(.GET, "https://api.github.com/gists/public")
    .responseArray { (response:Response<[Gist], NSError>) in 
      ...
  }
}

因為responseArray的完成處理程序返回的數組參數中是一個泛型對象,因此我們需要修改讓它明確返回的對象類型,因此將參數修改為:Respoonse<[Gist], NSError>。否則當數據返回時將不知道如何創建相應的對象。

getPublicGists的完成處理程序匹配responseArray中的一個,并不需要在這里處理任何錯誤。因此,在.responseArray的塊(block)中只需要調用完成處理程序即可。對于錯誤的處理則是調用者需要關心的事:

func getPublicGists(completionHandler: (Result<[Gist], NSError>) -> Void){ 
  Alamofire.request(GistRouter.GetPublic())
    .responseArray { (response:Response<[Gist], NSError>) in 
      completionHandler(response.result)
  } 
}

創建一個函數像getPublicGists一樣,返回你的業務對象數組。

Ok,現在讓我們看看我們需要在什么時候調用getPublicGists。先看看之前在MasterViewController是在如何調用的:

func loadGists() { 
  GitHubAPIManager.sharedInstance.printPublicGists()
}
  
override func viewDidAppear(animated: Bool) { 
  super.viewDidAppear(animated)
  loadGists()
}

看來最好是將printPublicGists()替換為getPublicGist。這個非常容易做:

func loadGists() { 
  GitHubAPIManager.sharedInstance.getPublicGists() { result in
    guard result.error == nil else { 
      print(result.error)
      // TODO: display error
      return
    }
    
    if let fetchedGists = result.value { 
      self.gists = fetchedGists  
    }
    self.tableView.reloadData()
  }
}

我們發起一個異步調用,并返回gists數組。如果成功調用,我們會把gists保存到本地數組變量中,并告訴表格視圖使用新的數據刷新顯示。簡單漂亮!

創建你的loadGists方法,并調用之前你的getPublicGists方法,把返回的結果保存到數組對象中,這樣你的MasterViewConroller就可以將它們顯示到表格視圖中了。

現在API調用和表格視圖已經很好的整合了。保存并運行看看效果。

<div style="text-align: center">
<img src="http://o6pjjbgcb.bkt.clouddn.com/rest_060.png?imageView2/0/w/400" style="width:320px"/>
</div>

小結

到這里我們已經完成了app的核心功能。下面我們逐步添加以下功能:

  • 在單元格中顯示圖片
  • 當滾動時加載更多Gists
  • 下拉刷新
  • Gists的詳細視圖
  • 刪除Gists
  • 新建Gists

GitHub上本章的代碼:tableview

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 229,732評論 6 539
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 99,214評論 3 426
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 177,781評論 0 382
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 63,588評論 1 316
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 72,315評論 6 410
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 55,699評論 1 327
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,698評論 3 446
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 42,882評論 0 289
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 49,441評論 1 335
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 41,189評論 3 356
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 43,388評論 1 372
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,933評論 5 363
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 44,613評論 3 348
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 35,023評論 0 28
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 36,310評論 1 293
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 52,112評論 3 398
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 48,334評論 2 377

推薦閱讀更多精彩內容