UI の状態を保存する（ビュー）

また、インテントからアクティビティを開くと、構成の変更時、およびシステムがアクティビティを復元するときに、エクストラのバンドルがアクティビティに配信されます。

これらのシナリオのいずれにおいても、ViewModel を使用して、 構成の変更時にデータベースからデータを再び読み込んでサイクルを無駄にしないようにしてください。

保持する UI データが単純かつ軽量である場合は、保存済みインスタンス状態 API のみを使用して状態データを保持できます。

SavedStateRegistry を使用して保存済み状態に接続する

Fragment 1.1.0 およびその推移的な依存関係 Activity 1.0.0 以降、Activity や Fragment などの UI コントローラは、SavedStateRegistryOwner を実装し、そのコントローラにバインドされた SavedStateRegistry を提供するようになりました。SavedStateRegistry を使用すると、コンポーネントを UI コントローラの保存済み状態に接続できます。これにより、保存済み状態を使用したり、コンポーネントを保存済み状態に寄与させることが可能になります。たとえば、ViewModel の保存済み状態モジュールは、SavedStateRegistry を使用して SavedStateHandle を作成し、ViewModel オブジェクトに渡します。SavedStateRegistry は、getSavedStateRegistry を呼び出すことで UI コントローラ内から取得できます。

保存済み状態に寄与するコンポーネントは、SavedStateRegistry.SavedStateProvider を実装する必要があります。これは、saveState という単一のメソッドを定義します。saveState() メソッドを使用すると、コンポーネントは、そのコンポーネントから保存する必要がある状態をすべて含む Bundle を返すことができます。SavedStateRegistry は、UI コントローラのライフサイクルの保存状態フェーズでこのメソッドを呼び出します。

class SearchManager implements SavedStateRegistry.SavedStateProvider {
    private static String QUERY = "query";
    private String query = null;
    ...

    @NonNull
    @Override
    public Bundle saveState() {
        Bundle bundle = new Bundle();
        bundle.putString(QUERY, query);
        return bundle;
    }
}

SavedStateProvider を登録するには、registerSavedStateProvider() で SavedStateRegistry を呼び出して、プロバイダのデータと プロバイダに関連付けるキーを渡します。プロバイダの以前に保存されたデータは、SavedStateRegistry で consumeRestoredStateForKey() を呼び出してプロバイダのデータに関連付けられたキーを渡すことにより、保存済み状態から取得できます。

Activity または Fragment 内で、super.onCreate() を呼び出した後に onCreate() で SavedStateProvider を登録できます。または、LifecycleOwner を実装する SavedStateRegistryOwner に LifecycleObserver を設定し、ON_CREATE イベントが発生したときに SavedStateProvider を登録することもできます。LifecycleObserver を使用すると、以前に保存した状態の登録と取得を SavedStateRegistryOwner 自体から分離できます。

class SearchManager(registryOwner: SavedStateRegistryOwner) : SavedStateRegistry.SavedStateProvider {
    companion object {
        private const val PROVIDER = "search_manager"
        private const val QUERY = "query"
    }

    private val query: String? = null

    init {
        // Register a LifecycleObserver for when the Lifecycle hits ON_CREATE
        registryOwner.lifecycle.addObserver(LifecycleEventObserver { _, event ->
            if (event == Lifecycle.Event.ON_CREATE) {
                val registry = registryOwner.savedStateRegistry

                // Register this object for future calls to saveState()
                registry.registerSavedStateProvider(PROVIDER, this)

                // Get the previously saved state and restore it
                val state = registry.consumeRestoredStateForKey(PROVIDER)

                // Apply the previously saved state
                query = state?.getString(QUERY)
            }
        }
    }

    override fun saveState(): Bundle {
        return bundleOf(QUERY to query)
    }

    ...
}

class SearchFragment : Fragment() {
    private var searchManager = SearchManager(this)
    ...
}

class SearchManager implements SavedStateRegistry.SavedStateProvider {
    private static String PROVIDER = "search_manager";
    private static String QUERY = "query";
    private String query = null;

    public SearchManager(SavedStateRegistryOwner registryOwner) {
        registryOwner.getLifecycle().addObserver((LifecycleEventObserver) (source, event) -> {
            if (event == Lifecycle.Event.ON_CREATE) {
                SavedStateRegistry registry = registryOwner.getSavedStateRegistry();

                // Register this object for future calls to saveState()
                registry.registerSavedStateProvider(PROVIDER, this);

                // Get the previously saved state and restore it
                Bundle state = registry.consumeRestoredStateForKey(PROVIDER);

                // Apply the previously saved state
                if (state != null) {
                    query = state.getString(QUERY);
                }
            }
        });
    }

    @NonNull
    @Override
    public Bundle saveState() {
        Bundle bundle = new Bundle();
        bundle.putString(QUERY, query);
        return bundle;
    }

    ...
}

class SearchFragment extends Fragment {
    private SearchManager searchManager = new SearchManager(this);
    ...
}

永続ローカル ストレージを使用して、複雑なデータまたは大規模なデータのプロセスの終了を処理する

データベースや共有環境設定などの永続ローカル ストレージは、アプリがユーザーのデバイスにインストールされている間は（ユーザーがアプリのデータを削除しない限り）存続します。このようなローカル ストレージは、システムによって開始されたアクティビティとアプリのプロセスの終了後も存続しますが、ローカル ストレージからメモリに読み込む必要があるため、取得に時間がかかることがあります。一般的には、この永続ローカル ストレージは、アクティビティの開始時と終了時に失いたくないすべてのデータが保存されるアプリ アーキテクチャの一部になっている可能性があります。

ViewModel も保存済みインスタンスの状態も、長期ストレージ ソリューションではないため、データベースなどのローカル ストレージの代わりにはなりません。これらのメカニズムは、一時的な UI の状態のみを一時的に保存するときに使用してください。他のアプリのデータには、永続ストレージを使用する必要があります。ローカル ストレージを利用して、アプリモデルのデータを長期的に（たとえば、デバイスの再起動後も）保持する方法について詳しくは、アプリ アーキテクチャ ガイドをご覧ください。

UI の状態の管理: 分割統治

UI の状態を効率的に保存および復元するには、さまざまなタイプの永続メカニズム間で作業を分割します。ほとんどの場合、これらのメカニズムではそれぞれ異なるタイプのデータが、データの複雑さ、アクセス速度、全期間のトレードオフに基づいて Activity で使用され保存されます。

• 永続ローカル ストレージ: アクティビティの開始時と終了時に失いたくないすべてのアプリデータを保存します。
  • 例: 曲オブジェクトのコレクション。これには、音声ファイルやメタデータが含まれる可能性があります。
• ViewModel: 関連付けられている UI（画面の UI 状態）の表示に必要なすべてのデータをメモリ内に保存します。
  • 例: 最近の検索結果の曲オブジェクト、最近の検索クエリ。
• 保存済みインスタンスの状態: システムが停止して UI を再作成する場合に、UI の状態を再読み込みするために必要な少量のデータを保存します。複雑なオブジェクトはここではなくローカル ストレージに保存し、それらのオブジェクトの一意の ID は保存済みインスタンス状態 API に保存します。
  • 例: 最近の検索クエリの保存。

例として、曲のライブラリを検索できるアクティビティについて考えてみましょう。各種のイベントは次のように処理されます。

ユーザーが曲を追加すると、ViewModel によって即座にデリゲートされ、そのデータがローカルに保存されます。この新たに追加した曲を UI に表示する必要がある場合は、ViewModel オブジェクト内のデータを更新して曲の追加を反映する必要もあります。データベースへの挿入は、すべてメインスレッド以外で行ってください。

ユーザーが曲を検索したとき、データベースから読み込むすべての曲データは、その複雑さにかかわらず、画面 UI 状態の一部として直ちに ViewModel オブジェクトに保存する必要があります。

アクティビティがバックグラウンドに移動され、システムが保存済みインスタンス状態 API を呼び出したときは、プロセスが再作成を行う場合に備えて、検索クエリを保存済みインスタンスの状態に保存する必要があります。この場所に保存されているアプリデータを読み込むには情報が必要であるため、検索クエリを ViewModel の SavedStateHandle に保存します。データを読み込んで UI を現在の状態に戻すために必要な情報は、これがすべてです。

複雑な状態の復元: 断片を組み立て直す

ユーザーがアクティビティに戻るときにアクティビティを再作成するシナリオには、次の 2 つが考えられます。

• アクティビティがシステムによって停止された後に再作成されるケース。システムはクエリを保存済みインスタンス状態のバンドルに保存しています。SavedStateHandle が使用されていない場合、UI はクエリを ViewModel に渡す必要があります。ViewModel は、検索結果がキャッシュに保存されていないことを確認し、渡された検索クエリを使用して検索結果の読み込みをデリゲートします。
• 構成の変更後にアクティビティが再作成されるケース。ViewModel インスタンスは破棄されていないため、ViewModel はすべての情報をメモリ内でキャッシュに保存しており、データベースへのクエリを再実行する必要がありません。

参考情報

UI の状態の保存について詳しくは、以下のリソースをご覧ください。

• UI レイヤのドキュメント
• ViewModel の保存済み状態のモジュール

ブログ

• ViewModel: 簡単な例
• ViewModel: 永続性、onSaveInstanceState、 UI の状態の復元、ローダ

Codelab

• Android ライフサイクル対応コンポーネントの Codelab