Realm
安装方式
- cocoapods(推荐):
1.[安装CocoaPods 0.39.0 或者更高版本]
2.运行 pod repo update,以确保 CocoaPods 能够获取到Realm 的最新版本
3.在您的Podfile中,添加pod 'Realm'到您的 app 目标中,添加pod 'Realm/Headers'到您的测试目标中;
4.在终端运行pod install;
5.采用 CocoaPods 生成的.xcworkspace来运行工程!
6.如果需要在 Swift 当中使用的话,将于 Swift/RLMSupport.swift 的这个文件拖动到您 Xcode 项目的文件导航器当中,检查以确保 **Copy items if needed** 选项已被勾选。
- Static Framework:
1.下载Realm 的最新版本并解压;
2.将 Realm.framework 从 ios/static/文件夹拖曳到您 Xcode 项目中的文件导航器当中。确保 **Copy items if needed** 选中然后单击 **Finish**;
3.在 Xcode 文件导航器中选择您的项目,然后选择您的应用目标,进入到** Build Phases** 选项卡中。在 **Link Binary with Libraries** 中单击 + 号然后添加 **libc++.tbd** 以及 **libz.tbd**;
4.如果你在用 Swift 来使用 Realm,那么将位于 Swift/RLMSupport.swift
的文件拖曳进您 Xcode 项目中的文件导航器当中,确保 **Copy items if needed** 选中。
Realm浏览器/数据库管理器
- 在
mac
的Appstore
下载一款名为Realm Browser
的软件即可进行管理
Xcode插件,快速创建RLMObject对象
点击下载release zip ,解压以后打开plugin/RealmPlugin.xcodeproj
进行编译,重启Xcode,command + N
,拉倒底部,出现一个Realm Model Object
的图标,点击即可创建RLMObject
对象
创建数据模型
创建一个数据模型,并创建参数
// .h
#import <Realm/Realm.h>
@interface Student : RLMObject
@property NSInteger *age; // 年龄
@property NSInteger *num; // 学号
@property NSString *name; // 名字
@end
注意事项:由于Realm
在自己的引擎内部有很好的语义解释系统,所以 Objective‑C
的许多属性特性将被忽略,如nonatomic
, atomic
, strong
, copy
和 weak
等。 因此为了避免误解,我们推荐您在编写数据模型的时候不要使用任何的属性特性
生成主键
// .m
#import "Student.h"
@implementation Data
+ (NSString *)primaryKey {
return @"num"; // 学号唯一,并成为数据库的主键
}
@end
忽略属性(Ignored Properties)
重写 +ignoredProperties
可以防止Realm
存储数据模型的某个属性。Realm
将不会干涉这些属性的常规操作,它们将由成员变量(ivar
)提供支持,并且您能够轻易重写它们的 setter
和 getter
@interface Person : RLMObject
@property NSInteger tmpID;
@property (readonly) NSString *name; // 只读属性将被自动忽略
@property NSString *firstName;
@property NSString *lastName;
@end
@implementation Person
+ (NSArray *)ignoredProperties {
return @[@"tmpID"];
}
- (NSString *)name {
return [NSString stringWithFormat:@"%@ %@", self.firstName, self.lastName];
}
@end
属性默认值
重写+defaultPropertyValues可以在每次对象创建之后为其提供默认值
@interface Book : RLMObject
@property float price;
@property NSString *title;
@end
@implementation Book
+ (NSDictionary *)defaultPropertyValues {
return @{@"price" : @0, @"title": @""};
}
@end
创建嵌套数据模型
数据结构:Person
具有name
、birthdate
、dogs
,Dog
具有name
、owner< Person >
。
// .h
#import <Realm/Realm.h>
@class Person;
// 狗狗的数据模型
@interface Dog : RLMObject
@property NSString *name;
@property Person *owner;
@end
RLM_ARRAY_TYPE(Dog) // 定义RLMArray<Dog>
// 狗狗主人的数据模型
@interface Person : RLMObject
@property NSString *name;
@property NSDate *birthdate;
// 通过RLMArray建立关系
@property RLMArray<Dog> *dogs;
@end
RLM_ARRAY_TYPE(Person) // 定义RLMArray<Person>
// .m
@implementation Dog
@end // 暂无使用
@implementation Person
@end // 暂无使用
使用Realm数据模型
Dog *myDog = [[Dog alloc] init];
myDog.name = @"myDog";
Dog *yourDog = [[Dog alloc] init];
yourDog.name = @"yourDog";
Person *me = [[Person alloc] initWithValue:@[@"crylown",[NSDate dateWithTimeIntervalSinceNow:1],@[myDog,yourDog]]];
yourDog.owner = me;
myDog.owner = me;
使用Realm进行数据管理
realm transactionWithBlock:^{
// 进行数据处理
}];
添加数据
RLMRealm *realm = [RLMRealm defaultRealm];
realm transactionWithBlock:^{
// 添加到数据库 me为RLMObject
[realm addObject:me];
}];
查询数据
数据库查询
// 查询默认的 Realm 数据库
RLMResults *dogs = [Dog allObjects]; // 从默认的 Realm 数据库中,检索所有狗狗
- 如果有需要,也可以查询指定的数据库
// 查询指定的 Realm 数据库
RLMRealm *petsRealm = [RLMRealm realmWithPath:@"pets.realm"]; // 获得一个指定的 Realm 数据库
RLMResults *otherDogs = [Dog allObjectsInRealm:petsRealm]; // 从该 Realm 数据库中,检索所有狗狗
- 使用断言字符串查询:
RLMResults *tanDogs = [Dog objectsWhere:@"color = '棕黄色' AND name BEGINSWITH '大'"];
- 链式查询
如果我们想获得获得棕黄色狗狗的查询结果,并且在这个查询结果的基础上再获得名字以“大”开头的棕黄色狗狗。
RLMResults *tanDogs = [Dog objectsWhere:@"color = '棕黄色'"];
RLMResults *tanDogsWithBNames = [tanDogs objectsWhere:@"name BEGINSWITH '大'"];
修改数据
如果您的数据模型中设置了主键的话,那么您可以使用+[RLMObject createOrUpdateInRealm:withValue:]
来更新对象,或者当对象不存在时插入新的对象。
// 创建一个带有主键的“书籍”对象,作为事先存储的书籍
Book *cheeseBook = [[Book alloc] init];
cheeseBook.title = @"奶酪食谱";
cheeseBook.price = @9000;
cheeseBook.id = @1;
// 通过 id = 1 更新该书籍
[realm beginWriteTransaction];
[Book createOrUpdateInRealm:realm withValue:cheeseBook];
[realm commitWriteTransaction];
删除数据
- 删除某个在Realm数据库中的数据。
Book *cheeseBook = ... // 存储在 Realm 中的 Book 对象
// 在事务中删除一个对象
[realm beginWriteTransaction];
[realm deleteObject:cheeseBook];
[realm commitWriteTransaction];
- 删除数据库中的所有数据。
// 从 Realm 中删除所有数据
[realm beginWriteTransaction];
[realm deleteAllObjects];
[realm commitWriteTransaction];
数据排序
RLMResults
允许您指定一个排序标准,从而可以根据一个或多个属性进行排序。比如说,下列代码将上面例子中返回的狗狗根据名字升序进行排序:
// 排序名字以“大”开头的棕黄色狗狗
RLMResults *sortedDogs = [[Dog objectsWhere:@"color = '棕黄色' AND name BEGINSWITH '大'"]
sortedResultsUsingProperty:@"name" ascending:YES];
数据库配置
一般地,我们使用的为默认的Realm数据库,即调用[RLMRealm defaultRealm]来初始化以及访问我们的realm变量
RLMRealm *realm = [RLMRealm defaultRealm];
Realm配置
- 每个用户有自己不同的数据库,在App启动以后根据用户的uid来设置数据库,可以通过对默认配置进行更改,然后通过访问默认数据库来实现不同用户不同数据库.
- 因为设置了模型插入数据库以后如果发生属性更改,需要进行版本迁移.可以使用app的版本作为数据库的版本,当版本迭代发生以后,改了模型的属性,通过更改App的版本号实现版本迁移.
// 版本迁移和配置数据库基本数据
- (void)setRealmMigration:(NSString *)username{
RLMRealmConfiguration *config = [RLMRealmConfiguration defaultConfiguration];
// BTLog(@"%@---",config.fileURL);
// 使用默认的目录,但是使用用户名来替换默认的文件名
config.fileURL = [[[config.fileURL URLByDeletingLastPathComponent]
URLByAppendingPathComponent:username ? username : @"defalut"]
URLByAppendingPathExtension:@"realm"];
// 将这个配置应用到默认的 Realm 数据库当中
[RLMRealmConfiguration setDefaultConfiguration:config];
// 设置新的架构版本。这个版本号必须高于之前所用的版本号(如果您之前从未设置过架构版本,那么这个版本号设置为 0)
NSDictionary *infoDic = [[NSBundle mainBundle] infoDictionary];
NSString *appVersion = [infoDic objectForKey:@"CFBundleShortVersionString"];
uint64_t schemaVersion = appVersion.floatValue;
config.schemaVersion = schemaVersion;
// 设置闭包,这个闭包将会在打开低于上面所设置版本号的 Realm 数据库的时候被自动调用
config.migrationBlock = ^(RLMMigration *migration, uint64_t oldSchemaVersion) {
// 目前我们还未进行数据迁移,因此 oldSchemaVersion == 0
if (oldSchemaVersion < schemaVersion) {
// 什么都不要做!Realm 会自行检测新增和需要移除的属性,然后自动更新硬盘上的数据库架构
}
};
// 告诉 Realm 为默认的 Realm 数据库使用这个新的配置对象
[RLMRealmConfiguration setDefaultConfiguration:config];
// 现在我们已经告诉了 Realm 如何处理架构的变化,打开文件之后将会自动执行迁移
[RLMRealm defaultRealm];
// realm文件的位置
BTLog(@"fileurl===%@",[RLMRealmConfiguration defaultConfiguration].fileURL);
}