测试前如何重置@AppStorage？UserDefaults清除无效问题排查

核心原因 #

@AppStorage 默认不会使用 UserDefaults.standard，而是绑定到应用Bundle ID对应的专属套件；如果你的App配置了App Group，则会使用App Group的套件ID。这就是为什么你在UserDefaults.standard里找不到对应键、且清除操作无效的原因。

步骤1：确认@AppStorage的存储域 #

方式1：在App内打印验证 #

在App任意位置添加代码，打印@AppStorage实际使用的UserDefaults实例内容：

guard let appBundleID = Bundle.main.bundleIdentifier else { return }
let appStorageDefaults = UserDefaults(suiteName: appBundleID)!
// 打印所有键值对，确认你的@AppStorage键是否在这里
print("AppStorage存储内容：\(appStorageDefaults.dictionaryRepresentation())")

如果你的App使用了App Group，替换appBundleID为你的App Group ID（格式通常是group.com.yourcompany.yourapp）。

方式2：在UI测试中定位存储文件 #

通过XCUIApplication获取App的容器路径，找到对应的Preferences plist文件：

let app = XCUIApplication()
// 替换为你的Bundle ID或App Group ID
let targetSuiteID = "com.yourcompany.yourapp"
if let containerURL = app.containerURL(forSecurityApplicationGroupIdentifier: targetSuiteID) {
    let plistPath = containerURL.appendingPathComponent("Library/Preferences/\(targetSuiteID).plist").path
    print("AppStorage存储文件路径：\(plistPath)")
}

步骤2：UI测试中清除@AppStorage数据的正确方法 #

方法1：直接清除目标套件 #

在UI测试的setup阶段，针对@AppStorage使用的套件执行清除操作：

override func setUp() {
    super.setUp()
    continueAfterFailure = false
    
    // 替换为你的实际套件ID
    let targetSuiteID = "com.yourcompany.yourapp"
    let appStorageDefaults = UserDefaults(suiteName: targetSuiteID)!
    appStorageDefaults.removePersistentDomain(forName: targetSuiteID)
    appStorageDefaults.synchronize()
    
    let app = XCUIApplication()
    app.launch()
}

方法2：通过启动环境变量触发App内重置 #

这种方式更可靠，因为UI测试进程和App进程是分离的，直接操作UserDefaults可能存在跨进程同步问题：

1. 在UI测试中设置启动环境变量：

override func setUp() {
    super.setUp()
    continueAfterFailure = false
    
    let app = XCUIApplication()
    app.launchEnvironment = ["RESET_APP_STORAGE": "true"]
    app.launch()
}

2. 在App的初始化代码中处理重置逻辑：

@main
struct YourApp: App {
    init() {
        if ProcessInfo.processInfo.environment["RESET_APP_STORAGE"] == "true" {
            guard let suiteID = Bundle.main.bundleIdentifier else { return }
            let appStorageDefaults = UserDefaults(suiteName: suiteID)!
            appStorageDefaults.removePersistentDomain(forName: suiteID)
            appStorageDefaults.synchronize()
        }
    }
    
    var body: some Scene {
        WindowGroup {
            ContentView()
        }
    }
}

验证清除效果 #

在UI测试中，清除后可以打印目标套件的键值对，确认数据已被清除：

let targetSuiteID = "com.yourcompany.yourapp"
let appStorageDefaults = UserDefaults(suiteName: targetSuiteID)!
print("清除后剩余键：\(appStorageDefaults.dictionaryRepresentation().keys)")

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