Swift的UserDefaults簡易封裝

UserDefaults 這個東西相信大家都用過,但是它的存取需要寫很長的方法調用,感覺很笨拙。我們為何不用 subscript 來改造它呢?

蘋果十分不提倡將一些 Name 用 hardcode 的方式來表示,不要直接用 String 表示一個 asset 名稱,不要用 tag 來獲取 IB 中拖拽的 view。這些行為十分影響軟件的可維護性。所以我們將應用中的 UserDefaults Key 用某種方式來表示:

final class PreferenceKey<T>: PreferenceKeys { }
class PreferenceKeys: RawRepresentable, Hashable {
    let rawValue: String
    
    required init!(rawValue: String) {
        self.rawValue = rawValue
    }
    
    convenience init(_ key: String) {
        self.init(rawValue: key)
    }
    
    var hashValue: Int {
        return rawValue.hashValue
    }
}

這小段代碼很精巧,既通過 rawValue 存儲了 key,同時通過范型在類型中注入了 value 的類型信息。

存儲所有配置項的 Key與默認值:

// 設置key的默認值 
let defaultPreferences: [PreferenceKeys: Any] = [
    .firstLaunch: true,
]

extension PreferenceKeys {
    static let firstLaunch = PreferenceKey<Bool>("FirstLaunch")
    static let token = PreferenceKey<String>("Token")
}

接著定義一個專門負責存儲的管理類:

final class PreferenceManager {
    static let shared = PreferenceManager()
    let defaults = UserDefaults.standard
    
    private init() {
        registerDefaultPreferences()
    }
    
    private func registerDefaultPreferences() {
        // Convert dictionary of type [PreferenceKey: Any] to [String: Any].
        let defaultValues: [String: Any] = defaultPreferences.reduce([:]) {
            var dictionary = $0
            dictionary[$1.key.rawValue] = $1.value
            return dictionary
        }
        defaults.register(defaults: defaultValues)
    }
}

extension 補充下:

extension PreferenceManager {    
    subscript(key: PreferenceKey<URL>) -> URL? {
        get { return defaults.url(forKey: key.rawValue) }
        set { defaults.set(newValue, forKey: key.rawValue) }
    }
    
    subscript(key: PreferenceKey<[Any]>) -> [Any]? {
        get { return defaults.array(forKey: key.rawValue) }
        set { defaults.set(newValue, forKey: key.rawValue) }
    }
    
    subscript(key: PreferenceKey<[String: Any]>) -> [String: Any]? {
        get { return defaults.dictionary(forKey: key.rawValue) }
        set { defaults.set(newValue, forKey: key.rawValue) }
    }
    
    subscript(key: PreferenceKey<String>) -> String? {
        get { return defaults.string(forKey: key.rawValue) }
        set { defaults.set(newValue, forKey: key.rawValue) }
    }
    
    subscript(key: PreferenceKey<[String]>) -> [String]? {
        get { return defaults.stringArray(forKey: key.rawValue) }
        set { defaults.set(newValue, forKey: key.rawValue) }
    }
    
    subscript(key: PreferenceKey<Data>) -> Data? {
        get { return defaults.data(forKey: key.rawValue) }
        set { defaults.set(newValue, forKey: key.rawValue) }
    }
    
    subscript(key: PreferenceKey<Bool>) -> Bool {
        get { return defaults.bool(forKey: key.rawValue) }
        set { defaults.set(newValue, forKey: key.rawValue) }
    }
    
    subscript(key: PreferenceKey<Int>) -> Int {
        get { return defaults.integer(forKey: key.rawValue) }
        set { defaults.set(newValue, forKey: key.rawValue) }
    }
    
    subscript(key: PreferenceKey<Float>) -> Float {
        get { return defaults.float(forKey: key.rawValue) }
        set { defaults.set(newValue, forKey: key.rawValue) }
    }
    
    subscript(key: PreferenceKey<Double>) -> Double {
        get { return defaults.double(forKey: key.rawValue) }
        set { defaults.set(newValue, forKey: key.rawValue) }
    }
    
    subscript(key: PreferenceKey<Any>) -> Any? {
        get {
            let decodedObject = defaults.data(forKey:  key.rawValue)
            if let decoded = decodedObject {
                let object = NSKeyedUnarchiver.unarchiveObject(with: decoded)
                return object
            }
            return nil
        }
        set {
            var encodedObject: Data? = nil
            if newValue != nil {
                encodedObject = NSKeyedArchiver.archivedData(withRootObject: newValue!)
            }
            defaults.set(encodedObject, forKey: key.rawValue)
        }
    }
}

借助范型,我們將 subscript 用不同類型分開,這樣存取不同類型的值時就不用去取分方法名稱了,是不是很方便呢?

使用方式如下:

let firstLaunch = PreferenceManager.shared[.firstLaunch]

PreferenceManager.shared[.firstLaunch] = false

效率是不是瞬間爆炸???


看到這里可能你就會想問RawRepresentable是什么

它是什么

首先我們簡單看一下這個東西是用來描述什么問題的,它的定義如下:

public protocol RawRepresentable {
    associatedtype RawValue

    public init?(rawValue: Self.RawValue)

    public var rawValue: Self.RawValue { get }
}

簡單來說呢,遵循這個協議的類型可以表示另一個類型,并且可以通過 rawValue這個屬性得到它表示的值。再簡單的說就是表示一個值。

但是這個協議有沒有它存在的道理呢?當然有!這也是為什么面向協議編程是 Swift 的一大核心之一。Swift 這個語言本身的組成也必須要求 RawRepresentable 這個協議,因為基本類型 enum 就遵循了它。當然還有很多系統類庫的類型,比如 OptionSet 和一些從 Objective-C 遷移過來的 NS_ENUM 都遵循了這個協議。

Well, How to Use It?

首先我們來寫一個簡單的 OptionSet :

struct Directions: OptionSet {
    typealias RawValue = UInt8

    var rawValue: UInt8

    static let up = Directions(rawValue: 1 << 0)
    static let down = Directions(rawValue: 1 << 1)
    static let left = Directions(rawValue: 1 << 2)
    static let right = Directions(rawValue: 1 << 3)
}

由于 OptionSet 也是一個協議,而這個協議并沒有指定 RawRepresentable 中的一個 associatedtype RawValue ,因此我們用第一行的語句指定:我們這個類型表示了一個 UInt8 類型。由于協議規定我們需要有個 rawValue 屬性,所以我們還需要再聲明一個 rawValue 成員變量。

下面我們需要定義幾個選項,使用的方式就是靜態常量,至于數值的設計本文不展開敘述了,大家可以參考位運算相關文章以及回憶自己高中時學的排列組合。

使用的時候也很方便,我們可以通過 [.up, .left] 或者 .down 來表示一個 Direction 變量,這得益于 Swift 的類型推斷和便利的語法。

Wrap Up

RawRepresentable 就是為了讓某類數值能具有更抽象的展現形式,并賦予更多相關的操作能力。

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。

推薦閱讀更多精彩內容