iOS開發之Alamofire源碼解析

今天博客中的Alamofire源碼的版本是以3.4版本爲例。上篇博客系統的對NSURLSession相關的東西進行了詳細的解析，詳情請看《詳解NSURLSession》，爲了就是給本篇博客打下基礎。由於AlamoFire就是對NSURLSession及其相關的東西進行了進一步的封裝，讓網絡請求使用起來更爲簡單。本篇博客就詳細的來窺探一下AlamoFire源碼，主要來看一下AlamoFire是如何對NSURLSession進行封裝的，而且來看一下在封裝時使用了哪些Swift語言中的高級用法，也就是看一下Swift語言進一步的使用方法。

固然AlamoFire是AF的Swift版本了，其中雖然是使用Swift語言實現的，可是實現思路與AFNetWorking大同小異。若是你以前閱讀過AFNetWorking的源碼，那麼你對Alamofire的源碼應該並不陌生，好多地方的實現思路是一致的。今天博客中不是教你如何去使用AlamoFire，而是告訴你Alamofire是如何實現的。本篇博客中的乾貨仍是比較足的，關於AlamoFire的官方文檔請移步Alamofire -- github連接。

下方第一部分的類圖是在閱讀AlamoFire源碼時爲了梳理每一個結構間的關係畫的一個簡單的類圖，下方的類圖沒有涵蓋AlamoFire中全部的類，而是給出了核心部分的模塊以及各個模塊間的關係。接下來咱們將對下方的模塊進行拆分，而後各個擊破。本篇博客的主題思路是先總體的看一下AlamoFire的組織架構，並解析每部分的關係。而後對每一個模塊進行詳細的解析，在解析時咱們會對一些Swift語言的知識點進行提取，而後將其進行剖析。

 

一.Alamofire核心模塊概述

咱們先總體上來看一下AlamoFire這個框架關係，概述一些核心模塊。該部分咱們先來看一下AlamoFire的文件組織結構，而後在給出這些文件組織結構中類的關係。因此在本部分類圖是少不了的。廢話少說，進入該部分的主題。

1.Alamofire的目錄結構解析

首先咱們來看一下AlamoFire的目錄結構，從總體上來把控一下AlamoFire。下方截圖是AlamoFire框架的全部文件，文件不算多，Alamofire框架的源代碼並不算多，全部理清Alamofire的框架結構仍是不難的。下方截圖中是AlamoFire中的全部文件，Core文件夾下是Alamofire的核心文件，Features主要是對核心文件的擴展。今天咱們就以核心文件爲主，Feature文件爲輔來窺探一下AlamoFire框架的源碼。

下方是對Core文件夾下的各個文件的功能簡述：

• Alamofire.swift ---- 該文件中主要是給用戶提供一些便利的調用方法，用戶能夠直接調用該文件中的便利方法來使用Alamofire相關功能。

• Manager.swift ---- Manager中定義了Session對象，Session相關的Delegate，以及Delegate執行的隊列等相關信息，在Manager中建立Request對象發起請求。Manager管理的就是各類請求，Manager對象是以單例的形式對外開放的。

• Request.swift ---- 該文件如其名，就是負責建立Session的各類task的，並執行相關的SessionTask，並調用相關書籍解析的功能模塊對數據進行解析並經過回調返回給用戶。

• ParameterEncoding.swift ---- 負責請求參數的各類編碼（ URL、URLEncodedInURL、JSON、PropertyList等編碼），並將編碼後的數據與URLRequest結合後的結果進行返回。

• Result.swift ---- 對解析後的數據封裝成Result對象。

• Response.swift ---- 負責將服務器相應的數據進行封裝生成Response對象，該對象中就包括上述的Result對象，用戶最終會經過閉包回調的形式獲取到該Response的對象。

• Notifications.swift ---- 其中是一個Notification結構體，該結構體中定義了一些字符串，這些字符串就是所需通知的Key，當網絡請求DidResume、DidSuspend、DidCancel、DidComplete都會發出通知。

• Error.swift ---- 其中是一個Error的結構體，其中封裝的是各類錯誤狀態。

Features文件夾下各個文件的功能簡述：

• Download.swift ----- 對Manager和Request類進行擴展，使其支持Down Task，其中封裝了 NSURLSessionDownloadDelegate相關代理方法。

• Upload.swift ---- 在該文件中也是對Manager和Request類進行的擴展，使其支持Upload Task，其中封裝了 NSURLSessionDataDelegate中獲取上傳數據進度的代理方法，也就是 taskDidSendBodyData代理方法。

• MultipartFormData.swift ---- 該文件從名字就能夠看出是爲了組織多表單數據上傳的數據的，在Upload Task中就使用到了 MultipartFormData。

• Stream.swift ---- 和Download和Upload文件類似，該文件中也是對Manager和Rquest作延展，主要使其支持數據流的傳輸，其中主要封裝和實現了 NSURLSessionStreamDelegate相關的代理方法。

• ResponseSerialization.swift ---- 該文件中主要是對Request類進行數據解析的延展的。其中封裝了各類對響應數據的解析方式，其中包括Data、String、JSON、PropertyList 等解析方式。

• NetworkReachabilityManager.swift ---- 該文件主要是對 SystemConfiguration .framework中的 SCNetworkReachability 相關的東西進行封裝的，主要用來管理和監聽網絡狀態的變化 。

• ServerTrustPolicy.swift ---- 這個文件主要是對NSURLSession作的延展，其中定義了各類網絡請求的認證策略，主要證書認證相關東西。

• Timeline.swift ---- 該文件是爲了方便調試而生的，其中記錄了相關操做的時間點，而且對其進行記錄，便於在Debug時使用到。

• Validation.swift ---- 主要是用來驗證請求是否成功，若是出錯了就作相應的處理。

上面是AlamoFire中全部文件的概述，上面這些算是對AlamoFire框架有大概的瞭解吧。結合上方的概述，來研讀AlamoFire源碼仍是比較清晰的。下方就是AlamoFire 3.4中相關文件的木頭結構，以下所示：

　　

 

2.核心類間的結構

上面簡單的介紹了Alamofire框架的目錄結構以及每一個文件所負責的內容。接下來咱們進入到各個文件的內部，來總體的看一下核心類之間的關係。下方是核心類的「類圖」，固然下方只是核心類的。接下來來概述一下下方的類圖，由於下圖太大，在此看起來不太清楚，若是你感興趣，你能夠另存爲，而後放大查看。

• 下方黑框中的部分對應的就是Alamofire.swift中的內容。其中主要是一些URL轉換字符串的延展以及 URLRequst轉換成 MutableURLRequest的延展，還有一些用戶使用的便利方法。

• 黃框中就是咱們 Manager.swift中的內容了， Manager類的對象是以單例的形式對外展示的，上述黑框中的便利方法，主要是獲取Manager類的單例，而後調用相應的方法。

• 綠框中所對應的主要是 Request.Swift和Features文件夾中的內容，主要是Request類及其延展，固然還有對 Manager和 NSURLSession的延展。

• 紅框中的就是網絡請求會話的各類任務的回調方法的封裝了，在這些回調方法中提供了默認實現，並對外留有回調塊，以便讓用戶來本身實現這些回調方法。

　　

 

2、Alamofire.swift源碼解析

第一部分算是概覽了一下Alamofire框架中的各個組成部分，接下來該進入到上述的各個模塊中來進一步來窺探其實現和組織方式了。仍是「順藤摸瓜」，先從用戶看的到的地方着手，而後層層深刻，直到你看不見的地方。因此第二部分咱們先來看一下Alamofire.swift中的內容，由於該文件是Alamofire框架的入口。

1.Alamofire.swft中的類圖結構

下方的類圖就是第一部分類圖中黑框的放大版，根據Alamofire.swift這個文件咱們不難畫出下方這個類圖。有一點要說明的就是在類圖中省略了一些遍歷方法，只寫了一些主要的，不過核心的功能仍是有的。下方的URLStringConvertible和URLRequestConvertible是負責類型轉換的接口，具體的請看下方的介紹。該文件中除了類型轉換的方法外就是一些調用Manager的單例的便利方法了。

　　

2.Alamofire.swift技術細節

下方就是URLStringConvertible協議以及相關延展的具體實現，主要功能就是將String、NSURL、NSURLComponents、NSURLRequest中的URL轉換成字符串類型。將要轉換的類型要遵循URLStringConvertible協議，並在計算變量URLString中返回轉換後的字符串。具體作法以下所示，這中類型轉換方式在開發中常常會使用到，下方會給出其餘實例。URLRequestConvertible協議的功能與URLStringConvertible大同小異，URLRequestConvertible協議的實現者負責將NSURLRequest轉換成NSMutableURLRequest類型。在此就不作過多的贅述了。

　　

下方截圖是Alamofire.swift中的一個便利方法，其餘幾個便利方法與此類似，都是調用Manager單例中相應的方法，便利方法爲了鏈式調用Request類中的相關方法，因此全部的便利方法都會返回當前Manager單例使用的Request對象。具體以下所示：

　　

 

3.擴展用例

學以至用，觸類旁通。上面那種「面向協議」開發的思想值得咱們學習，以前在設計模式相關的系列博客中不止一次的提到過要「面向接口編程」，此處的協議就是接口。雖然上面只是使用協議來進行簡單的類型轉換，這種思想是很是值得咱們學習的。經過上面類型轉換的方式，咱們能夠寫出下方代碼。下方代碼不是Alamofire框架中的代碼，是我根據上述的類型轉換的實例所實現的，下方定義了一個類型轉換的協議，須要轉換的類型要遵循這個協議，下方以String爲例，具體作法以下所示。

　　

 

3、Manager.swift源碼解析

由於便利方法主要是調用的Manager類的單例，因此接下來咱們來看Manager.swift中的東西。Manager類中主要負責Session和Request的初始化，而且提供SessionDelegate代理方法的默認實現。在實現代理方法時留出了相應的閉包已提供給用戶使用該閉包來回調相應的代理方法。在Manager中的SessionDelegate類就是NSURLSessionDelegate以及相關子協議的代理類 ，其中就給出了各個代理方法的默認實現，在實現時並定義了一系列的Closure回調變量，當這些閉包變量不爲空時就會執行閉包塊中的內容，而不會執行提供的默認實現。

1.Manager.swift相關類圖

下方類圖就是黃色部分的放大版，主要是Manager類與SessionDelegate的關係。從下方類圖中不難看出，SessionDelegate類遵循了NSURLSessionDelegate協議以及子協議，並給出了代理相應的實現方法。下方的代碼會給出代理的具體封裝和實現方式。

　　

 

2.Manager類的相關屬性

開門見山，由於Manager類對外是以單例的形式對外使用的，因此咱們先來看看Manager類的單例實現。下方截圖中的sharedInstance計算屬性就是Manager的單例，其中存儲的就是一個Manager對象，在建立Manager對象時咱們爲Manager對象中存儲的NSURLSession對象指定了一個defaultSessionConfiguration和一個defaultHTTPHeaders。

　　

上面是Manager類中單例的實現，接下來咱們來解析類中核心的屬性，下方是一些核心屬性的解析：

• defaultHTTPHeaders屬性 ： defaultHTTPHeaders是Manager類中的一個計算屬性，負責組織默認的請求Header中的內容。

• session屬性： 該屬性的類型是NSURLSession類型的，負責請求會話，並建立各類會話任務。

• queue屬性：該屬性是一個串行隊列，該隊列負責執行session建立Session Task的任務。

• delegate屬性：該屬性是SessionDelegate類型的，而SessionDelegate類遵循了NSURLSessionDelegate及其子協議，並給出了相應的實現，在下方會着重介紹SessionDelegate。而此處的delegate屬性負責調用SessionDelegate類中相應的回調方法。

 

3.Manager類的request方法

在Manager.swift源文件中給出了request方法的實現，Manager類的單例所調用的upload、download等方法是在其餘源文件中作的延展。那些延展中的方法稍後在聊，本部分中就先對request方法進行解析。下方的方法就是咱們在便利方法中使用Manager類的單例所調用的方法。method參數表示請求方式（GET, POST, PUT等），URLString參數是請求地址，parameter就是請求參數了。encoding參數就是請求參數的編碼方式，此處默認是URL編碼。headers字典參數就是請求頭信息了，默認爲nil。下方代碼主要是建立NSMutableURLRequest對象，而後將參數進行相應的編碼後添加進NSMutableURLRequest對象中，而後調用request()方法發起請求。

　　

下方代碼段是上述函數中所調用的request()方法，下方的request()方法負責經過Session建立dataTask，也就是負責執行Data Task任務。而後在初始化Request類的對象時，將建立的Data Task對象傳給Request對象。而後將Request對象的 Task Delegate對象存入Manager類的delegate屬性中。由於在delegate屬性中的代理方法是調用相應的Task Delegate的方法，因此在此有必要進行存儲。而後調用Request對象的resume()方法發起數據的網絡請求。爲了鏈式調用Request對象的其餘方法，因此將Request類的對象進行返回。代碼以下所示：

　　

 

4. Manager中SessionDelegate解析

SessionDelegate能夠說是代理的代理，由於在SessionDelegate中有一個subdelegates字典屬性，該屬性負責存儲Request對象中的各個Task Delegate。而SessionDelegate在相應的代理方法中會經過存儲的Task Delegate來調用Task Delegate中的方法，因此SessionDelegate說是代理的代理。

下方代碼段是SessionDelegate類中部分代碼的截圖，其中的subdelegates字典屬性中存儲的就是Request中的TaskDelegate，subdelegateQueue是一個並行隊列用來同步執行獲取和設置字典中的Task Delegate對象。而後就是爲SessionDelegate類定義了一個下標，該下標的功能是以Session Task爲下標的形式向subdelegates中添加和獲取相應的Task Delegate。該自定義下標就可讓類的對象使用下標的形式來設置和獲取屬性的值，稍後會給出擴展的Demo。

　　

關於SessionDelegate中所實現的代理方法，在此咱們就一執行Data Task請求的didReceiveData代理方法爲例。下方截圖就是SessionDelegate中的didReceiveData代理方法。代碼比較簡單，首先判斷該代理方法對象的Closure回調變量是否有值，若是有就執行該閉包回調塊，若是沒有值就獲取咱們存儲的Data Task Delegate, 而後去執行Data Task Delegate中的didReciveData方法。其餘方法也於此相似，因此就以點代面，在此就不作過多的贅述了。

 

5.知識點擴展

接下來有到了觸類旁通，擴展知識點的時刻了。接下來咱們單獨來建立一個小實例來看一下Swift中自定義下標是怎麼回事。大道至簡，接下來咱們將上述下標的使用進行簡化，建立一個Demo, 而後經過這個Demo來介紹一下下標的使用。

下方代碼段就是咱們建立的簡化版的下標示例，在Swift的類中是支持自定義下標的，自定下標可讓你如下標的形式來訪問和設置屬性。下方就自定義了一個下標，在下標中設置和返回value屬性的值。用法以下所示：

　　

 

4、Request.swift源碼解析

逐漸深刻，咱們如今來到了Request.swift這個類，由於上面的Manager中的請求最終走到了Request類的位置，因此接下來咱們要分析的就是Request.swift源文件中的內容。Request.swift源文件中主要是執行的Data Task請求，而且實現了相應的Data Task Delegate中的方法。其餘的任務例如Download Task， Upload Task，Stream Task等會在其餘文件中對Request作延展時執行上述這些任務。咱們在此就以Data Task爲例。Request類中說白了就是負責經過會話建立相應的Task，並實現相應Task的代理方法。

1. Request相關類圖

下方類圖就是Request相關類圖了，Request類及其延展中就是建立各類類型的Task，而後給出相應的Task Delegate。下方類圖還給出個各類Task Delegate間的繼承關係。Request相關源文件在給出TaskDelegate的代理方法的實現時，也封裝了閉包狀態下的回調方法。這中作法與SessionDelegate中作法一致。下方會給出具體的介紹。

　　

 

2.Request類的初始化方法

下方就是Request類的初始化方法，方法須要兩個參數，第一個參數是NSURLSession的對象，該對象也就是Manager單例中建立的Session的對象。而第二個參數雖然是Manager傳過來的，可是初始化task的任務還得交給Request類來作，Manager來只不過是定義了一個NSURLSessionTask的類型傳到了Request中，例如在Manager的request()方法中task是NSURLSessionDataTask，Manager的upload()方法中的task是NSURLSessionUploadTask類型。

在Request的初始化方法中根據Manager單例提供的task的類型來肯定是建立DataTaskDelegate、UploadTaskDelegate等。在相應的Task Delegate中會建立相應的Task。咱們還以上述的DataTask爲例，若是你調用Manager單例中的request()方法就會執行下方的DataTaskDelegate()的初始化。以下所示：

　　

上面的delegate是TaskDelegate類型的，由於UploadTaskDelegate、DownloadTaskDelegate以及DataTaskDelegate都是TaskDelegate的子類，因此此處用到了面向對象的「多態性」。下方兩個屬性就是Request類中的delegate和task屬性，delegate的初始化在上述Requset的初始化方法中，而此處的task是一個存儲屬性，task的初始化是放在相應的TaskDelegate中的，在TaskDelegate中建立完task對象後再賦值給Request類中的task屬性，以下所示：

　　

 

3. Requset類中的Progress閉包

在使用Request類的對象時，咱們能夠鏈式的調用Request中的方法，最經常使用的就是獲取相應任務執行的進度，也就是平時我使用的progress()方法。下方截圖中的代碼段就是progress()方法的實現。經過Task Delegate的類型來判斷目前執行的哪一種任務，而後將傳過來的progress的閉包賦值給相應的Task Delegate，在這些Task的Delegate中會在相應的回調方法中獲取任務執行進度，而後執行下方傳入的Closure。

　　

 

4.Request的resume()方法

下方就是Request類中的resume()方法，其中的代碼比較簡單。主要是用來記錄startTime，而後調用task的resume方法開始執行任務。固然在開始執行任務後要發起相應的通知，此處發出的是DidResume通知。全部的通知類型都在Notifications.swift文件中的Notifications結構體中存儲着。Request類中的其餘方法，好比suspend()、cancel()方法的實現方式與resume()相似，而且都會發出相應的通知，在此就不作過多的贅述了。

　　 

 

5.Request類中的相關代理類

從第一部分中的類圖中咱們能看出與Request類相關的代理類，TaskDelegate是全部代理類的基類。在該代理類中其實就是定義了一下必要的屬性和NSURLSessionTaskDelegate中對應的回調方法，而且爲這些回調方法提供相應的閉包回調的形式。此處就以TaskDelegate代理類爲例。下方就是TaskDelegate代理類爲NSURLSessionTaskDelegate中相應的代理方法提供的Closure方式。其餘的代理類如DataTaskDelegate、DownloadTaskDelegate等與此相似。而相應的代理方法中就是對回調進行了處理，不過在處理以前會判斷相應的Closure是否爲nil, 若是不爲nil的話就執行Closure閉包塊中的內容。若是爲nil，就執行提供的默認處理。

　　

 

事無鉅細，至此Alamofire中的核心類就已經介紹完畢，由於篇幅有限，其餘類在此就不作過多贅述了。其餘類以及其餘文件中的內容在第一部分中作了概述，其內部的實現細節就不作過多贅述了，在Github上分享的代碼對這些類的關鍵技術細節給出了註釋。

在Alamofire框架中大量的使用了延展、閉包以及枚舉關聯值。特別是在解析網絡請求的數據時，將閉包類型做爲函數的參數，而後經過閉包變量來提供相應的解析方案，在此就不作過多的贅述了，其餘技術細節「仁者見仁，智者見智」。聽我說再多，看再多的技術博客若是不親自的去了解一下，說再多也是沒用的，實踐出真知。關於Alamofire源碼的其餘內容在此就不作過多贅述了，若是感興趣就親自的去閱讀吧，歡迎互相交流。今天博客就先到這兒。

github分享連接：https://github.com/lizelu/iOS_NetWorkingAndAlamofire