Latest 1.1.0
Homepage https://github.com/yanxiaobing/XBUserDefaults
License MIT
Platforms ios 8.0, requires ARC
Authors
  • XBUserDefaults是利用Objective-C RunTime机制对NSUserDefaults进行一层封装。
  • 大大增加了易用性和可维护性。
  • 性能基本毫无影响(100000次NSString读写,耗时仅多0.4s±0.05s)。

几乎每个iOS项目中都会使用到NSUserDefaults,作为iOS开发常用的五种数据存储方式之一(NSUserDefaultsplistNSKeyedArchiverFMDBCoreData),NSUserDefaults算是最易用的了。

但是项目中用的多了之后key管理起来就很麻烦了,而且用每次用到都要写一大坨代码。相信用过的朋友都有同感吧!

实现思路

  • 数据存取

    @property属性设置为@dynamic,然后利用消息机制在+(BOOL)resolveInstanceMethod:(SEL)sel方法中根据@property类型动态添加相关(setter/getter)方法。相关内容则依然存储在NSUserDefaults中。

  • 数据迁移

    为了更好的方便项目中已经大量使用NSUserDefaults的用户能相对轻松的迁移数据,内置了数据迁移方法transferToXBWithNewOldKeysDic:(NSDictionary *)newOldKeysDic,通过newOldKeysDic映射表将旧数据迁移到新方式中去。newKey为属性名,通过newKey可以获取到属性类型,在根据类型和oldKey获取到旧数据并赋值给新方式。

安装方式

目前可以通过两种方式将XBUserDefaults集成到您的项目中。

在你的 Podfile文件中添加 XBUserDefaults:

source 'https://github.com/CocoaPods/Specs.git'
platform :ios, '8.0'

target 'TargetName' do
pod 'XBUserDefaults'
end

然后执行:

$ pod install

Usage

创建一个XBUserDefaults子类,并将子类单例化。eg:

XBTestUserDefaults.h

#import "XBUserDefaults.h"

@interface XBTestUserDefaults : XBUserDefaults

@property (nonatomic ,copy) NSString *name; // 名字
@property (nonatomic ,assign) NSInteger age;// 年龄

+(instancetype)sharedInstance; // 单例方法
@end

XBTestUserDefaults.m


#import "XBTestUserDefaults.h"

@implementation XBTestUserDefaults

@dynamic name,age;  //一定要记得将属性名设置@dynamic,不然不会动态绑定setter/getter方法,保存不了值

static XBTestUserDefaults* _instance = nil;
+(instancetype) sharedInstance
{
static dispatch_once_t onceToken ;
dispatch_once(&onceToken, ^{
_instance = [[self alloc] init] ;
}) ;
return _instance ;
}
@end

如果需要数据迁移只需在旧数据使用前调用

// @"name"、@"age"对应新方式的属性名。
// @"test_name"、@"test_age"对应旧方式保存值的`key`。
// 旧数据类型需要与新方式的属性类型匹配。

NSDictionary *dic = @{@"name":@"test_name",
                    @"age":@"test_age"
                    };
// 确认映射表正确配置后,就可以将之前那一坨坨代码删掉了。然后在使用`NSUserDefaults`之前调用迁移方法。
[[XBTestUserDefaults sharedInstance] transferToXBWithNewOldKeysDic:dic]; 

// 使用`NSUserDefaults`
// [[NSUserDefaults standardUserDefaults] setObject:@"我不是小冰冰" forKey:@"test_name"];
// NSLog(@"test_name:%@",[[NSUserDefaults standardUserDefaults] objectForKey:@"test_name"]);

// 使用`XBUserDefaults`
[XBTestUserDefaults sharedInstance].name = @"我不是小冰冰";
NSLog(@"name:%@",[XBTestUserDefaults sharedInstance].name);

添加新字段只需要在@interface中添加对应类型的@property并在@implementation文件中@dynamic propertyName,然后像普通@property使用了。

Notices

  • 最好用子类单例的形式。
  • 添加新的属性的时候一定要记得在.m文件中@dynamic propertyName
  • 数据迁移一定要注意映射表的构建,key-value 对应propertyName-oldKey。
  • 数据迁移最好放在app升级的逻辑中做。
  • 数据迁移不需要自己写逻辑控制只执行一次。作者已经帮你做好了。

特别说明

在某QQ群推广的时候,经网友提醒,很早以前已经有一个这样的轮子了,经过比较,人家的轮子更好更强大。不过数据迁移这块支持的不是很好。

既然已经发布了,我就留着自己用了。

大家可以参考下,再自行选择。GVUserDefaults

License

XBUserDefaults is released under the MIT license. See LICENSE for details.

Latest podspec

{
    "name": "XBUserDefaults",
    "version": "1.1.0",
    "summary": "Easy to use NSUserDefaults",
    "homepage": "https://github.com/yanxiaobing/XBUserDefaults",
    "license": "MIT",
    "authors": {
        "XBingo": "[email protected]"
    },
    "platforms": {
        "ios": "8.0"
    },
    "source": {
        "git": "https://github.com/yanxiaobing/XBUserDefaults.git",
        "tag": "1.1.0"
    },
    "requires_arc": true,
    "source_files": "XBUserDefaults/**/*.{h,m}"
}

Pin It on Pinterest

Share This