iOS 面向协议方式封装空白页功能

为了良好的交互体验，相信你们在对待scrollView无数据时的提示页都会使用一些第三方来定制，最典型的就是使用DZNEmptyDataSet。可是每一个界面都写一堆与DZNEmptyDataSetDelegate，DZNEmptyDataSetSource相关的代码就不太好，那通常状况下天然的就会采用继承的方式来避免。而Swift除了能够面向对象编程，它还能够面向协议编程。那可不能够也用协议来解决状况呢？嘿嘿，这个能够有，那咱们接下来就来试试怎么经过协议的方式来避免上述状况，而且实现一行代码添加空白页功能

前言

ps: 目前 LXFProtocolTool 已更新屡次，代码实现已有较大差异，有兴趣的同窗能够在阅读完本文后再看看具体的代码实现 EmptyDataSetable

若是对面向协议有疑问的同窗能够看下我以前的两篇文章

iOS - Swift 面向协议编程（一）

iOS - Swift 面向协议编程（二）

以前的文章中提到了，协议除了起规范做用，还有别一个用处，就是赋予能力。咱们如今的目的就是让目标控制器或者目标视图在遵照咱们的协议后，就能够有实现空白页的功能。

1、基本实现

一、建立协议

// MARK:- 空视图占位协议
public protocol LXFEmptyDataSetable {
    
}
复制代码

二、肯定面向类

肯定咱们面向的类，通常tableView或者collectionView都是写在控制器里，那咱们面向的类就规定为UIViewController，或许也有人写在UIView里，不过这里先按UIViewController来写吧

// MARK:- UIViewController - 空视图占位协议
public extension LXFEmptyDataSetable where Self : UIViewController {
    // 三、的实现的方法写在这里
}
复制代码

三、定义功能方法

将scrollView传递进来，让咱们定义的方法来暗地里作些操做

func lxf_EmptyDataSet(_ scrollView: UIScrollView) {
    scrollView.emptyDataSetDelegate = self
    scrollView.emptyDataSetSource = self
}
复制代码

四、设置数据源和代理

在三、定义功能方法中将delegate和source设置为了self ，而协议是没法遵照再次遵照其它协议的，那让什么来遵照对应的协议呢？要明白这里的self指的是UIViewController,考虑到UIView的可能，这里我就让万物对象之父NSObject来遵照，并实现对应的数据源方法和代理方法

extension NSObject : DZNEmptyDataSetDelegate, DZNEmptyDataSetSource {
    public func image(forEmptyDataSet scrollView: UIScrollView!) -> UIImage! {
        // 返回提示图片
    }
    public func title(forEmptyDataSet scrollView: UIScrollView!) -> NSAttributedString! {
        // 设置富文本标题
    }
    public func verticalOffset(forEmptyDataSet scrollView: UIScrollView!) -> CGFloat {
        // 设置纵向偏移
    }
}
复制代码

2、定制空白页

经过上述步骤后，只要让UIViewController遵照咱们的协议，再调用一下lxf_EmptyDataSet方法就能够实现数据空白页了。可是，这样直接写死的方式很很差，有时候一些场景是须要咱们作出定制的，那怎么实现定制呢？协议又不能有本身的变量来存放咱们的定制。

这里先作出一个限定，咱们要使用重载方法来完成该功能，实现便可高定制，又可以使用默认定制。

回到刚刚的话题，使用UserDefaults来实现能够吗？能够，可是比较麻烦，由于UserDefaults是单例，整个进程共用这一份资源，若是你当前controller遵照了咱们的协议LXFEmptyDataSetable并作出了定制，那么当下一个controller在遵照协议后使用了默认定制时，那你要怎么办？还要区分scrollView，那就得保存当前scrollView，在退出当前controller后还要把对应的东西置空。好咯好咯，那你说到底要怎么搞才最合适？

解决方案：拓展UIScrollView！！！有没有发现？，很是地恰巧，咱们定义的方法lxf_EmptyDataSet须要外界将UIScrollView传递进来，在DZNEmptyDataSet的数据源方法和代理方法也有scrollView。那让UIScrollView来携带咱们的定制就好啦。

一、定义定制相关的枚举

这里我定义了经常使用的定制相关的枚举

public enum LXFEmptyDataSetAttributeKeyType {
    /// 纵向偏移(-50) CGFloat
    case verticalOffset
    /// 提示语(暂无数据) String
    case tipStr
    /// 提示语的font(system15) UIFont
    case tipFont
    /// 提示语颜色(D2D2D2) UIColor
    case tipColor
    /// 提示图(LXFEmptyDataPic) UIImage
    case tipImage
    /// 容许滚动(true) Bool
    case allowScroll
}
复制代码

二、拓展UIScrollView

为UIScrollView定义一个定制相关的属性字典

extension UIScrollView {
    private struct AssociatedKeys {
        static var lxf_emptyAttributeDict:[LXFEmptyDataSetAttributeKeyType : Any]?
    }
    /// 属性字典
    var lxf_emptyAttributeDict: [LXFEmptyDataSetAttributeKeyType : Any]? {
        get {
            return objc_getAssociatedObject(self, &AssociatedKeys.lxf_emptyAttributeDict) as? [LXFEmptyDataSetAttributeKeyType : Any]
        }
        set {
            objc_setAssociatedObject(self, &AssociatedKeys.lxf_emptyAttributeDict, newValue as [LXFEmptyDataSetAttributeKeyType : Any]?, objc_AssociationPolicy.OBJC_ASSOCIATION_RETAIN_NONATOMIC)
        }
    }
}
复制代码

三、完善lxf_EmptyDataSet方法

这里咱们让外界经过闭包的方式来定制本身的空白页

// MARK:- UIViewController - 空视图占位协议
public extension LXFEmptyDataSetable where Self : UIViewController {
    func lxf_EmptyDataSet(_ scrollView: UIScrollView, attributeBlock: (()->([LXFEmptyDataSetAttributeKeyType : Any]))? = nil) {
        scrollView.lxf_emptyAttributeDict = attributeBlock != nil ? attributeBlock!() : nil
        scrollView.emptyDataSetDelegate = self
        scrollView.emptyDataSetSource = self
    }
}
复制代码

四、使用定制属性字典

这里以返回提示图片的方法为例吧

public func image(forEmptyDataSet scrollView: UIScrollView!) -> UIImage! {
    guard let tipImg = scrollView.lxf_emptyAttributeDict?[.tipImage] as? UIImage else {
        return UIImage(named: "LXFEmptyDataPic")
    }
    return tipImg
}
复制代码

五、外界的使用姿式

class LXFEmptyDemoController: UIViewController {
    override func viewDidLoad() {
        super.viewDidLoad()

        initUI()
    }
}

extension LXFEmptyDemoController: LXFEmptyDataSetable {
    fileprivate func initUI() {
        let tableView = UITableView()
        // ...
        
        // 高定制
        self.lxf_EmptyDataSet(tableView) { () -> ([LXFEmptyDataSetAttributeKeyType : Any]) in
            return [
                .tipStr:"哟哟哟",
                .verticalOffset:-150,
                .allowScroll: false
            ]
        }
        
        // 默认定制
        // self.lxf_EmptyDataSet(tableView)
    }
}
复制代码

3、开源库

我对这个过程进行一次整理，并作成一个名为 LXFProtocolTool 的库并上传至gitHub。可使用Cocoapods的方式来安装使用

pod 'LXFProtocolTool'
复制代码

我也将 iOS - Swift 面向协议编程（二） 中说起的经过协议便捷加载xib的功能也集成了进来。你们能够根据本身的须要在Podfile写明要安装的功能

• Xib加载

pod 'LXFProtocolTool/LXFNibloadable'
复制代码

• 空白视图

pod 'LXFProtocolTool/LXFEmptyDataSetable'
复制代码

建立这个库的目的是为了经过协议的方式来方便快捷地实现一些的实用功能，目前功能很少，不过日后会逐渐增长，或许你有什么想实现的功能也能够提出来，喜欢的就给个Star鼓励下我吧 🚀 🚀 🚀