UserDefaults 在 SwiftUI 中与 Toggle 绑定

Question

我正在尝试找出构建绑定到 UserDefaults 的简单设置屏幕的最佳方法。

基本上，我有一个 Toggle 并且我想要：

• 更改此切换时要保存的 UserDefault 值（UserDefault 应该是事实的来源）
• 切换为始终显示 UserDefault 的值

我已经观看了许多 SwiftUI WWDC 会议，但我仍然不确定应该如何使用 Combine 和 SwiftUI 中提供的不同工具来设置所有内容。我目前的想法是我应该使用 BindableObject，这样我就可以使用 hat 来封装许多不同的设置。

我想我已经接近了，因为它几乎可以按预期工作，但行为不一致。

当我在设备上构建并运行它时，我打开它并打开 Toggle，然后如果我稍微上下滚动视图，开关就会关闭（好像它实际上并没有保存 UserDefaults 中的值） .

但是，如果我打开开关，离开应用程序，然后稍后再回来，它仍然处于打开状态，就像它记住了设置一样。

有什么建议吗？我发布这篇文章是希望它能帮助其他刚接触 SwiftUI 和 Combine 的人，因为我找不到关于这个主题的任何类似问题。

import SwiftUI
import Combine

struct ContentView : View {

    @ObjectBinding var settingsStore = SettingsStore()

    var body: some View {
        NavigationView {
            Form {
                Toggle(isOn: $settingsStore.settingActivated) {
                    Text("Setting Activated")
                }
            }
        }.navigationBarTitle(Text("Settings"))
    }
}

class SettingsStore: BindableObject {

    var didChange = NotificationCenter.default.publisher(for: .settingsUpdated).receive(on: RunLoop.main)

    var settingActivated: Bool {
        get {
            UserDefaults.settingActivated
        }
        set {
            UserDefaults.settingActivated = newValue
        }
    }
}

extension UserDefaults {

    private static var defaults: UserDefaults? {
        return UserDefaults.standard
    }

    private struct Keys {
        static let settingActivated = "SettingActivated"
    }

    static var settingActivated: Bool {
        get {
            return defaults?.value(forKey: Keys.settingActivated) as? Bool ?? false
        }
        set {
            defaults?.setValue(newValue, forKey: Keys.settingActivated)
        }
    }
}

extension Notification.Name {
    public static let settingsUpdated = Notification.Name("SettingsUpdated")
}

Answer 1

更新

------- iOS 14：-------

从 iOS 14 开始，现在有一种非常简单的方式来读取和写入 UserDefaults。

使用名为 @AppStorage 的新属性包装器

它的使用方法如下：

import SwiftUI

struct ContentView : View {

    @AppStorage("settingActivated") var settingActivated = false

    var body: some View {
        NavigationView {
            Form {
                Toggle(isOn: $settingActivated) {
                    Text("Setting Activated")
                }
            }.navigationBarTitle(Text("Settings"))
        }
    }
}

就是这样！它是如此简单，非常直接。正在从 UserDefaults 中保存和读取您的所有信息。

-------- iOS 13：---------

Swift 5.1 发生了很多变化。 BindableObject 已完全弃用。此外，PassthroughSubject 也发生了重大变化。

对于任何想使其工作的人，以下是相同的工作示例。我重用了“gohnjanotis”的代码来简化它。

import SwiftUI
import Combine

struct ContentView : View {

    @ObservedObject var settingsStore: SettingsStore

    var body: some View {
        NavigationView {
            Form {
                Toggle(isOn: $settingsStore.settingActivated) {
                    Text("Setting Activated")
                }
            }.navigationBarTitle(Text("Settings"))
        }
    }
}

class SettingsStore: ObservableObject {

    let willChange = PassthroughSubject<Void, Never>()

    var settingActivated: Bool = UserDefaults.settingActivated {
        willSet {

            UserDefaults.settingActivated = newValue

            willChange.send()
        }
    }
}

extension UserDefaults {

    private struct Keys {
        static let settingActivated = "SettingActivated"
    }

    static var settingActivated: Bool {
        get {
            return UserDefaults.standard.bool(forKey: Keys.settingActivated)
        }
        set {
            UserDefaults.standard.set(newValue, forKey: Keys.settingActivated)
        }
    }
}

Answer 2

在this video by azamsharp 和this tutorial by Paul Hudson 的帮助下，我已经能够生成一个绑定到 UserDefaults 的切换开关，并立即显示您分配给它的任何更改。

• 场景代表：

在'window'变量下添加这行代码

var settingsStore = SettingsStore()

并修改 window.rootViewController 以显示这个

window.rootViewController = UIHostingController(rootView: contentView.environmentObject(settingsStore))

• 设置商店：

import Foundation

class SettingsStore: ObservableObject {
    @Published var isOn: Bool = UserDefaults.standard.bool(forKey: "isOn") {
        didSet {
            UserDefaults.standard.set(self.isOn, forKey: "isOn")
        }
    }
}

• 设置商店菜单

如果你愿意，创建一个名为 this 的 SwiftUI 视图并粘贴：

import SwiftUI

struct SettingsStoreMenu: View {
    
    @ObservedObject var settingsStore: SettingsStore
    
    var body: some View {
        Toggle(isOn: self.$settingsStore.isOn) {
            Text("")
        }
    }
}

• 最后但并非最不重要的一点

不要忘记从您拥有的任何主视图中将 SettingsStore 注入 SettingsStoreMenu，例如

import SwiftUI

struct MainView: View {
        
    @EnvironmentObject var settingsStore: SettingsStore

    @State var showingSettingsStoreMenu: Bool = false

    
    var body: some View {
        HStack {
            Button("Go to Settings Store Menu") {
                    self.showingSettingsStoreMenu.toggle()
            }
            .sheet(isPresented: self.$showingSettingsStoreMenu) {
                    SettingsStoreMenu(settingsStore: self.settingsStore)
            }
        }
    }
}

（或任何你想要的方式。）

Answer 3

这个接缝效果很好：

enum BackupLocalisations: String, CaseIterable, Hashable, Identifiable {
    case iPhone = "iPhone"
    case iCloud = "iCloud"
    
    var name: String {
        return self.rawValue
    }
    var id: BackupLocalisations {self}
}

enum Keys {
    static let iCloudIsOn = "iCloudIsOn"
    static let backupLocalisation = "backupLocalisation"
    static let backupsNumber = "backupsNumber"
}

    class SceneDelegate: UIResponder, UIWindowSceneDelegate {
    
    var window: UIWindow?
    var settings = Settings()

…/…
    let contentView = ContentView()
            .environmentObject(settings)
… }

class Settings: ObservableObject {
    @Published var iCloudIsOn: Bool = UserDefaults.standard.bool(forKey: Keys.iCloudIsOn) {
        didSet { UserDefaults.standard.set(self.iCloudIsOn, forKey: Keys.iCloudIsOn) }
    }
    
    @Published var backupLocalisation: String = UserDefaults.standard.object(forKey: Keys.backupLocalisation) as? String ?? "iPhone" {
        didSet { UserDefaults.standard.set(self.backupLocalisation, forKey: Keys.backupLocalisation) }
    }
    
    @Published var backupsNumber: Int = UserDefaults.standard.integer(forKey: Keys.backupsNumber) {
        didSet { UserDefaults.standard.set(self.backupsNumber, forKey: Keys.backupsNumber) }
    }
}

struct ContentView: View {
    @ObservedObject var settings: Settings

    var body: some View {
        NavigationView {
            Form {
                Section(footer: Text("iCloud is \(UserDefaults.standard.bool(forKey: Keys.iCloudIsOn) ? "on" : "off")")) {
                    Toggle(isOn: self.$settings.iCloudIsOn) { Text("Use iCloud") }
                }
                Section {
                    Picker(selection: $settings.backupLocalisation, label: Text("\(self.settings.backupsNumber) sauvegarde\(self.settings.backupsNumber > 1 ? "s" : "") sur").foregroundColor(Color(.label))) {
                        ForEach(BackupLocalisations.allCases) { b in
                            Text(b.name).tag(b.rawValue)
                        }
                    }
                    
                    Stepper(value: self.$settings.backupsNumber) {
                        Text("Nombre de sauvegardes")
                    }
                }
            }.navigationBarTitle(Text("Settings"))
            
        }
    }
}

struct ContentView_Previews: PreviewProvider {
    static var previews: some View {
        ContentView().environmentObject(Settings())
    }
}

Xcode 11.3.1

Answer 4

试试这样的。您也可以考虑使用EnvironmentObject 而不是ObjectBinding per this answer。

import Foundation

@propertyWrapper
struct UserDefault<Value: Codable> {
    let key: String
    let defaultValue: Value

    var value: Value {
        get {
            return UserDefaults.standard.object(forKey: key) as? Value ?? defaultValue
        }
        set {
            UserDefaults.standard.set(newValue, forKey: key)
        }
    }
}

使用对象绑定，切换将使用键 myBoolSetting 将用户默认设置为 true / false。您可以看到 Text 视图文本中反映的当前值。

import Combine
import SwiftUI

final class SettingsStore: BindableObject {
    let didChange = PassthroughSubject<Void, Never>()

    @UserDefault(key: "myBoolSetting", defaultValue: false)
    var myBoolSetting: Bool {
        didSet {
            didChange.send()
        }
    }
}


struct ContentView : View {
    @ObjectBinding var settingsStore = SettingsStore()

    var body: some View {
        Toggle(isOn: $settingsStore.myBoolSetting) {
            Text("\($settingsStore.myBoolSetting.value.description)")
        }
    }
}

Answer 5

我看到的一个问题是您使用错误的 API 来设置/获取来自 UserDefaults 的值。你应该使用：

static var settingActivated: Bool {
    get {
        defaults?.bool(forKey: Keys.settingActivated) ?? false
    }
    set {
        defaults?.set(newValue, forKey: Keys.settingActivated)
    }
}

Answer 6

这是我经过一些实验后得出的结论，使用PassthroughSubject 而不是尝试对通知进行操作。它似乎始终如一地按预期工作。

我猜可能有一些 Swift 或 SwiftUI 技术可以让这变得更简单，所以请指出任何其他关于如何做这样的事情的想法。

import SwiftUI
import Combine

struct ContentView : View {

    @ObjectBinding var settingsStore: SettingsStore

    var body: some View {
        NavigationView {
            Form {
                Toggle(isOn: $settingsStore.settingActivated) {
                    Text("Setting Activated")
                }
            }.navigationBarTitle(Text("Settings"))
        }
    }
}

class SettingsStore: BindableObject {

    let didChange = PassthroughSubject<Void, Never>()

    var settingActivated: Bool = UserDefaults.settingActivated {
        didSet {

            UserDefaults.settingActivated = settingActivated

            didChange.send()
        }
    }
}

extension UserDefaults {

    private struct Keys {
        static let settingActivated = "SettingActivated"
    }

    static var settingActivated: Bool {
        get {
            return UserDefaults.standard.bool(forKey: Keys.settingActivated)
        }
        set {
            UserDefaults.standard.set(newValue, forKey: Keys.settingActivated)
        }
    }
}

Answer 7

您可以扩展@Published 属性包装器以将值存储在UserDefaults 中（如this answer 中所建议的那样）：

private var cancellables = [String: AnyCancellable]()

extension Published {
    init(defaultValue: Value, key: String) {
        let value = UserDefaults.standard.object(forKey: key) as? Value ?? defaultValue
        self.init(initialValue: value)
        cancellables[key] = projectedValue.sink { val in
            UserDefaults.standard.set(val, forKey: key)
        }
    }
}

这是基于发布的问题的示例：

import SwiftUI
import Combine

struct ContentView : View {
    @ObservedObject var settingsStore = SettingsStore()

    var body: some View {
        NavigationView {
            Form {
                Toggle(isOn: $settingsStore.settingActivated) {
                    Text("Setting Activated")
                }
            }.navigationBarTitle(Text("Settings"))
        }
    }
}

class SettingsStore: ObservableObject {
    @Published(defaultValue: false, key: "SettingActivated")
    var settingActivated: Bool
}