对象

@objc(RealmSwiftObject)
open class Object : RLMObjectBase, RealmCollectionValue
extension Object: ObservableObject
extension Object: RealmSubscribable
extension Object: ThreadConfined

Object 是用于定义 Realm 模型对象的类。

在 Realm 中，您可以通过子类化Object并添加要托管的属性来定义模型类。 然后，实例化并使用自定义子类，而不是直接使用Object类。

class Dog: Object {
    @objc dynamic var name: String = ""
    @objc dynamic var adopted: Bool = false
    let siblings = List<Dog>()
}

支持的属性类型

StringNSString 、 Date 、 NSDate 、 Data 、 NSData 、 Decimal128和ObjectId属性可以声明为可选。 Object和EmbeddedObject子类必须声明为可选。 Int 、 Int8 、 Int16 、 Int32 、 Int64 、 Float 、 Double 、 Bool 、枚举和List属性不能。 要存储可选数字，请改用RealmOptional<Int> 、 RealmOptional<Float> 、 RealmOptional<Double>或RealmOptional<Bool> ，它们会包装一个可选数值。 列表根本不能是可选的。

除List和RealmOptional之外的所有属性类型都必须声明为@objc dynamic var 。 List和RealmOptional属性必须声明为非动态let属性。 不允许使用 Swift lazy属性。

请注意，上面列出的任何限制都不适用于配置为被 Realm 忽略的属性。

查询

您可以通过调用objects(_:)实例方法从 Realm 中检索给定类型的所有对象。

关系

有关更多详细信息，请参阅我们的Cocoa 指南。

初始化器

  • 创建 Realm 对象的非托管实例。

    对Realm实例调用add(_:) ，以将非托管对象添加到该 Realm 中。

    看

    Realm().add(_:)

    声明

    Swift

    public override required init()
    在 GitHub 上显示

  • 创建 Realm 对象的非托管实例。

    value参数用于填充对象。 它可以是键值编码兼容对象、从NSJSONSerialization中的方法返回的数组或字典，或者是包含每个托管属性一个元素的Array 。 如果任何必需属性不存在且未为这些属性定义默认值，则会引发异常。

    传入Array作为value参数时，所有属性都必须存在、有效，并且顺序与模型中定义的属性相同。

    对Realm实例调用add(_:) ，以将非托管对象添加到该 Realm 中。

    声明

    Swift

    public convenience init(value: Any)

    参数

    value

    用于填充对象的值。
    在 GitHub 上显示

属性

  • 托管对象的 Realm，如果对象为非托管对象，则为nil 。

    声明

    Swift

    public var realm: Realm? { get }
    在 GitHub 上显示

  • 列出对象的托管属性的对象模式。

    声明

    Swift

    public var objectSchema: ObjectSchema { get }
    在 GitHub 上显示

  • 指示对象是否因现已无效而无法再访问。

    如果对象已从托管它的 Realm 中删除，或者对该 Realm 调用了invalidate() ，则无法再访问该对象。该属性是键值可观察的。

    声明

    Swift

    @objc
dynamic open override var isInvalidated: Bool { get }
    在 GitHub 上显示

  • 对象的人类可读描述。

    声明

    Swift

    open override var description: String { get }
    在 GitHub 上显示

对象定制

  • 重写此方法以指定用作主键的属性名称。

    只有类型为String和Int的属性才能指定为主键。每当设置属性时，主键属性都会为每个值强制唯一性，这会产生少量开销。 系统会自动为主键属性创建索引。

    声明

    Swift

    @objc
open class func primaryKey() -> String?

    返回值

    指定为主键的属性名称；如果模型没有主键，则为nil 。

    在 GitHub 上显示

  • 重写此方法以指定要忽略的属性的名称。 这些属性不会由托管该对象的 Realm 进行托管。

    声明

    Swift

    @objc
open class func ignoredProperties() -> [String]

    返回值

    要忽略的属性名称数组。

    在 GitHub 上显示

  • 返回应编制索引的属性的属性名称数组。

    仅支持字符串、整数、布尔值、 Date和NSDate属性。

    声明

    Swift

    @objc
open class func indexedProperties() -> [String]

    返回值

    属性名称数组。

    在 GitHub 上显示

键值编码和下标

通知

  • 注册一个区块，以便在每次对象更改时调用。

    在每次写事务（write transaction）删除对象或修改对象的任何托管属性（包括将属性设置为其现有值的自分配）后，将异步调用该块。

    对于在不同线程或不同进程中执行的写事务（write transaction），当管理 Realm（自动）刷新到包含更改的版本时，将调用该区块，而对于本地写事务（write transaction），将在提交写事务（write transaction）后的未来某个时间点调用该区块。

    如果未指定队列，则将通过标准事件循环传递通知，因此当事件循环被其他活动阻塞时无法传递通知。如果给出了队列，则将通知传递到该队列。 当无法立即传递通知时，可以将多个通知合并为一个通知。

    与List和Results不同，添加新的通知块后，不会执行“初始”回调。

    只有由 Realm 托管的对象才能以这种方式进行观察。只要您希望将更新发送到区块，就必须保留返回的令牌。 要停止接收更新，请对令牌调用invalidate() 。

    在回调块中捕获对观察到的对象的强引用是安全的。 由于回调由返回的令牌而不是对象本身保留，因此不存在保留周期。

    警告

    在写事务（write transaction）期间或当包含的 Realm 为只读时，无法调用此方法。

    声明

    Swift

    public func observe<T: Object>(on queue: DispatchQueue? = nil,
                               _ block: @escaping (ObjectChange<T>) -> Void) -> NotificationToken

    参数

    queue

    用于接收通知的串行调度队列。 如果为nil ，则通知将传递到当前线程。
    block

    要调用的区块，其中包含有关对象更改的信息。

    返回值

    只要您希望传递更新，就必须持有的令牌。

    在 GitHub 上显示

对比

  • 返回两个 Realm 对象是否相同。

    当且仅当对象由同一个 Realm 托管并指向数据库中的同一个底层对象时，对象才被视为相同。

    注意

    相等比较由isEqual(_:)实施。 如果 Realm 对象类型是使用主键定义的，则isEqual(_:)的行为与此方法相同。如果未使用主键定义 Realm 对象类型，则isEqual(_:)将使用比较对象身份的NSObject行为。此方法可用于比较两个对象在数据库中的相等性，无论它们的Realm 对象类型是否定义了主键。

    声明

    Swift

    public func isSameObject(as object: Object?) -> Bool

    参数

    object

    与接收器进行比较的对象。
    在 GitHub 上显示

对象

  • 每次对象更改时发出 Void 的发布者。

    尽管有这个名称，但它实际上是在collection发生更改后发出的。

    声明

    Swift

    public var objectWillChange: RealmPublishers.WillChange<Object> { get }
    在 GitHub 上显示

  • 指示此对象是否已冻结。

    看

    Object.freeze()

    声明

    Swift

    public var isFrozen: Bool { get }
    在 GitHub 上显示

  • 返回此对象的冻结（不可变）快照。

    冻结副本是一个不可变对象，其中包含与该对象当前包含的数据相同的数据，但在写入包含的 Realm 时不会更新。 与活动对象不同，冻结对象可以从任何线程访问。

    警告

    在 Realm 上执行写事务（write transaction）时长时间持有冻结对象可能会导致 Realm 文件变大。有关更多信息，请参阅Realm.Configuration.maximumNumberOfActiveVersions 。

    警告

    此方法只能在托管对象上调用。

    声明

    Swift

    public func freeze() -> Self
    在 GitHub 上显示