Swift中异步UI变更的单元测试问题及解决方法

问题场景 #

自定义DemoView通过异步任务更新标签文本，测试时出现超时，断言无法捕获UI变更：

自定义视图代码 #

import UIKit

class DemoView: UIView {
    
    var label: UILabel!

    override init(frame: CGRect) {
        super.init(frame: frame)
        setup()
    }
    
    required init?(coder: NSCoder) {
        super.init(coder: coder)
        setup()
    }
    
    func setup() {
        label = UILabel(frame: .zero)
        self.addSubview(label)
        label.translatesAutoresizingMaskIntoConstraints = false
        self.centerXAnchor.constraint(equalTo: label.centerXAnchor).isActive = true
        self.centerYAnchor.constraint(equalTo: label.centerYAnchor).isActive = true
    }
    
    @MainActor
    func setLabel(_ text: String) {
        Task {
            try await Task.sleep(for: .milliseconds(100))
            label.text = text
        }
    }
}

原测试代码 #

@MainActor
func testExample() async throws {
    let demoView = DemoView(frame: .zero)
    XCTAssertEqual(demoView.label.text, nil)
    
    demoView.setLabel("New Text")
    let expectLabelChange = expectation(for: NSPredicate(block: { _, _ in
        demoView.label.text != nil
    }), evaluatedWith: demoView.label)
    await waitForExpectations(timeout: 5)
    
    XCTAssertEqual(demoView.label.text, "New Text")
}

问题原因 #

测试超时失败，核心原因是：@MainActor标记的测试方法运行在主线程，await waitForExpectations会阻塞主线程；而setLabel内部的Task同样绑定到MainActor，休眠后需要主线程执行UI更新代码。主线程被阻塞期间，异步任务无法调度执行，直到超时后主线程释放，Task才会更新文本，此时断言已经执行完毕导致失败。

解决方案 #

方案1：让setLabel返回Task，测试中直接等待任务完成 #

修改DemoView的setLabel方法，返回内部创建的Task，测试代码通过await等待任务执行完毕：

修改后的DemoView代码

@MainActor
func setLabel(_ text: String) -> Task<Void, Error> {
    Task {
        try await Task.sleep(for: .milliseconds(100))
        label.text = text
    }
}

对应测试代码

@MainActor
func testExample() async throws {
    let demoView = DemoView(frame: .zero)
    XCTAssertEqual(demoView.label.text, nil)
    
    // 调用方法并等待异步任务完成
    let updateTask = demoView.setLabel("New Text")
    try await updateTask.value
    
    // 直接断言结果
    XCTAssertEqual(demoView.label.text, "New Text")
}

方案2：不修改原视图代码，用异步让出执行权的方式等待 #

如果无法修改DemoView的代码，可在测试中通过循环+Task.yield()让出主线程执行权，让异步任务有机会完成：

@MainActor
func testExample() async throws {
    let demoView = DemoView(frame: .zero)
    XCTAssertEqual(demoView.label.text, nil)
    
    demoView.setLabel("New Text")
    
    // 设置超时时间，避免无限等待
    let timeoutDate = Date().addingTimeInterval(5)
    while demoView.label.text != "New Text" && Date() < timeoutDate {
        // 让出执行权，让绑定到MainActor的异步任务运行
        await Task.yield()
    }
    
    XCTAssertEqual(demoView.label.text, "New Text")
}

方案3：使用XCTest的异步断言（Xcode 16+） #

如果使用Xcode 16及以上版本，可直接用XCTAssertEventually简化异步断言逻辑：

@MainActor
func testExample() async throws {
    let demoView = DemoView(frame: .zero)
    XCTAssertEqual(demoView.label.text, nil)
    
    demoView.setLabel("New Text")
    
    // 自动等待直到条件满足或超时
    XCTAssertEventuallyEqual(demoView.label.text, "New Text", timeout: 5)
}

内容的提问来源于stack exchange，提问作者Codey