自己動(dòng)手寫一個(gè)iOS 網(wǎng)絡(luò)請(qǐng)求庫(kù)的三部曲

2015-06-02 09:41:00

NSURLSession 是 iOS7 引入的新網(wǎng)絡(luò)請(qǐng)求接口，在 WWDC2013 中有詳細(xì)介紹，下面是描述其結(jié)構(gòu)的一頁(yè) slides：

代碼示例：https://github.com/johnlui/Swift-On-iOS/blob/master/BuildYourHTTPRequestLibrary

開(kāi)源項(xiàng)目：Pitaya，適合大文件上傳的 HTTP 請(qǐng)求庫(kù)：https://github.com/johnlui/Pitaya

本系列文章中，我們將嘗試使用 NSURLSession 技術(shù)構(gòu)建一個(gè)自己的網(wǎng)絡(luò)請(qǐng)求庫(kù)。

NSURLSession 簡(jiǎn)介

NSURLSession 是 iOS7 引入的新網(wǎng)絡(luò)請(qǐng)求接口，在 WWDC2013 中有詳細(xì)介紹，下面是描述其結(jié)構(gòu)的一頁(yè) slides：

當(dāng)應(yīng)用在前臺(tái)時(shí)，NSURLSession 跟 NSURLConnection 沒(méi)有什么區(qū)別，但是在程序切換到后臺(tái)之后 Background Session 就會(huì)更加靈活。

嘗試 NSURLSession

準(zhǔn)備工作

新建一個(gè)名為 BuildYourHTTPRequestLibrary 的單頁(yè)面應(yīng)用，在頁(yè)面上居中放置一個(gè)按鈕，名為 Request：

拖動(dòng)綁定 Touch Up Inside 事件：

使用 NSURLSession

在 mainButtonBeTapped 函數(shù)內(nèi)填充以下代碼：

@IBAction func mainButtonBeTapped(sender: AnyObject) { 
let session = NSURLSession.sharedSession() 
let request = NSURLRequest(URL: NSURL(string: "http://baidu.com")!) 
let task = session.dataTaskWithRequest(request, completionHandler: { (data, response, error) -> Void in 
let string = NSString(data: data, encoding: NSUTF8StringEncoding) 
println(string) 
}) 
task.resume() 
}

使用成功！

感受異步

異步

改寫 mainButtonBeTapped 函數(shù)的代碼：

@IBAction func mainButtonBeTapped(sender: AnyObject) { 
let session = NSURLSession.sharedSession() 
let request = NSURLRequest(URL: NSURL(string: "http://baidu.com")!) 
let task = session.dataTaskWithRequest(request, completionHandler: { (data, response, error) -> Void in 
println("just wait for 5 seconds!") 
sleep(5) 
let string = NSString(data: data, encoding: NSUTF8StringEncoding) 
println(string) 
}) 
task.resume() 
}

再次嘗試，兩次打印之間間隔了五秒，主線程未阻塞，證明 NSURLSession 為異步執(zhí)行。

阻塞

嘗試多次點(diǎn)擊，我們能夠看到每五秒執(zhí)行一次，直到全部執(zhí)行完畢。

NSURLSession 采用的是 “異步阻塞” 模型，即所有請(qǐng)求在發(fā)出后都進(jìn)入 2# 線程執(zhí)行，在 2# 線程內(nèi)部按照阻塞隊(duì)列模式執(zhí)行。

#p#

開(kāi)源項(xiàng)目：Pitaya，適合大文件上傳的 HTTP 請(qǐng)求庫(kù)：https://github.com/johnlui/Pitaya

本章中，我們將一起嘗試使用一個(gè)類來(lái)封裝我們之前的代碼，并嘗試加入動(dòng)態(tài)增加 HTTP 參數(shù)（params）的功能，之后封裝出一個(gè)強(qiáng)大的接口。

[[135519]]

基本封裝

基礎(chǔ)準(zhǔn)備

新建一個(gè) Swift 空文件，命名為 Network.swift，在里面寫一個(gè) Network 類，之后寫一個(gè)靜態(tài)方法 request()：

class Network{ 
static func request() { 
let session = NSURLSession.sharedSession() 
let request = NSURLRequest(URL: NSURL(string: "http://baidu.com")!) 
let task = session.dataTaskWithRequest(request, completionHandler: { (data, response, error) -> Void in 
println("just wait for 5 seconds!") 
sleep(5) 
let string = NSString(data: data, encoding: NSUTF8StringEncoding) 
println(string) 
}) 
task.resume() 
} 
}

修改 ViewController 中的按鈕函數(shù)：

@IBAction func mainButtonBeTapped(sender: AnyObject) { 
Network.request() 
}

運(yùn)行項(xiàng)目，點(diǎn)擊按鈕，效果和之前一致。

自定義 HTTP method 和 URL

修改 request() 方法，將 HTTP 方法和 URL 傳進(jìn)去：

static func request(method: String, url: String) { 
let session = NSURLSession.sharedSession() 
let request = NSMutableURLRequest(URL: NSURL(string: url)!) 
request.HTTPMethod = method 
let task = session.dataTaskWithRequest(request, completionHandler: { (data, response, error) -> Void in 
println("just wait for 5 seconds!") 
sleep(5) 
let string = NSString(data: data, encoding: NSUTF8StringEncoding) 
println(string) 
}) 
task.resume() 
}

修改前面的函數(shù)調(diào)用：

@IBAction func mainButtonBeTapped(sender: AnyObject) { 
Network.request("GET", url: "http://baidu.com") 
}

運(yùn)行項(xiàng)目，點(diǎn)擊按鈕，效果和之前一致。

使用閉包處理請(qǐng)求結(jié)果

函數(shù)是 Swift 中的一等公民，閉包可以作為函數(shù)參數(shù)和返回值，十分強(qiáng)大。下面我們就用閉包來(lái)處理網(wǎng)絡(luò)請(qǐng)求的返回值。修改 request() 方法，傳遞進(jìn)去一個(gè)閉包：

static func request(method: String, url: String, callback: (data: NSData!, response: NSURLResponse!, error: NSError!) -> Void) { 
let session = NSURLSession.sharedSession() 
let request = NSMutableURLRequest(URL: NSURL(string: url)!) 
request.HTTPMethod = method 
let task = session.dataTaskWithRequest(request, completionHandler: { (data, response, error) -> Void in 
callback(data: data, response: response , error: error) 
}) 
task.resume() 
}

在前面函數(shù)調(diào)用處使用閉包進(jìn)行結(jié)果處理：

@IBAction func mainButtonBeTapped(sender: AnyObject) { 
Network.request("GET", url: "http://baidu.com") { (data, response, error) -> Void in 
println("just wait for 5 seconds!") 
sleep(5) 
let string = NSString(data: data, encoding: NSUTF8StringEncoding) 
println(string) 
} 
}

運(yùn)行項(xiàng)目，點(diǎn)擊按鈕，效果和之前一致。

動(dòng)態(tài)增加 Params

GET 方法

GET 方法下，params 在經(jīng)過(guò) url encode 之后直接附在 URL 末尾發(fā)送給服務(wù)器。修改 request() 方法，傳遞進(jìn)去一個(gè) params 的字典：

static func request(method: String, url: String, params: Dictionary = Dictionary(), callback: (data: NSData!, response: NSURLResponse!, error: NSError!) -> Void) { 
... ... 
}

為了處理 params，我們從 Alamofire 偷來(lái)他的 params 處理函數(shù)。如果是 GET 方法，那就把處理過(guò)的 params 增加到 URL 后面。Network 類的完整代碼如下：

class Network{ 
static func request(method: String, url: String, params: Dictionary = Dictionary(), callback: (data: NSData!, response: NSURLResponse!, error: NSError!) -> Void) { 
let session = NSURLSession.sharedSession() 
 
var newURL = url 
if method == "GET" { 
newURL += "?" + Network().buildParams(params) 
} 
 
let request = NSMutableURLRequest(URL: NSURL(string: newURL)!) 
request.HTTPMethod = method 
 
let task = session.dataTaskWithRequest(request, completionHandler: { (data, response, error) -> Void in 
callback(data: data, response: response , error: error) 
}) 
task.resume() 
} 
 
// 從 Alamofire 偷了三個(gè)函數(shù) 
func buildParams(parameters: [String: AnyObject]) -> String { 
var components: [(String, String)] = [] 
for key in sorted(Array(parameters.keys), [(String, String)] { 
var components: [(String, String)] = [] 
if let dictionary = value as? [String: AnyObject] { 
for (nestedKey, value) in dictionary { 
components += queryComponents("\(key)[\(nestedKey)]", value) 
} 
} else if let array = value as? [AnyObject] { 
for value in array { 
components += queryComponents("\(key)", value) 
} 
} else { 
components.extend([(escape(key), escape("\(value)"))]) 
} 
 
return components 
} 
func escape(string: String) -> String { 
let legalURLCharactersToBeEscaped: CFStringRef = ":&=;+!@#$()',*" 
return CFURLCreateStringByAddingPercentEscapes(nil, string, nil, legalURLCharactersToBeEscaped, CFStringBuiltInEncodings.UTF8.rawValue) as String 
} 
}

修改前面的函數(shù)調(diào)用：

@IBAction func mainButtonBeTapped(sender: AnyObject) { 
Network.request("GET", url: "http://pitayaswift.sinaapp.com/pitaya.php", params: ["get": "Network"]) { (data, response, error) -> Void in 
let string = NSString(data: data, encoding: NSUTF8StringEncoding) 
println(string) 
} 
}

http://pitayaswift.sinaapp.com/pitaya.php 是我部署的用于測(cè)試的服務(wù)端代碼，會(huì)直接返回 ?get=ooxx 中的 ooxx。運(yùn)行項(xiàng)目，點(diǎn)擊按鈕，查看效果：

POST 方法

POST 方法下有幾個(gè)協(xié)議可供選擇，此處沒(méi)有文件上傳，我們采用較簡(jiǎn)單的 application/x-www-form-urlencoded 方式發(fā)送請(qǐng)求。request() 方法增加一些代碼：

static func request(method: String, url: String, params: Dictionary = Dictionary(), callback: (data: NSData!, response: NSURLResponse!, error: NSError!) -> Void) { 
let session = NSURLSession.sharedSession() 
 
var newURL = url 
if method == "GET" { 
newURL += "?" + Network().buildParams(params) 
} 
 
let request = NSMutableURLRequest(URL: NSURL(string: newURL)!) 
request.HTTPMethod = method 
 
if method == "POST" { 
request.addValue("application/x-www-form-urlencoded", forHTTPHeaderField: "Content-Type") 
request.HTTPBody = Network().buildParams(params).dataUsingEncoding(NSUTF8StringEncoding) 
} 
 
let task = session.dataTaskWithRequest(request, completionHandler: { (data, response, error) -> Void in 
callback(data: data, response: response , error: error) 
}) 
task.resume() 
}

修改前面的函數(shù)調(diào)用：

@IBAction func mainButtonBeTapped(sender: AnyObject) { 
Network.request("POST", url: "http://pitayaswift.sinaapp.com/pitaya.php", params: ["post": "Network"]) { (data, response, error) -> Void in 
let string = NSString(data: data, encoding: NSUTF8StringEncoding) 
println(string) 
} 
}

使用 POST 方式發(fā)送請(qǐng)求，同樣服務(wù)端會(huì)返回 key 為 post 的 value 的值。運(yùn)行項(xiàng)目，點(diǎn)擊按鈕，結(jié)果和前面 GET 方法的結(jié)果一致。

至此，接口封裝完成！

#p#

開(kāi)源項(xiàng)目：Pitaya，適合大文件上傳的 HTTP 請(qǐng)求庫(kù)：https://github.com/johnlui/Pitaya

本文中，我們將一起降低之前代碼的耦合度，并使用適配器模式實(shí)現(xiàn)一層獨(dú)立于底層結(jié)構(gòu)的網(wǎng)絡(luò) API，造一個(gè)真正的網(wǎng)絡(luò)請(qǐng)求“庫(kù)”。

降低耦合度

如何降低耦合度

現(xiàn)在的清湯掛面式的代碼雖然便于理解，但是功能單一，代碼雜亂。我們一起來(lái)分析 NSURLSession 的使用過(guò)程：

構(gòu)造 NSURLRequest

確定 URL

確定 HTTP 方法（GET、POST 等）

添加特定的 HTTP 頭

填充 HTTP Body

驅(qū)動(dòng) session.dataTaskWithRequest 方法，開(kāi)始請(qǐng)求

具體實(shí)施

在 Network 下另外新建一個(gè) NetworkManager 類，將 URL、params、files 等設(shè)為成員變量，讓他們?cè)跇?gòu)造函數(shù)中初始化：

class NetworkManager { 
 
let method: String! 
let params: Dictionary let callback: (data: NSData!, response: NSURLResponse!, error: NSError!) -> Void 
 
let session = NSURLSession.sharedSession() 
let url: String! 
var request: NSMutableURLRequest! 
var task: NSURLSessionTask! 
 
init(url: String, method: String, params: Dictionary = Dictionary(), callback: (data: NSData!, response: NSURLResponse!, error: NSError!) -> Void) { 
self.url = url 
self.request = NSMutableURLRequest(URL: NSURL(string: url)!) 
self.method = method 
self.params = params 
self.callback = callback 
} 
}

之后，將上面分析的

1. 確定 URL

2. 確定 HTTP 方法（GET、POST 等）

3. 添加特定的 HTTP 頭

4. 填充 HTTP Body

前三步封裝到一個(gè) function 中，***一步封裝到一個(gè) function 中，然后把驅(qū)動(dòng) session.dataTaskWithRequest 的代碼封裝到一個(gè) function 中：

func buildRequest() { 
if self.method == "GET" && self.params.count > 0 { 
self.request = NSMutableURLRequest(URL: NSURL(string: url + "?" + buildParams(self.params))!) 
} 
 
request.HTTPMethod = self.method 
 
if self.params.count > 0 { 
request.addValue("application/x-www-form-urlencoded", forHTTPHeaderField: "Content-Type") 
} 
} 
func buildBody() { 
if self.params.count > 0 && self.method != "GET" { 
request.HTTPBody = buildParams(self.params).nsdata 
} 
} 
func fireTask() { 
task = session.dataTaskWithRequest(request, completionHandler: { (data, response, error) -> Void in 
self.callback(data: data, response: response, error: error) 
}) 
task.resume() 
}

之后使用一個(gè)統(tǒng)一的方法來(lái)驅(qū)動(dòng)上面三個(gè) function，完成請(qǐng)求：

func fire() { 
buildRequest() 
buildBody() 
fireTask() 
}

同時(shí)，不要忘了那三個(gè) parse params 的從 Alamofire 偷來(lái)的函數(shù)哦，也要放到這個(gè)類里面。至此，降低耦合的工作基本完成，接下來(lái)我們開(kāi)始封裝“網(wǎng)絡(luò)API”。

使用適配器模式封裝“網(wǎng)絡(luò)API”

理解適配器模式

適配器模式是設(shè)計(jì)模式中的一種，很容易理解：我的 APP 需要一個(gè)獲取某一個(gè) URL 返回的字符串的功能，我現(xiàn)在選擇的是 Alamofire，但是正在發(fā)展的 Pitaya 看起來(lái)不錯(cuò)，我以后想替換成 Pitaya，所以我封裝了一層我自己的網(wǎng)絡(luò)接口，用來(lái)屏蔽底層細(xì)節(jié)，到時(shí)候只需要修改這個(gè)類，不需要再深入項(xiàng)目中改那么多接口調(diào)用了。

適配器模式聽(tīng)起來(lái)高大上，其實(shí)這是我們?cè)谌粘＞幋a中非常常用的設(shè)計(jì)模式。

Do it!

修改 Network 類的代碼為：

class Network{ 
static func request(method: String, url: String, params: Dictionary = Dictionary(), callback: (data: NSData!, response: NSURLResponse!, error: NSError!) -> Void) { 
let manager = NetworkManager(url: url, method: method, params: params, callback: callback) 
manager.fire() 
} 
}

搞定！

封裝多級(jí)接口

不帶 params 的接口：

static func request(method: String, url: String, callback: (data: NSData!, response: NSURLResponse!, error: NSError!) -> Void) { 
let manager = NetworkManager(url: url, method: method, callback: callback) 
manager.fire() 
}

兩個(gè) get 接口（帶與不帶 params）：

static func get(url: String, callback: (data: NSData!, response: NSURLResponse!, error: NSError!) -> Void) { 
let manager = NetworkManager(url: url, method: "GET", callback: callback) 
manager.fire() 
} 
static func get(url: String, params: Dictionary, callback: (data: NSData!, response: NSURLResponse!, error: NSError!) -> Void) { 
let manager = NetworkManager(url: url, method: "GET", params: params, callback: callback) 
manager.fire() 
}

兩個(gè) post 接口（帶與不帶 params）：

static func post(url: String, callback: (data: NSData!, response: NSURLResponse!, error: NSError!) -> Void) { 
let manager = NetworkManager(url: url, method: "POST", callback: callback) 
manager.fire() 
} 
static func post(url: String, params: Dictionary, callback: (data: NSData!, response: NSURLResponse!, error: NSError!) -> Void) { 
let manager = NetworkManager(url: url, method: "POST", params: params, callback: callback) 
manager.fire() 
}

測(cè)試接口

修改 ViewController 中的調(diào)用代碼，測(cè)試多級(jí) API：

@IBAction func mainButtonBeTapped(sender: AnyObject) { 
let url = "http://pitayaswift.sinaapp.com/pitaya.php" 
 
Network.post(url, callback: { (data, response, error) -> Void in 
println("POST 1 請(qǐng)求成功") 
}) 
Network.post(url, params: ["post": "POST Network"], callback: { (data, response, error) -> Void in 
let string = NSString(data: data, encoding: NSUTF8StringEncoding) as! String 
println("POST 2 請(qǐng)求成功 " + string) 
}) 
 
Network.get(url, callback: { (data, response, error) -> Void in 
println("GET 1 請(qǐng)求成功") 
}) 
Network.get(url, params: ["get": "POST Network"], callback: { (data, response, error) -> Void in 
let string = NSString(data: data, encoding: NSUTF8StringEncoding) as! String 
println("GET 2 請(qǐng)求成功 " + string) 
}) 
 
Network.request("GET", url: url, params: ["get": "Request Network"]) { (data, response, error) -> Void in 
let string = NSString(data: data, encoding: NSUTF8StringEncoding) as! String 
println("Request 請(qǐng)求成功 " + string) 
} 
}