Swift里我用这个姿势写UserDefaults

github地址:UserDefaultsEVO

人在江湖飘,总免不了要存一些值到UserDefaults。

UserDefaults.standard.set("@没故事的卓同学", forKey: "Author")

let author = UserDefaults.standard.value(forKey: "Author")

有存就有取,还可能有很多地方会取这个值。这样的话每次写这个 key 就有点蛋疼了。


key 写成一个全局的常量虽然解决了代码重复的问题,但是体验上还是没有改变。一个 app 里也有不少的字符串常量,怎么表明这个字符串是用于持久化的 key 呢?

解决方案

利用 rawValue 类型为 String 的枚举作为 key,通过协议为指定枚举增加存取到 UserDefaults 的能力。
首先声明一个枚举,建议在UserDefaults的扩展里写,当然如果你想要省掉前面一个命名空间也是可以的:

extension UserDefaults {
    enum TestData: String,UserDefaultSettable {
        case name
    }
}

注意到这个枚举需要实现<code>UserDefaultSettable</code>协议。
接着就可以在这个枚举里调用<code>store(value: )</code>方法来存储:

 UserDefaults.TestData.name.store(value: "name")
 let storeValue = UserDefaults.TestData.name.storedString

这个枚举<code>TestData.name</code>可以理解为一张银行卡。拿着这张卡到银行,说我要存,就够了。这个枚举就是一个ID。

这个思路和Swift 3以后的通知中心形式相似。



Notification.Name 也是一个 rawValue 为字符串的枚举。

extension NSNotification {
    public struct Name : RawRepresentable, Equatable, Hashable, Comparable {

        public init(_ rawValue: String)

        public init(rawValue: String)
    }
}

当然严格的说并不是一个枚举,只是和枚举一样实现了<code>RawRepresentable</code>协议。不过我觉得直接声明一个枚举在这里会比实现<code>RawRepresentable</code>便捷一些。

实现

主要就是<code>UserDefaultSettable</code>协议的扩展了。

public protocol UserDefaultSettable {
    var uniqueKey: String { get }
}

public extension UserDefaultSettable where Self: RawRepresentable, Self.RawValue == String {

    public func store(value: Any?){
        UserDefaults.standard.set(value, forKey: uniqueKey)
    }

    public var storedValue: Any? {
        return UserDefaults.standard.value(forKey: uniqueKey)
    }

    // 为所有的key加上枚举名作为命名空间,避免重复
    public var uniqueKey: String {
        return "\(Self.self).\(rawValue)"
    }

    public func store(value: Bool) {
        // ......
    }
    public var storedBool: Bool {
              // ......
    }
    // 还有支持其他存储类型的函数,就不全写了
}

主要的实现代码很简单,就是为 RawValue 为 String 的枚举添加了 store 和 获取存储 value 的方法。

为了避免直接取枚举的名字作为key可能引起的重名,声明了一个计算属性来生成存储的 key,规则就是加上枚举 Type 名作为前缀。比如上面的例子里存储的 key 就是 TestData.name 。

欢迎关注我的微博:@没故事的卓同学


参考链接:
Swift: UserDefaults Protocol
UserDefault 数据存储和读取简易封装

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

推荐阅读更多精彩内容