SDUserDefaults:存储用户信息太痛苦?用这个就够了~

╰+哭是因爲堅強的太久メ 2023-01-09 15:52 114阅读 0赞

![511af25151f197494bc12b17316f5006.png][]

#### 前言 ####

--------------------

先讲一下为什么要去封装这个单例类.一开始我是怎么进行数据的存储的?写一个单例然后添加属性,修改属性的Set方法,为了防止手写失误,还要定义宏常量.在删除的时候,不但要把属性置为nil,还要把NSUserDefaults的值置空,相当繁琐复杂,每增加一个属性就要增加最少十行代码.非常不利于管理.

在没有封装**SDUserDefaults**,多少在深夜中惊醒,生怕因为自己的疏忽,导致一些用户数据存储不上,可真是往事不堪回首呐,所以利用自己的一个空闲时间,封装一个**SDUserDefaults**存储单例,省去繁琐的步骤.使用起来简单粗暴.下面我们就来看一下如何使用**SDUserDefaults**这个单例类进行用户数据存储.

#### 导入方式 ####

--------------------

\*手动导入: 下载演示Demo以及 **SDUserDefaults**. 把SDUserDefaults文件夹导入你自己的项目合适位置. 使用方法可以看 **自定义使用** 和 **基本使用方式**

*  cocoapod导入: 方式如下所示,使用方法可看 **自定义使用** 模块.

pod 'SDUserDefaults'

然后 `pod install`

#### SDUserDefaults 基本用法 (适用于手动导入) ####

--------------------

1.先去Github的SDUserDefaults下载演示Demo以及**SDUserDefaults**.

2.把SDUserDefaults文件夹导入你自己的项目合适位置,文件夹中主要包含**SDUserDefaults**和**SDCodingObject**两个类.

![9577411c32bc306629d19f849be7c5a0.png][]

3.在**SDUserDefaults**的.h文件中添加你想要存储的属性,这里需要注意的是属性必须是遵循NSCoding协议的类,Foundation中的类都已经遵循该协议.如下图所示.

![cc297e326cdceeefe2241a46ff649f0a.png][]

这时候有人会问,那我自定义的类需要怎么办?难道我需要自己实现NSCoding协议中的\*\*- (void)encodeWithCoder**和**\- (instancetype)initWithCoder**方法吗?完全不需要!你需要继承于**SDCodingObject\*\*这个类即可,我在其中都做了NSCoding协议的实现,并且所有的属性都会进行归档操作.例如上图的TestModel类.代码如下所示.

![91fe0be684abdad377c6153c91268b63.png][]

4.**存储数据**:只需要我们把对应的属性进行赋值,然后调用**saveUserInfoAction**方法即可.代码如下所示.

[SDUserDefaults standardUserDefaults].name = @"用户数据";
        TextModel *testModel = [[TextModel alloc] init];
        testModel.name = @"骚栋";
        testModel.age = @(15);
        testModel.location = @"北京";
        [SDUserDefaults standardUserDefaults].testModel = testModel;
        [[SDUserDefaults standardUserDefaults] saveUserInfoAction]; // 存储数据

5.**获取数据**:直接取值就好,简单粗暴,没有任何问题.代码如下所示.

/*****获取数据*****/
        NSLog(@"%@",[SDUserDefaults standardUserDefaults].name);
        NSLog(@"%@",[SDUserDefaults standardUserDefaults].testModel.name);
        NSLog(@"%@",[SDUserDefaults standardUserDefaults].testModel.age);
        NSLog(@"%@",[SDUserDefaults standardUserDefaults].testModel.location);

6.**删除数据**:想要删除数据直接调用**deleteUserInfo**即可.

[[SDUserDefaults standardUserDefaults] deleteUserInfo];

7.**更新数据**:想要删除的话,就把那个属性置为nil,想要修改某个属性就把那个属性修改,最后调用**saveUserInfoAction**方法保存即可即可.

[SDUserDefaults standardUserDefaults].name = @"新的用户数据";
        [SDUserDefaults standardUserDefaults].testModel.location = nil;
        [[SDUserDefaults standardUserDefaults] saveUserInfoAction]; // 更新数据

8.**忽略归档属性**:不想让部分属性进行归档持久化怎么办?使用 **unEncodePropertys** 即可.添加忽略的属性名称则该属性不会进行归档操作,注意,要忽略尽量在 **saveUserInfoAction** 前使用吆~

[SDUserDefaults standardUserDefaults].testModel.unEncodePropertys = @[@"age",@"names"];

经过上面的步骤,我们就知道了如何使用**SDUserDefaults**,是不是非常的简单,接下来,我们看一下**SDUserDefaults**是如何实现的,只有了解原理,你才能在此基础上更好的定制自己想要的效果.

#### SDUserDefaults 自定义使用 (适用于手动导入和cocoapods) ####

--------------------

有很多的童鞋会说,我凭啥要用你的SDUserDefaults来初始化啊,我就想自己写一个UserDefaults单例来管理我自己的存储属性不行啊?

行,当然可以了,在1.0.3版本的时候,骚栋增加了一个新的类,叫做SDUserObject类,只需要你写的单例继承于这个类,并且使用 **- (instancetype)initWithIdentifier** 方法来初始化,那么依然可以使用强大的属性,但是自己书写的代码量会大大减少.我们来看一下Demo中的例子是如何使用的吧.

基本操作什么的,还是如同上一个模块一样.我们来看一下存储的单例类是定义的.我们需要让单例类继承于**SDUserObject**类,如下图所示.

![dac11843dc96ae4eb9f27c758da45e7c.png][]

然后在创建单例的时候需要使用带有标识符参数的 **- (instancetype)initWithIdentifier** 方法进行初始化.如下图所示.

![204cc530383f91c6efeda001495bbce0.png][]

然后在保存和删除的方法上使用**saveAllPropertyAction** 和 **deleteAllPropertyAction** 即可.

![2d15cb6d922015d4cc746bbe2eab561b.png][]

这里对几个问题做一下解释.

*  为什么会有SDUserObject类的出现?

答:后期的SDUserDefaults会使用cocoapods进行管理,那么到时候如果通过cocoapods引入的时候不能去改动源码吧,所以我们通过继承于SDUserObject的方式来使用SDUserDefaults这个三方,同时呢,现在手动导入的方式,也会有很多童鞋有这样的自定义类的需求,所以SDUserObject的出现是很有必要的~

*  为什么在初始化SDUserObject类或者子类的时候需要使用\*\*- (instancetype)initWithIdentifier\*\*这个带有标识符的初始化方法呢?

答:唯一标识符identifier的作用是做了存储的key来使用的.如果有的童鞋写了两个单例类,但是用了相同的identifier就会出现数据错乱问题,所以这里我把这个唯一标识符暴露在.h属性中,用于个别童鞋进行单独的定制.只要保证全局唯一即可.

#### SDUserDefaults 的Keychain存储 ####

--------------------

SDUserDefaults 的1.0.0版本是基于NSUserDefaults进行存储的,由于NSUserDefaults是使用的明文plist文件进行存储,所以安全性有一定的欠缺,那么有的童鞋想来个更加安全的存储,是否可以呢?当然了,在1.0.6版本,骚栋对于keychain存储方式已经做了添加,我们可以使用两种方式来实现keychain存储方式.

> ###### keychain简单介绍: ######
> 
> iOS的keychain可以说是系统里唯一可以做到安全可靠存储应用敏感数据并且可以在应用卸载或重新安装时仍然保留其数据的地方。iOS设备中的Keychain是一个安全的存储容器，可以用来为不同应用保存敏感信息比如用户名，密码，网络密码，认证令牌。苹果自己用keychain来保存Wi-Fi网络密码，VPN凭证等等。它是一个在所有app之外的sqlite数据库。

*  手动导入SDUserDefaults时,我们可以直接修改 **SDKeychainUserDefaults**单例,使用方式和**SDUserDefaults** 类一致即可.但是 **SDKeychainUserDefaults** 的存储位置是在Keychain,而不是NSUserDefaults中.

![a61796f29a42be1a67fb3791a9878b19.png][]

*  cocoapods导入方式只需要使用\*\*initKeychainObjectWithIdentifier:\*\*即可. 如下所示. 可以查看Demo中的TestUserDefaults的初始化方法.

![26b4bb5dea32c4a58ec6bffc97579913.png][]

#### SDUserDefaults 实现 ####

--------------------

如何实现 **SDUserDefaults**的呢?主要用到了以下三点,分别是**runtime**,**NSCoding协议**,**NSUserDefaults**.

先说一下**NSUserDefaults**在其中扮演的角色,虽然**NSUserDefaults**还是作为存储空间使用,但是已经不单单是每一个单例属性都要进行一遍操作,因为**SDUserDefaults**已经遵循了**NSCoding协议**,所以我们可以直接进行归档存储,代码如下所示.

- (void)saveUserInfoAction {
        
        NSData *userInfoData = [NSKeyedArchiver archivedDataWithRootObject:self];
        [[NSUserDefaults standardUserDefaults] setObject:userInfoData forKey:SD_USER_MANAGER];
    }

那么什么时候进行从**NSUserDefaults**中进行取值呢?那就在单例创建的时候,判断一下**NSUserDefaults**是否含有归档数据,如果有,则进行归档,没有则进行空白初始化,代码如下所示.

static SDUserDefaults *userDefaults = nil;
    
    + (instancetype)standardUserDefaults {
        
        static dispatch_once_t onceToken;
        dispatch_once(&onceToken, ^{
            if (userDefaults == nil) {
                userDefaults = [SDUserDefaults initUserInfoAction];
            }
        });
        
        return userDefaults;
    }
    
    + (instancetype)initUserInfoAction {
        
        NSData *userInfoData = [[NSUserDefaults standardUserDefaults] objectForKey:SD_USER_MANAGER];
        if (userInfoData == nil) {
            return [[SDUserDefaults alloc] init];
        } else {
            return [NSKeyedUnarchiver unarchiveObjectWithData:userInfoData];
        }
    }

再说一下**runtime**和**NSCoding协议**的配合使用,这个主要是在**SDCodingObject**中进行了实现,利用**runtime**的方法遍历出所有的属性以及属性值,然后进行归档和解档操作.代码如下所示.

#pragma mark - 归档与解档
    
    - (void)encodeWithCoder:(nonnull NSCoder *)aCoder {
        
        unsigned int propertyCount = 0;
        objc_property_t *propertyList = class_copyPropertyList([self class], &propertyCount);
        for (int i = 0; i < propertyCount; i++) {
            objc_property_t *thisProperty = &propertyList[i];
            const char *name = property_getName(*thisProperty);
            NSString *propertyName = [NSString stringWithFormat:@"%s",name];
            id propertyValue = [self valueForKey:propertyName];
            [aCoder encodeObject:propertyValue forKey:propertyName];
        }
        free(propertyList);
    }
    
    - (nullable instancetype)initWithCoder:(nonnull NSCoder *)aDecoder {
        
        if (self = [super init]) {
            
            unsigned int propertyCount = 0;
            objc_property_t *propertyList = class_copyPropertyList([self class], &propertyCount);
            for (int i = 0; i < propertyCount; i++) {
                objc_property_t *thisProperty = &propertyList[i];
                const char *name = property_getName(*thisProperty);
                NSString *propertyName = [NSString stringWithFormat:@"%s",name];
                [self setValue:[aDecoder decodeObjectForKey:propertyName] forKey:propertyName];
            }
            free(propertyList);
        }
        return self;
    }

当然了,我怕有些人不知道什么类没有遵循**NSCoding协议**,所以我在**SDCodingObject**初始化的时候就会检测所有的属性是否遵循了**NSCoding协议**,如果没有就会直接抛出异常,让老铁们能快速知道是什么属性没有遵循协议,方便问题的查找,代码如下所示.

// 检测所有成员变量是否遵循NSCoding协议
    - (void)testPropertyConformsToNSCodingProtocol {
        
        unsigned int propertyCount = 0;
        objc_property_t *propertyList = class_copyPropertyList([self class], &propertyCount);
        for (int i = 0; i < propertyCount; i++) {
            objc_property_t thisProperty = propertyList[i];
            const char * type = property_getAttributes(thisProperty);
            NSString * typeString = [NSString stringWithUTF8String:type];
            NSArray * attributes = [typeString componentsSeparatedByString:@","];
            NSString * typeAttribute = [attributes objectAtIndex:0];
            if ([typeAttribute hasPrefix:@"T@"] && [typeAttribute length] > 1) {
                NSString * typeClassName = [typeAttribute substringWithRange:NSMakeRange(3, [typeAttribute length]-4)];  //turns @"NSDate" into NSDate
                Class typeClass = NSClassFromString(typeClassName);
                
                BOOL isConforms = [typeClass conformsToProtocol:@protocol(NSCoding)];
                if (!isConforms) {
                    NSString *exceptionContent = [NSString stringWithFormat:@"%@ 类中的 %@属性 未遵循NSCoding协议,请手动调整",NSStringFromClass([self class]),typeClassName];
                    @throw [NSException exceptionWithName:@"property has not NSCoding Protocol" reason:exceptionContent userInfo:nil];
                }
            }
        }
        free(propertyList);
    }

当然了,在删除用户数据的时候也是用到了**runtime**,这样是非常方便的.代码如下所示.

- (void)deleteUserInfo {
        
        unsigned int propertyCount = 0;
        objc_property_t *propertyList = class_copyPropertyList([self class], &propertyCount);
        for (int i = 0; i < propertyCount; i++) {
            objc_property_t *thisProperty = &propertyList[i];
            const char *name = property_getName(*thisProperty);
            NSString *propertyName = [NSString stringWithFormat:@"%s",name];
            [self setValue:nil forKey:propertyName];
        }
        free(propertyList);
        [[NSUserDefaults standardUserDefaults] removeObjectForKey:SD_USER_MANAGER];
    }

#### 后语 ####

--------------------

**SDUserDefaults**算是一个小工具类吧,有需要的直接拿走不谢,最后再一次附上Github的传送门(能点个star就更好了~~哈哈),如果有任何问题,欢迎在评论区或者简信联系我,谢谢大家了.

![1cc773b3510614b54c92ffc3dc40d24a.gif][]

[511af25151f197494bc12b17316f5006.png]: /images/20221119/f97f933aa8a84f039bacff256b567b7e.png
[9577411c32bc306629d19f849be7c5a0.png]: /images/20221119/339c822c862849838d323fefa635482e.png
[cc297e326cdceeefe2241a46ff649f0a.png]: https://img-blog.csdnimg.cn/img_convert/cc297e326cdceeefe2241a46ff649f0a.png
[91fe0be684abdad377c6153c91268b63.png]: https://img-blog.csdnimg.cn/img_convert/91fe0be684abdad377c6153c91268b63.png
[dac11843dc96ae4eb9f27c758da45e7c.png]: https://img-blog.csdnimg.cn/img_convert/dac11843dc96ae4eb9f27c758da45e7c.png
[204cc530383f91c6efeda001495bbce0.png]: https://img-blog.csdnimg.cn/img_convert/204cc530383f91c6efeda001495bbce0.png
[2d15cb6d922015d4cc746bbe2eab561b.png]: https://img-blog.csdnimg.cn/img_convert/2d15cb6d922015d4cc746bbe2eab561b.png
[a61796f29a42be1a67fb3791a9878b19.png]: https://img-blog.csdnimg.cn/img_convert/a61796f29a42be1a67fb3791a9878b19.png
[26b4bb5dea32c4a58ec6bffc97579913.png]: https://img-blog.csdnimg.cn/img_convert/26b4bb5dea32c4a58ec6bffc97579913.png
[1cc773b3510614b54c92ffc3dc40d24a.gif]: /images/20221119/5c6238e503704a8a9134d0c87819f107.png