UWP使用Realm数据库

Realm数据库是SQLite、Core Data的替代品，跨平台、支持加密、更快的执行效率，不用写sql。

安装Realm

使用VS新建一个UWP项目，右键解决方案资源管理器中项目节点下的的引用节点，选择管理Nuget程序包，打开NuGet包管理器。切换到浏览标签，搜索Realm，选择第一项Realm，点击右侧的安装。

uwp_realm_01.png

创建 FodyWeavers.xml 文件

在项目中，新建一个xml文件，命名为FodyWeavers.xml，文件属性保持默认，内容如下：

<?xml version="1.0" encoding="utf-8" ?>
<Weavers>
    <RealmWeaver />
</Weavers>

The Realm package contains everything you need to use Realm. It depends on Fodyweaver, responsible for turning your RealmObject subclasses into persisted ones.

创建至少一个RealmObject派生类

class User: RealmObject
{
    [Realms.PrimaryKey]
    public int Id { get; set; }
    public string Name { get; set; }
    public int Age { get; set; }
}

class Book : RealmObject
{
    [Realms.PrimaryKey]
    public int Id { get; set; }
    public string Name { get; set; }
}

Realm数据库基本操作

//对Realm数据库进行配置，Test.relam为数据库文件名
var config = new RealmConfiguration("Test.realm");
//打印一下这个数据库文件实际的保存路径
System.Diagnostics.Debug.WriteLine($"{Windows.Storage.ApplicationData.Current.LocalFolder.Path}\\Test.relam");
//设置数据库中的表对应的实体类，这里设置数据库只有一个User表；如果不设置，默认所有派生自RealmObject的类都会在该数据库中生成对应表 
config.ObjectClasses = new Type[] { typeof(User) };
//设置数据库加密密码，长度为固定的64 bytes
//config.EncryptionKey = new byte[64]
    //{
    //    0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08,
    //    0x11, 0x12, 0x13, 0x14, 0x15, 0x16, 0x17, 0x18,
    //    0x21, 0x22, 0x23, 0x24, 0x25, 0x26, 0x27, 0x28,
    //    0x31, 0x32, 0x33, 0x34, 0x35, 0x36, 0x37, 0x38,
    //    0x41, 0x42, 0x43, 0x44, 0x45, 0x46, 0x47, 0x48,
    //    0x51, 0x52, 0x53, 0x54, 0x55, 0x56, 0x57, 0x58,
    //    0x61, 0x62, 0x63, 0x64, 0x65, 0x66, 0x67, 0x68,
    //    0x71, 0x72, 0x73, 0x74, 0x75, 0x76, 0x77, 0x78
    //};
//获取Relam实例
var realm = Realm.GetInstance(config);

//插入记录
var mandUser = new User() { Id = 3, Name = "Mandarava", Sex = "M" };            
realm.Write(() =>
{
    realm.Add<User>(new User() { Id = 1, Name = "Tom", Sex = "M" });
    realm.Add<User>(new User() { Id = 2, Name = "Jerry", Sex = "F" });
    realm.Add<User>(mandUser);
    realm.Add<User>(new User() { Id = 4, Name = "Jack", Sex = "M" });
});

//更新记录
realm.Write(() => {
    //更新mandUser的Sex字段
    mandUser.Sex = "男";
    //更新mandUser //因为这里的new User的Id=3,mandUser的Id也是3，Id是PrimaryKey，所以这里仍然更新mandUser
    realm.Add<User>(new User() { Id = 3, Name = "鳗驼螺", Sex = "Male" }, true); 
}); 

//查询记录
var users = realm.All<User>().Where(user => user.Sex == "M");
foreach(var user in users)
{
    System.Diagnostics.Debug.WriteLine($"{user.Id}\t{user.Name}\t{user.Sex}");
}

//删除记录
realm.Write(() =>{
    //删除指定的记录
    realm.Remove(mandUser);
    //删除满足条件的一组记录
    var dusers = realm.All<User>().Where(user => user.Sex == "M");
    realm.RemoveRange<User>(dusers);
});

注：Realm.Write方法都是基于事务处理的。

No RealmObjects 错误

如果在运行时出现下面的错误：

System.InvalidOperationException:“No RealmObjects. Has linker stripped them? See https://realm.io/docs/xamarin/latest/#linker-stripped-schema”

如果没有在项目中写任何RelamObject派生类，就会出现这个问题。实际上是config.ObjectClasses没有设置造成的。所以，至少需要创建一个RelamObject的派生类。

Relam数据库管理工具

可以使用 Realm Studio 管理数据库文件，它是官方提供的一个跨平台Realm数据库管理工具。

参考

1. Getting Started