从 UserDefaults 快速保存和检索自定义对象

Question

我在 Playground 中使用 Swift 3，Xcode 8.0：

import Foundation
class Person: NSObject, NSCoding {
    var name: String
    var age: Int
    init(name: String, age: Int) {
        self.name = name
        self.age = age
    }
    required convenience init(coder aDecoder: NSCoder) {
        let name = aDecoder.decodeObject(forKey: "name") as! String
        let age = aDecoder.decodeObject(forKey: "age") as! Int
        self.init(
            name: name,
            age: age
        )
    }
    func encode(with aCoder: NSCoder) {
        aCoder.encode(name, forKey: "name")
        aCoder.encode(age, forKey: "age")
    }
}

Answer 1

斯威夫特 4 或更高版本

您可以再次在 Playground 中保存/测试您的值

---

UserDefaults 需要在实际项目中进行测试。 注意：无需强制同步。 如果你想在 Playground 中测试编码/解码，你可以使用 keyed archiver 将数据保存到文档目录中的 plist 文件中。 您还需要解决课堂上的一些问题：

---

class Person: NSObject, NSCoding {
    let name: String
    let age: Int
    init(name: String, age: Int) {
        self.name = name
        self.age = age
    }
    required init(coder decoder: NSCoder) {
        self.name = decoder.decodeObject(forKey: "name") as? String ?? ""
        self.age = decoder.decodeInteger(forKey: "age")
    }
    func encode(with coder: NSCoder) {
        coder.encode(name, forKey: "name")
        coder.encode(age, forKey: "age")
    }
}

---

测试：

class ViewController: UIViewController {
    override func viewDidLoad() {
        super.viewDidLoad()

        do {
            // setting a value for a key
            let newPerson = Person(name: "Joe", age: 10)
            var people = [Person]()
            people.append(newPerson)
            let encodedData = try NSKeyedArchiver.archivedData(withRootObject: people, requiringSecureCoding: false)
            UserDefaults.standard.set(encodedData, forKey: "people")
            // retrieving a value for a key
            if let data = UserDefaults.standard.data(forKey: "people"),
                let myPeopleList = try NSKeyedUnarchiver.unarchiveTopLevelObjectWithData(data) as? [Person] {
                myPeopleList.forEach({print($0.name, $0.age)})  // Joe 10
            }                    
        } catch {
            print(error)
        }
        
    }
}

Answer 2

let age = aDecoder.decodeObject(forKey: "age") as! Int

Swift 3 已更改； 这不再适用于值类型。 现在正确的语法是：

let age = aDecoder.decodeInteger(forKey: "age")

有各种不同类型的相关 decode...() 函数：

let myBool = aDecoder.decodeBoolean(forKey: "myStoredBool")
let myFloat = aDecoder.decodeFloat(forKey: "myStoredFloat")

编辑： Swift 3 中所有可能的 decodeXXX 函数的完整列表

编辑：

另一个重要注意事项：如果您之前保存了使用旧版本 Swift 编码的数据，则必须使用 decodeObject() 解码这些值，但是一旦使用 encode(...) 重新编码数据，它就不能再被如果它是值类型，则使用 decodeObject() 解码。 因此，Markus Wyss 的回答将允许您处理使用任一 Swift 版本对数据进行编码的情况：

self.age = aDecoder.decodeObject(forKey: "age") as? Int ?? aDecoder.decodeInteger(forKey: "age")

Answer 3

在 Swift 4 中：

您可以使用 Codable 从 Userdefaults 中保存和检索自定义对象。 如果您经常这样做，那么您可以添加为扩展名并像下面一样使用它。

extension UserDefaults {

   func save<T:Encodable>(customObject object: T, inKey key: String) {
       let encoder = JSONEncoder()
       if let encoded = try? encoder.encode(object) {
           self.set(encoded, forKey: key)
       }
   }

   func retrieve<T:Decodable>(object type:T.Type, fromKey key: String) -> T? {
       if let data = self.data(forKey: key) {
           let decoder = JSONDecoder()
           if let object = try? decoder.decode(type, from: data) {
               return object
           }else {
               print("Couldnt decode object")
               return nil
           }
       }else {
           print("Couldnt find key")
           return nil
       }
   }

}

你的班级必须遵循 Codable。 它只是可编码和可解码协议的类型别名。

class UpdateProfile: Codable {
  //Your stuffs
}

用法：

let updateProfile = UpdateProfile()

//To save the object
UserDefaults.standard.save(customObject: updateProfile, inKey: "YourKey")

//To retrieve the saved object
let obj = UserDefaults.standard.retrieve(object: UpdateProfile.self, fromKey: "YourKey")

有关更多编码和解码自定义类型，请查看Apple 的文档。

Answer 4

试试这个：

self.age = aDecoder.decodeObject(forKey: "age") as? Int ?? aDecoder.decodeInteger(forKey: "age")

Answer 5

在 Swift 5 中，我会使用属性包装器来简化代码：

/// A type that adds an interface to use the user’s defaults with codable types
///
/// Example:
/// ```
/// @UserDefaultCodable(key: "nameKey", defaultValue: "Root") var name: String
/// ```
/// Adding the attribute @UserDefaultCodable the property works reading and writing from user's defaults
/// with any codable type
///
@propertyWrapper public struct UserDefaultCodable<T: Codable> {
    private let key: String
    private let defaultValue: T

    /// Initialize the key and the default value.
    public init(key: String, defaultValue: T) {
        self.key = key
        self.defaultValue = defaultValue
    }

    public var wrappedValue: T {
        get {
            // Read value from UserDefaults
            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)

            // Set value to UserDefaults
            UserDefaults.standard.set(data, forKey: key)
        }
    }
}

Answer 6

在UserDefaults中保存“自定义对象”的简单示例如下：

您无需借助THE GREAT'CODABLE'编写用于保存/检索对象的样板代码，这就是您摆脱烦人的手动编码/解码的目的

因此，如果您已经在使用NSCoding并切换到Codable（Encodable + Decodable的组合）协议，请从代码中删除以下两种方法

required init(coder decoder: NSCoder) // NOT REQUIRED ANY MORE, DECODABLE TAKES CARE OF IT

func encode(with coder: NSCoder) // NOT REQUIRED ANY MORE, ENCODABLE TAKES CARE OF IT

让我们从Codable的简单性入手...

创建要存储在UserDefaults中的自定义类或结构

struct Person : Codable {
    var name:String
}

OR

class Person : Codable {

    var name:String

    init(name:String) {
        self.name = name
    }
}

将对象保存在UserDefaults中，如下所示

 if let encoded = try? JSONEncoder().encode(Person(name: "Dhaval")) {
     UserDefaults.standard.set(encoded, forKey: "kSavedPerson")
 }

从UserDefaults加载对象，如下所示

guard let savedPersonData = UserDefaults.standard.object(forKey: "kSavedPerson") as? Data else { return }
guard let savedPerson = try? JSONDecoder().decode(Person.self, from: savedPersonData) else { return }

print("\n Saved person name : \(savedPerson.name)")

而已 ...

保存/加载愉快.. :)