Custom Cache Key for images #324
Conversation
There was a problem hiding this comment.
Thanks for putting this together @graphiclife! 🍻
Just a few minor changes before we push this through.
| @@ -263,6 +263,7 @@ open class ImageDownloader { | |||
| _ urlRequest: URLRequestConvertible, | |||
| receiptID: String = UUID().uuidString, | |||
| filter: ImageFilter? = nil, | |||
| customCacheKey: String? = nil, | |||
There was a problem hiding this comment.
Could you add a docstring for this?
Source/ImageDownloader.swift
Outdated
| @@ -284,7 +285,15 @@ open class ImageDownloader { | |||
| if let request = urlRequest.urlRequest { | |||
| switch request.cachePolicy { | |||
| case .useProtocolCachePolicy, .returnCacheDataElseLoad, .returnCacheDataDontLoad: | |||
| if let image = self.imageCache?.image(for: request, withIdentifier: filter?.identifier) { | |||
| var cachedImage: Image? | |||
| strongSelf.imageCache?.add(filteredImage, withIdentifier: customCacheKey) | ||
| } else { | ||
| strongSelf.imageCache?.add(filteredImage, for: request, withIdentifier: filter?.identifier) | ||
| } |
| @@ -129,6 +129,7 @@ extension UIButton { | |||
| url: URL, | |||
| placeholderImage: UIImage? = nil, | |||
| filter: ImageFilter? = nil, | |||
| customCacheKey: String? = nil, | |||
| @@ -208,6 +208,7 @@ extension UIImageView { | |||
| progressQueue: DispatchQueue = DispatchQueue.main, | |||
| imageTransition: ImageTransition = .noTransition, | |||
| runImageTransitionIfCached: Bool = false, | |||
| customCacheKey: String? = nil, | |||
|
Apologies for not getting back to you sooner about this PR @graphiclife. I like this approach better than #328. I'm going to close that one out in favor of this approach. |
Added parameter customCacheKey in af_setImage in UIImageView+AlamofireImage, UIButton+AlamofireImage. Added parameter customCacheKey in ImageDownloader.download Added test testThatImageCanBeCachedWithACustomCacheKey * Added docstring for customCacheKey. * 'var' -> 'let' for cachedImage
|
@cnoon Any updates on this? |
|
Not yet @graphiclife, right now we're very focused on the AF5 release and keeping AFI in sync with that. I'm not sure right now if this change will make it into AFI 4 or not. |
|
Hi guys, just wondering, do you have a timeline to get into master? I am having the same issue, and this approach would suffice. Is there anything I or someone could do to bring this to master? |
|
Hi @graphiclife, I have squashed these changes with a few edits and added tests in deff207 and pushed the change into Cheers. 🍻 |
|
@cnoon Excellent news, thanks! |
Added parameter customCacheKey in af_setImage in UIImageView+AlamofireImage, UIButton+AlamofireImage.
Added parameter customCacheKey in ImageDownloader.download
Added test testThatImageCanBeCachedWithACustomCacheKey
Goals ⚽
Ability to cache images based on other factors than the url, which could be necessary if the backend hosting the image has a misconfigured cache management or provides images through REST-endpoints.
Implementation Details 🚧
Added an optional cache key parameter to af_setImage-functions.
Testing Details 🔍
Added testThatImageCanBeCachedWithACustomCacheKey in UIImageViewTests .