Elegant network abstraction layer in Swift.
- 中文
- Design
- Features
- Requirements
- Communication
- Installation
- Usage
- Base Usage - Target - Request - Download - Upload - Decode
- Target - Configuration of a Host.
- Request - Configuration of a DataRequest.
- Download - Configuration of a DownloadRequest or ResumeDownloadRequest.
- Upload - Configuration of a UploadRequest(Data - File - InputStream - FormData).
- Progress - Progress
- Response - Decode - Error
- Plugin - WillSend - DidReceive
- License
- UpdateLog
Design
Alamofire and Moya are elegant Swift network frames. They each have their own advantages. When I use them, I always want to combine the advantages of both, make them easy to use and retain their original features. So I wrote the SolarNetwork.
- SLNetwork corresponds to a SessionManager.
- SLTarget corresponds to a Host, or a set of requests for the same configuration.
- SLRequest, SLDownloadRequest, SLUploadRequest corresponds to Request of Data, Download, Upload.
- SLProgress return progress when download or upload.
- SLResponse response of a request which you can decode to JsonObject or Model.
- SLPlugin you can modify SLRequest in
willSend
and modify SLResponse indidReceive
. - SLReflection reflex properties of SubSLRequest to Alamofire.Parameters.
So a complete request process is:
SLNetwork(SLTarget).request(SLRequest).willSend(SLRequest)
.progressClosure(SLProgress)
.reponseData(OriginalResponse)
.didReceive(SLResponse).decodeTo(Dictionary)
.completionClosure(SLResponse)
.decodeTo(Model: Decodable).dealWithError
In most cases, what you need to concerned about is:
SLNetwork(SLTarget).request(SLRequest)
.progressClosure(SLProgress)
.completionClosure(SLResponse)
Features
- URL / JSON / plist Parameter Encoding
- Upload File / Data / Stream / MultipartFormData
- Download File using Request or Resume Data
- Authentication with URLCredential
- Upload and Download Progress Closures with Progress
- Dynamically Adapt and Retry Requests
- TLS Certificate and Public Key Pinning
- Network Reachability
- Pre-populate the DNS cache
- Complete Logger
Requirements
- iOS 8.0+
- Xcode 9+
- Swift 4+
Communication
- If you'd like to ask a general question, use Stack Overflow.
- If you found a bug, open an issue.
- If you have a feature request, open an issue.
- If you want to contribute, submit a pull request.
Installation
CocoaPods
CocoaPods is a dependency manager for Cocoa projects. You can install it with the following command:
$ gem install cocoapods
CocoaPods 1.1+ is required.
To integrate SolarNetwork into your Xcode project using CocoaPods, specify it in your Podfile
:
source 'https://github.com/CocoaPods/Specs.git'
platform :ios, '8.0'
use_frameworks!
target '<Your Target Name>' do
pod 'SolarNetwork'
end
Then, run the following command:
$ pod install
Carthage
Carthage is a decentralized dependency manager that builds your dependencies and provides you with binary frameworks.
You can install Carthage with Homebrew using the following command:
$ brew update
$ brew install carthage
To integrate Alamofire into your Xcode project using Carthage, specify it in your Cartfile
:
github "ThreeGayHub/SolarNetwork"
Run carthage update
If this is your first time using Carthage in the project, you'll need to go through some additional steps as explained over at Carthage.
Usage
Base Usage
Target
import SolarNetwork
struct HTTPBinTarget: SLTarget {
var baseURLString: String { return "https://httpbin.org" }
}
let HTTPBinNetwork = SLNetwork(HTTPBinTarget())
Request
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"
}
/**
properties will encode to parameters by Reflection
["userName": "myUserName",
"password": "myPassword",
"name" : "youName"]
*/
let userName = "myUserName"
let password = "myPassword"
var name: String?
}
let postReq = HTTPBinPOSTRequest()
postReq.name = "yourName"
HTTPBinNetwork.request(postReq) { (response) in
if let dictionary = response.dataDictionary {
}
else if let error = response.error {
//show error
}
}
Download
import SolarNetwork
class HTTPBinDownLoadRequest: SLDownloadRequest {
override func loadRequest() {
super.loadRequest()
self.path = "/image/png"
self.isResume = true //control the download request is resume or not, default is false
}
}
HTTPBinNetwork.download(HTTPBinDownLoadRequest(), progressClosure: { (progress) in
}) { (resposne) in
}
Upload
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
In Swift 4, you can use Codable.
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
}
}
License
Alamofire is released under the MIT license. See LICENSE for details.