利用 Associated Objects 为 UIImageView 添加 activityIndicator

iTychooo 的个人博客

在实现类似与微博或者微信的 timeline 功能时, 往往需要在 UITableViewCell 中利用 UIImageView 展示单张或多张图片, 这些图片的来源通常都是网络. 而一旦网络速度不稳定, cell 中的 imageView 异步加载图片的过程就会一直显示 backgroundColor. 用户对图片正在下载的情况全然不知. 而像 SDWebImage 和 Kingfisher 这样的第三方框架很好的解决了这种问题: 一方面可以显示一张 placeholderImage, 也可以显示一个 UIActivityIndicatorView 让用户感受到下载的进程.

而实现 activityIndicatorView 的方法又有很多种, 我第一个想到的就是自定义一个 UIView, 在里面添加一个 UIImageView 和 一个 UIActivityIndicatorView. 之后使用这个自定义的 view 就可以很好的完成任务. 而最近我在使用 Kingfisher 时, 发现它利用 分类 的功能结合 runtime 的特性, 直接为 UIImageView 添加一个 indicatorView 的实例变量.

通过 分类 -> extension 不能添加新的实例变量, 但我们可以利用 runtime 的 Associated Objects 来弥补这一不足.

首先, 为 UIImageView 定义 extension, 为其添加 activityIndicator 的 set 和 get 方法.

private var activityIndicatorKey: Void?
private var showActivityIndicatorWhenLoadingKey: Void?
extension UIImageView {
    
    private var activityIndicator: UIActivityIndicatorView? {
        return objc_getAssociatedObject(self, &activityIndicatorKey) as? 
        UIActivityIndicatorView
    }
    
    private func setActivityIndicator(activityIndicator: UIActivityIndicatorView?) {
        objc_setAssociatedObject(self, &activityIndicatorKey, activityIndicator,
        objc_AssociationPolicy.OBJC_ASSOCIATION_RETAIN_NONATOMIC)
    }

这里我们简单说一下 Associated Objects -> 关联对象 是什么? 它本来是 Objective - C 2.0 运行时的一个特性, 上面代码所看到的 objc_getAssociatedObject() 与 objc_setAssociatedObject 允许你将任何键值在运行时关联到对象上的函数. 另外还有一个函数 objc_removeAssociatedObjects. 它们的主要功能就是对已经存在的类在扩展中添加自定义属性.

另外在上面定义的 set 方法中, 该实例的存储方式被定义为 .OBJC_ASSOCIATION_RETAIN_NONATOMIC, 它等价与 @property (nonatomic, strong) -> 强引用, 不能被原子化使用. 而 objc_AssociationPolicy 是一个枚举类型, 它提供了多种方法来帮助你确定你定义的键值与对象之间的关联方式.

接着, 我们实现一个计算属性 showActivityIndicatorWhenLoading

var showActivityIndicatorWhenLoading: Bool {
        get {
            guard let result = objc_getAssociatedObject(self, &showActivityIndicatorWhenLoadingKey) as? NSNumber else {
                return false
            }
      
            return result.boolValue
        }
        
        set {
            if showActivityIndicatorWhenLoading == newValue {
                return
            }
            
            if newValue {
                let indicator = UIActivityIndicatorView(activityIndicatorStyle:
                 UIActivityIndicatorViewStyle.Gray)
                indicator.center = CGPoint(x: CGRectGetMidX(bounds), y:
                 CGRectGetMidY(bounds))
                
                indicator.hidden = true
                indicator.hidesWhenStopped = true
                addSubview(indicator)
                
                setActivityIndicator(indicator)
                
            } else {
                activityIndicator?.removeFromSuperview()
                setActivityIndicator(nil)
            }
            
            objc_setAssociatedObject(self, &showActivityIndicatorWhenLoadingKey,
             NSNumber(bool: newValue),
             objc_AssociationPolicy.OBJC_ASSOCIATION_RETAIN_NONATOMIC)
        }
    }

在其 set 方法中, 初始化 indicatorView , 利用之前代码段定义的 setActivityIndicator 方法. 将这个 indicatorView 与 imageView 对象关联. 并在最后,利用 objc_setAssociatedObject 将 showActivityIndicatorWhenLoading -> 是否正在加载图片的 bool 值与 imageView 对象关联.

在 get 方法中, 我们利用 objc_getAssociatedObject 去拿到之前存储的 bool 值.

至此, 我们对 UIImageView 的 extension 就已经完成了. 接下来看看实际使用中的代码.

    /// ImageAttachment 是一个枚举类型, 其中包括下载 image 的 URLString
    public func cube_setImageAtFeedCellWithAttachment(attachment: ImageAttachment, withSize size: CGSize?) {
        
        guard let attachmentURL = NSURL(string: attachment.URLString) else {
            return
        }
        
        /// 这段代码会调用 showActivityIndicatorWhenLoading 的 set 方法
        /// 初始化 indicatorView
         showActivityIndicatorWhenLoading = true
       
        if showActivityIndicatorWhenLoading {
             /// 我们已经可以直接访问 ImageView 的 activityIndicator 实例了.
           activityIndicator?.hidden = false
           activityIndicator?.startAnimating()
        }
        
        setImageAttachmentURL(attachmentURL)
        
        ImageCache.shardInstance.imageOfAttachment(attachment, withSideLenght: size?.width)
         { [weak self] (url, image, cacheType) in
        
            guard let strongSelf = self, let attachmentURL = strongSelf.imageAttachmentURL where attachmentURL == url else {
                return
            }
            
            if cacheType != .Memory {
                UIView.transitionWithView(strongSelf, duration: 0.2, 
                options: .TransitionCrossDissolve, animations: { 
                    strongSelf.image = image
                    }, completion: nil)
            }
            
            strongSelf.image = image
            /// 图片从缓存或者下载完成后, 停止 activityIndicator 的旋转
            strongSelf.activityIndicator?.stopAnimating()
        }
     
    }

Ok, 上面的代码也非常好理解. 我在关键的位置已经添加了注释. 其实这是一个非常简单的功能实现. 我作为一个初学者第一次了解了 runtime 的实际应用场景. 其实像介绍 runloop 以及 runtime 这些特性的文章看过不少, 但一直不太确定其应用场景到底是什么. 最近的这个小发现让我亢奋了好几天, 所以分享给正在学习 iOS 开发的朋友. 或许可以借此契机对 runtime 做深入了解.

参考及推荐阅读:

http://nshipster.cn/associated-objects/ 来自 NSHipster

http://blog.leichunfeng.com/blog/2015/06/26/objective-c-associated-objects-implementation-principle/ 来自雷纯峰的技术博客