Property Wrapper优化UserDefaults的使用

目的

简化保存UserDefaults的写法,通过正常属性赋值取值的方式进行UserDefaults的存取。
比如,正常,保存和读取UserDefaults是这样的:

UserDefaults.standard.setValue("aaa", forKey: "stringvalue")
UserDefaults.standard.value(forKey: "stringvalue") as? String

如果我想要这样做呢?

// 保存到UserDefaults中
UserDefaults.stringValue = "aaa"
// 从UserDefaults中读取
print(UserDefaults.stringValue)

定义要存取的值

属性保存为UserDefaults的类属性,如:

extension UserDefaults {
    static var boolValue: Bool?
    static var stringValue: String?
    static var dictValue: [String: String]?
    static var dateValue: Date?
}

这样的赋值方式只是保存在了内存里面,接下来要使用Property Wrapper在进行存取的时候额外做点事情,把值保存和读取在UserDefaults里面。

定义Property Wrapper

// 最基本的结构
@propertyWrapper
struct UserDefault<Value> {
    var wrappedValue: Value 
}

现在为wrappedValue设置get和set方法,在这里面进行UserDefaults的存取。
因为取值的时候并不能保证一定能取到,所以要设置一个默认值,在无法取到值的时候使用默认值替代。

@propertyWrapper
struct UserDefault<Value> {
    let key: String
    // 默认值
    let defaultValue: Value

    var wrappedValue: Value {
        get {
            // 在无法从UserDefaults里面取到值的时候,就取默认值
            return UserDefaults.standard.object(forKey: key) as? Value ?? defaultValue
        }
        set {
            UserDefaults.standard.set(newValue, forKey: key)
        }
    }
}

为特定属性添加存取特性

extension UserDefaults {
    @UserDefault(key: "boolvalue", defaultValue: false)
    static var boolValue: Bool
    @UserDefault(key: "stingvalue", defaultValue: "default")
    static var stringValue: String
    @UserDefault(key: "dictvalue", defaultValue: [String: String]())
    static var dictValue: [String: String]
    @UserDefault(key: "datevalue", defaultValue: Date())
    static var dateValue: Date
}

之所以把可选值的"?"去掉,是因为UserDefaults.standard.object(forKey: key) as? Value当Value为可选值的时候,即使前面的值为nil,也不会走后面的?? defaultValue了。

添加对nil的支持

如果想要在设置一个属性为nil的时候,不需要设置默认值,那就要添加一个新的初始化方法,在Value为可选值的时候,可以使用该初始化方法。
判断Value是否是可选值可以判断该Value是否遵从ExpressibleByNilLiteral协议。

extension UserDefault where Value: ExpressibleByNilLiteral {

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

当Value值为可选值的时候,就可以不传默认值了。
当传nil的时候,删除UserDefaults中的key,可以在set中判断newValue是否为nil。我们先设置一个protocol:

protocol AnyOptional {
    var isNil: Bool { get }
}

extension Optional: AnyOptional {
    var isNil: Bool { self == nil }
}

此时就可以用AnyOptional来判断是否是nil了:

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

    var wrappedValue: Value {
        get {
            return UserDefaults.standard.object(forKey: key) as? Value ?? defaultValue
        }
        set {
            if let optionalValue = newValue as? AnyOptional, optionalValue.isNil {
                UserDefaults.standard.removeObject(forKey: key)
            } else {
                UserDefaults.standard.set(newValue, forKey: key)
            }
        }
    }
}

此时,我们的属性设置可以为可选值:

extension UserDefaults {
    @UserDefault(key: "boolvalue", defaultValue: false)
    static var boolValue: Bool
    @UserDefault(key: "stingvalue", defaultValue: "default")
    static var stringValue: String
    // 不需要传默认值
    @UserDefault(key: "dictvalue")
    static var dictValue: [String: String]?
    @UserDefault(key: "datevalue", defaultValue: Date())
    static var dateValue: Date
}

添加对自定义模型的支持

UserDefaults不支持class、struct等的类型的保存,需要先进行序列化/反序列化才能进行正常读取。所以,针对这样的情况,对这些非基本类型的保存,就使用另外的Property Wrapper进行单独处理。
比如,一个Person类的保存:

extension UserDefaults {
    @UserDefault(key: "personvalue", defaultValue: Person(name: nil, age: nil))
    static var personValue: Person
}

class Person {
    var name: String?
    var age: Int?

    init(name: String?, age: Int?) {
        self.name = name
        self.age = age
    }
}

let person: Person = Person(name: "Ivan", age: 30)

UserDefaults.personValue = person  // Wrong!!!

以上操作会导致报错。所以我们需要进行额外的操作:

@propertyWrapper
struct UserDefaultCodable<Value: Codable> {
    let key: String
    let defaultValue: Value
    var container: UserDefaults = .standard

    var wrappedValue: Value {
        get {
            if let data = container.object(forKey: key) as? Data,
               let user = try? JSONDecoder().decode(Value.self, from: data) {
                return user
            }
            return  defaultValue
        }
        set {
            if let encoded = try? JSONEncoder().encode(newValue) {
                container.set(encoded, forKey: key)
            }
        }
    }
}

使该类支持Codable:

class Person: Codable {
    var name: String?
    var age: Int?

    init(name: String?, age: Int?) {
        self.name = name
        self.age = age
    }
}

这时候,就可以对非基础类型进行正常的存取了。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 217,542评论 6 504
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,822评论 3 394
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 163,912评论 0 354
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,449评论 1 293
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,500评论 6 392
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,370评论 1 302
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,193评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,074评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,505评论 1 314
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,722评论 3 335
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,841评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,569评论 5 345
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,168评论 3 328
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,783评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,918评论 1 269
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,962评论 2 370
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,781评论 2 354

推荐阅读更多精彩内容