[Realm][Swift] 新しいタイプの導入

Realm は、非常に便利ですが、タイプとしてサポートされていない情報を保持しようとすると少し面倒だったので、その方法を説明します。

Update(2020.11.1) 10進数表現のタイプという意味では、Decimal128 が Realm に正式に導入されました。

[Realm][Swift] Realm に Decimal が導入されました

追加したかったタイプ

家計簿アプリを作りたかったので、Realm が Decimal をサポートするのを待っています。
しばらくかかりそうなので、自分で Decimal 相当を組み込んでみることにしました。

Decimal

10の冪乗で処理されるため、10進数の計算で誤差が発生しないことが特徴です。ですので、金融関連のアプリケーションでは必須と言えるタイプになっています。

独自タイプの定義

自分で Realm 自体に手を入れることは、あまり意味がないので、Realm でサポートしているタイプを組み合わせて保存することにしました。

金額を記憶させるタイプなので、”Currency” としました。

public class Currency: Object {
  // smallest sub-currency is 1/1000, so storing .0001 woudl be enough for keeping precision (maybe too much for USD, EUR, ...)
  @objc dynamic var savedValue: Int64  // store value*1000, ex: $100 -> 100,000 for keeping decimal precision
  
  public required init() { // required from Object, use zero as default value
    self.savedValue = 0
  }
}

後から、必要に応じて、Decimal からの initializer や、Int64 からの initializer を追加します。

モデルに独自タイプを持たせる

以下では、Realm で定義していた 口座のモデル (Account)に、初期残高を持たせるようにしたものです。

public class MCAccount: Object {
  @objc open dynamic var id:String
  @objc open dynamic var name:String = ""
  @objc open dynamic var initialAmount:Currency? // (1) 独自タイプ追加
  public let tags = List()
  @objc open dynamic var askedForDelete = false
  
  public override static func primaryKey() -> String? {
    return "id"
  }
  
  public required init() {
    self.id = UUID().uuidString
    super.init()
  }
}

(1) に初期残高を追加しました。よく考えれば、独自のタイプは、Realm での新しいタイプの Object になるので、この場合であれば、to-one relationship になるものでした。

to-one relationship

to-one relationship を追加して気付いたのですが、Realm では、to-one relationship は、optional で定義しないといけないという制限がありました。

そこで、optional にして定義しました。

# ここから、思ったより手間であることがわかり始めます。

optional

Realm がサポートしているタイプであれば、to-one relationship は単にプロパティということになるので、optional であることは必要ありません。

サポートしていないタイプを、プロパティのように持たせるために、to-one relationship という形で持たなければいけなくなりました。

アプリ設計者視点としては、そのプロパティを持つ Object （ここでは、Account) が初期化されたときに、Currency も初期化してくれて良いのです。

ですが、Realm 的な DB の観点からすると Object 間の関係を持っている要素を初期化等するときに、相手先の Object がすでに存在するかはわからないので、
optional にしてくれないと困る というのもよくわかります。

わかるのですが、optional としてしまうと、Account から Currency へのアクセスが常に optional かどうかのチェックが必要となり面倒です。

自分の場合は、すでにある程度コードを書いていたので、このような基本的なアクセスに変更が入るのは避けたいです。

wrapper

ということで、以下のような Wrapper を作って、できるだけアクセスAPIの変更がないようにしました。

public class MCAccount: Object {
  @objc open dynamic var id:String
  @objc open dynamic var name:String = ""
  @objc open dynamic var internalInitialAmount:Currency? // (1) internalInitialAmount として、直接アクセスさせない
  @objc open dynamic var comment: String = ""
  
  var initialAmount:Currency {  // (2) initialAmount としては、computed property を定義して、これまでと同等のアクセスを用意
    get {
      if internalInitialAmount == nil {
        self.internalInitialAmount = Currency(int64: 0)
      }
      return self.internalInitialAmount!
    }
    set {
      internalInitialAmount = newValue
    }
  }
}

まとめ：独自タイプを Realm で定義したモデルに追加する

以下の手順で追加できます。

説明は以上です。
不明な点やおかしな点ありましたら、ご連絡いただけるとありがたいです。

関連記事:

[SwiftUI][Realm] SwiftUI と Realm で TODOアプリを作る [Realm][Swift] Realm に Decimal が導入されました [SwiftUI][CoreData] SwiftUI と MVVM で始める CoreData 入門 (その１４：CoreData を Realm と入れ替え) [SwiftUI][Realm][Xcode12] Realm を使ったアプリの開発方法（その1 : 要素作成）