Realm ファイル サイズの縮小 - Swift SDK

ピン留めトランザクションを避ける

Realm は、読み取りトランザクションの有効期間を Realm インスタンスのメモリ有効期間に関連付けます。 古い Realm トランザクションを「ピン留めする」のを避けます。 自動更新 Realm を使用し、明示的な自動リリース プールでバックグラウンド スレッドからの Realm API の使用をラップします。

スレッド化

Realm は、実行ループの反復開始時にアクセスするデータのバージョンを更新します。 これによりデータの一貫したビューが提供されますが、ファイル サイズに影響があります。

次のシナリオを考えてみましょう。

• スレッド A : Realm からいくつかのデータを読み取り、長時間実行される操作のスレッドをブロックします。

• スレッド B : 別のスレッドにデータを書き込みます。

• スレッド A : 読み取りスレッドのバージョンは更新されません。 Realm は中間バージョンのデータを保持する必要があり、書込みごとにファイル サイズが増加します。

この問題を回避するには、Realm でvalidate()を呼び出します。 これは、これまで読み取ったオブジェクトが不要になることをRealm に伝えています。 これにより、Realm はそれらのオブジェクトの中間バージョンを追跡することが解放されます。 次回アクセスすると、Realm には最新バージョンのオブジェクトが含まれます。

Realm を圧縮するために、次の 2 つの方法を使用することもできます。

• 構成でShouldCompactOnLaunchを設定する

• writeCopy(toFile:encryptionKey:) の使用

ディスパッチ キュー

Grid Central Dispatch を使用してRealmにアクセスする場合 では、同様のファイルが増加する可能性があります。ディスパッチ キューのオートリリース プールは、コードの実行後すぐにドレイン されない可能性があります。 Realmは、ディスパッチ プールが邦土オブジェクトを処理するまで、データの中間バージョンを再利用できません。ディスパッチ キューから邦土にアクセスする場合は、明示的な自動リリース プールを使用します。

Realm を非同期に圧縮

Swift async/await 構文を使用してRealmを非同期に開くと、バックグラウンドでRealmを圧縮できます。

func testAsyncCompact() async {
    let config = Realm.Configuration(shouldCompactOnLaunch: { totalBytes, usedBytes in
        // totalBytes refers to the size of the file on disk in bytes (data + free space)
        // usedBytes refers to the number of bytes used by data in the file
        // Compact if the file is over 100MB in size and less than 50% 'used'
        let oneHundredMB = 100 * 1024 * 1024
        return (totalBytes > oneHundredMB) && (Double(usedBytes) / Double(totalBytes)) < 0.5
    })
    do {
        // Realm is compacted asynchronously on the first open if the
        // configuration block conditions were met.
        let realm = try await Realm(configuration: config)
    } catch {
        // handle error compacting or opening Realm
    }
}

Realm Swift SDK バージョン 10.15.0 および 10.16.0 以降では、Realm API の多くが Swift async/await 構文をサポートしています。 プロジェクトは、次の要件を満たしている必要があります。

アプリが async/awaitコンテキストで Realm にアクセスする場合は、スレッド関連のクラッシュを回避するためにコードを@MainActorでマークします。

圧縮コピーの作成

Realm.writeCopy(toFile:encryptionKey:) を使用して、Realm の圧縮された（およびオプションで 暗号化された ）コピーを別のファイルの場所に保存できます使用して複数のドキュメントを挿入できます。 宛先ファイルがすでに存在することはできません。

手動圧縮を使用する際のヒント

Realm を圧縮すると、UI スレッドがブロックされる可能性があり、コストのかかる操作になる可能性があります。 Realm を開くたびにアプリケーションが圧縮されないようにする必要があります。 代わりに、アプリケーションが圧縮を最適化して、ファイルサイズが大きくなりすぎるのを防ぐのに十分な頻度で圧縮を行います。 アプリケーションがリソースが制限された環境で実行されている場合、一定のファイルサイズに達したときや、ファイルサイズがパフォーマンスに悪影響を及ぼす場合は、圧縮する必要がある場合があります。

これらの推奨事項は、アプリケーションの手動圧縮を最適化するのに役立ちます。

• 最大ファイルサイズを、平均 Realm 状態サイズの倍数に設定します。 平均的な Realm 状態サイズが 10 MB の場合は、予想される使用量とデバイスの制約に応じて、最大ファイル サイズを 20 MB または 40 MB に設定できます。

• 開始点として、Realm ファイルサイズの 50% 以上が使用されなくなった場合に Realm を圧縮します。 現在使用されているバイトを合計ファイルサイズで割った値で、現在使用されているスペースの割合を判断します。 次に、それが 50% 未満であるかどうかを確認します。 つまり、Realm ファイル サイズの 50% 以上が未使用領域であり、圧縮に適しています。 試すと、アプリケーションに最適なパーセンテージが異なることが見つかる場合があります。

これらの計算は、 shouldCompactOnLaunchコールバックでは次のようになります。

// Set a maxFileSize equal to 20MB in bytes
let maxFileSize = 20 * 1024 * 1024
// Check for the realm file size to be greater than the max file size,
// and the amount of bytes currently used to be less than 50% of the
// total realm file size
return (realmFileSizeInBytes > maxFileSize) && (Double(usedBytes) / Double(realmFileSizeInBytes)) < 0.5

アプリケーション内の Realm ファイルを圧縮する頻度の適切なバランスを見つけるために、条件を試してください。