SolarNetwork-優(yōu)雅的Swift網(wǎng)絡(luò)封裝

GitHub: SolarNetwork

前言

剛開始寫Swift項(xiàng)目時(shí)，用到網(wǎng)絡(luò)請(qǐng)求時(shí)，毫無(wú)疑問(wèn)，選擇了Moya。但隨著項(xiàng)目的增大，接口越來(lái)越多，TargetType文件也越來(lái)越大，尋找某一個(gè)接口的參數(shù)和其他配置時(shí)，就要在各種Switch中跳來(lái)跳去，感到十分煩惱，就算分了多個(gè)TargetType，也還是存在這個(gè)問(wèn)題，于是就干脆借鑒Moya的優(yōu)點(diǎn)，基于Alamofire重新封裝了一個(gè)簡(jiǎn)單易用的網(wǎng)絡(luò)庫(kù)，保留了TargetType的服務(wù)配置功能，并將接口配置分離成各個(gè)獨(dú)立的Request，形成一個(gè)新的網(wǎng)絡(luò)庫(kù)SolarNetwork。

目錄

• 設(shè)計(jì)
• 特性
• 要求
• 使用

設(shè)計(jì)

SolarNetwork包括以前幾個(gè)類：

• SLNetwork 對(duì)應(yīng)一個(gè)SessionManager，負(fù)責(zé)Request的發(fā)送，Progress和Response的回調(diào)。
• SLTarget 對(duì)應(yīng)一個(gè)Host或者一系列具有相同配置請(qǐng)求的配置。
• SLRequest, SLDownloadRequest, SLUploadRequest 分別對(duì)應(yīng)Data, Download和Upload，是這3種請(qǐng)求的配置。
• SLProgress 下載和上傳進(jìn)度的回調(diào)。
• SLResponse 是一個(gè)已處理過(guò)的Response，你可以進(jìn)一步選擇轉(zhuǎn)換為JsonObject或者M(jìn)odel。
• SLPlugin 提供了兩個(gè)切入點(diǎn)，分別用來(lái)在請(qǐng)求發(fā)送前修改請(qǐng)求的willSend 和 接收到網(wǎng)絡(luò)回調(diào)后修改回調(diào)內(nèi)容的 didReceive。
• SLReflection 負(fù)責(zé)將SLRequest的子類屬性反射為Alamofire.Parameters。

所以一個(gè)網(wǎng)絡(luò)請(qǐng)求的具體流程為：

SLNetwork(SLTarget).request(SLRequest).willSend(SLRequest)
                   .progressClosure(SLProgress)
                   .reponseData(OriginalResponse)
                   .didReceive(SLResponse).decodeTo(Dictionary)
                   .completionClosure(SLResponse)
                   .decodeTo(Model: Decodable).dealWithError

SLNetwork(SLTarget).request(SLRequest)
                   .progressClosure(SLProgress)
                   .completionClosure(SLResponse)

特性

• 靈活的多服務(wù)配置(baseURL, Header, ParameterEncoding, URLSessionConfiguration, TSL……)
• 完整的數(shù)據(jù)請(qǐng)求方法
• 完整的下載和斷點(diǎn)下載方法(意外退出也能恢復(fù))
• 完整的上傳方法：File, Data, InputStream, FormData
• 上傳和下載的進(jìn)度回調(diào)
• 網(wǎng)絡(luò)狀態(tài)Reachability回調(diào)
• 保留Alamofire的對(duì)外API
• 修改Request和Response的Plugin
• Swift4下利用Decodable將JSON轉(zhuǎn)為Model
• 完整的日志打印

更多內(nèi)容請(qǐng)直接到GitHub查看。

要求

• iOS 8.0+
• Xcode 9+
• Swift 4+

使用

配置服務(wù)

import SolarNetwork

struct HTTPBinTarget: SLTarget {
    var baseURLString: String { return "https://httpbin.org" }
}

let HTTPBinNetwork = SLNetwork(HTTPBinTarget())

發(fā)送一個(gè)請(qǐng)求

import SolarNetwork

//Mark: - GET
class HTTPBinGETRequest: SLRequest {
    
    override func loadRequest() {
        super.loadRequest()
        
        self.path = "/get"
    }
    
}

HTTPBinNetwork.request(HTTPBinGETRequest()) { (response) in
    if let dictionary = response.dataDictionary {
                        
    }
    else if let error = response.error {
        //show error
    }
}

//Mark: - POST
class HTTPBinPOSTRequest: SLRequest {
    
    override func loadRequest() {
        super.loadRequest()
        
        self.method = .post
        self.path = "/post"
    }
    
    /**
     利用反射，將屬性自動(dòng)轉(zhuǎn)換為Parameters，不需要自己組裝了
     ["userName": "myUserName",
      "password": "myPassword"]
     */
    let userName = "myUserName"
    let password = "myPassword"

}

HTTPBinNetwork.request(HTTPBinPOSTRequest()) { (response) in
    if let dictionary = response.dataDictionary {
                        
    }
    else if let error = response.error {
        //show error
    }
}

下載和斷點(diǎn)續(xù)傳

import SolarNetwork

class GitHubDownloadRequest: SLDownloadRequest {
    
    override func loadRequest() {
        super.loadRequest()
		
        self.URLString = "http://cdnvue.com/video/rzGHzRA19L/64tBZo"
    }
}

let downloadRequest = GitHubDownloadRequest()
GitHubNetwork.download(downloadRequest, progressClosure: { (progress) in
                    
}) { (response) in
                    
}

//如果需要斷點(diǎn)下載此文件，請(qǐng)?jiān)O(shè)置該屬性為true
downloadRequest.isResume = true

//自定義文件下載完成后的存放路徑，默認(rèn)為"/Library/Caches/SLNetwork/Destination/(requestID)"
downloadRequest.destinationURL = FileManager.default.urls(for: .cachesDirectory, in: .userDomainMask)[0]

上傳

import SolarNetwork

class HTTPBinUploadRequest: SLUploadRequest {
    
    override func loadRequest() {
        super.loadRequest()
        
        self.path = "/post"
    }
    
}

let uploadRequest = HTTPBinUploadRequest()
uploadRequest.data = data //data to upload
HTTPBinNetwork.upload(uploadRequest, progressClosure: { (progress) in
                            
}) { (response) in
                            
}

Decode

Swift 4下，利用Decodable將Json轉(zhuǎn)為Model

import SolarNetwork

struct User: Decodable { //Swift 4 Codable
    var id: Int
    var name: String
    var token: String
}

HTTPBinNetwork.request(UserRequest()) { (response) in
    if let user = response.decode(to: User.self) {
                        
    }
    else if let error = response.error {
        //show error
    }
}

更多內(nèi)容，Demo和交流請(qǐng)到GitHub