データ更新に応じてUI変更を自動実行しよう ―データを非同期でUIに反映できる「LiveData」とは？

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

　CodeZineの連載「Android Studio2で始めるアプリ開発入門」が終了してから約1年後、Android Jetpackがリリースされ、一歩進んだAndroidアプリ開発が可能になりました。しかし、連載をもとに内容をアップデートした『Androidアプリ開発の教科書』では、入門書という位置付けのため、Jetpackの内容までは踏み込んでいません。本連載は、「Android Studio2で始めるアプリ開発入門」連載、および『Androidアプリ開発の教科書』の続編にあたる内容として、Jetpackを取り上げていきます。前回は、RoomとViewModelを組み合わせる方法とともに、リポジトリを紹介しました。今回は、データの更新を非同期でUIに反映できるLiveDataを紹介します。

LiveDataとは

　今回のテーマはLiveDataです。まずは、そのLiveDataがどのようなものかを解説していきます。なお、今回のサンプルは、GitHubから参照できます。

LiveDataを使わないアプリの問題点

　今回も前回紹介したカクテルメモアプリを題材にします。そのカクテルメモアプリに、前回はViewModelとリポジトリを導入しました。もちろん、Roomも利用しています。その場合のアプリケーションのデータの流れに注目すると、例えば、カクテルリストをクリックしてデータベースからデータを取得し、そのデータを入力画面に表示させる必要があります。もちろん、データベース処理に関してはRoomが担当し、そのRoomを操作するのがリポジトリ、そのリポジトリを操作して画面表示に必要なデータをそろえるのがViewModelの役割と、役割分業を前回紹介しました。それでも、ViewModelがそろえたデータを実際の画面部品に反映させるのはアクティビティやフラグメントの役割となります（図1）。そのため、アクティビティに変更処理コードを記述する必要があります。

図1: データに応じたUIの変更処理はアクティビティにコードを記述

　入力されたカクテルデータに関して、データベースに保存する処理、すなわち、前回の図1の画面の［保存］ボタンをクリックした際の処理については、ViewModelが保持したデータを、リポジトリを経由してRoomによってデータベースに保存される流れです。しかし、その保存後、図2のように、選択されたカクテル名を「未選択」表示にしたり、入力欄のデータをクリアし、入力欄そのものが入力できないようにしたり、また、［保存］ボタンがタップ不可にする処理が必要です。

図2: 保存処理が完了後の画面

　このように、最終的にデータに応じて画面部品の表示内容を変更する処理が、どうしてもアクティビティやフラグメントの役割になってしまい、そのためのコードを記述する必要が出てきます。

　さらに、それらのUIに必要なデータの用意が非同期で行われる場合、非同期に応じたUIの変更処理が発生し、よりコードが煩瑣になります。前回のリスト5のように、アクティビティでコルーチンスコープを用意しなければならないコードは、その典型です。

非同期でデータの変更をUIに反映できるLiveData

　このような問題を解決するために用意されたものがLiveDataです。LiveDataでは、内部に保持しているデータが変更されたことを自動検知し、そのタイミングであらかじめ登録されておいたUIの変更処理が自動実行されるようになっています。そのため、画面に必要なデータをLiveDataとして用意しておき、そのLiveDataにUIの変更処理を登録しておくだけで、UIの表示処理をその都度コードとして記述する必要がなくなります（図3）。しかも、これらのUI変更処理が非同期で自動実行されるため、データの変更そのものが非同期で行われることに対しても、問題なく対応できるようになっています。

図3: データの変更のたびにUI変更処理が自動実行されるLiveData

LiveDataの準備

　概要はここまでにして、実際にコードを交えてLiveDataの使い方を紹介していきます。

LiveDataはMutableLiveDataが使いやすい

　先述のように、LiveDataを導入すると、UIに必要なデータはLiveDataとして用意することになります。となると、前回のリスト1やリスト2のように、MainViewModel内でバラバラに用意したcocktailId、cocktailName、cocktailNoteの3個のデータをひとまとめにしてLiveDataに埋め込み、MainViewModel内でのデータ保持は、LiveDataオブジェクトとします。これは、Javaではリスト1、Kotlinではリスト2のようなコードとなります。

リスト1：MainViewModelのLiveDataフィールド（Java版）

public class MainViewModel extends AndroidViewModel {
  private MutableLiveData<Cocktailmemo> _cocktailmemoLiveData = new MutableLiveData<>();
    :
  //_cocktailmemoLiveDataフィールドのゲッタ。
  public LiveData<Cocktailmemo> getCocktailmemoLiveData() {
    return _cocktailmemoLiveData;
  }
}

リスト2：MainViewModelのLiveDataプロパティ（Kotlin版）

class MainViewModel(application: Application) : AndroidViewModel(application) {
  val cocktailmemoLiveData = MutableLiveData<Cocktailmemo>()
    :
}

　それぞれのコードを見てもわかるように、LiveDataというクラスではなく、MutableLiveDataクラスを利用しています。これは、LiveDataクラスは抽象クラスであり、直接そのインスタンスは利用できません。そこで、そのLiveDataの子クラスであるMutableLiveDataを利用します。

LiveDataの内部保持データはジェネリクスで指定

　次に、そのMutableLiveDataのジェネリクスに注目してください。先述のように、LiveDataには、UIに必要なデータを内部に保持します。そして、その内部で保持するデータがどのようなものかを、ジェネリクスとして型指定する必要があります。

　今回のカクテルメモアプリでは、前回のリスト1やリスト2からわかるように、cocktailId、cocktailName、cocktailNoteの3個のデータです。これら3個のデータをまとめたものは、すなわち、Cocktailmemoエンティティそのものです。そこで、リスト1やリスト2では、MutableLiveDataのジェネリクスにCocktailmemoを型指定として記述しているのです。