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

联系方式

• 微博
• Twitter
• GitHub
• 博客

备注

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

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