整体结构
我们知道Delegate是一对一,NSNotification可以一对多,现在我们也想用代理实现多个对象同时监听,所以就有了多重代理这个东西。
我已经对多重代理进行了封装,只需要把MulicastDelegate文件夹拖进你的项目中就可以用了,包含MulticastDelegate.swift和Weak.swift两个文件,git地址MulticastDelegate
直接上代码,注释的比较详细,整体还是比较简单的
import Foundation
/**
* `MulticastDelegate` 可以轻松地为给定的协议或类创建一个多重代理。
*/
open class MulticastDelegate<T>: NSObject {
/**
* 用来存储delegate的数组
*/
fileprivate var delegates = [Weak]()
/**
* 用这个属性来判断delegates是否为空
*
* 如果数组delegates中一个元素都没有返回true
*/
public var isEmpty: Bool {
return delegates.count == 0
}
/**
* 这个方法用来向delegates中添加新的delegate
*/
public func add(_ delegate: T) {
guard !self.contains(delegate) else {
return
}
delegates.append(Weak(value: delegate as AnyObject))
}
/**
* 这个方法用来删除delegates中某个delegate
*/
public func remove(_ delegate: T) {
let weak = Weak(value: delegate as AnyObject)
if let index = delegates.index(of: weak) {
delegates.remove(at: index)
}
}
/**
* 这个方法用来触发代理方法
*/
public func invoke(_ invocation: @escaping (T) -> ()) {
clearNil()
delegates.forEach({
if let delegate = $0.value as? T {
invocation(delegate)
}
})
}
/**
* 这个方法用来判断delegates中是否已经存在某个delegate
*/
private func contains(_ delegate: T) -> Bool {
return delegates.contains(Weak(value: delegate as AnyObject))
}
/**
* 这个方法用来移除delegates中无效的delegate
*/
private func clearNil() {
delegates = delegates.filter{ $0.value != nil }
}
}
/**
* 自定义操作符实现delegate的添加,同add
*
* - 参数 left: The multicast delegate
* - 参数 right: The delegate to be added
*/
public func +=<T>(left: MulticastDelegate<T>, right: T) {
left.add(right)
}
/**
* 自定义操作符实现delegate的删除,同remove
*
* - 参数 left: The multicast delegate
* - 参数 right: The delegate to be removed
*/
public func -=<T>(left: MulticastDelegate<T>, right: T) {
left.remove(right)
}
/**
* 自定义类型添加Sequence,需要添加返回迭代器的方法 -> makeIterator(),实现for循环功能
*/
extension MulticastDelegate: Sequence {
public func makeIterator() -> AnyIterator<T> {
clearNil()
var iterator = delegates.makeIterator()
return AnyIterator {
while let next = iterator.next() {
if let delegate = next.value {
return delegate as? T
}
}
return nil
}
}
}
为了避免循环这里用了Proxy,这个在我那篇关于CADisplayLink内存泄漏的文章也有提到,原理都是一样的。
import Foundation
/**
* `Weak` 代理用来避免内存泄漏
*/
class Weak: Equatable {
weak var value: AnyObject?
init(value: AnyObject) {
self.value = value
}
static func ==(lhs: Weak, rhs: Weak) -> Bool {
return lhs.value === rhs.value
}
}
这里需要提一下我看到有些人用NSHashTable来避免内存泄漏。
private let delegates: NSHashTable<AnyObject> = NSHashTable.weakObjects()
NSHashTable和NSSet(NSMutableSet)很相似,但又有所不同,提供了比NSSet更多的操作选项,尤其是在对弱引用关系的支持上,NSHashTable在对象/内存处理时更加的灵活。相较于NSSet,NSHashTable具有以下特性:
- NSSet(NSMutableSet)持有其元素的强引用,同时这些元素是使用hash值及isEqual:方法来做hash检测及判断是否相等的。
- NSHashTable是可变的,它没有不可变版本。
- 它可以持有元素的弱引用,而且在对象被销毁后能正确地将其移除。而这一点在NSSet是做不到的。
- 它的成员可以在添加时被拷贝。
- 它的成员可以使用指针来标识是否相等及做hash检测。
- 它可以包含任意指针,其成员没有限制为对象。我们可以配置一个NSHashTable实例来操作任意的指针,而不仅仅是对象。
NSHashTable吸引人的地方在于可以持有元素的弱引用,而且在对象被销毁后能正确地将其移除
在添加对象的操作中,NSHashTable所有的时间差不多是NSMutableSet的2倍,而在其它操作中,性能大体和NSSet相近。所以我选择用了数组,其实差别不大,看个人喜好。
用途
说了这么多,看着很吊的样子那到底锤子用哦,我抛砖迎玉提几个场景,大家可以根据自己需要用到合适的地方。
1.类似IM库,当接受到消息,在几个不同地方做回调,比如改变消息数,显示小红点等。
这个我在Demo中有写到,用的时候可以像我一样再封装一层MessageManager
MessageDelegate.swift
文件
import Foundation
protocol MessageDelegate {
func getNewMessage(message: String)
}
MessageManager.swift
文件
import Foundation
class MessageManager: NSObject {
public var delegate = MulticastDelegate<MessageDelegate>()
static let shareManager = MessageManager()
override init() {
super.init()
}
}
使用
import UIKit
class ViewController: UIViewController, MessageDelegate {
var btn = UIButton()
override func viewDidLoad() {
super.viewDidLoad()
MessageManager.shareManager.delegate.add(self)
btn.frame = CGRect(x: 100, y: 100, width: 100, height: 100)
btn.backgroundColor = UIColor.red
btn.addTarget(self, action: #selector(bottonClick(sender:)), for: UIControlEvents.touchUpInside)
self.view.addSubview(btn)
}
@objc func bottonClick(sender: UIButton) {
MessageManager.shareManager.delegate.invoke { (delegate) in
delegate.getNewMessage(message: "您收到一条新消息啦")
}
}
func getNewMessage(message: String) {
print("ViewController \(message)")
}
override func didReceiveMemoryWarning() {
super.didReceiveMemoryWarning()
}
}
import UIKit
class SecondViewController: UIViewController, MessageDelegate{
override func viewDidLoad() {
super.viewDidLoad()
MessageManager.shareManager.delegate.add(self)
}
override func didReceiveMemoryWarning() {
super.didReceiveMemoryWarning()
}
func getNewMessage(message: String) {
print("SecondViewController \(message)")
}
}
2.希望多个对象能够侦听来自UINavigationController的委托回调,这个比上面那个略微高级一点。
可以根据需要可以添加更多的代理方法,使用在demo中有这里就不放了,不然文章太臭长了
import UIKit
class MulticastUINavigationControllerDelegate: MulticastDelegate<UINavigationControllerDelegate>, UINavigationControllerDelegate {
public override init() {
super.init()
}
@objc open func navigationController(_ navigationController: UINavigationController, willShow viewController: UIViewController, animated: Bool) {
for delegate in self {
delegate.navigationController?(navigationController, willShow: viewController, animated: animated)
}
}
func navigationControllerSupportedInterfaceOrientations(_ navigationController: UINavigationController) -> UIInterfaceOrientationMask {
return reduce(.all, { (mask, delegate) in
guard let newMask = delegate.navigationControllerSupportedInterfaceOrientations?(navigationController) else {
return mask
}
return mask.intersection(newMask)
})
}
}
3.降低耦合
比如UITableView继承于UIScrollView,我们希望他的delegate中UIScrollViewDelegate的方法由一个独立的类来处理,以便实现一些效果,比如像下图这样的头部图片滚动拉伸效果,只需要实现UIScrolViewDelegate的scrollViewDidScroll方法,这样做的好处是可以降低代码耦合度,将实现不同功能的方法封装在独立的delegate中,便于复用和维护管理。
import UIKit
class ScrollDelegate: MulticastDelegate<UIScrollViewDelegate>,UIScrollViewDelegate{
override init() {
super.init()
}
func scrollViewDidScroll(_ scrollView: UIScrollView) {
for delegate in self {
delegate.scrollViewDidScroll?(scrollView)
}
}
}
class CustomeHeaderView: UIView,UIScrollViewDelegate {
override init(frame: CGRect) {
super.init(frame: frame)
}
func scrollViewDidScroll(_ scrollView: UIScrollView) {
let offSetY = scrollView.contentOffset.y+20
if scrollView.contentOffset.y>0&&scrollView.contentOffset.y<100{
self.alpha = offSetY/100
}
}
required init?(coder aDecoder: NSCoder) {
fatalError("init(coder:) has not been implemented")
}
}
参考文章
NSHashTable的特性和使用
iOS开发中利用消息转发实现多重代理
利用OC的消息转发机制实现多重代理
MulticastDelegate
Multicast on Swift 3 and MVVM-C
Notifying many delegates at once with Multicast Delegates