Kingfisher源码解析之Options解释

Kingfisher源码解析系列，由于水平有限，哪里有错，肯请不吝赐教

• Kingfisher源码解析之使用
• Kingfisher源码解析之Options解释
• Kingfisher源码解析之加载流程
• Kingfisher源码解析之加载动图
• Kingfisher源码解析之ImageCache
• Kingfisher源码解析之Processor和CacheSerializer
• Kingfisher源码解析之ImagePrefetcher

1. targetCache,originalCache
   • 类型ImageCache,Kingfisher中的缓存管理器，提供内存和磁盘缓存
   • targetCache最终展示出来的缓存管理器
   • originalCache原始数据的缓存管理器
   • 默认值都为nil，为nil时，使用ImageCache(name: "default")
2. downloader
   • 类型ImageDownloader，图片下载器，提供图片下载的功能
   • 默认值为nil，为nil时，使用ImageDownloader(name: "default")
3. downloadPriority 下载优先级
4. transition
   • 类型ImageTransition，默认是为ImageTransition.none
   • 为imageView显示image的时候提供过渡动画
5. forceTransition
   • 类型为Bool，默认值false
   • 是否强制使用过渡动画，当值为true时，transition不为.none时就使用过渡动画，当值为false时，只有transition不为.none并且不使用缓存时，才使用缓存动画
6. forceRefresh 是否强制刷新，若值为true，则不使用缓存
7. fromMemoryCacheOrRefresh 当值为true时，刷新的时候，若使用缓存，则只使用内存缓存，不去磁盘缓存
8. cacheMemoryOnly 是否只使用内存缓存
9. onlyFromCache 是否只从缓存中加载
10. backgroundDecode 是否在子线程去解码
11. preloadAllAnimationData
    • 是否预加载GIF图每一帧画面,默认值为false
    • 若使用UIImageView.setImage(),去加载图片，则会被强制设置成true，因为

     @objc extension UIImageView {
        func shouldPreloadAllAnimation() -> Bool { return true }
     }
    
     public func setImage(
        with source: Source?,
        placeholder: Placeholder? = nil,
        options: KingfisherOptionsInfo? = nil ...
       -> DownloadTask? {
             ...
            //若shouldPreloadAllAnimation()的值为true
            //则把preloadAllAnimationData设为true
            //而ImageView中的shouldPreloadAllAnimation()一直为true
             if base.shouldPreloadAllAnimation() {
                options.preloadAllAnimationData = true
             }
            ...  
    } 
    
    

12. onlyLoadFirstFrame 若图片是GIF图时，是否只显示第一帧
13. callbackQueue,processingQueue
    • callbackQueue,图片处理结束之后，回调所在的队列，默认值mainCurrentOrAsync
    • processingQueue，处理图片时所在的队列，比如利用processor给图片添加圆角等操作时，所在的队列，默认使用一个串行的子队列
    • 一共有四个值可选择.mainAsync,.mainCurrentOrAsync,.untouch,.dispatch(DispatchQueue)
    • .mainAsync主线程中异步执行
    • .mainCurrentOrAsync，若当前线程是主线程，则直接执行，否则在主线程异步执行
    • .untouch 不改变当前所在的线程
    • .dispatch(DispatchQueue) 在指定的队列中执行
14. requestModifier 发送请求时对原始的请求进行修改，返回新的Request
15. redirectHandler 当请求发生重定向是，自定义的一些处理
16. processor 加工者，自定义data|image转成image的逻辑，
17. imageModifier image修饰器，对image做一些修改，比如返回image.withRenderingMode(renderingMode)
18. cacheSerializer 定义图片序列化和反序列化
19. keepCurrentImageWhileLoading 当加载一个新图时，是否要保持当前的图片
20. cacheOriginalImage 是否要缓存原始的数据
21. onFailureImage 加载失败时，要展示的图片
22. alsoPrefetchToMemory 预加载时，需要从磁盘加载时，是否也需要同步到内存中
23. loadDiskFileSynchronously 从磁盘中加载时，是否同步的去加载
24. memoryCacheExpiration，diskCacheExpiration 设置内存、磁盘缓存过期时间
25. memoryCacheAccessExtendingExpiration
    • 当从内存、磁盘中取图片时，往后延长过期时间的策略
    • 有以下几个值：.none,.cacheTime,.expirationTime(_ expiration: StorageExpiration)
    • .none保持原来的过期时间
    • .cacheTime 设置过期时间为当前时间加上原来的过期时间
    • .expirationTime(_ expiration: StorageExpiration) 设置过期时间到指定时间
26. alternativeSources 当加载失败时，可供替代的数据源
27. onDataReceived 接收到数据时，需要回调时，可设置此属性，比如setImage时设置的DownloadProgressBlock，就是在里面封装了此属性