Dark Angel

iOS中NSUserDefaults的黑科技

次阅读
本文目录
  1. 前言
  2. NSUserDefaults简介
  3. 黑科技
    1. 还原默认值
    2. 巧用SuiteName
      1. App Groups数据共享
      2. 超微型简单方便易用数据库
  4. 总结

前言

在iOS开发中,我们时常需要保存一些数据,或者希望在用户下次打开App时,依然可以保留一些设置等,比如主题设置语言设置,那么我们一般会选择使用NSUserDefaults作为轻量级数据持久化方案。这里不对其他的数据持久化方案(如Plist、归档、Sqlite3、CoreData等)进行探讨,主要来介绍一下NSUserDefaults中的一些黑科技。

NSUserDefaults简介

NSUserDefaults在Foundation框架中被定义,用来存储和读取一些轻量级数据。其本质是操作plist文件。

它比其他数据持久化方案的优点在于:

  • 轻量级。
  • 方便快捷直接使用。
  • 支持NSData, NSString, NSNumber, NSDate, NSArray and NSDictionary

缺点在于:

  • 不适合大量数据。
  • 无法存储自定义model

黑科技

一些NSUserDefaults最基础的用法,这里就不赘述了。说到黑科技,一般指的是鲜为人知而又十分厉害的技术。这里主要介绍两个黑科技。

还原默认值

一般NSUserDefaults使用,都会保存一些自定义的Key和Value,其实这个不涉及还原默认值的问题。其实有些时候,是需要修改其中的系统默认值的。比如应用内切换中英文,就需要修改AppleLanguages的value。既然修改了系统默认值,怎么还原默认值呢?

我们先来看一下修改前的:

po [NSUserDefaults standardUserDefaults].dictionaryRepresentation

{
    ...
    AppleLanguages =     (
        en,
        "zh-Hans-US"
    );
    AppleLocale = "en_US";
    ...
}

可以看到AppleLanguages对应的是一个数组,如果我们在App内想切换成中文,执行

[[NSUserDefaults standardUserDefaults] setObject:@[@"zh-Hans"] forKey:@"AppleLanguages"];

再次看下修改后

po [NSUserDefaults standardUserDefaults].dictionaryRepresentation

{
    ...
    AppleLanguages =     (
        zh-Hans
    );
    AppleLocale = "en_US";
    ...
}

好吧,这个AppleLanguages字段的值已经被记录了。这时候,kill客户端,重新打开客户端,发现,这个值肯定不会变。那么如果这个时候用户在系统设置中切换到了日语,那么我想在客户端中通过跟随手机系统的设置,还原到日语,该怎么办呢?

或许你会想到记录初始值,只要提前记录,在还原时再set回去就可以了。嗯~没毛病,可是在什么地方什么时候记录初始值呢?这个AppleLanguages字段其实就是系统的语言默认值,你已经把它改过了,如果在你改过之后用户又修改了系统语言,那你是拿不到新默认值的,所以这条路是走不通的。

那怎么实现还原默认值呢?看下这个方法:

/*!
 -setObject:forKey: immediately stores a value (or removes the value if nil is passed as the value) for the provided key in the search list entry for the receiver's suite name in the current user and any host, then asynchronously stores the value persistently, where it is made available to other processes.
 */
- (void)setObject:(nullable id)value forKey:(NSString *)defaultName;

这个方法Document中并没有描述过多,基本都是在强调value必须是NSData, NSString, NSNumber, NSDate, NSArray and NSDictionary中的一种,且NSArray and NSDictionary中的值也必须是Plist支持的类型。在注释中有强调,removes the value if nil is passed as the value,传nil等同于删除这个键值对。

/// -removeObjectForKey: is equivalent to -[... setObject:nil forKey:defaultName]
- (void)removeObjectForKey:(NSString *)defaultName;

其实这里才是关键

[[NSUserDefaults standardUserDefaults] setObject:nil forKey:@"AppleLanguages"];
//or
[[NSUserDefaults standardUserDefaults] removeObjectForKey:@"AppleLanguages"];

然后再次

po [NSUserDefaults standardUserDefaults].dictionaryRepresentation

{
    ...
    AppleLanguages =     (
        en,
        "zh-Hans-US"
    );
    AppleLocale = "en_US";
    ...
}

你会发现,WTF,居然这个字段还存在,且还原成了默认值,厉害了word哥。本方法是本人历经各种坑之后发现的,且官方文档中没有任何提及,只能说Apple爸爸任性。

巧用SuiteName

- (nullable instancetype)initWithSuiteName:(nullable NSString *)suitename NS_AVAILABLE(10_9, 7_0) NS_DESIGNATED_INITIALIZER;

这个方法,想必各位不会陌生,在跨App间通信或者主App与Extension共享数据,都会用到,一般配合使用的是App Groups

App Groups数据共享

在App Groups中使用,一般两个App都需要加入同一个Group。然后在两个App分别使用

- (NSUserDefaults *)userDefaults
{
    return [[NSUserDefaults alloc] initWithSuiteName:@"group.urwork.autosignin"];    //name需要是Group的id
}

来存储和读取数据,即可实现数据共享。

超微型简单方便易用数据库

这里,其实主要介绍一下initWithSuiteName:的另一个用途,我称之为超微型简单方便易用数据库

需求:后台同学最近太忙(😳这不是理由),需要客户端同学临时开发一个本地的浏览历史功能。简单的说就是在客户端本地保存每个用户浏览的文章记录。

吐糟:好吧,时间紧,任务重,功能先上线,后续再优化已经是一个习惯了😳。

实现方案:简单,本地存个字典(或者Plist文件),每个key是一个用户id,value是一个数组,数组里的每个元素是一个字典,这个字典里有articleIdtitleimgUrl...。结构大概是这样:

{
  "10086" : [
    {
      "articleId" : 1,
      "imgUrl" : "https://img.xxx.com/abcdefg.png",
      "title" : "中国历史",
      ...
    },
    {
      "articleId" : 2,
      "imgUrl" : "https://img.xxx.com/abcdefg.png",
      "title" : "中国教育",
      ...
    },
    ...
  ],
  "10087" : [
    {
      "articleId" : 2,
      "imgUrl" : "https://img.xxx.com/abcdefg.png",
      "title" : "中国教育",
      ...
    },
    ...
  ]
}

看起来OK,但是小伙伴们,性能问题还是要考虑的。我想获取某个用户的浏览历史,需要把文件整体读到内存中,然后用dict[@"10086"]的方法,得到这个用户的浏览历史Array,用户少还好,多了,每次读取的IO操作会很耗时,对性能有影响。

可能你会说用数据库啊什么的,当然可以,但是又是需要依赖一堆第三方,还要写好多代码,创建好多类。我就是想简单实现一下,有没有更好的方法呢?当然有,超微型简单方便易用数据库

每个用户都可以用一个NSUserDefaults来代替,每个用户的浏览历史,可以直接用setObject:forKey:的方式来存储,如:

//这个跟App Groups没有关系
//已有则读取,没有则创建
NSUserDefaults *userDefaults = [[NSUserDefaults alloc] initWithSuiteName:@"10086"];
//存储
[userDefaults setObject:history forKey:@"ArticleBrowsingHistory"];
//读取
NSArray *history = [userDefaults objectForKey:@"ArticleBrowsingHistory"];

所有用户相对独立,每个用户是一个plist文件,在沙盒目录/Library/Preferences/中,想删除也很容易,直接删除这个文件即可。

其实这个超微型简单方便易用数据库还可以实现好多功能,看你怎么操作了。如果你的App没有后台,不同用户的主题设置、语言设置可能不同,都可以通过这个来存储。

总结

其实很多我们很常用的东西都有很多我们未发掘出的用途,生活也是同样,学会发现,一切会更美好。

Dark Angel

iOS界的低调探索者

 
Powered By Hexo