Alamofire network library URLCache-based cache extension

• Features
• Installation
• Usage
  • Cache and refresh
  • Ignore server-side cache configuration
  • Clear cache
• License

Features

• Cache data and refresh
• Ignore server config
• Clear cache

Installation

Cocoapods

To integrate AlamofireURLCache into your Xcode project using Cocoapods, specify it in your Podfile:

Swift 5 (Alamofire version is 5.x)

pod 'AlamofireURLCache5'

Note that the current Cocoapods integration only supports the latest version of Swit5.x (corresponding to the Alamofire 5.x version), if you use Swift4.x or use Alamofire4.x, please use Carthage integration

Carthage

To integrate AlamofireURLCache into your Xcode project using Carthage, specify it in your Cartfile:

Swift 5 (Alamofire version is 5.x)

github "kenshincui/AlamofireURLCache"

Swift 4 or Swift 5 (Alamofire version is 4.x)

github "kenshincui/AlamofireURLCache" == 0.4

Swift 3 (Alamofire version is 3.x)

github "kenshincui/AlamofireURLCache" == 0.1

Run carthage update to build the framework and drag the built AlamofireURLCache.framework into your Xcode project.

Swift Package Manager

The Swift Package Manager is a tool for automating the distribution of Swift code and is integrated into the swift compiler.

Once you have your Swift package set up, adding AlamofireURLCache5 as a dependency is as easy as adding it to the dependencies value of your Package.swift.

dependencies: [
    .package(url: "https://github.com/HarshitDaftary/AlamofireURLCache.git", .upToNextMajor(from: "0.5.1"))
]

Swift Package on Xcode

You can simply add this library to your Xcode project, Go to File > Swift Packages > Add Package Dependency.

Enter following URL in search box

https://github.com/HarshitDaftary/AlamofireURLCache.git

Click Next to get library to your code.

Manually

If you prefer not to use any of the aforementioned dependency managers, you can integrate AlamofireURLCache into your project manually(Only need to copy AlamofireURLCache.swift to you project).

Usage

Cache and refresh

You can use the cache() method to save cache for this request, and set the request with the refreshCache parameter to re-initiate the request to refresh the cache data.

• Simply cache data

AF.request("https://myapi.applinzi.com/url-cache/no-cache.php").responseJSON(completionHandler: { response in
    if response.value != nil {
        self.textView.text = (response.value as! [String:Any]).debugDescription
    } else {
        self.textView.text = "Error!"
    }
    
}).cache(maxAge: 10)

• Refresh cache

AF.request("https://myapi.applinzi.com/url-cache/no-cache.php",refreshCache:true).responseJSON(completionHandler: { response in
    if response.value != nil {
        self.textView.text = (response.value as! [String:Any]).debugDescription
    } else {
        self.textView.text = "Error!"
    }
    
}).cache(maxAge: 10)

Ignore server-side cache configuration

By default, if the server is configured with cache headers, the server-side configuration is used, but you can use the custom cache age and ignore this configuration by setting the ignoreServer parameter。

AF.request("https://myapi.applinzi.com/url-cache/default-cache.php",refreshCache:false).responseJSON(completionHandler: { response in
    if response.value != nil {
        self.textView.text = (response.value as! [String:Any]).debugDescription
    } else {
        self.textView.text = "Error!"
    }
    
}).cache(maxAge: 10,isPrivate: false,ignoreServer: true)

Clear cache

Sometimes you need to clean the cache manually rather than refresh the cache data, then you can use AlamofireURLCache cache cache API. But for network requests error, serialization error, etc. we recommend the use of autoClearCache parameters Automatically ignores the wrong cache data.

AF.clearCache(dataRequest: dataRequest) // clear cache by DataRequest
AF.clearCache(request: urlRequest) // clear cache by URLRequest

// ignore data cache when request error
AF.request("https://myapi.applinzi.com/url-cache/no-cache.php",refreshCache:false).responseJSON(completionHandler: { response in
    if response.value != nil {
        self.textView.text = (response.value as! [String:Any]).debugDescription
    } else {
        self.textView.text = "Error!"
    }
    
},autoClearCache:true).cache(maxAge: 10)

When using AlamofireURLCache, we recommend that you add the autoClearCache parameter in any case.

In Swift 3 ~ Swift 4

If you are using Swift3 or Swift4, the code in the above demo only needs to modify AF to Alamofire.

License

AlamofireURLCache is released under the MIT license. See LICENSE for details.