SEWUserDefaults：使用FMDB实现的UserDefaults

做iOS开发多年，一直都是拿来主义，没有什么贡献。近段时间在做知识梳理的过程中，整理了一些比较实用的代码，模块化出来分享给大家。希望各位大佬拍砖，大家共同学习提高。

首先整理出来的是 SEWUserDefaults，一个基于FMDB实现的UserDefaults，其功能与NSUserDefaults一样。你可能会很奇怪，为什么要重新实现系统已提供的功能，吃饱了撑的？或是嫌弃Apple的代码不够好？NO！

先说一下项目背景，为什么要写这样一份代码。众所周知，NSUserDefaults是iOS系统提供的用于保存一些简单数据的工具类。其好处是简单方便，缺点也就是太简单只适合存储简单数据。问题是从iOS11开始发现的，在撸代码的过程中发现有时候明明存储到NSUserDefaults成功，但是读取的时候却没有数据，这不是坑吗，说好的信任呢？没办法，所以就基于FMDB实现了一个UserDefaults，即SEWUserDefaults。

SEWUserDefaults分两个部分，SEWUserDefaults和SEWUserDefaults+Database。SEWUserDefaults是提供给开发者的使用接口，其方法与NSUserDefaults中的方法一致，所以可以很方便的使用。SEWUserDefaults+Database是一个私有的Category，用来包装数据库增删改查操作。

SEWUserDefaults.h如下：

@interface SEWUserDefaults : NSObject

+ (void)openLog;
+ (void)closeLog;

+ (instancetype)standardUserDefaults;

- (nullable id)objectForKey:(NSString *)defaultName;

- (BOOL)setObject:(nullable id)value forKey:(NSString *)defaultName;

- (BOOL)removeObjectForKey:(NSString *)defaultName;

- (nullable NSString *)stringForKey:(NSString *)defaultName;

- (NSInteger)integerForKey:(NSString *)defaultName;

- (float)floatForKey:(NSString *)defaultName;

- (double)doubleForKey:(NSString *)defaultName;

- (BOOL)boolForKey:(NSString *)defaultName;

- (BOOL)setInteger:(NSInteger)value forKey:(NSString *)defaultName;

- (BOOL)setFloat:(float)value forKey:(NSString *)defaultName;

- (BOOL)setDouble:(double)value forKey:(NSString *)defaultName;

- (BOOL)setBool:(BOOL)value forKey:(NSString *)defaultName;

@end

SEWUserDefaults.h中最重要的两个方法是 setObject: forKey: 和 objectForKey:两个方法，其它所有方法都是这两个方法的不同包装。
先看setObject: forKey: 方法：

- (BOOL)setObject:(nullable id)value forKey:(NSString *)defaultName
{
    BOOL result = NO;
    if (value && ![value isKindOfClass:[NSNull class]]) {
        result = [self replaceIntoValueObject:value forKey:defaultName];
    } else {
        result = [self removeObjectForKey:defaultName];
    }
    return result;
}

当value不为空时，进行数据库更新（调用SEWUserDefaults+Database中的replaceIntoValueObject: forKey:方法）。当value为空时，删除对应key的记录（调用SEWUserDefaults+Database中的removeObjectForKey:方法）。

objectForKey:则是直接从数据库中查询相应的记录：

- (nullable id)objectForKey:(NSString *)defaultName
{
    return [self valueObjectForKey:defaultName];
}

SEWUserDefaults+Database.h如下：

@interface SEWUserDefaults (Database)

- (void)createTableIfNotExist;

- (BOOL)replaceIntoValueObject:(id)object forKey:(NSString *)defaultName;

- (BOOL)deleteValueObjectForKey:(NSString *)defaultName;

- (nullable id)valueObjectForKey:(NSString *)defaultName;

@end

其中最重要的两个方法为replaceIntoValueObject:forKey:和valueObjectForKey:分别实现数据更新和查询。

replaceIntoValueObject:forKey:实现：

- (BOOL)replaceIntoValueObject:(id)object forKey:(NSString *)defaultName
{
    NSAssert(object != nil && defaultName != nil, @"数据不能为空");

    id targetObject = nil;
    if ([object isKindOfClass:[NSString class]] || [object isKindOfClass:[NSNumber class]] || [object isKindOfClass:[NSData class]]) {
        targetObject = object;
    } else {
        targetObject = [NSKeyedArchiver archivedDataWithRootObject:object];
    }

    NSString *sql = [NSString stringWithFormat:@"replace into %@ (%@, %@) values ('%@', '%@')", kTableName, kTableColumnKey, kTableColumnValue, defaultName, object];


    __block BOOL executeResult = NO;
    [self.databaseQueue inDatabase:^(FMDatabase *db) {
        executeResult = [db executeUpdate:sql];
#if DEBUG
        if (kLogSwich) {
            if (executeResult) {
                NSLog(@"SQL 执行成功：%@", sql);
            } else {
                NSLog(@"SQL 执行失败：%@", sql);
            }
        }
#endif
    }];
    return executeResult;
}

在更新数据时NSString和NSNumber可以直接存储，其它类型由NSKeyedArchiver序列化之后存储，所以只要实现了NSCoding协议的对象都可以存储。
valueObjectForKey:方法实现：

- (nullable id)valueObjectForKey:(NSString *)defaultName
{
    NSString *sql = [NSString stringWithFormat:@"select * from %@ where %@ = '%@'", kTableName, kTableColumnKey, defaultName];
    __block id targetObject = nil;
    [self.databaseQueue inDatabase:^(FMDatabase *db) {
        FMResultSet *resultSet = [db executeQuery:sql];
        while ([resultSet next]) {
            id object = [resultSet objectForColumn:[kTableColumnValue copy]];
            do {
                if ([object isKindOfClass:[NSNull class]]) {
                    break;
                }
            
                if ([object isKindOfClass:[NSString class]] || [object isKindOfClass:[NSNumber class]]) {
                    targetObject = object;
                    break;
                }
            
                if ([object isKindOfClass:[NSData class]]) {
                    id tempObject = [NSKeyedUnarchiver unarchiveObjectWithData:object];
                    if (tempObject) {
                        targetObject = tempObject;
                    } else {
                        targetObject = object;
                    }
                    break;
                }
                
            } while (0);
        }
    }];
    return targetObject;
}

方法执行数据库查询，遍历结果集时，如果是NSString或者NSNumber类型直接返回，如果是NSData类型则进行反序列化解析出相应对象后返回。

线程安全性

所有数据库操作均使用FMDatabaseQueue进行，故SEWUserDefaults也是线程安全的。

Podfile

pod 'SEWUserDefaults'

Github

Github地址：https://github.com/sierwan/SEWUserDefaults 欢迎star

小广告

自己做的一个免费小工具APP，欢迎下载使用： https://itunes.apple.com/cn/app/isecrets-%E5%AE%89%E5%85%A8%E4%B8%93%E4%B8%9A%E7%9A%84%E5%AF%86%E7%A0%81%E7%AE%A1%E7%90%86%E5%B7%A5%E5%85%B7/id1359152999?mt=8