• 2022/10/8
• 3分

【Swift】UserDefaultsの使い方とは？データの保存/削除/取得/更新方法

＼ アプリをリリースしました ／

友達や家族の誕生日をメモ！通知も届く-みんなの誕生日-

posted withアプリーチ

アプリが停止してもデータを保持させるために使用できるUserDefaultsの使い方と実装方法をまとめていきたいと思います。

iOSアプリで端末(ローカル)にデータを永続的に保存する方法

Swiftではアプリ内からデータを永続的に保存する手段がいくつか存在します。

• テキストファイル
• UserDefaults
• Realm Swift(ライブラリ)
• Keychain

それぞれに一長一短がありますが、今回はUserDefaultsを使用した方法をまとめていきます。

UserDefaultsとは？

公式リファレンス：UserDefaults

「UserDefaults」とはいわゆるアプリ内に生成されるデータベースのようなものでアプリが停止してもデータを保持することが可能になっています。

アプリを削除しない限りデータが失われることが無いので、半永続的に管理したいデータやアプリを停止しても保持していたい値などを格納しておくことで簡単に再利用可能になっています。

格納するデータは文字列のキー値と任意の値との関係性を持って保持されてます。

Swift：UserDefaultsの使い方

Swiftでは「UserDefaults」を操作するためのインターフェース(CRUD操作など)を提供しているUserDefaultsクラスが用意されています。

class UserDefaults : NSObject

保存できるデータ型はString、Int、Bool、Array、Dictionary、Data、Dateです。独自のクラスや構造体形式ではそのまま保存することができませんがData型に変換することで保存することも可能です。

CRUD操作

ここからはUIKitを使用している場合にUserDefaultsを操作する方法をまとめていきます。SwiftUIを使用している場合は@AppStorageというプロパティラッパーを使用することで操作することができます。

CRUD操作をする前にまずUserDefaultsクラスのインスタンスを生成しておきます。UserDefaultsクラスはシングルトンパターンになっているのでstandardメソッドを使用してインスタンスに参照します。

// インスタンスを生成
let userDefaults = UserDefaults.standard

おすすめ記事：【GoF】23種類のデザインパターンとは？Swiftでよく使う活用例

登録・更新

データを登録するにはsetメソッドを使用します。引数には実際に保存しておきたい値とキーとなる文字列を渡します。

userDefaults.set("foo", forKey: "sample")

格納する値のデータ型によって自動でオーバーライドされたメソッドが呼び出されるのでデータ型によって変更する必要はありません。

既に格納済みの値を更新したい時もsetメソッドを使って上書きすることができます。

一度に複数登録する

データを一度に複数登録するにはregisterメソッドを使用します。引数には辞書型でキーと値を複数渡すことができます。

userDefaults.register(defaults: ["DataStore": "default"])

取得

既にデータベースに格納している値を取得する際はその値のデータ型に応じたメソッドを呼び出す必要があります。

userDefaults.string(forKey: "キー")
userDefaults.integer(forKey: "キー")
userDefaults.float(forKey: "キー")
userDefaults.double(forKey: "キー")
userDefaults.bool(forKey: "キー")
userDefaults.url(forKey: "キー")
userDefaults.array(forKey: "キー")
userDefaults.dictionary(forKey: "キー")
userDefaults.data(forKey: "キー")
userDefaults.stringArray(forKey: "キー")
userDefaults.object(forKey: "キー")

削除

データを削除するにはremoveObjectメソッドを使用します。削除するデータはキー文字列で指定するので保存されている値によってメソッドを変更する必要はありません。

userDefaults.removeObject(forKey: "sample")

UserDefaultsの注意点と保管場所

データを扱う上で便利なUserDefaultsですが取り扱いには注意が必要です。

• 大量のデータを保存しない
• 重要なデータを保存しない

UserDefaultsに過度なデータを入れるとアプリのパフォーマンスが著しく低下する可能性があるようです。

UserDefaultsがどこにデータを保管しているかというとアプリインストール時にデバイス内に生成されるサンドボックス構造になったファイル群の中の/AppData/Library/Preferences/です。この中にプロパティリスト形式の[bundle-identifier].plistというファイル名で保存されます。アプリ情報を設定する「info.plist」なんかがプロパティリストでは有名ですね。

├── AppData
│ ├── Documents
│ ├── Library
│        ├── Application Support
│        ├── Caches
│        ├── Preferences ★
│        ├── Saved Application State
│        └── SplashBoard
│ ├── SystemData
│ └── tmp

プロパティリストは値1つを参照したいだけでもファイル全体を読み込む必要があり、値を更新した際にはファイル全体を書き換える必要があるのでファイル容量が多いほど圧迫してしまいます。

公式ドキュメントではUserDefaultsに対する容量制限とかはなさそうですが使いすぎないように注意することをおすすめします。

また中に格納されている情報は知見のある人だと閲覧できてしまうため秘密にしたい情報などの格納は避けた方が無難です。

確認する方法

Swift6対応

Xcode16からSwift6対応が本格化し始め、UserDefaultsにも絡んでくるので少し掘り下げてみたいと思います。とはいえ公式ドキュメントには「UserDefaultsはスレッドセーフです」と記述されていました。

UserDefaultsはSendableではない

UserDefaultsクラスはスレッドセーフではあるがSendableプロトコルには準拠していないようです。Sendableプロトコルに準拠していないため「Strict Concurrency Checking(厳密な並行性チェック)」を有効にすると以下のような警告が発生しました。

Stored property 'userDefaults' of 'Sendable'-conforming class 'UserDefaultsRepository' has non-sendable type 'UserDefaults'; this is an error in the Swift 6 language mode

この件はAppleのDeveloper Forumsでも取り上げられていました。

UserDefaultsの管理クラスをどうするか

UserDefaults処理を一元管理するために作成していたUserDefaultsRepositoryクラスがSwift6対応により先程の警告が発生するようになってしまいました。そのため警告をなくすためにUserDefaultsRepositoryクラスがスレッドセーフであることを明確にする必要があります。そのための手段とて大きく2つあると思います。

class UserDefaultsRepository {
    /// `UserDefaults`が`Sendable`ではない
    private let userDefaults: UserDefaults = UserDefaults.standard
}

1つ目は単純にactorにする方法です。これによりスレッドセーフを保証できますが、定義しているメソッドがacyncになり、呼び出し時にTask { await }が必要になるのが少し気になります。

/// actor定義することでスレッドセーフを保証
/// 全てのメソッドが`acync`になる
actor UserDefaultsRepository {
    /// `UserDefaults`が`Sendable`ではない
    private let userDefaults: UserDefaults = UserDefaults.standard
}

2つ目はSendableを付与する方法です。この場合UserDefaultsがSendableではないので@uncheckedを付与しないと警告が消えません。@uncheckedを付与する場合は自前でスレッドセーフな実装を保証する必要がありますがUserDefaultsがスレッドセーフなのでこれで問題ないかも知れないですね。

final class UserDefaultsRepository: @unchecked Sendable {
    /// `UserDefaults`が`Sendable`ではない
    private let userDefaults: UserDefaults = UserDefaults.standard
}

まだまだ勉強中ですので間違っている点や至らぬ点、こうした方が良いよなどがありましたら教えていただけると助かります。

ご覧いただきありがとうございました。