单元测试时如何临时模拟指定的系统默认时区？

方案1：依赖注入（首推，无任何副作用） #

直接将时区作为方法的可选入参，默认值设为系统当前时区，线上业务调用无需修改传参，测试时按需传入指定时区即可，完全规避全局变量和额外运行开销。

应用代码改造示例 #

import Foundation

enum ReminderUtils {
    // 增加timeZone参数，默认值为系统当前时区
    static func toDayResolution(_ timeMillis: Int64, timeZone: TimeZone = .current) -> Int64 {
        // 原有逻辑内所有用到TimeZone.current的地方，替换为入参timeZone即可
    }
}

测试代码示例 #

func testToDayResolutionInCuba() throws {
    let cubaTimeZone = TimeZone(identifier: "America/Havana")!
    // 测试时显式传入指定时区，无任何全局状态篡改
    let timestampWithoutTime = ReminderUtils.toDayResolution(timeMillis, timeZone: cubaTimeZone)
    // 后续断言逻辑
}

方案优势 #

• 无全局变量，线程安全，支持多测试用例并行执行
• 线上版本无任何额外判断逻辑，性能和原生实现完全一致
• 依赖关系明确，代码可读性、可维护性更高

方案2：测试期方法置换（零侵入业务代码） #

如果项目中大量位置依赖TimeZone.current，逐个改造入参成本过高，可以选择在测试目标中通过方法置换实现模拟，所有逻辑完全隔离在测试包内，对线上代码无任何侵入。

测试目标工具代码示例 #

import XCTest
import Foundation

private var mockedTimeZone: TimeZone?
private var originalCurrentIMP: IMP?

extension TimeZone {
    @objc static func mocked_current() -> TimeZone {
        return mockedTimeZone ?? unsafeBitCast(originalCurrentIMP, to: (@convention(c) () -> TimeZone).self)()
    }
}

/// 临时模拟当前时区，执行完block后自动还原
func withMockedTimeZone(_ timeZone: TimeZone, execute block: () throws -> Void) rethrows {
    guard let originalMethod = class_getClassMethod(TimeZone.self, #selector(getter: TimeZone.current)),
          let mockedMethod = class_getClassMethod(TimeZone.self, #selector(TimeZone.mocked_current)) else {
        try block()
        return
    }
    originalCurrentIMP = method_getImplementation(originalMethod)
    method_exchangeImplementations(originalMethod, mockedMethod)
    mockedTimeZone = timeZone
    defer {
        method_exchangeImplementations(originalMethod, mockedMethod)
        mockedTimeZone = nil
        originalCurrentIMP = nil
    }
    try block()
}

测试代码示例 #

func testToDayResolutionInCuba() throws {
    let cubaTimeZone = TimeZone(identifier: "America/Havana")!
    try withMockedTimeZone(cubaTimeZone) {
        // 原有业务代码无需任何修改，内部调用的TimeZone.current会自动返回模拟值
        let timestampWithoutTime = ReminderUtils.toDayResolution(timeMillis)
        // 后续断言逻辑
    }
}

方案优势 #

• 完全不侵入线上业务代码，线上版本无任何额外逻辑、无性能损耗
• 无需改造原有业务实现，改造成本极低
• 模拟逻辑完全收敛在测试目标中，不会污染线上运行环境

方案选型建议 #

• 新开发业务、或改造量较小的项目优先选择依赖注入方案，实现最干净、无任何黑魔法
• 老旧项目、改造入参成本过高的场景选择方法置换方案，性价比最高

内容的提问来源于stack exchange，提问作者Cheok Yan Cheng