객체

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

Object Realm 모델 객체를 정의하는 데 사용되는 클래스입니다.

Realm에서는 Object 을(를) 서브클래스화하고 managed 속성을 추가하여 모델 클래스를 정의합니다. 그런 다음 Object 클래스를 직접 사용하는 대신 사용자 지정 하위 클래스를 인스턴스화하여 사용합니다.

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

지원되는 속성 유형

  • String, NSString
  • Int
  • Int8, Int16, Int32, Int64
  • Float
  • Double
  • Bool
  • Date, NSDate
  • Data, NSData
  • Decimal128
  • ObjectId
  • @objc enum RealmEnum 을 준수하는 것으로 선언되었습니다.
  • RealmOptional<Value> 선택적 숫자 속성의 경우
  • Object 서브클래스, 다대일 관계 모델링
  • EmbeddedObject 하위 클래스, 일대일 관계를 소유한 모델
  • List<Element>, 다대다 관계 모델링

String, NSString, 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 의 메서드에서 반환된 배열 또는 사전 또는 각 managed 속성에 대해 하나의 요소를 포함하는 Array 일 수 있습니다. 필수 속성이 없고 해당 속성이 기본값으로 정의되지 않은 경우 예외가 발생합니다.

    Array 를 value 인수로 전달할 때 모든 속성이 존재하고 유효해야 하며 모델에 정의된 속성과 동일한 순서여야 합니다.

    Realm 인스턴스에서 add(_:) 를 호출하여 관리되지 않는 객체를 해당 Realm에 추가합니다.

    선언

    Swift

    public convenience init(value: Any)

    매개변수

    value

    객체를 채우는 데 사용되는 값입니다.
    GitHub에 표시

속성

  • 객체를 managed하는 Realm이거나 객체가 관리되지 않는 경우 nil 입니다.

    선언

    Swift

    public var realm: Realm? { get }
    GitHub에 표시

  • managed 객체의 속성을 나열하는 객체 스키마입니다.

    선언

    Swift

    public var objectSchema: ObjectSchema { get }
    GitHub에 표시

  • 객체가 유효하지 않아 더 이상 액세스할 수 없는지 여부를 나타냅니다.

    객체를 managed 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에 표시

  • 무시할 속성의 이름을 지정하려면 이 메서드를 재정의합니다. 이러한 속성은 객체를 managed하는 Realm에서 managed하지 않습니다.

    선언

    Swift

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

    반환 값

    무시할 속성 이름의 배열입니다.

    GitHub에 표시

  • 인덱스화해야 하는 속성의 속성 이름 배열을 반환합니다.

    문자열, 정수, 부울, Date 및 NSDate 속성만 지원됩니다.

    선언

    Swift

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

    반환 값

    속성 이름의 배열입니다.

    GitHub에 표시

키-값 코딩 & 구독

  • 지정된 이름을 가진 속성의 값을 반환하거나 설정합니다.

    선언

    Swift

    @objc
open subscript(key: String) -> Any? { get set }
    GitHub에 표시

알림

  • 객체가 변경될 때마다 호출될 블록을 등록합니다.

    이 블록은 객체를 삭제하거나 속성을 기존 값으로 설정하는 자체 할당을 포함하여 객체의 managed 속성을 수정하는 각 쓰기 트랜잭션(write transaction) 후에 비동기적으로 호출됩니다.

    다른 스레드 또는 다른 프로세스에서 수행되는 쓰기 트랜잭션 (write transaction)의 경우 관리 Realm이 변경 사항이 포함된 버전으로 (자동)새로 고침될 때 블록이 호출되는 반면, 로컬 쓰기 트랜잭션 (write transaction)의 경우 다음과 같은 미래의 어느 점에 블록이 호출됩니다. 쓰기 트랜잭션 (write transaction)이 커밋됩니다.

    대기열이 제공되지 않으면 표준 이벤트 루프를 통해 알림이 전달되므로 이벤트 루프가 다른 활동에 의해 차단되는 동안에는 알림을 전달할 수 없습니다. 대기열이 제공되면 대신 해당 대기열로 알림이 전달됩니다. 알림을 즉시 전달할 수 없는 경우 여러 알림이 단일 알림으로 병합될 수 있습니다.

    List 및 Results 과 달리 새 알림 차단을 추가한 후에는 '초기' 콜백이 이루어지지 않습니다.

    Realm에서 managed 객체만 이러한 방식으로 관찰할 수 있습니다. 블록에 업데이트를 전송하려는 한 반환된 토큰을 보관해야 합니다. 업데이트 수신을 중지하려면 토큰에서 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에서 managed되고 데이터베이스에서 동일한 기본 객체를 점하는 경우에만 동일한 것으로 간주됩니다.

    참고

    동등성 비교는 isEqual(_:) 에 의해 구현됩니다. Realm 객체 유형이 기본 키로 정의된 경우 isEqual(_:) 는 이 메서드와 동일하게 작동합니다. Realm 객체 유형이 기본 키로 정의되지 않은 경우 isEqual(_:) 는 NSObject 객체 ID를 비교하는 동작을 사용합니다. 이 메서드는 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 를 참조하세요.

    경고

    이 메서드는 managed 객체에 대해서만 호출할 수 있습니다.

    선언

    Swift

    public func freeze() -> Self
    GitHub에 표시