Swift开发小技巧系列 - 改造UserDefaults

原文链接

正文

开发过iOS的人,一定使用过UserDefaults来存取数据。UserDefaults使用起来很简单,我们就以存取用户名和邮箱为例,来探讨下UserDefaults的具体使用。

存储代码

let username = "DerekCoder"
let email = "derekcoder@gmail.com"

let defaults = UserDefaults.standard
defaults.set(username, forKey: "username")
defaults.set(email, forKey: "email")

读取代码

let defaults = UserDefaults.standard
let username = defaults.string(forKey: "username") // 类型: String?
let email = defaults.string(forKey: "email") // 类型: String?

虽然实现很简单,但是上面代码有个很明显的问题。"username""email"这两个常量我们不应该每次用到都敲一遍,这样很容易敲错或者忘记具体怎么拼写,我们应该充分利用IDE自动补全的功能。

OK,我们对上面代码进行改进

let username = "DerekCoder"
let email = "derekcoder@gmail.com"

let KEY_FOR_USERNAME = "username"
let KEY_FOR_EMAIL = "email"

let defaults = UserDefaults.standard
defaults.set(username, forKey: KEY_FOR_USERNAME)
defaults.set(email, forKey: KEY_FOR_EMAIL)
let defaults = UserDefaults.standard
let username = defaults.string(forKey: KEY_FOR_USERNAME) // 类型: String?
let email = defaults.string(forKey: KEY_FOR_EMAIL) // 类型: String?

这时候我们就解决了敲错Key的名字的问题,但是还是有一个问题,就是如果我们不记得定义的常量名字怎么办,当然这时候我们可以去定义的常量的文件查看,这样的话就会打断你当前的进程,影响效率,也影响心情。那有没有一种方法可以让IDE自动提示你当前定义的所有的UserDefault Keys,然后我们只要选择就可以了。

我的解决方案如下:

  • 添加一个新的类型UserDefaults.Name
extension UserDefaults {
    public struct Name: RawRepresentable, Equatable {
        public var rawValue: String
        
        
        public init(rawValue: String) {
            self.rawValue = rawValue
        }
        
        public init(_ rawValue: String) {
            self.rawValue = rawValue
        }
    }
}
  • 扩展UserDefaults.Name类型,让它支持字符串直接赋值
extension UserDefaults.Name: ExpressibleByStringLiteral {
    public typealias UnicodeScalarLiteralType = String
    public typealias ExtendedGraphemeClusterLiteralType = String
    
    public init(stringLiteral value: String) {
        self.rawValue = value
    }
    
    public init(unicodeScalarLiteral value: String) {
        self.init(stringLiteral: value)
    }
    
    public init(extendedGraphemeClusterLiteral value: String) {
        self.init(stringLiteral: value)
    }
}
  • 扩展UserDefaults,添加新的方法来实现赋值和读取数据
extension UserDefaults {
    public func object(forName name: UserDefaults.Name) -> Any? {
        return object(forKey: name.rawValue)
    }
    
    public func set(_ value: Any?, forName name: UserDefaults.Name) {
        set(value, forKey: name.rawValue)
    }
    
    public func string(forName name: UserDefaults.Name) -> String? {
        return string(forKey: name.rawValue)
    }
    // 此处省略了一些的方法
    ...
}
  • 定义你的Key常量
extension UserDefaults.Name {
    static let username: UserDefaults.Name = "username"
    static let email: UserDefaults.Name = "email"
}
  • 实现你的赋值和读取
let defaults = UserDefaults.standard
defaults.set(username, forName: .username)
defaults.set(email, forName: .email)

let username = defaults.string(forName: .username) // 类型: String?
let email = defaults.string(forName: .email) // 类型: String?

最后一步赋值和读取时,当你需要用到Key常量时,你只需要先敲一个点,Xcode就会把所有的UserDefaults的Key常量展示出来,你选择你需要的key即可。你再也不用害怕敲错或者忘记定义的常量名字具体是什么了。

Screen Shot 2017-09-19 at 4.00.49 PM.png

我们再做一个扩展,让UserDefaults支持,如果对应的Key的值不存在,返回一个defaultValue

extension UserDefaults {
    public func string(forName name: UserDefaults.Name, defaultValue: String) -> String {
        return string(forKey: name.rawValue) ?? defaultValue
    }
}
let defaults = UserDefaults.standard
let username = defaults.string(forName: .username, defaultValue: "Unknown") // 类型: String

总结

  • 对于UserDefaults的扩展,为了强调重点,我省略了一些方法。查看全部代码,请参考SwiftDevHints

联系方式

备注

我们在软件开发的过程中,为了提高效率,其中很重要的一环就是把反复使用到的功能或模块封装起来。因此我在GitHub上开源了一个小工具集 - SwiftDevHints,来总结自己在实际项目开发过程中封装的一些小功能。

刚刚介绍的只是其中一个小功能,想看看其它更多功能,请直接点击SwiftDevHints。如果您觉得对您有所帮助,请给一个star吧。

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

推荐阅读更多精彩内容

  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 171,858评论 25 707
  • 1. Java基础部分 基础部分的顺序:基本语法,类相关的语法,内部类的语法,继承相关的语法,异常的语法,线程的语...
    子非鱼_t_阅读 31,602评论 18 399
  • 因为要结局swift3.0中引用snapKit的问题,看到一篇介绍Xcode8,swift3变化的文章,觉得很详细...
    uniapp阅读 4,407评论 0 12
  • 郊外,有一棵漂亮的樱花树,白天有许多人,但是到了晚,却没有一个人,今天例外,有两个长的差不多的女孩子坐在村上。 “...
    画家小可爱阅读 331评论 1 3
  • 我的复杂美丽教程~ 1,早中晚各3遍眼保健操 2,睡前热毛巾敷眼睛 3,运动1小时 4,早中晚各胸部按摩一套 5,...
    逸包包阅读 224评论 0 1