Cloud Firestore integration in Android Kotlin

Introduction

Cloud Firestore lets your app save and get data from the cloud easily. It helps your app share data between users and devices in real time.

You want to save user notes or messages online so they can access them from any device.

Your app needs to show live updates, like chat messages or scores, without refreshing.

You want to store app settings or user profiles in a central place.

You want to build a to-do list app that syncs tasks across phones.

You want to keep track of user activity or preferences in the cloud.

Syntax

Android Kotlin

val db = FirebaseFirestore.getInstance()
db.collection("collectionName").document("docId").set(dataMap)
  .addOnSuccessListener { /* success code */ }
  .addOnFailureListener { /* failure code */ }

Use getInstance() to get the Firestore database object.

Use collection() and document() to point to where you want to save or read data.

Examples

This saves a user with name and age to the 'users' collection under 'user1' document.

Android Kotlin

val db = FirebaseFirestore.getInstance()

// Save data to a document
val user = hashMapOf("name" to "Alice", "age" to 25)
db.collection("users").document("user1").set(user)

This reads the 'name' field from the 'user1' document in 'users' collection.

Android Kotlin

val db = FirebaseFirestore.getInstance()

// Read data from a document
val docRef = db.collection("users").document("user1")
docRef.get().addOnSuccessListener { document ->
  if (document != null && document.exists()) {
    val name = document.getString("name")
  }
}

This listens for live changes to the 'user1' document and updates the app automatically.

Android Kotlin

val db = FirebaseFirestore.getInstance()

// Listen for real-time updates
val docRef = db.collection("users").document("user1")
docRef.addSnapshotListener { snapshot, e ->
  if (e != null) return@addSnapshotListener
  if (snapshot != null && snapshot.exists()) {
    val age = snapshot.getLong("age")
  }
}

Sample App

This app saves a user named Bob with age 30 to Firestore. It shows a message on screen if saving worked or failed.

Android Kotlin

import android.os.Bundle
import android.widget.TextView
import androidx.appcompat.app.AppCompatActivity
import com.google.firebase.firestore.FirebaseFirestore

class MainActivity : AppCompatActivity() {
  private lateinit var db: FirebaseFirestore
  private lateinit var textView: TextView

  override fun onCreate(savedInstanceState: Bundle?) {
    super.onCreate(savedInstanceState)
    textView = TextView(this)
    setContentView(textView)

    db = FirebaseFirestore.getInstance()

    val user = hashMapOf("name" to "Bob", "age" to 30)
    db.collection("users").document("user1").set(user)
      .addOnSuccessListener {
        textView.text = "User saved successfully"
      }
      .addOnFailureListener {
        textView.text = "Failed to save user"
      }
  }
}

Important Notes

Make sure to add Firebase to your Android project and include Firestore dependencies.

Firestore operations are asynchronous, so use listeners to handle success or failure.

Always check for null or errors when reading data to avoid crashes.

Summary

Cloud Firestore stores and syncs app data in the cloud.

Use FirebaseFirestore.getInstance() to start using Firestore.

Save, read, and listen to data with simple Kotlin code and listeners.

Practice

1. What is the primary purpose of Cloud Firestore in an Android app?

easy

A. To compile Kotlin code

B. To design the app's user interface

C. To store and sync app data in the cloud

D. To manage app permissions

Solution

1. Step 1: Understand Cloud Firestore's role

   Cloud Firestore is a cloud database service that stores and syncs app data.

2. Step 2: Differentiate from other app functions

   UI design, code compilation, and permission management are handled by other tools, not Firestore.

3. Final Answer:

   To store and sync app data in the cloud -> Option C

4. Quick Check:

   Cloud Firestore = Data storage and sync [OK]

Hint: Remember Firestore is a cloud database, not UI or code tool [OK]

Common Mistakes:

• Confusing Firestore with UI design tools
• Thinking Firestore compiles code
• Assuming Firestore manages app permissions

2. Which Kotlin code correctly initializes a Firestore instance?

easy

A. val db = FirebaseFirestore.getInstance()

B. val db = Firestore.getInstance()

C. val db = Firebase.getFirestore()

D. val db = FirestoreClient.get()

Solution

1. Step 1: Recall Firestore initialization syntax

   The official way to get Firestore instance in Kotlin is FirebaseFirestore.getInstance().

2. Step 2: Check other options for correctness

   Other options use incorrect class or method names not in Firestore API.

3. Final Answer:

   val db = FirebaseFirestore.getInstance() -> Option A

4. Quick Check:

   Correct Firestore init = val db = FirebaseFirestore.getInstance() [OK]

Hint: Use FirebaseFirestore.getInstance() to start Firestore [OK]

Common Mistakes:

• Using Firestore.getInstance() which does not exist
• Confusing FirebaseFirestore with Firebase class
• Using FirestoreClient which is not part of Android SDK

3. Given this code snippet, what will be printed if the document exists with field "name" = "Alice"?

val db = FirebaseFirestore.getInstance()
db.collection("users").document("user1").get()
  .addOnSuccessListener { document ->
    if (document != null && document.exists()) {
      println(document.getString("name"))
    } else {
      println("No such document")
    }
  }

medium

A. Alice

B. No such document

C. null

D. Error at runtime

Solution

1. Step 1: Understand the get() and success listener

   The get() fetches the document asynchronously; if it exists, the listener runs the success block.

2. Step 2: Check document existence and print field

   Since document exists and has "name" = "Alice", println(document.getString("name")) prints "Alice".

3. Final Answer:

   Alice -> Option A

4. Quick Check:

   Document exists with name = Alice [OK]

Hint: If document exists, getString returns the field value [OK]

Common Mistakes:

• Assuming document is null when it exists
• Expecting 'No such document' incorrectly
• Confusing getString with get() returning document

4. Identify the error in this Firestore write operation:

val db = FirebaseFirestore.getInstance()
db.collection("users").document("user1").set("name", "Bob")

medium

A. document() must be called after set()

B. Collection name cannot be "users"

C. FirebaseFirestore.getInstance() is incorrect

D. set() requires a Map or an object, not two parameters

Solution

1. Step 1: Check set() method signature

   set() expects a single argument: a Map or an object representing fields and values.

2. Step 2: Analyze the provided code

   Passing two parameters "name", "Bob" is invalid and causes a compile error.

3. Final Answer:

   set() requires a Map or an object, not two parameters -> Option D

4. Quick Check:

   set() needs one argument (Map/object) [OK]

Hint: Use a Map for set(), not separate key-value parameters [OK]

Common Mistakes:

• Passing multiple parameters to set() instead of a Map
• Calling document() after set() instead of before
• Thinking collection name restrictions cause error

5. You want to listen in real-time to changes in a Firestore collection "messages" and update your UI accordingly. Which code snippet correctly sets up this listener?

hard

A. db.collection("messages").get().addOnSuccessListener { snapshots -> for (doc in snapshots) { println(doc.getString("text")) } }

B. db.collection("messages").addSnapshotListener { snapshots, e -> if (e != null) { println("Listen failed") } else { for (doc in snapshots!!) { println(doc.getString("text")) } } }

C. db.collection("messages").document().addSnapshotListener { doc, e -> println(doc?.getString("text")) }

D. db.collection("messages").addListener { snapshots -> println(snapshots) }

Solution

1. Step 1: Understand real-time listeners in Firestore

   addSnapshotListener listens for real-time updates on a collection or document.

2. Step 2: Analyze each option

   db.collection("messages").addSnapshotListener { snapshots, e -> if (e != null) { println("Listen failed") } else { for (doc in snapshots!!) { println(doc.getString("text")) } } } correctly uses addSnapshotListener on collection with error check and iterates snapshots. db.collection("messages").get().addOnSuccessListener { snapshots -> for (doc in snapshots) { println(doc.getString("text")) } } uses get() which is one-time fetch. db.collection("messages").document().addSnapshotListener { doc, e -> println(doc?.getString("text")) } listens on a document without specifying ID. db.collection("messages").addListener { snapshots -> println(snapshots) } uses non-existent addListener method.

3. Final Answer:

   db.collection("messages").addSnapshotListener { snapshots, e -> if (e != null) { println("Listen failed") } else { for (doc in snapshots!!) { println(doc.getString("text")) } } } -> Option B

4. Quick Check:

   Real-time listener = addSnapshotListener on collection [OK]

Hint: Use addSnapshotListener on collection for real-time updates [OK]

Common Mistakes:

• Using get() instead of addSnapshotListener for real-time
• Calling addSnapshotListener on document without ID
• Using non-existent addListener method