使用XCTKeyPathExpectation遇异常：值匹配却触发超时错误

在异步测试中使用XCTKeyPathExpectation时出现异常：明明目标属性值已符合预期，但测试仍超时失败，错误信息显示预期值与实际值均为true，却提示未满足期望。

测试代码 #

TestMock.swift #

import Foundation
@testable import UnitTests

final class TestMock: NSObject {
    @objc private(set) var testCalled: Bool = false

    func test() {
        self.testCalled = true
    }
}

UnitTestsTests.swift #

import XCTest
@testable import UnitTests

final class UnitTestsTests: XCTestCase {
    var testMock: TestMock!

    override func setUpWithError() throws {
        self.testMock = TestMock()
    }

    override func tearDownWithError() throws {
        self.testMock = nil
        try super.tearDownWithError()
    }

    func testExample() throws {
        let expectation = XCTKeyPathExpectation(keyPath: \TestMock.testCalled,
                                                observedObject: self.testMock,
                                                expectedValue: true)
        self.testMock.test()
        self.wait(for: [expectation], timeout: 1.0)
    }
}

错误信息 #

testExample(): Asynchronous wait failed: Exceeded timeout of 1 seconds, with unfulfilled expectations: "Expect value of 'Swift.ReferenceWritableKeyPath<UnitTestsTests.TestMock, Swift.Bool>' of <UnitTestsTests.TestMock: 0x600003bfc090> to be 'true', was 'true'."

怀疑是Swift Bool与Objective-C Bool的类型匹配问题，但找不到解决办法。

问题根源在于**XCTKeyPathExpectation依赖KVO机制，而你的代码未满足KVO的触发条件**，具体修正点如下：

1. 给属性添加dynamic关键字 #

Swift存储属性默认不会生成KVO变更通知，必须添加dynamic关键字，让Objective-C runtime能自动处理KVO事件。修改TestMock类：

import Foundation
@testable import UnitTests

final class TestMock: NSObject {
    @objc dynamic private(set) var testCalled: Bool = false

    func test() {
        self.testCalled = true
    }
}

2. 调整操作时序（针对异步场景） #

如果是测试异步逻辑，要确保XCTKeyPathExpectation完成监听后，再触发属性变更。同步调用test()会导致变更事件在期望监听前就发生，期望无法捕捉到。建议将操作放到异步队列：

func testExample() throws {
    let expectation = XCTKeyPathExpectation(keyPath: \TestMock.testCalled,
                                            observedObject: self.testMock,
                                            expectedValue: true)
    // 模拟异步操作
    DispatchQueue.global().async {
        self.testMock.test()
    }
    self.wait(for: [expectation], timeout: 1.0)
}

原理说明 #

• dynamic关键字强制属性通过Objective-C runtime访问，自动触发KVO的变更通知，让XCTKeyPathExpectation能感知到属性值变化。
• 异步执行变更操作，保证期望先完成监听设置，再接收变更事件，避免因时序问题导致期望失效。

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