iOS组件之SwiftyUserDefaults

worldcup.png

最近开发过程中遇到一个线上Crash，在api发布到线上以后，app崩溃率提升到30%，打开bugly查看崩溃原因，提示attempt to insert no-property list in to ..... too long，原来是请求服务器配置的数据，在存入UserDefaults之后导致的crash。

1. 一段可疑的代码

LietomeProvider.request(.forumConfig, completion: { result in
            switch result {
            case .success(let response):
                guard response.code == NoneError else {
                    let last = UserDefaults.standard.dictionary(forKey: "example.cn.main.forum")
                    if last != nil {
                        self.forumConfig = ForumConfig.mj_object(withKeyValues: last)
                    }
                    return
                }
                let dataJSON = response.dataJSON
                let remote = dataJSON.dictionaryObject
                self.forumConfig = ForumConfig.mj_object(withKeyValues: remote)
                UserDefaults.standard.setValue(remote, forKey: "example.cn.main.forum") // 崩溃在这里
                UserDefaults.standard.synchronize()
            case .failure:
                break
            }
        })

上面的代码为什么会崩溃呢？原来读取的服务器配置信息remote是一个字典，这个字典包含很多的key-value信息，但是由于api开发人员忘了将一个key-value赋值，导致只有key而没有value，这样就导致存入UserDefaults的内容为null或者nil，我们知道NSNull是没有实现NSCoding协议的，这就导致存入UserDefaults的时候崩溃了。

2. 使用SwiftyUserDefaults替代UserDefaults

系统提供给我们的组件相当于是一个毛坯房，使用相当简单，但是会有很多的坑，所以可以对系统组件进行封装，实现自定义的目的；也可以借助第三方组件，来替代系统的UserDefaults，SwiftyUserDefaults就是这样一个组件，它的使用方法相当简单，现定义需要存储的key，然后通过swift的下标[]语法进行存取操作，如下代码所示，笔者添加了注释，读者朋友应该很容易理解。

// FRUserDefaultsKeys.swift

import SwiftyUserDefaults
extension DefaultsKeys {
    /// 论坛的配置信息
    static let FRConfigureCachedKey = DefaultsKey<[String:Any]?>("example.cn.forum.configure")
    /// 论坛版块列表的浏览历史记录
    static let FRSectionUserDefaultCacheKey = DefaultsKey<[String:Any]?>("example.cn.main.forum.history")
    /// 论坛搜索的最新一条搜索历史记录
    static let frLatestSearchedKey = DefaultsKey("fr.example.searchedKey")
    /// 论坛搜索的所有历史记录
    static let frSearchedKeywordHistory = DefaultsKey<[String]>("fr.example.searchedHistory")
}

// FRConfigure.swift

import SwiftyUserDefaults
LietomeProvider.request(.forumConfig, completion: { result in
            switch result {
            case .success(let response):
                guard response.code == NoneError else {
                    let last = Defaults[.FRConfigureCachedKey] // 使用SwiftyDefaults
                    if last != nil {
                        self.forumConfig = ForumConfig.mj_object(withKeyValues: last)
                    }
                    return
                }
                let dataJSON = response.dataJSON
                let remote = dataJSON.dictionaryObject
                self.forumConfig = ForumConfig.mj_object(withKeyValues: remote)
                Defaults[.FRConfigureCachedKey] = remote // 使用SwiftyDefaults
            case .failure:
                break
            }
})

使用该组件，可以避免UserDefaults导致的crash，而且不必再通过手写字符串的方式作为key来存取数据，这无疑减小了出错的概率。

SwiftyUserDefaults的项目非常小巧，它就是结合swify的灵活的语法实现了对UserDefaults的封装，有兴趣的读者可以到github看一下它的代码。在后续的文章中，笔者会对该组件的代码做一个解析和分享。