Alamofire-初探

Alamofire.png

對于iOS開發者來說,AFNetworking是我們大家所熟知的,而Alamofire呢?Alamofire框架其實就是AFNetworking兄弟,出自于同一個作者。既是同一個作者,那么他們的使用方法,框架結構上應該也是保持一致的。AFNetworkingAlamofire

一、網絡請求步驟

  1. 設置請求url
  2. 設置URLRequest對象,配置請求相關信息
  3. 創建會話配置URLSessionConfiguration
  4. 創建會話URLSession
  5. 創建任務和設置請求回調,并發起請求

一般通過以上幾個步來完成網絡請求,當然要根據不同應用場景來配置請求屬性。

二、體驗

發起一個請求:

func responseData() {
    let url = "http://onapp.yahibo.top/public/?s=api/test/list"
    Alamofire.request(url).responseJSON {
        (response) in
        switch response.result{
        case .success(let json):
            print("json:\(json)")
            let dict = json as! Dictionary<String, Any>
            let list = dict["data"] as! Array<AnyObject>
            guard let result = [UserModel1].deserialize(from: list) else{return}
            self.observable.onNext(result as [Any])
            break
        case .failure(let error):
            print("error:\(error)")
            break
        }
    }
}
  • responseJSON為相應類型,指定為json數據類型
  • responseAlamofire對服務器響應結果的封裝
  • 使用常規解包獲取數據headimg
  • 通過HandyJSON轉換為模型數據,供UI展示

直接通過Alamofire發起請求通過一個閉包返回請求結果,不需要二次封裝使用簡單。這里我們沒有標明請求類型,沒有請求參數,那Alamofire是如何封裝這些請求參數的呢,點擊進入查看方法定義:

public func request(
    _ url: URLConvertible,
    method: HTTPMethod = .get,
    parameters: Parameters? = nil,
    encoding: ParameterEncoding = URLEncoding.default,
    headers: HTTPHeaders? = nil)
    -> DataRequest
{
    return SessionManager.default.request(
        url,
        method: method,
        parameters: parameters,
        encoding: encoding,
        headers: headers
    )
}

這里已經提供了請求所需要的參數,并設置了默認值,因此外界在沒有指定方法時默認為get方式。根據實際開發需求設置響應的參數:

Alamofire.request(url,method: .post,parameters: ["page":"1","size":"20"]).responseJSON

這是我們開發中常見的設置請求方式,請求參數,這里的url支持多種數據類型,可以是String、URL、URLRequest等類型,為什么這么設計呢?因為在項目中可能當前我們跟前有一個String類型的連接,也有可能是個URL類型的連接,這時候在不需要轉換的情況下就可以直接使用,方便快捷,更加靈活。

效果如下:

Alamofire.gif

三、URLSession

同樣在Alamofire中也是對URLSession封裝的,在OC中為NSURLSession,其實是一樣的。一般網絡請求分三個步驟:

1、設置URL請求地址
let url = URL.init(string: "協議://主機地址/路徑/參數1&參數2")!
  • 協議:指定http協議還是https協議
  • 主機:即服務器地址ip地址或綁定ip的域名
  • 路徑:項目在服務器上的位置
  • 參數:即get參數拼接在連接上
2、設置URLRequest屬性
var request  = URLRequest.init(url: url)
request.httpMethod = HTTPMethod.post.rawValue
request.setValue("application/json", forHTTPHeaderField: "Content-Type")
let postData = ["username":"hibo","password":"123456"]
request.httpBody = try?JSONSerialization.data(withJSONObject: postData, options: [])
request.timeoutInterval = 30
request.cachePolicy = .useProtocolCachePolicy
  • httpMethod設置請求方式postget
  • setValue設置請求頭信息
  • httpBody設置請求參數,參數打包在請求體中
  • timeoutInterval設置請求超時時間
  • cachePolicy設置網絡請求緩存策略

通過以上的參數設置,能夠感受到發送一次請求是多么不容易,因此網絡請求是必須要被封裝的

3、發起請求
URLSession.shared.dataTask(with: request) { (data, response, error) in
    print("*******網絡請求*******")
    do {
        let list =  try JSONSerialization.jsonObject(with: data!, options: .allowFragments)
        print(list)
    }catch{
        print(error)
    }
}.resume()
  • URLSession.shared為全局共享單例會話對象
  • 調用dataTask創建網絡請求任務
  • resume默認為掛起狀態,調用重新啟動網絡請求任務
  • data:請求到的數據流,通過JSONSerialization序列化為json格式使用

四、URLSessionConfiguration

URLSession.shared中內部已經配置了該項,此項為會話配置項,一般使用都會進行配置以適用于不同場景。查看該類如下:

open class var `default`: URLSessionConfiguration { get }
open class var ephemeral: URLSessionConfiguration { get }
@available(iOS 8.0, *)
open class func background(withIdentifier identifier: String) -> URLSessionConfiguration
  • default:默認模式,常用模式,在該模式下系統會創建持久化緩存,并在用戶的鑰匙串中保存證書
  • ephemeral:不支持持久性存儲,所有內容的會隨著session的生命周期結束而釋放
  • background:與default模式類似,在該模式下會創建一個獨立線程來傳輸網絡請求數據,可以在后臺乃至APP關閉的時候也可以進行數據傳輸

創建一個會話:

let configuration = URLSessionConfiguration.background(withIdentifier: "request_id")
let session = URLSession.init(configuration: configuration, delegate: self, delegateQueue: OperationQueue.main)
session.dataTask(with: request) { (data, response, error) in
    print("*******網絡請求*******")
    do {
        let list =  try JSONSerialization.jsonObject(with: data!, options: .allowFragments)
        print(list)
    }catch{
        print(error)
    }
}.resume()
  • 設置一個唯一會話標識,通過標識來區分不同的會話任務
  • 遵循URLSessionDelegate代理,實現代理方法,在本類中監控任務進度

下載任務:

let configuration = URLSessionConfiguration.background(withIdentifier: "request_id")
let session = URLSession.init(configuration: configuration, delegate: self, delegateQueue: OperationQueue.main)
session.downloadTask(with: url).resume()

注意在使用background模式時一定要開啟后臺下載權限,否則無法完成后臺下載并回調數據。需要以下兩步才能完成:

1、開啟后臺下載權限

var backgroundHandler: (()->Void)? = nil
//設置此處開啟后臺下載權限
func application(_ application: UIApplication, handleEventsForBackgroundURLSession identifier: String, completionHandler: @escaping () -> Void) {
    self.backgroundHandler = completionHandler
}

2、實現SessionDelegate代理方法,調用閉包方法,通知系統更新屏幕

func urlSessionDidFinishEvents(forBackgroundURLSession session: URLSession) {
    print("后臺任務下載回來")
    DispatchQueue.main.async {
        guard let appDelegate = UIApplication.shared.delegate as? AppDelegate, let backgroundHandle = appDelegate.backgroundHandler else { return }
        backgroundHandle()
    }
}

蘋果官方給出需要實現以上兩個方法來完成后臺下載,通知系統及時更新屏幕。官方文檔

五、相關屬性

官方文檔

1、常規屬性

  • identifier:配置對象的后臺會話標識符
  • httpAdditionalHeaders:與請求一起發送的附加頭文件字典
  • networkServiceType:網絡服務的類型
  • allowsCellularAccess:一個布爾值,用于是否應通過蜂窩網絡進行連接
  • timeoutIntervalForRequest:等待附加數據的超時時間
  • timeoutIntervalForResource:資源請求允許的最大時間范圍
  • sharedContainerIdentifier:應將后臺URL會話中的文件下載到的共享容器的標識符
  • waitsForConnectivity:一個布爾值,指示會話是否應等待連接變為可用還是立即失敗

2、設置Cookie策略

  • httpCookieAcceptPolicy:決定何時接受cookie的策略常量
  • httpShouldSetCookies:一個布爾值,確定請求是否包含來自cookie存儲區的cookie
  • httpCookieStorage:用于會話中存儲cookiecookie存儲區
  • HTTPCookie:該對象為不可變對象,從包含cookie屬性的字典初始化,支持兩個不同的cookie版本,v0、v1

3、設置安全策略

  • TLS協議:用于在兩個通信應用程序之間提供保密性和數據完整性
  • tlsMaximumSupportedProtocol:在此會話中建立連接時客戶端應請求的最大TLS協議版本
  • tlsMinimumSupportedProtocol:協議協商期間應接受的最小TLS協議
  • urlCredentialStorage:為身份驗證提供憑據的憑據存儲區

4、設置緩存策略

  • urlCache:用于為會話中的請求提供緩存響應的URL緩存
  • requestCachePolicy:決定何時從緩存中返回響應的預定義常量

5、支持后臺轉移

  • sessionSendsLaunchEvents:一個布爾值,指示當傳輸完成時,應用程序應在后臺恢復還是啟動
  • isDiscretionary:一個布爾值,用于確定后臺任務是否可以由系統自行安排已獲得最佳性能
  • shouldUseExtendedBackgroundIdleMode:一個布爾值,指示當應用程序轉移到后臺時是否應保持TCP連接打開

6、支持自定義協議

  • protocolClasses:在會話中處理請求的額外協議子類的數組
  • URLProtocol:該對象用來處理加載協議特定URL數據

7、支持多路徑TCP

  • multipathServiceType:指定用于通過Wi-Fi和蜂窩接口傳輸數據的多路徑TCP連接策略的服務類型

8、設置HTTP策略和代理屬性

  • httpMaximumConnectionsPerHost:同時連接到給定主機的最大數量
  • httpShouldUsePipelining:一個布爾值,用于確定會話是否使用HTTP流水線
  • connectionProxyDictionary:包含相關要在此會話中使用的代理信息的字典

9、支持連接更改

  • waitsForConnectivity:一個布爾值,指示會話應等待連接可用還是立即失敗

一個請求任務就有如此多的配置屬性,可想而知對一個網絡框架的整合,工作量也是非常大的。接下來我們就一步步來了解一下Alamofire是如何一步步整合的。

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