UserDefaults 属性包装器不保存值 iOS 版本低于 iOS 13

Question

我正在使用属性包装器来保存我的用户默认值。在 iOS 13 设备上，此解决方案效果很好。但是在 iOS 11 和 iOS 12 上，这些值不会保存到用户默认值中。我读到属性包装器是向后兼容的，所以我不知道为什么这在旧 iOS 版本上不起作用。

这是属性包装器：

@propertyWrapper
struct UserDefaultWrapper<T: Codable> {
    private let key: String
    private let defaultValue: T

    init(key: String, defaultValue: T) {
        self.key = key
        self.defaultValue = defaultValue
    }

    var wrappedValue: T {
        get {
            guard let data = UserDefaults.standard.object(forKey: key) as? Data else {
                // Return defaultValue when no data in UserDefaults
                return defaultValue
            }

            // Convert data to the desire data type
            let value = try? JSONDecoder().decode(T.self, from: data)
            return value ?? defaultValue
        }
        set {
            // Convert newValue to data
            let data = try? JSONEncoder().encode(newValue)

            UserDefaults.standard.set(data, forKey: key)
            UserDefaults.standard.synchronize()
        }
    }
}

struct UserDefault {
    @UserDefaultWrapper(key: "userIsSignedIn", defaultValue: false)
    static var isSignedIn: Bool
}

然后我可以像这样设置值：

UserDefault.isSignedIn = true

我是否使用了错误的属性包装器？是否还有其他人在旧 iOS 版本上遇到属性包装器问题？

Answer 1

与属性包装无关！问题在于，在 iOS 12 及之前的版本中，像 Bool（或 String 等）这样的简单值，虽然 Codable 作为 Codable 结构的 property（例如），但不能本身 采用 JSON 编码。错误（您正在丢弃）对此非常清楚：

顶级 Bool 编码为数字 JSON 片段。

要查看这个，只需运行以下代码：

    do {
        _ = try JSONEncoder().encode(false)
        print("succeeded")
    } catch {
        print(error)
    }

在 iOS 12 上，我们收到错误消息。在 iOS 13 上，我们会收到 "succeeded"。

但如果我们将 Bool（或 String 等）包装在 Codable 结构中，一切都很好：

    struct S : Codable { let prop : Bool }
    do {
        _ = try JSONEncoder().encode(S(prop:false))
        print("succeeded")
    } catch {
        print(error)
    }

这在两个 iOS 12 和 iOS 13 上都可以正常工作。

这一事实表明了一个解决方案！重新定义您的属性包装器，以便将其值包装在通用 Wrapper 结构中：

struct UserDefaultWrapper<T: Codable> {

    struct Wrapper<T> : Codable where T : Codable {
        let wrapped : T
    }

    private let key: String
    private let defaultValue: T

    init(key: String, defaultValue: T) {
        self.key = key
        self.defaultValue = defaultValue
    }

    var wrappedValue: T {
        get {
            guard let data = UserDefaults.standard.object(forKey: key) as? Data 
                else { return defaultValue }
            let value = try? JSONDecoder().decode(Wrapper<T>.self, from: data)
            return value?.wrapped ?? defaultValue
        }
        set {
            do {
                let data = try JSONEncoder().encode(Wrapper(wrapped:newValue))
                UserDefaults.standard.set(data, forKey: key)
            } catch {
                print(error)
            }
        }
    }
}

现在它适用于 iOS 12 和 iOS 13。

---

顺便说一句，我实际上认为保存为属性列表而不是 JSON 会更好。但这通常对这个问题没有影响。您也不能将裸 Bool 编码为属性列表。你仍然需要 Wrapper 方法。