Firebase と Jetpack Compose を使用して Android アプリを作成する

1. はじめに

最終更新日: 2022 年 11 月 16 日

Firebase と Jetpack Compose を使用して Android アプリを作成する

この Codelab では、Make It So という Android アプリを作成します。このアプリの UI は、ネイティブ UI を構築するための Android の最新ツールキットである Jetpack Compose で完全に構築されています。これは直感的で、.xml ファイルを記述してアクティビティ、フラグメント、ビューにバインドするよりもコードが少なくて済みます。

Firebase と Jetpack Compose の連携の優位性を理解するには、まず最新の Android アーキテクチャを理解する必要があります。優れたアーキテクチャでは、コンポーネントがどのように編成され、相互に通信するかが明確になるため、システムを簡単に理解、開発、維持できます。Android の世界では、推奨アーキテクチャはモデル - ビュー - ViewModel と呼ばれます。モデルは、アプリケーション内のデータにアクセスするレイヤを表します。ビューは UI レイヤであり、ビジネス ロジックについて何も知らない必要があります。また、ViewModel にはビジネス ロジックが適用されます。そのため、Model レイヤを呼び出すために ViewModel が必要になる場合があります。

Jetpack Compose でビルドした Android アプリにモデル - ビュー - ViewModel がどのように適用されるかを理解するには、こちらの記事をお読みいただくことを強くおすすめします。これにより、コードベースが理解しやすくなり、次のステップを完了しやすくなります。

作成するアプリの概要

Make It So: タスクの追加と編集、フラグ、優先度、期限の追加、タスクの完了のマークを付けることができるシンプルな ToDo リスト アプリケーションです。以下の画像は、このアプリケーションの 2 つのメインページです。タスク作成ページと、作成されたタスクの一覧を表示するメインページです。

このアプリにはない機能を追加します。

• メールアドレスとパスワードでユーザーを認証する
• Firestore コレクションにリスナーを追加し、UI が変更に反応するようにする
• カスタム トレースを追加して、アプリ内の特定のコードのパフォーマンスをモニタリングする
• Remote Config を使用して機能トグルを作成し、段階的なロールアウトを使用してリリースする

ラボの内容

• 最新の Android アプリケーションで Firebase Authentication、Performance Monitoring、Remote Config、Cloud Firestore を使用する方法
• Firebase API を MVVM アーキテクチャに適合させる方法
• Firebase API で行った変更を Compose UI に反映する方法

必要なもの

• Android Studio Flamingo+
• API 21 以降を搭載した Android Emulator
• Kotlin プログラミング言語に精通していること

2. サンプルアプリを入手して Firebase を設定する

サンプルアプリのコードを取得する

コマンドラインから GitHub リポジトリのクローンを作成します。

git clone https://github.com/FirebaseExtended/make-it-so-android.git

Firebase を設定する

まず、Firebase コンソールに移動し、[+ プロジェクトを追加] ボタンをクリックして Firebase プロジェクトを作成します。

画面の手順に沿ってプロジェクトの作成を完了します。

各 Firebase プロジェクト内で、Android、iOS、ウェブ、Flutter、Unity 用のさまざまなアプリを作成できます。以下に示すように、Android オプションを選択します。

続いて、次の手順を実行します。

1. パッケージ名として com.example.makeitso を入力し、必要に応じてニックネームを入力します。この Codelab では、デバッグ用の署名証明書を追加する必要はありません。
2. [次へ] をクリックしてアプリを登録し、Firebase 構成ファイルにアクセスします。
3. [google-services.json をダウンロード] をクリックして、構成ファイルをダウンロードし、make-it-so-android/app ディレクトリに保存します。
4. [次へ] をクリックします。Firebase SDK はサンプル プロジェクトの build.gradle ファイルにすでに含まれているため、[次へ] をクリックして [次のステップ] に進みます。
5. [コンソールに進む] をクリックして終了します。

Make it So アプリを正しく動作させるには、コードに移動する前にコンソールで 2 つの作業を行う必要があります。それは、認証プロバイダを有効にして、Firestore データベースを作成することです。まず、Authentication を有効にして、ユーザーがアプリにログインできるようにします。

1. [Build] メニューから [Authentication] を選択し、[Get Started] をクリックします。
2. [ログイン方法] カードで [メール/パスワード] を選択して有効にします。
3. 次に、[新しいプロバイダを追加] をクリックし、[匿名] を選択して有効にします。

次に、Firestore を設定します。Firestore を使用して、ログイン中のユーザーのタスクを保存します。各ユーザーは、データベースのコレクションに含まれる独自のドキュメントを取得します。

1. [構築] メニューから [Firestore] を選択し、[データベースを作成] をクリックします。
2. [Start in production mode] を有効にしたままの状態で [Next] をクリックします。
3. プロンプトが表示されたら、Cloud Firestore データを保存するロケーションを選択します。本番環境アプリを開発する場合は、このリージョンをユーザーの大半に近いリージョンに配置し、Functions などの他の Firebase サービスと共通にします。この Codelab では、デフォルトのリージョンをそのまま使用することも、最も近いリージョンを選択することもできます。
4. [有効にする] をクリックして Firestore データベースをプロビジョニングします。

では、Firestore データベースに堅牢なセキュリティ ルールを作成しましょう。Firestore ダッシュボードを開き、[ルール] タブに移動します。次のようにセキュリティ ルールを更新します。

rules_version = '2';
service cloud.firestore {
  match /databases/{database}/documents {
    match /{document=**} {
      allow create: if request.auth != null;
      allow read, update, delete: if request.auth != null && resource.data.userId == request.auth.uid;
    }
  }
}

基本的には、このルールにより、アプリのログイン ユーザーなら誰でも任意のコレクション内に自分のドキュメントを作成できることが規定されています。作成したドキュメントは、そのドキュメントを作成したユーザーのみが表示、更新、削除できるようになります。

アプリケーションを実行する

これで、アプリケーションを実行する準備が整いました。Android Studio で make-it-so-android/start フォルダを開き、アプリを実行します（Android Emulator または実際の Android デバイスで実行できます）。

3. Firebase Authentication

どの機能を追加しますか？

Make It So サンプルアプリの現在の状態では、ユーザーは最初にログインしなくてもアプリの使用を開始できます。これを実現するために匿名認証を使用します。ただし、匿名アカウントでは、ユーザーは他のデバイスのデータにアクセスしたり、今後のセッションでデータにアクセスしたりすることはできません。匿名認証はウォーム オンボーディングに役立ちますが、ユーザーが別のログイン方法に切り替えられるようにする必要があります。この Codelab では、このことを念頭に置いて、Make It So アプリにメールとパスワードによる認証を追加します。

コードを記述する

ユーザーがメールアドレスとパスワードを入力してアカウントを作成したら、すぐに Firebase Authentication API にメール認証情報を要求し、新しい認証情報を匿名アカウントにリンクする必要があります。Android Studio で AccountServiceImpl.kt ファイルを開き、linkAccount 関数を次のように更新します。

model/service/impl/AccountServiceImpl.kt

override suspend fun linkAccount(email: String, password: String) {
    val credential = EmailAuthProvider.getCredential(email, password)
    auth.currentUser!!.linkWithCredential(credential).await()
}

次に、SignUpViewModel.kt を開き、onSignUpClick 関数の launchCatching ブロック内でサービス linkAccount 関数を呼び出します。

screens/sign_up/SignUpViewModel.kt

launchCatching {
    accountService.linkAccount(email, password)
    openAndPopUp(SETTINGS_SCREEN, SIGN_UP_SCREEN)
}

まず認証を試み、呼び出しが成功すると次の画面（SettingsScreen）に進みます。これらの呼び出しを launchCatching ブロック内で実行する場合、最初の行でエラーが発生すると、例外が捕捉されて処理され、2 行目にはまったく到達しません。

SettingsScreen が再び開かれたらすぐに、ユーザーがすでに認証されているため、[ログイン] と [アカウントを作成] のオプションが消えていることを確認する必要があります。そのためには、SettingsViewModel が現在のユーザーのステータス（AccountService.kt で利用可能）をリッスンし、アカウントが匿名かどうかを確認できるようにします。これを行うには、SettingsViewModel.kt の uiState を次のように更新します。

screens/settings/SettingsViewModel.kt

val uiState = accountService.currentUser.map {
    SettingsUiState(it.isAnonymous)
}

最後に、SettingsScreen.kt の uiState を更新して、SettingsViewModel によって出力された状態を収集します。

screens/settings/SettingsScreen.kt

val uiState by viewModel.uiState.collectAsState(
    initial = SettingsUiState(false)
)

これで、ユーザーが変更されるたびに、SettingsScreen が再コンポーズされ、ユーザーの新しい認証状態に応じてオプションが表示されます。

テスト

Make it So を実行し、画面の右上にある歯車アイコンをクリックして設定に移動します。アカウント作成オプションをクリックします。

有効なメールアドレスと安全なパスワードを入力してアカウントを作成します。設定ページにリダイレクトされ、アカウントのログアウトと削除の 2 つの新しいオプションが表示されます。作成した新しいアカウントは、Firebase コンソールの [Authentication] ダッシュボードで [Users] タブをクリックして確認できます。

4. Cloud Firestore

どの機能を追加しますか？

Cloud Firestore の場合は、Make it So で表示されたタスクを表すドキュメントを格納する Firestore コレクションにリスナーを追加します。このリスナーを追加すると、このコレクションに加えられたすべての更新を受け取ります。

コードを記述する

StorageServiceImpl.kt で利用可能な Flow を次のように更新します。

model/service/impl/StorageServiceImpl.kt

override val tasks: Flow<List<Task>>
    get() =
      auth.currentUser.flatMapLatest { user ->
        firestore.collection(TASK_COLLECTION).whereEqualTo(USER_ID_FIELD, user.id).dataObjects()
      }

このコードは、user.id に基づいてタスク コレクションにリスナーを追加しています。各タスクは、tasks という名前のコレクション内のドキュメントで表され、各タスクには userId という名前のフィールドがあります。currentUser のステータスが変更されると（ログアウトした場合など）、新しい Flow が生成されます。

次に、TasksViewModel.kt の Flow をサービスと同じになるように反映する必要があります。

screens/tasks/TasksViewModel.kt

val tasks = storageService.tasks

最後に、UI を表す TasksScreens.kt の composable function でこのフローを認識し、状態として収集します。状態が変更されるたびに、コンポーズ可能な関数は自動的に再コンポーズされ、最新の状態がユーザーに表示されます。TasksScreen composable function に次のように追加します。

screens/tasks/TasksScreen.kt

val tasks = viewModel
    .tasks
    .collectAsStateWithLifecycle(emptyList())

コンポーズ可能な関数がこれらの状態にアクセスしたら、LazyColumn（画面にリストを表示するために使用する構造）を次のように更新できます。

screens/tasks/TasksScreen.kt

LazyColumn {
    items(tasks.value, key = { it.id }) { taskItem ->
        TaskItem( [...] )
    }
}

テスト

設定が正しく機能することをテストするには、アプリを使用して新しいタスクを追加します（画面右下にある追加ボタンをクリックします）。タスクの作成が完了すると、Firestore コンソールの Firestore コレクションにタスクが表示されます。同じアカウントで別のデバイスで ToDo リストにログインすると、ToDo リストを編集し、すべてのデバイスでリアルタイムに更新を確認できます。

5. パフォーマンス モニタリング

どの機能を追加しますか？

アプリのパフォーマンスが良くない場合、ユーザーはアプリを使用するのをやめてしまう可能性が非常に高いため、パフォーマンスは非常に重要です。簡単なタスクを実行するのに時間がかかりすぎるからです。そのため、ユーザーがアプリ内で行う特定のジャーニーに関する指標を収集すると役に立つ場合があります。これを実現するために、Firebase Performance Monitoring にはカスタム トレースが用意されています。Make it So では、次の手順に沿ってカスタム トレースを追加し、さまざまなコードでパフォーマンスを測定します。

コードを記述する

Performance.kt ファイルを開くと、trace というインライン関数が表示されます。この関数は、Performance Monitoring API を呼び出してカスタム トレースを作成し、トレース名をパラメータとして渡します。もう 1 つのパラメータは、モニタリングするコードブロックです。各トレースで収集されるデフォルトの指標は、実行が完了するまでにかかった時間です。

model/service/Performance.kt

inline fun <T> trace(name: String, block: Trace.() -> T): T = Trace.create(name).trace(block)

測定に重要と思われるコードベースの部分を選択し、そこにカスタム トレースを追加できます。ここでは、この Codelab の前半（AccountServiceImpl.kt）で確認した linkAccount 関数にカスタム トレースを追加する例を示します。

model/service/impl/AccountServiceImpl.kt

override suspend fun linkAccount(email: String, password: String): Unit =
  trace(LINK_ACCOUNT_TRACE) {
      val credential = EmailAuthProvider.getCredential(email, password)
      auth.currentUser!!.linkWithCredential(credential).await()
  }

それでは実際に試してみましょう。Make it So アプリにカスタム トレースを追加し、次のセクションに進んで、想定どおりに動作するかどうかをテストします。

テスト

カスタム トレースの追加が完了したら、アプリを実行し、測定対象の機能を数回使用します。次に、Firebase コンソールでパフォーマンス ダッシュボードに移動します。画面下部には、[ネットワーク リクエスト]、[カスタム トレース]、[画面のレンダリング] の 3 つのタブがあります。

[カスタム トレース] タブに移動し、コードベースに追加したトレースが表示されていることと、これらのコードの実行に通常どれくらいの時間がかかるかを確認します。

6. Remote Config

どの機能を追加しますか？

Remote Config には、アプリの外観をリモートで変更する、ユーザー セグメントごとに異なる動作を構成するなど、さまざまなユースケースがあります。この Codelab では、Remote Config を使用して、Make it So アプリで新しいタスク編集機能を表示または非表示にする機能切り替えを作成します。

コーディングの時間です。

まず、Firebase コンソールで構成を作成する必要があります。これを行うには、Remote Config ダッシュボードに移動し、[パラメータを追加] ボタンをクリックします。下の画像に沿って各フィールドに情報を入力します。

すべてのフィールドに入力したら、[保存] ボタンをクリックし、[公開] をクリックします。パラメータが作成され、コードベースで使用できるようになったので、新しい値をフェッチするコードをアプリに追加する必要があります。ConfigurationServiceImpl.kt ファイルを開き、次の 2 つの関数の実装を更新します。

model/service/impl/ConfigurationServiceImpl.kt

override suspend fun fetchConfiguration(): Boolean {
  return remoteConfig.fetchAndActivate().await()
}

override val isShowTaskEditButtonConfig: Boolean
  get() = remoteConfig[SHOW_TASK_EDIT_BUTTON_KEY].asBoolean()

最初の関数はサーバーから値を取得し、アプリが起動するとすぐに SplashViewModel.kt で呼び出されます。最初からすべての画面で最新の値を利用できるようにするには、この方法が最適です。ユーザーが何かをしている最中に、後で UI やアプリの動作を変更すると、ユーザー エクスペリエンスが低下します。

2 つ目の関数は、コンソールで作成したパラメータに公開されているブール値を返します。この情報を TasksViewModel.kt で取得するには、loadTaskOptions 関数に次のコードを追加します。

screens/tasks/TasksViewModel.kt

fun loadTaskOptions() {
  val hasEditOption = configurationService.isShowTaskEditButtonConfig
  options.value = TaskActionOption.getOptions(hasEditOption)
}

最初の行で値を取得し、それを使用して 2 行目のタスクアイテムのメニュー オプションを読み込みます。値が false の場合は、メニューに編集オプションが含まれていません。オプションのリストができたら、次は UI に正しく表示されるようにする必要があります。Jetpack Compose でアプリを作成する場合は、TasksScreen の UI がどのように見えるかを宣言する composable function を見つける必要があります。TasksScreen.kt ファイルを開き、TasksViewModel.kt で利用可能なオプションを指すように LazyColum を更新します。

screens/tasks/TasksScreen.kt

val options by viewModel.options

LazyColumn {
  items(tasks.value, key = { it.id }) { taskItem ->
    TaskItem(
      options = options,
      [...]
    )
  }
}

TaskItem は、単一のタスクの UI の外観を宣言する別の composable function です。各タスクには、タスクの末尾にあるその他アイコンをクリックすると表示されるオプション メニューがあります。

テストする時間です。

これでアプリを実行する準備が整いました。Firebase コンソールを使用して公開した値が、アプリの動作と一致していることを確認します。

• false の場合は、その他アイコンをクリックすると 2 つのオプションが表示されます。
• true の場合は、その他アイコンをクリックすると 3 つのオプションが表示されます。

コンソールで値を数回変更して、アプリを再起動してみてください。このように、Remote Config を使用してアプリ内の新機能を簡単にリリースできます。

7. 完了

Firebase と Jetpack Compose を使用して Android アプリを正常に作成できました。

UI 用の Jetpack Compose で完全に構築された Android アプリに Firebase Authentication、Performance Monitoring、Remote Config、Cloud Firestore を追加し、推奨される MVVM アーキテクチャに適合するようにしました。

参考資料

• Firebase と Compose を使用して Android アプリを作成する
• Jetpack Compose アプリに Firebase Authentication を追加する
• Jetpack Compose アプリに Cloud Firestore を追加する
• Firebase と Compose でビルドした Android アプリにコルーチンと Flow を追加する
• Firebase Performance Monitoring を Jetpack Compose アプリに追加する
• Firebase Remote Config を Jetpack Compose アプリに追加する

リファレンス ドキュメント

• Firebase Authentication
• Cloud Firestore
• Performance Monitoring
• Remote Config