CoreData之Transformable属性

我们经常用到CoreData存储数据,但是CoreData能存储的基本都是一些标准的数据类型,当我们想存储NSDictionaryNSArray时,基本都是把它们转为 NSData 然后用 binary data 的类型写入到 Core Data,然后要用的时候再从 Core Data 中读出 NSData,再转回NSDictionary或者 NSArray。比如NSDictionary,我们可能用NSJSONSerialization

//NSData->NSDictionary
+ (nullable id)JSONObjectWithData:(NSData *)data options:(NSJSONReadingOptions)opt error:(NSError **)error
//NSDictionary->NSData
+ (nullable NSData *)dataWithJSONObject:(id)obj options:(NSJSONWritingOptions)opt error:(NSError **)error;

这两个方法转换,对NSArray,我们可能用NSKeyedArchiver

//NSArray->NSData
+ (NSData *)archivedDataWithRootObject:(id)rootObject;
//NSData->NSArray
+ (nullable id)unarchiveObjectWithData:(NSData *)data;

这两个方法转换。显然每次这样做是挺麻烦的。再看看Core Data还支持哪些我们没用过的类型,于是乎就看到了Transformable

CoreData支持Transformable类型

关于Transformable,苹果开发文档是这样说的:

The idea behind transformable attributes is that you access an attribute as a non-standard type, but behind the scenes Core Data uses an instance of NSValueTransformer to convert the attribute to and from an instance of NSData. Core Data then stores the data instance to the persistent store.

意思就是用了transformable属性,CoreData在底层自动帮我们把非标准类型与NSData之间做了转换,这就节省了很多人力,而且减少了错误概率。这个转换过程依赖了一个NSValueTransformer实例。NSValueTransformer用于把一个值转换为另一个值。它指定了可以处理哪类输入,并且合适时甚至支持反向的转换。

它的主要方法有:

+ (void)setValueTransformer:(nullable NSValueTransformer *)transformer forName:(NSValueTransformerName)name;
 // class of the "output" objects, as returned by transformedValue:
+ (Class)transformedValueClass;   
 // flag indicating whether transformation is read-only or not
+ (BOOL)allowsReverseTransformation;   
 // by default returns value
- (nullable id)transformedValue:(nullable id)value;         
// by default raises an exception if +allowsReverseTransformation returns NO and otherwise invokes transformedValue: 
- (nullable id)reverseTransformedValue:(nullable id)value;    

一个单例用一个名字来注册,其他几个方法定义了输入与输出的类型以及反向转换。

我们创建一个Students.xcdatamodel, 新建一个StudentEntity,有四个属性是Tranformable的,其中courses实际上是想存储NSArray类型,对应学生的课程表; scores实际上是想存储NSDictionary类型,对应学生的各科成绩;contact实际上是想存储自定义的Contact类型,对应学生的各种联系方式; avatar实际上是想存储UIImage类型,对应学生的头像。

Students.xcdatamodel

如果我们不指定NSValueTransformer的名字,Core Data 会默认使用
NSKeyedUnarchiveFromDataTransformerName来注册一个transformer,它实际上用archivedDataWithRootObject:unarchiverObjectWithData:方法来做类型转换。使用这个默认的transformer的非标准数据类型必须实现 NSCoding 协议,才能将其实例序列化为 NSData,并且进行存取。所以对于那些支持用NSKeyedArchiver转化并且实现了NSCoding协议的类型就可以直接使用默认的transformer了,比如NSDictionary、NSArrary等。
但是,对于一些不能直接用NSKeyedArchiver转换的非标准类型就不可以直接使用默认的transformer了,比如UIImage需要借助UIImagePNGRepresentation方法转换为NSData进行归档。此时,我们就需要自定义一个NSValueTransformer实例,并且重载几个关键的方法。

If you specify a custom transformer, it must transform an instance of the non-standard data type into an instance of NSData and support reverse transformation.

首先,我们如上图所示,对avatar属性的Value Transformer取个名字,比如UIIMageToNSDataTransformer, 那在对应的studentEntity.h文件中,我们定义一个UIIMageToNSDataTransformer类继承自NSValueTransformer。

// studentEntity.h
@interface StudentEntity : RHManagedObject
@property (nonatomic,strong) NSNumber *sid;
@property (nonatomic,strong) NSString *name;
@property (nonatomic,strong) NSNumber *age;
@property (nonatomic,strong) id       courses;//dictionary
@property (nonatomic,strong) id       scores;//array
@property (nonatomic,strong) id       avatar;//image;
@property (nonatomic,strong) id       contact;//custom class
@end

@interface UIIMageToNSDataTransformer: NSValueTransformer

@end

在studentEntity.m文件中重载几个方法:

+ (Class)transformedValueClass {
    return [NSData class];
}
+ (BOOL)allowsReverseTransformation {
    return YES;
}
- (id)transformedValue:(id)value
{
    if (value == nil) {
        return nil;
    }
    if ([value isKindOfClass:[NSData class]]) {
        return value;
    }
    return UIImagePNGRepresentation((UIImage *)value);
}
- (id)reverseTransformedValue:(id)value
{
    return [UIImage imageWithData:(NSData *)value];
}

这样,就可以像NSDictionary一样简便地存取UIImage属性值了。

另外,对于我们自定义的Contact类型,要想使用这种转化,必须要实现NSCoding协议,既实现:

- (void)encodeWithCoder:(NSCoder *)aCoder;
- (nullable instancetype)initWithCoder:(NSCoder *)aDecoder; 

这两个方法。我们这样做:

@interface Contact : NSObject <NSCoding>

@property (nonatomic, strong) NSString  *addr;
@property (nonatomic, strong) NSString  *phone;
@property (nonatomic, assign) NSInteger qq;

@end

@implementation Contact

- (instancetype)initWithCoder:(NSCoder *)aDecoder
{
    self = [super init];
    if (self) {
        _addr   = [aDecoder decodeObjectForKey:@"addr"];
        _phone  = [aDecoder decodeObjectForKey:@"phone"];
        _qq     = [aDecoder decodeIntegerForKey:@"qq"];
    }
    return self;
}

- (void)encodeWithCoder:(NSCoder *)aCoder {
    [aCoder encodeObject:_addr forKey:@"addr"];
    [aCoder encodeObject:_phone forKey:@"phone"];
    [aCoder encodeInteger:_qq forKey:@"qq"];
}

@end

至此,我们就可以很方便地存取上面所有的数据了,而不用每次手动转化了。

- (instancetype)initWithModel:(StudentModel *)model
{
    self = [super init];
    if (self) {
        self.sid    = model.sid;
        self.name   = model.name;
        self.age    = model.age;
        self.avatar = model.avatar;//直接赋值,不需转化
        self.courses = model.courses;//直接赋值,不需转化
        self.scores  = model.scores;//直接赋值,不需转化
        self.contact = model.contact;//直接赋值,不需转化
    }
    return self;
}

- (void)setModel:(StudentModel *)model {
    model.sid   = self.sid;
    model.name  = self.name;
    model.age   = self.age;
    model.avatar = self.avatar;//直接赋值,不需转化
    model.courses = self.courses;//直接赋值,不需转化
    model.scores  = self.scores;//直接赋值,不需转化
    model.contact = self.contact;//直接赋值,不需转化
}

我们先测试写入数据:


StudentProfile *profile = [[StudentProfile alloc] init];
profile.sid     = @(1001);
profile.name    = @"小明";
profile.age     = @(12);
profile.courses = [NSMutableArray arrayWithObjects:kCourseYuwen,kCourseShuxu,kCourseYinyu, nil];
profile.avatar  = [UIImage imageNamed:@"default_avatar"];
profile.scores  = [NSMutableDictionary dictionary];
[profile.scores setObject:@(80) forKey:kCourseYuwen];
[profile.scores setObject:@(91) forKey:kCourseShuxu];
[profile.scores setObject:@(88) forKey:kCourseYinyu];
    
profile.contact = [Contact new];
profile.contact.addr = @"希望小学3年2班";
profile.contact.phone = @"188-1221-3309";
profile.contact.qq = 1033294537;
//save data
[[_Dao getStudentDao] saveStudentProfile:profile commit:YES];

然后读取数据:

NSArray *students = [[_Dao getStudentDao] loadAll];
    
for (StudentProfile *student in students) {
    NSLog(@"==========ID  :%@==========",student.sid);
    NSLog(@"==========NAME:%@==========",student.name);
    NSLog(@"==========AGE :%@==========",student.age);
    for (id key in student.scores) {
        NSString *course = key;
        NSLog(@"==========%@ :%@分==========",course,[student.scores objectForKey:key]);
    }
    NSLog(@"==========ADDR :%@==========",student.contact.addr);
    NSLog(@"==========PHONE:%@==========",student.contact.phone);
    NSLog(@"==========QQ   :%ld==========",student.contact.qq);

    UIImage *avatar = student.avatar;
    NSLog(@"==========AVATAR :%@==========",avatar);
}

输入结果:

==========ID  :1001==========
==========NAME:小明==========
==========AGE :12==========
==========语文 :80分==========
==========数学 :91分==========
==========英语 :88分==========
==========ADDR :希望小学3年2班==========
==========PHONE:188-1221-3309==========
 ==========QQ  :1033294537==========
==========AVATAR :<UIImage: 0x60000009cf20>, {60, 48}==========

如果我们不自定义UIIMageToNSDataTransformer的,avatar输出是NULL,既存取失败的。如果Contact不实现NSCoding协议,程序会crash的。

BTW:使用自定义的 transformer 还可以引申出另一个应用,就是可以用于对 entity 中某个 attribute 进行加密/解密,用自定义的加密/解密算法。单独对某个 attribute 进行加密/解密,可以避免对整个 entity 甚至是整个 database 进行加密/解密,提高了性能,降低了内存消耗。

更深入的学习可以参考 TransformerKit库

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 158,847评论 4 362
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 67,208评论 1 292
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 108,587评论 0 243
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 43,942评论 0 205
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,332评论 3 287
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,587评论 1 218
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,853评论 2 312
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,568评论 0 198
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,273评论 1 242
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,542评论 2 246
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,033评论 1 260
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,373评论 2 253
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,031评论 3 236
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,073评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,830评论 0 195
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,628评论 2 274
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,537评论 2 269

推荐阅读更多精彩内容

  • *面试心声:其实这些题本人都没怎么背,但是在上海 两周半 面了大约10家 收到差不多3个offer,总结起来就是把...
    Dove_iOS阅读 27,036评论 29 470
  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,100评论 18 139
  • 发现 关注 消息 iOS 第三方库、插件、知名博客总结 作者大灰狼的小绵羊哥哥关注 2017.06.26 09:4...
    肇东周阅读 11,612评论 4 59
  • 1.自定义控件 a.继承某个控件 b.重写initWithFrame方法可以设置一些它的属性 c.在layouts...
    圍繞的城阅读 2,958评论 2 4
  • 湛蓝的大海,乘浪前行的海豚,迎面吹来的海风。 站在船头的老人转身,娓娓道来: “看似无边无际的海洋,让我们心生敬畏...
    杀杀君阅读 977评论 4 15