在 Realm Studio 中修改模式
Overview
Realm Studio 为您提供了对模式进行非破坏性变更 (non-breaking change)的工具。您可以:
重要
如果您在 Realm Studio 中对模式进行更改,则在客户端应用程序中使用 Realm 文件时,您必须迁移 Realm 文件。
进行模式更改后,您可以在 Realm Studio 中为新属性和类添加值。 您还可以根据新的类和属性创建新对象。 这为您提供了一个图形用户界面 (GUI) 工具来试验模式更改,直到获得所需的Realm 对象模型。
完成更改后,您可以从Realm Studio导出模型定义。 这将为您提供所选语言的新类定义,您可以将其放入代码中。
您还可以保存域文件的更新版本以在应用中使用。 当您保存具有更新模式的域文件时,您必须执行迁移才能在应用中使用它。
向模式添加类
要将新类添加到模式中,请执行以下操作:
按 Realm Studio 窗口左上角Classes标题旁边的 +按钮
为新类命名
指定主键(可选)
按Add class按钮
现在,您将在左侧边栏显示的班级列表中看到一个新班级。
向类添加属性
要为类添加属性,请执行以下操作:
在左侧边栏中选择要添加属性的类
按下 Realm Studio 窗口右上角Create {Class Name}按钮下的+按钮
为新属性命名
从下拉选择器中为新属性选择类型
如果需要,单击复选框选择Make this a list of strings和Optional: Allow a null value
按Add property按钮
您将看到新属性与其他类属性一起显示。
如果您的类中已经有对象,则可以通过单击每个值的属性字段来添加此属性的值。 如果这是一个没有对象的新类,则可以在该类中创建新对象。
保存模型定义
更改模式后,可以将新模式导出为类定义。
要导出更新的类定义,请执行以下操作:
转到 File > Save model definitions,选择您的首选语言。支持的语言包括:Swift、JavaScript、TypeScript、Java、Kotlin 和 C# 等。
指定新类定义的名称和目的地。按 Save 按钮。
如果目标目录不存在,Realm Studio 将创建它。在该目标目录中,你会发现一个包含完整的类和属性列表的文件,其中包括新添加的内容。
这是一个用于迭代模式的绝佳工具。 您还可以导出多种语言的类定义,以进行跨平台开发。
执行迁移
更改模式后,您可以向新属性添加值,甚至创建新对象。 如果您想在应用程序中使用此更新的 Realm 文件,则可以将数据保存为。 不过,在客户端应用程序中使用它之前,您需要执行迁移。
Realm 要求您在更改模式时单调递增版本。 如果您尝试在不迁移的情况下使用更新的对象模式打开域,您的客户端将抛出错误。
有关如何完成此迁移的说明,请参阅 SDK 的迁移指南。