MagicalRecord的使用

2016-01-07

创建数据库

1. 首先分析清楚自己需要什么

我的目的是要缓存信件列表界面，新建列表界面的model就是letter，所以我需要一个Letter的实体(entity)，那这个Letter有哪些属性呢？写信的人(sender)、信的内容(content)、信的时间(dateString)、信的已读未读状态(isRead)、发信还是收信(incoming)；所以我Letter的entity创建之后是这样：

这样就好了吗，并没有，如果是普通的展示界面，只有letter的实体，这样就足够了；但是对于我的这个项目来说，是展示信件的，是比较私人的，我缓存的信件列表应该只有我能看到，如果别人在我的手机上登陆了呢？因为我没有做区分，所以，当他登入的时候，他能看到我的数据，因为数据是缓存在手机上的！

所以，我需要一个User的Entity，这个User的Entity的目的是：跟Letter绑定，保证每个人都看到自己应该看到的；user有两个attribute：accout和writeName，(正常情况下应该是uid，但是我的这个是比较简单，所以没有uid)；

紧接着问题是，Letter和User之间Relationships，是一对一还是一对多，我的每个letter都应该有一个user，并且只有一个user，但是我一个user应该有很多letter，当我从数据库获取letter的时候，其实就是拿着user去查找的，当我user跟letter是一对一的话，那我就只能取出一封信，明显是不对的。

结论：我的数据库，有两个Entity，一个是Letter，一个是User；Letter和User的Relationships的type是一对一，User和Letter的Relationships的type是一对多；

2. 然后导入MagicalRecord

我之前缓存数据一直都是使用的FMDB，没用过CoreData，但是当我在拆分成彻底的MVC的时候，我总是希望我可以直接拿着这个model就可以存储，取出来就是model，就可以直接使用，而不是一个个属性，再重新赋值，所以我就想尝试一下CoreData；但原生的太复杂，所以就选择MagicalRecord。

MagicalRecord的使用: github上只有各个方法的使用，但是我没找到Demo，所以我把我是如何使用的贴出来，仅供参考

在pch文件里，导入头文件
a. 在applicationDidFinishLaunchingWithOptions:里初始化

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
    // Override point for customization after application launch.
    self.window = [[UIWindow alloc] initWithFrame:[UIScreen mainScreen].bounds];
    
    [MagicalRecord setupAutoMigratingCoreDataStack];    
    // 设置window的rootViewController
    [self setupWindowRootViewController];

    return YES;
}

b. 在程序停止时，调用cleanup方法

- (void)applicationWillTerminate:(UIApplication *)application {
    // Called when the application is about to terminate. Save data if appropriate. See also applicationDidEnterBackground:.
    [MagicalRecord cleanUp];
}

c. 生成model类
选中.xcdatamodeld文件，CMD+N，

全部勾选，然后生成model类

d. 网络请求成功后，顺便保存数据

// 将letter保存到数据库
- (void)saveLetterWithLetterEntity:(LetterEntity *)tempLetter {
    // MagicalRecord保存的方法，不是主线程
    [MagicalRecord saveWithBlock:^(NSManagedObjectContext *localContext) {
       // 首先，通过pkNumber查询，得到letter
       // 如果letter不存在，则创建
       // 赋值保存，注意这里的user.lettters是NSSet，因为
        Letter *letter = [Letter MR_findFirstByAttribute:@"pkNumber" withValue:tempLetter.pkNumber inContext:localContext];
        if (!letter) {
            // 创建letter
            letter = [Letter MR_createEntityInContext:localContext];
            User *user = [User MR_createEntityInContext:localContext];
            letter.user = user;
        }
        letter.dateString = tempLetter.letterDateString;
        letter.content = tempLetter.letterContent;
        letter.sender = tempLetter.letterSender;
        letter.pkNumber = tempLetter.pkNumber;
        letter.incoming = [NSNumber numberWithBool:tempLetter.incoming];
        // 收信默认为未读，发信默认都是已读
        if (tempLetter.incoming) {
            // 收信
            letter.isRead = [NSNumber numberWithBool:NO];
        }
        else {
            letter.isRead = [NSNumber numberWithBool:YES];
        }
        
        letter.user.writeName = [[NSUserDefaults standardUserDefaults] objectForKey:k_WRITENAME];
        letter.user.account = [[NSUserDefaults standardUserDefaults] objectForKey:k_USERNAME];
        if (_letters == nil) {
            _letters = [NSMutableArray array];
        }
        [_letters addObject:letter];
        letter.user.letters = [NSSet setWithArray:_letters];
    } completion:^(BOOL contextDidSave, NSError *error) {
        DLog(@"=-===%@", (contextDidSave ? @"saveSuccessed" : @"saveFailure"));
    }];
}

e. 网络失败时从数据库获取数据

- (NSMutableArray *)lettersFromDataBase {

    NSMutableArray *receiveArray = [NSMutableArray array];
    NSMutableArray *sendArray = [NSMutableArray array];
    
    NSString *account = [[NSUserDefaults standardUserDefaults] objectForKey:k_USERNAME];
    User *user = [[User MR_findByAttribute:@"account" withValue:account] firstObject];

//    NSPredicate *receivePredicate = [NSPredicate predicateWithFormat:@"incoming == %@ && user == %@", [NSNumber numberWithBool:YES], user];
//    NSPredicate *sendPredicate = [NSPredicate predicateWithFormat:@"incoming == %@ && user == %@", [NSNumber numberWithBool:NO], user];
//    receiveArray = [NSMutableArray arrayWithArray:[Letter MR_findAllWithPredicate:receivePredicate]];
//    sendArray = [NSMutableArray arrayWithArray:[Letter MR_findAllWithPredicate:sendPredicate]];

    
    NSArray *userLetters = [Letter MR_findByAttribute:@"user" withValue:user];
    if (userLetters) {
        for (int i = 0; i < userLetters.count; i++) {
            Letter *tempLetter = userLetters[i];
            LetterEntity *tempEntity = [[LetterEntity alloc] init];
            tempEntity.letterContent = tempLetter.content;
            tempEntity.letterDateString = tempLetter.dateString;
            tempEntity.letterSender = tempLetter.sender;
            tempEntity.pkNumber = tempLetter.pkNumber;
            tempEntity.incoming = [tempLetter.incoming boolValue];

            if ([tempLetter.incoming boolValue]) {
                [receiveArray addObject:tempEntity];
            }
            else {
                [sendArray addObject:tempEntity];
            }
        }
    }
    // 这里的顺序不能错，sendArray在前，receiveArray在后面
    NSMutableArray *resultArray = [NSMutableArray arrayWithObjects: sendArray, receiveArray, nil];
    return resultArray;
}

参考

深入浅出MagicalRecord，这篇博客讲的很详细，从CoreData到MagicalRecord
RayWenderlich的MagicalRecord Tutorial，这篇是教程，可以跟着敲，练习