iOS黑魔法之可视化NSUserDefaults

NSUserDefaults作为持久化存储的类，为广大iOS开发者所熟知，每时每刻都在被使用着。但是相信大家在使用的过程中也发现了，查看NSUserDefaults当前都存储了哪些值的时候很麻烦，因为NSUserDefaults作为一个单例类，在使用的时候极其的分散，你甚至只能全局搜索然后一一查看，很是不便。这个问题在进行多人协作时更加的明显，很多时候你自己想定义的值可能别人已经定义过了，这样就造成了两个不同命名的值在完成相同的功能，这样就有可能造成一系列的问题，甚至是生产事故。
这篇文章提供了一个解决方案，使用runtime和KVO，在NSUserDefaults的基础上实现了一个持久化存储类，该类具有可视化、统一管理、无冗余、低耦合等特点，代码量也不多。

一、你不知道的NSUserDefaults

1.1 NSUserDefaults到底存了哪些值

相信很多人平时使用NSUserDefaults，大多数只是使用了基本的读写的功能，并没有使用也没有在意其他的。但是实际上，我们App的很多底层的设置和参数都是用NSUserDefaults实现的，具体有哪些我们来一探究尽：

// 将其序列化为字典格式
NSDictionary *dict = [[NSUserDefaults standardUserDefaults] dictionaryRepresentation];

我们在控制台看到转化为字典格式后，未存任何值的NSUserDefaults已经有21个值了

这其中像AppleLocale这个很明显就是当前的本地语言，我们在更改App的语言时，其实更改的就是这一项，其他的看名字也能了解个大概，但是它们具体干啥的我也没有一一的对查找。

可以看出来，平时我们对App的一些设置，在关闭App下次再进入时仍然起作用，Apple在底层其实也是用了和我们一样的方法，并没有什么内部特权或者什么。

1.2 获取NSUserDefaults的实体文件

我们在使用NSUserDefaults进行值的存取的时候，实际上是以plist文件存在App的沙盒中的，具体的目录为AppData -> Library -> Preferences下相应的plist文件：

实体文件

获取的方式为，点击Xcode菜单栏的Window，选择Devices And Simulators，接着选择你当前的App，点击设置图标并选择Download Container

点击这个设置按钮

接下来选择plist文件保存的位置

选择保存的位置

这里我们保存到桌面上，点击save后就开始保存了，保存完成后是一个.xcappdata的文件，我们有击并选择显示包内容，就可以看到沙盒目录了：

沙盒目录

按照目录找到plist文件：

实体文件

双击打开，就可以看到当前NSUserDefaults中存取的值了：

打开的plist文件

值得注意的是，由于Apple的安全机制，和SQL数据库一样，我们在每次修改值后，都必须重复一次上面的操作来获取最新的数据，并不能像安卓手机一样直接实时查看，这一点还是比较麻烦的。

二、制作一个可视化的NSUserDefaults

2.1 源码

// .h
#import 

#define GQUD [GQUserDefaults shareInstance]

NS_ASSUME_NONNULL_BEGIN

@interface GQUserDefaults : NSObject

@property (nonatomic, assign) BOOL udLogined; //是否登录
@property (nonatomic, assign) int udVersion; //当前版本号

///初始化
+ (instancetype)shareInstance;

///清除全部本地存储
- (void)clearAll;

@end

NS_ASSUME_NONNULL_END

// .m
#import "GQUserDefaults.h"
#import 

@interface GQUserDefaults ()

@property (nonatomic, strong) NSMutableDictionary *propertiesDic;//自身成员变量储存dic

@end

@implementation GQUserDefaults

//初始化（单例）
+ (instancetype)shareInstance {
    static GQUserDefaults *instance = nil;
    static dispatch_once_t onceToken;
    dispatch_once(&onceToken, ^{
        instance = [[GQUserDefaults alloc] init];
        [instance allPropertyNamesWithKVO];
    });
    return instance;
}

//获取类的所有属性并加上监听
- (void)allPropertyNamesWithKVO {
    
    // 1.获得所有的成员变量
    unsigned int unsignedcount = 0;
    objc_property_t *properties = class_copyPropertyList([self class], &unsignedcount);
    
    self.propertiesDic = [NSMutableDictionary dictionary];
    
    //2.遍历所有成员变量
    for (unsigned int i = 0; i < unsignedcount; i++) {
        
        //获取成员变量
        objc_property_t property = properties[i];
        
        //成员变量在runtime中的描述格式
        NSString *attrs = @(property_getAttributes(property));
        NSUInteger dotLoc = [attrs rangeOfString:@","].location;
        //定义成员变量类型code
        NSString *code = nil;
        NSUInteger loc = 1;
        if (dotLoc == NSNotFound) { // 没有,
            code = [attrs substringFromIndex:loc];
        } else {
            code = [attrs substringWithRange:NSMakeRange(loc, dotLoc - loc)];
        }
        if (code.length > 3 && [code hasPrefix:@"@\""]) {
            // 去掉@"和"，截取中间的类型名称
            code = [code substringWithRange:NSMakeRange(2, code.length - 3)];
        }
        
        //全部转化为小写
        NSString *lowerCode = code.lowercaseString;
        //获取成员变量名
        NSString *name = [NSString stringWithUTF8String:property_getName(property)];
        //将成员变量名作为key，成员变量类型小写code为value
        [self.propertiesDic setObject:lowerCode forKey:name];
        
        //3.如果NSUserDefaults中值不为空，那么用KVC设值
        if ([[NSUserDefaults standardUserDefaults] objectForKey:name] != nil) {
            
            //确保每次初始化后
            [self setValue:[[NSUserDefaults standardUserDefaults] objectForKey:name] forKey:name];
        }
        
        //4.添加KVO观察成员变量的改变
        [self addObserver:self forKeyPath:name options:NSKeyValueObservingOptionNew context:nil];
    }
    
    //5.释放
    free(properties);
}

//KVO响应方法
- (void)observeValueForKeyPath:(NSString *)keyPath ofObject:(id)object change:(NSDictionary *)change context:(void *)context {
    
    if (object == self) {//此处需要先判断监听的对象是否正确
        
        //从自身成员变量储存dic中，根据成员变量名取出成员变量小写类型lowerCode
        NSString *lowerCode = [self.propertiesDic objectForKey:keyPath];
        
        if ([lowerCode isEqualToString:@"b"] || [lowerCode isEqualToString:@"nsstring"] || [lowerCode isEqualToString:@"nsarray"] || [lowerCode isEqualToString:@"nsdictionary"] || [lowerCode isEqualToString:@"nsdata"] || [lowerCode isEqualToString:@"nsdate"]) {
            //Bool、NSArray、NSDictionary、NSData和NSDate
            if (![[change objectForKey:@"new"] isEqual:[[NSUserDefaults standardUserDefaults] objectForKey:keyPath]]) {
                //将属性名作为key，属性值作为value，存入NSUserDefaults中
                [[NSUserDefaults standardUserDefaults] setObject:[change objectForKey:@"new"] forKey:keyPath];
                [[NSUserDefaults standardUserDefaults] synchronize];
            }
        } else if ([lowerCode isEqualToString:@"i"]) {
            //Int
            if (![[change objectForKey:@"new"] isEqual:[[NSUserDefaults standardUserDefaults] objectForKey:keyPath]]) {
                [[NSUserDefaults standardUserDefaults] setInteger:[[change objectForKey:@"new"] integerValue] forKey:keyPath];
                [[NSUserDefaults standardUserDefaults] synchronize];
            }
        } else if ([lowerCode isEqualToString:@"f"]) {
            //Float
            if (![[change objectForKey:@"new"] isEqual:[[NSUserDefaults standardUserDefaults] objectForKey:keyPath]]) {
                [[NSUserDefaults standardUserDefaults] setFloat:[[change objectForKey:@"new"] floatValue] forKey:keyPath];
                [[NSUserDefaults standardUserDefaults] synchronize];
            }
        } else if ([lowerCode isEqualToString:@"d"]) {
            //Double
            if (![[change objectForKey:@"new"] isEqual:[[NSUserDefaults standardUserDefaults] objectForKey:keyPath]]) {
                [[NSUserDefaults standardUserDefaults] setDouble:[[change objectForKey:@"new"] doubleValue] forKey:keyPath];
                [[NSUserDefaults standardUserDefaults] synchronize];
            }
        }
    } else {
        [super observeValueForKeyPath:keyPath ofObject:object change:change context:context];
    }
}

//清除全部本地存储
- (void)clearAll {

    unsigned int unsignedcount = 0;
    objc_property_t *properties = class_copyPropertyList([self class], &unsignedcount);

    //遍历所有成员变量
    for (unsigned int i = 0; i < unsignedcount; i++) {

        //获得属性名
        objc_property_t property = properties[i];
        NSString *name = [NSString stringWithUTF8String:property_getName(property)];
        
        //清除所有key-value
        [[NSUserDefaults standardUserDefaults] removeObjectForKey:name];
        
        //移除观察者
        [self removeObserver:self forKeyPath:name context:nil];
    }
}

@end

2.2 使用和分析

首先我们看.h文件，其中有两个前缀为ud的属性，一个为udLogined，一个为udVersion，这两个属性就是当前可视化类存取的值，我们在控制器中调用一下：

GQUD.udLogined = true;
GQUD.udVersion = 1;

查看一下沙盒文件中的值
双击打开，就可以看到当前NSUserDefaults中存取的值了：

沙盒文件中的值

可以看到，已经修改成功了，头文件中的两个属性赫然显示在其中，并且它们的值也和代码一样。

到了上面的这一步，就很清晰了，我们只需要将App中需要存取的值都统一放到这个类的.h文件中，在需要的时候进行赋值或者修改即可。而每次我们需要新增一个新的持久化值的时候，就在.h中新增一个属性，此时不光整个App中的所有的持久化存取的值一目了然，而且由于它们是属性，它们的类型也已经定义好了，免去了将类型搞错的麻烦（NSUserDefaults只支持NSString、 NSNumber、NSDate、NSData、 NSArray、NSDictionary、BOOL、NSInteger、NSFloat这些类型）。

类型提前定义好了

2.3 源码解析

.h中的文件很简单，就是暴露出来的属性和方法，其中最重要的就是暴露出来的属性，这些属性就是可视化NSUserDefaults的“可视化”所在之处，它们在此统一进行管理。

核心是.m文件，其中用到了runtime和KVC的知识。
其中allPropertyNamesWithKVO方法中，objc_property_t *properties = class_copyPropertyList([self class], &unsignedcount);获取到了当前类的所有属性，随后用for循环为这些属性逐一添加了KVO监听，而每当我们对这些属性值赋值或者修改的时候，便会调用KVO的响应方法，在响应方法的内部，实际还是NSUserDefaults根据属性的名字在起作用。
PS以上还用到了各种数据类型在runtime底层的含义，上面只是一个大概的叙述，具体的可以看看源码，其中每一个关键步骤我都添加了注释。

最后

文件的git地址