被忽视的 NSURLCache

• 使用 NSURLCache 和 NSCache 来实现缓存；

• 使用 NSURLSession 实现下载；

• 没有实现自己的缓存系统；

• 没有进行图片处理，所以他不能创建缩略图，更不能处理GIF 图片；

前篇: NSURLCache

• 我们如何知道缓存的图片什么时候过期（也许他永不过期）；

• 我们的磁盘不是无限大的，那些已经很久以前的图片文件该如何删除他们呢？

• 我们的内存也不是无限大的，我在内存中如何有些的管理这些缓存文件呢？内存不够的时候该怎么办？

• 系统自动管理缓存内容，所以你在开发 App 中不用知道该什么时候来删除这些磁盘或者内存中的缓存内容；不用担心系统内存不够的时候该如何有效的清理他们，一旦磁盘或者内存有压力，系统会自动清理他们，当然你也不用关心缓存的时间；

• 我感觉最大的优势在于 Cache-Control，因为我们只需要在服务端上根据 Http 协议设置 Cache-Control 的内容就可以告诉 NSURLCache, 这个缓存应该是什么时候过期了，客户端上设置不需要写任何一行代码 （NSURLRequest 的默认缓存策略就是这个）；

使用 NSURLCache 缓存

let cache = NSURLCache(memoryCapacity: 10 * 1024 * 1024,diskCapacity: 30 * 1024 * 1024,diskPath: "adow.adimageloader.urlcache")

sessionConfiguration = NSURLSessionConfiguration.defaultSessionConfiguration()
sessionConfiguration.URLCache = cache

let session = NSURLSession(configuration: sessionConfiguration, delegate: nil, delegateQueue: self.sessionQueue)

NSCache.setSharedURLCache(cache)

self.task = session.dataTaskWithRequest(request) { (data, response, error) in
        if let error = error {
            NSLog("error:%@", error.domain)
        }
        ...
    }

CachePolicy

• NSURLRequestReloadIgnoringLocalCacheData： 忽略缓存，必须从远程地址下载；

• NSURLRequestReturnCacheDataElseLoad：只要本地有缓存就使用本地的缓存（不管过期时间），只有本地没有缓存的时候才使用远程地址下载；

• NSURLRequestReturnCacheDataDontLoad：只从本地缓存获取内容，如果本地没有的话，也不会去远程地址下载（也就是离线模式）；

• NSURLRequestUseProtocolCachePolicy：默认缓存策略；

• 可以为每个 NSURLRequest 设置单个请求的 cachePolicy;

• 也可以通过 NSURLSessionConfiguration 设置 cachePolicy 来实现 NSURLSession 下所有的请求都使用同样的缓存策略；

Cache-Control

• Last-Modified 这个头的值表明所请求的资源上次修改的时间；

• Etag 这是 “entity tag” 的缩写，它是一个表示所请求资源的内容的标识符。

后篇: 实现 AWebImage

• AWebImage: 包含了 AWImageLoader 对象中真正的图片下载方法；

• UIImageView+AWebImage： UIImageView 的 extension, 毕竟大部分时候我们是直接在 UIImageView 上面显示下载的图片的；

构建 AWebImage

• 一个用于网络请求的队列 (NSOperationQueue);

• 一个所有图片请求共享的缓存 （NSURLCache）

• 确定的缓存策略，这里使用默认的缓存策略就好；

• 回调函数列表；

• 快速缓存；

• 其他的异步操作共享队列；

回调函数

    /// 添加一个 url 的回调函数，如果这个 url 已经在任务中了，只需要增加回调函数，并返回 true, 通知外部不需要重新发起任务
    func addFetch(key:String, callback:AWImageLoaderCallback) -> Bool {
        var skip = false
        let f_list = fetchList[key]
        if f_list != nil {
            skip = true
        }
        dispatch_barrier_sync(fetchListOperationQueue) {
            if var f_list = f_list {
                f_list.append(callback)
                self.fetchList[key] = f_list
            }
            else {
                self.fetchList[key] = [callback,]
            }
        }
        return skip

    }
    /// 删除一个地址的全部回调函数
    func removeFetch(key:String) {
        dispatch_barrier_sync(fetchListOperationQueue) {
            self.fetchList.removeValueForKey(key)
        }
    }
    /// 清理所有地址的回调函数
    func clearFetch() {
        dispatch_barrier_async(fetchListOperationQueue) {
            self.fetchList.removeAll()
        }
    }

快速缓存

fastCache = NSCache()
fastCache.totalCostLimit = 30 * 1024 * 1024

AWImageLoader 和 AWImageLoaderManager

    func downloadImage(url:NSURL, callback : AWImageLoaderCallback){
        /// 从 fastCache(NSCache) 获取到以及构造好的图片，直接在当前线程返回
        if let cached_image = self.imageFromFastCache(url) {
            callback(cached_image, url)
            return
        }
        let fetch_key = url.absoluteString
        /// 用来将图片返回到所有的回调函数
        let f_callback = {
            (image:UIImage) -> () in
            if let f_list = AWImageLoaderManager.sharedManager.readFetch(fetch_key) {
                AWImageLoaderManager.sharedManager.removeFetch(fetch_key)
                dispatch_async(dispatch_get_main_queue(), {
                    f_list.forEach({ (f) in
                        f(image,url)
                    })
                })
            }
        }
        /// origin
        /// addFetch 会返回这个请求是不是已经在列表中了，如果有的话，那就不用再次发出请求了，只需要为他添加一个回调函数就可以了
        let skip = AWImageLoaderManager.sharedManager.addFetch(fetch_key, callback: callback)
        if skip {
//            NSLog("skip")
            return
        }
        /// request
        let session = AWImageLoaderManager.sharedManager.defaultSession
        let request = NSURLRequest(URL: url)
        self.task = session.dataTaskWithRequest(request) { (data, response, error) in
            if let error = error {
                NSLog("error:%@", error.domain)
            }
            /// no data
            guard let _data = data else {
                NSLog("no image:%@", url.absoluteString)
                f_callback(emptyImage)
                return
            }
            dispatch_async(AWImageLoaderManager.sharedManager.imageDecodeQueue, {
//                NSLog("origin:%@", url.absoluteString)
                let image = UIImage(data: _data) ?? emptyImage
                AWImageLoaderManager.sharedManager.fastCache.setObject(image, forKey: fetch_key) /// 存入 fastCache
                f_callback(image)
                return
            })
        }
        self.task?.resume()
    }

UIImageView + AWebImage

       imageView.aw_downloadImageURL(photo.imageURL, showLoading: true, completionBlock: { (image, url) in

       })

• 开始获取图片的时候，会取消这个 UIImageView 之前的图片任务；

• 为每个 UIImageView 存储一个当前任务的下载地址，获取到图片后，在显示之前先判断一下这次回调图片的地址和保存在 UIImageView 中的地址是不是相同，如果不同的话，说明实际显示的图片已经换掉了，那就不用显示这张图片了。

private var imageUrlKey : Void?

/// 在 extension UIImageView 中增加
/// 下载的 imageurl
var aw_image_url : NSURL? {
    get{
        return objc_getAssociatedObject(self, &imageUrlKey) as? NSURL
    }
    set {
        objc_setAssociatedObject(self, &imageUrlKey, newValue, .OBJC_ASSOCIATION_RETAIN_NONATOMIC)
    }
}

func aw_downloadImageURL(url:NSURL,
                               showLoading:Bool,
                               completionBlock:AWImageLoaderCallback){
    /// 先设置要下载的图片地址
    self.aw_image_url = url
    if showLoading {
        self.aw_showLoading()
    }
    let loader = AWImageLoader()
    loader.downloadImage(url) { [weak self](image, url) in
        if showLoading {
            self?.aw_hideLoading()
        }
        guard let _self = self, let _aw_image_url = _self.aw_image_url else {
            NSLog("no imageView")
            return
        }
        /// 校验一下现在是否还需要显示这个地址的图片
        if _aw_image_url.absoluteString != url.absoluteString {
            NSLog("url not match:%@,%@", _aw_image_url,url)
        }
        else{
            self?.aw_setImage(image)
            completionBlock(image,url)
        }
    }
}

在 NSDefaultRunLoopMode 开始下载图片；

/// 只在 DefaultRunLoopMode 模式中加载
func aw_downloadImageURL_delay(url:NSURL,
                               showloading:Bool,
                               completionBlock : AWImageLoaderCallback) {
    /// 要一开始就重置状态，因为后面的方法被延时提交，而在返回的时候可能已经又其他图片从快速缓存中获取了
    self.aw_image_set = false
    /// 如果已经有存在的图片，就不要在 DefaultRunLoopMode 中加载
    let loader = AWImageLoader()
    if let cached_image = loader.imageFromFastCache(url) {
        self.aw_hideLoading()
        self.aw_setImage(cached_image)
        self.aw_image_url = url
        completionBlock(cached_image, url)
        return
    }
    /// 开始延时获取图片内容
    let par = _AWImageLoaderPar(url: url, showLoading: showloading, completionBlock: completionBlock)
    self.performSelector(#selector(UIImageView.aw_downloadImageURL_p(_:)), withObject: par, afterDelay: 0.0, inModes: [NSDefaultRunLoopMode,])
}
/// 延时提交的方法，由于这个方法延时提交，所以可能 cell 在下一次的 reuse 中已经获得了 image， 而此时又开始执行这个方法时就第二次获得了内容，他又会替换第一次的内容，因此在开始前先判断一下是否有图片被设置了；
@objc private func aw_downloadImageURL_p(par:_AWImageLoaderPar) {
    if self.aw_image_set {
        NSLog("image existed")
        return
    }
    self.aw_downloadImageURL(par.url, showLoading: par.showLoading, completionBlock: par.completionBlock)
}
@objc
private func aw_setImage(image:UIImage){
    self.image = image
    self.aw_image_set = true /// 设置图片后更新 aw_image_set,防止后面的任务会替换现在的图片
}

完整的 AWebImage 以及 Demo App 代码

由于 500px.com在墙外，这里例子中的图片有时会下载不成功，这时在 UIImageView 中显示的都是空白的图片，并且在下一次滚动后界面更新时会重新尝试下载。

MING-ARTICLE-CONFIG
{
    "article_title": "被忽视的 NSURLCache",
    "article_subtitle": "实现一个网络图片下载工具 AWebImage",
    "article_cover_photo": "<http://images.codingnext.com/pexels-photo-55613.jpg>",
    "article_category": "swift",
    "article_link": "you-forget-nsurlcache.html",
    "article_css": {},
    "article_publish_date": "2016-06-13",
    "article_comments": 1,
    "article_theme": "default"
}