Swift Combine中PassthroughSubject在XCTest里sink闭包不触发问题
Combine单元测试中PassthroughSubject sink闭包偶发不触发的诡异问题
复现特征
- 核心故障:
PassthroughSubject关联的sink闭包始终无法执行,测试用例直接超时失败 - 异常触发阈值:只要取消注释代码中那行被标记的
print打印语句,测试就能100%通过 - 环境差异:完全相同的代码在Xcode Playground中运行无任何异常
- 通用排障无效:重启Xcode、删除Derived Data缓存、把所有相关类和测试代码迁移到全新独立空白项目,问题依旧稳定复现
- 横向对比:日常使用RxSwift的全流程从未遇到过同类异常,当前阶段Combine的框架工程化成熟度确实和RxSwift存在可感知的差距
可复现代码
class BadPassThroughSendClass { let publisher = PassthroughSubject<Any, Never>() var anyCancellable: AnyCancellable? var sinkClosureBlock: (()->())? init() { createSubscription() } func createSubscription() { let subscription = publisher .subscribe(on: DispatchQueue.global()) .receive(on: DispatchQueue.global()) .sink { [unowned self] event in sinkClosureBlock?() } anyCancellable = AnyCancellable(subscription) } } class UnitTests: XCTestCase { func testBadPassThroughClass() { let badClass = BadPassThroughSendClass() let sinkExpectation = expectation(description: "Sink closure should fire") badClass.sinkClosureBlock = { sinkExpectation.fulfill() } // print("pass the test with this line") badClass.publisher.send("my test message") waitForExpectations(timeout: 0.5) } }
问题根因拆解
这不是无厘头的玄学问题,本质是Combine异步调度实现缺陷+编译器优化叠加出来的典型时序bug,和初步判断的“属于Apple框架缺陷”完全吻合:
- 写的订阅链加了两层
DispatchQueue.global()调度:subscribe(on:)负责把上游的订阅动作切到全局并发队列,receive(on:)负责把下游事件回调切到全局并发队列,所有跨线程的任务都是被丢进队列异步执行的 - 从框架实现层面看,Combine的全局队列调度器在投递跨线程任务时,没有做必要的内存屏障保证,在带优化等级的测试构建配置下,编译器会对代码做指令重排:事件发送、闭包赋值两个操作没有强制的顺序约束,极端情况下事件被投递到调度队列时,外部赋值的
sinkClosureBlock还是nil,自然执行不到fulfill Expectation的逻辑 - 加了
print行之后,这条涉及系统IO的操作天然成为了时序屏障,强制所有同步代码按书写顺序执行完再往下走,等调度队列的任务执行时,sinkClosureBlock已经完成赋值,测试就能正常通过 - Playground环境默认是无优化的纯Debug构建,不会触发这类指令重排,所以完全复现不出来问题
稳定规避方案
- 测试场景下不要把异步调度逻辑硬绑定在业务类的订阅链里:可以把调度器做成可注入的参数,测试时替换为
RunLoop.main或者ImmediateScheduler,从根源去掉异步调度带来的时序不确定性 - 不要在
send事件之后依赖事后赋值的闭包传递回调逻辑:直接把Expectation的fulfill逻辑写在sink闭包内部,跳过外部中间变量的赋值环节,就能完全避开闭包为空的时序窗口 - 如果必须保留现有调度逻辑,在调用
send事件前加一行同步屏障代码,比如DispatchQueue.global().sync {},强制所有内存操作按顺序完成,也能得到稳定的测试结果
内容的提问来源于stack exchange,提问作者cwiedemann
相关产品推荐
相关产品推荐

