iOS单例中 Block 回调一对多设计

起因:今天在开发过程中,小伙伴告诉我,我写的全局音乐播放器(单例模式实现)在多个地方同时接收监听状态 Block 时,除了最后一次接收有效以外,其它调用的地方都无法正常执行 Block 里代码。

需求背景

 播放器是通过代理委托来告知外部当前展示的 VC 类关于音乐播放信息,但需求迭代过程中新增了一个App全局页面展示的音乐悬浮窗,悬浮窗需要实时监听当前播放器的播放状态并更新 view ,而且保持原有 VC 类遵循播放器的代理并更新 view。原本通过代理委托一对一实现的场景被打破,现在要满足一对多的场景。产品最终要实现下面的效果:


效果图

解决方案选择

首先想到的第一个方案是,监听播放状态改用 Notification 通知。
 使用通知,实现起来简单,可以满足想要的结果,但也意味着外部每一处需要监听的播放状态,若是后续有更多的需要监听状态,肯定不能每一处都要添加Notification 通知。当初设计单例播放器的目的,就是 高内敛、低耦合,用通知的话实现方式太不优雅,肯定不能让小伙伴在所有要监听状态的地方都添加通知代码,决定放弃这个方案。
第二个方案,播放器单例代理改为一对多代理。
 原本播放器单例是通过代理一对一的形式实现的,如果是让单例的代理实现一对多呢?想起了之前看到的文章:多播代理,主要参考 iOS多播代理 文章。看了下多播代理实现目标,发现与自己的业务场景多少有些出入。播放器通过代理实现一对一的初衷,为了只让展示在用户前的 ViewController 去作为代理类去响应播放器的代理调用,UINavigationController 堆栈中被 topViewController 压在下面的 ViewController 没有必要继续去响应播放器的代理调用。再加上若采用该方案,意味着音乐播放器整体的消息传递方式要发生变动,工作量巨大。多播代理的方案也放弃了。
 回到现在已有的实现中,小伙伴在多处地方已经添加代码去接收这个 block,而且接收的对象都是普通对象,播放器本身是一个单例,分析下来,问题有了眉头——单例中的 block 若在外部多处接收,block 本身已有的代码块会被覆盖,最终就会造成前言提到的问题,只有最后一次可以接收到 block 的消息,其余全部失效。
 如果是让单例中的 block 也能够像多播代理实现一对多呢?
在网上搜罗了一番,发现了这篇文章 一个关于单例的 Block 回调设计 ,采用了 NSMapTable + NSPointerFunctionsWeakMemory 的组合方案来实现。

设计思路

整理了上面文章最终的实现思路:

  1. block 持有者为单例中的 NSMapTable ,而非由注册 block 回调对象 observer 持有,并且单例播放器本身仅维护 block 映射关系;
  2. 为了解决 block 自动释放问题,由 NSMapTable 来持有 block ,通过给 observer 绑定一个对象 DeallocWatcher ,利用 objc_setAssociatedObject 把 observer 与绑定对象 DeallocWatcher 进行关联,以此监听 DeallocWatcher 的 dealloc 释放,从而间接得知 observer 释放时机,达到 block 自动释放目的。
    文章中提到的间接监听释放时机,在 ReactiveCocoa 中的 onExit 方法也是类似的思路来实现。

实现步骤

  1. 创建 NSMapTable 映射表
// key为 observer 注册对象,用 weak 属性表示不持有 observer,仅指向 observer
// value 为 observer 注册的 block 回调,使用 strong 属性意味着映射表要持有 block
self.blockTable = [[NSMapTable alloc] initWithKeyOptions:NSPointerFunctionsWeakMemory valueOptions:NSPointerFunctionsStrongMemory capacity:1];
  1. 声明 observer 要绑定的对象 DeallocWatcher 类实现方法
@interface DeallocWatcher: NSObject

@property (nonatomic, copy) dispatch_block_t deallocCallback;

- (instancetype)initWithDeallocCallback:(dispatch_block_t)callback;

@end

@implementation DeallocWatcher

- (instancetype)initWithDeallocCallback:(dispatch_block_t)callback {
    self = [super init];
    if (self) {
        self.deallocCallback = callback;
    }
    return self;
}
// 关键代码,当该对象释放触发 dealloc 方法时,会去执行 callback 回调
- (void)dealloc
{
    if (self.deallocCallback) {
        self.deallocCallback();
    }
}

@end
  1. 给 observer 添加关联绑定对象 watch,并添加至映射表中。
- (void)addObserver:(id)observer callback:(isPlayingChangedBlock)callback {
// 这里要打破循环引用,因为关联代码中 watch 被 observer 持有,而 watch 中的 callback 去调用了 observer
    __weak typeof (observer) weakObserver = observer;
  DeallocWatcher *watch = [[DeallocWatcher alloc] initWithDeallocCallback:^{
    __strong typeof (observer) strongObserver = weakObserver;
    [self removeObserver:strongObserver];
  }];
  [self.blockTable setObject:callback forKey:observer];
// 将 observer 与 watch 进行绑定关联,key 则使用 observer 指针指向的内存地址
  objc_setAssociatedObject(observer,(__bridge const void * _Nonnull)([NSString stringWithFormat:@"%p", observer]), watch, OBJC_ASSOCIATION_RETAIN_NONATOMIC);
}
  1. observer 自动释放(后续更正:此处代码已经没必要执行。原因:当 watch 的 block 中执行 remove 方法时,这里 observer 已经释放了,手动关联的watch对象只是触发了dealloc回调,映射表中因为以observer为key弱引用存储,也在表中删除了该key值以及value值)
- (void)removeObserver:(id)observer {
  [self.blockTable removeObjectForKey:observer];
  objc_setAssociatedObject(observer, (__bridge const void * _Nonnull)([NSString stringWithFormat:@"%p", observer]), nil, OBJC_ASSOCIATION_RETAIN_NONATOMIC);
}
  1. 映射表中 block 的触发调用方法。
    下面代码就是项目中是否正在播放状态的成员变量 set 方法。每当 isPlaying 发生变化时,都会将映射表中的 block 执行一遍,最终达到单例中的 block 实现一对多的目的。
- (void)setIsPlaying:(BOOL)isPlaying{
  _isPlaying = isPlaying;

  [[[self.blockTable objectEnumerator] allObjects] enumerateObjectsUsingBlock:^(isPlayingChangedBlock callback, NSUInteger idx, BOOL * _Nonnull stop) {
    callback(isPlaying);
  }];
}

应小伙伴要求demo查看,我花了十来分钟写了个简易demo,有兴趣的可以去下载了。链接:https://github.com/RoganZheng/Block-one-to-many-demo-in-a-single-case

后续文章,凡是涉及到实践代码的内容,我会注意提供相关代码demo链接。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 214,588评论 6 496
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,456评论 3 389
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 160,146评论 0 350
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,387评论 1 288
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,481评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,510评论 1 293
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,522评论 3 414
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,296评论 0 270
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,745评论 1 307
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,039评论 2 330
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,202评论 1 343
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,901评论 5 338
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,538评论 3 322
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,165评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,415评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,081评论 2 365
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,085评论 2 352

推荐阅读更多精彩内容