【Android開発中級者に贈るJetpack入門】UIのデータを管理するViewModelとは？

一歩進んだAndroidアプリ開発ができる「Android Jetpack」入門 第1回

　CodeZineの連載「Android Studio2で始めるアプリ開発入門」が終了したのが2017年3月です。それからおよそ1年後の2018年5月にAndroid Jetpackがリリースされました。このJetpackのおかげで、一歩進んだAndroidアプリ開発が行えるようになりました。その後、CodeZineの連載をもとに、内容をアップデートした『Androidアプリ開発の教科書』が翔泳社から刊行されますが、入門書という位置付け上、Jetpackの内容までは踏み込んでいません。本連載は、「Android Studio2で始めるアプリ開発入門」連載、および『Androidアプリ開発の教科書』の続編にあたる内容として、Jetpackを取り上げていきます。その第1回として、UIのデータを管理するためのライブラリであるViewModelを紹介します。

Android Jetpackの紹介と本連載について

　本連載を開始するにあたって、まず、本連載のテーマであるAndroid Jetpackと、本連載の趣旨を紹介します。

Android Jetpackとは

　Android Jetpackは、Google I/O 2018で発表されたAndroidのライブラリ群です。Android開発で利用される基本のAPIとは別に用意され、開発者が任意に選択できるようになっています。これらのライブラリを利用することで、一からコーディングするとかなり手間がかかるような処理を簡単に実装できたり、定型コード（ボイラープレートコード）を記述せずに済んだり、より上位のAndroid開発が簡単にできるようになっています。

　このように、Jetpackは、Androidアプリの実開発において便利なライブラリである一方で、内容がそもそも「一歩進んだ」Android開発用なので、利用するにはある程度Android開発に慣れていることが前提となります。

　初めてAndroid開発を行ういわゆる入門者が、いきなり利用するには、Jetpackはハードルが高すぎます。仮に利用できたとしても、処理のブラックボックスが多発し、何か不具合があった時に全く対応できなくなってしまいます。

本連載の位置付け

　このようなJetpackは、その必要とする前提知識ゆえに、なかなか入門連載や入門書には含めることができません。CodeZineでは、拙連載である「Android Studio2で始めるアプリ開発入門」という入門連載がありますが（また、それらの連載をもとに書籍化した拙著『Androidアプリ開発の教科書』（翔泳社）も含めて）、Jetpackの内容がほとんど含まれていないのは、そのためです。何より、連載記事に関しては、そもそもJetpackそのものが存在していませんでした。

　そこで、本連載では、これらの続編のような位置付けとして、Jetpackを紹介していきます。裏を返せば、「Android Studio2で始めるアプリ開発入門」や『Androidアプリ開発の教科書』の内容はすでに知っている読者を対象として、連載を行っていくのでご了承ください。

本連載で取り上げるテーマ

　さて、本連載では、表1のようなテーマを取り上げていく予定です。

表1：本連載で取り上げるテーマ

テーマ	内容
ViewModel	UIのデータを管理するためのライブラリ
Room	データベース処理を自動化するライブラリ
Data Binding	UI部品とそこに表示するデータを自動的に連動させるライブラリ
WorkManager	バックグラウンドでデータを保存するためのライブラリ
Paging	簡単にページング機能を実現できるライブラリ
Navigation	画面遷移処理を自動化するためのライブラリ
ViewPager2	フラグメント間の遷移を画面スライドで実現するためのライブラリ
CameraX	新しいカメラAPI用ライブラリ
Compose	新しい宣言形式で画面を作成するライブラリ

　また、連載中はさまざまなコードを掲載していきますが、原則としてJavaとKotlinを併記する予定です。ただし、Javaのみ、Kotlinのみに対応したものに関しては、片方のコードのみの掲載となります。

ViewModelとは

　さあ、早速第1回のテーマであるViewModelの話に入っていきましょう。

ライフサイクルとデータの関係

　まず、図1をみてください。この画面は、数値を2個入力し、計算ボタンをクリックすると、2個の数値の足し算結果を表示するという非常に簡単なアプリの画面です。このアプリの処理コードは、すべてMainActivityに記述しています。

図1: 足し算アプリの画面

　図1の状態から画面を回転させると、図2のようになります。足し算結果の表示が消えてしまっています。この現象は以前から問題になっていました。

図2: 画面の回転で結果表示が消えてしまった画面

　アクティビティに処理を記述していく際、その画面に必要なデータも当然含まれてしまいます。図1や図2では、足し算結果が該当します。このデータが、とあるタイミングで消えてしまうことがあります。というのも、アクティビティにはライフサイクルがあり、画面のさまざまな状態に応じて専用のメソッド（ライフサイクルコールバックメソッド）が呼び出されるようになっています。

　そして、そのタイミングでアクティビティ内に保持していたデータがリセットされてしまうことがあります。これを防ぐためには、ライフサイクルコールバックメソッド内で、適切にデータを再現するコードをいちいち記述する必要がありました。もちろん、これは手間です。

UIのデータを保持するオブジェクトViewModel

　そこでJetpackに導入されたのがViewModelです。ViewModelは、アクティビティなどUIに必要なデータを保持しておくオブジェクトです。画面に表示させるデータ、例えば、先の足し算アプリの場合は、入力された2個の数値や足し算結果をアクティビティではなくViewModelに保持させておき、アクティビティからはそのデータを利用するようにしておくことで、アプリ全体ではアクティビティのライフサイクルに影響されずにデータを保持できるようになります。

　また、アクティビティはデータ表示やデータの管理から解放され、ライフサイクルの管理やタップイベントなどのUI操作処理に専念できるようになります。

ViewModelの生存期間

　ViewModelがアクティビティのライフサイクルに影響されずにデータを保持しておける理由は、もちろん、そのように作られたからです。図3をみてください。

図3:ViewModelとアクティビティの関係（出典: Android公式サイト）

　この図は、Androidの開発者用サイトのViewModelの解説ページ記載の図そのものです。これをみてもわかるように、ViewModelは、自身が生成したアクティビティに寄り添うように、アクティビティが終了するまで存在するようになっています。