Data storage is an essential element in Android app development. Cloud Firestore, part of Google’s Firebase platform, is a NoSQL database that enables real-time data storage, synchronization, and management. In this tutorial, we will take a closer look at how to use Cloud Firestore in an Android app using Kotlin.<\/p>\n
Firebase is a comprehensive platform for mobile and web application development, providing authentication, data storage, hosting, and cloud functions. Firestore is Firebase’s database service, which allows for structured data storage and offers features similar to a real-time database.<\/p>\n
After creating a new project in Android Studio, let\u2019s set up Firebase and Firestore.<\/p>\n
Add Firebase and Firestore dependencies in the project’s Initialize Firebase in the application’s entry point, Firestore stores data in the form of documents and collections. A document consists of key-value pairs, and a collection is a group of documents.<\/p>\n Let\u2019s look at an example of how to store data in Firestore. For instance, if you want to store user information, you can use the following code:<\/p>\n Firestore provides functionality to detect changes in data in real-time. Through this, you can easily receive changes in data and update the UI.<\/p>\n A basic example of reading data from Firestore is as follows:<\/p>\n To detect changes in data in real-time, you can use the Modifying and deleting data in Firestore is also very easy. Here\u2019s how to modify and delete data.<\/p>\n To modify a specific document, use the following code:<\/p>\n Here\u2019s how to delete data:<\/p>\n One of the most important aspects of using Firestore is security. You can manage data access permissions by setting security rules in the Firebase console.<\/p>\n In this tutorial, we learned how to use Firebase and Firestore in an Android app using Kotlin. By leveraging Cloud Firestore, you can manage data in real-time and maximize app performance with various features. Try applying this knowledge to real projects to gain more experience.<\/p>\nbuild.gradle<\/code> file:<\/p>\ndependencies {\n implementation platform('com.google.firebase:firebase-bom:31.0.2')\n implementation 'com.google.firebase:firebase-firestore-ktx'\n implementation 'com.google.firebase:firebase-auth-ktx'\n }\n <\/code><\/pre>\n2.3 Initializing Firebase<\/h3>\n
MainActivity<\/code>:<\/p>\nimport com.google.firebase.FirebaseApp\n \n class MainActivity : AppCompatActivity() {\n override fun onCreate(savedInstanceState: Bundle?) {\n super.onCreate(savedInstanceState)\n setContentView(R.layout.activity_main)\n FirebaseApp.initializeApp(this) \/\/ Initialize Firebase\n }\n }\n <\/code><\/pre>\n3. Firestore Data Structure<\/h2>\n
3.1 Example of Storing Data<\/h3>\n
import com.google.firebase.firestore.FirebaseFirestore\n \n class MainActivity : AppCompatActivity() {\n private lateinit var db: FirebaseFirestore\n \n override fun onCreate(savedInstanceState: Bundle?) {\n super.onCreate(savedInstanceState)\n setContentView(R.layout.activity_main)\n \n db = FirebaseFirestore.getInstance()\n saveUser()\n }\n \n private fun saveUser() {\n val user = hashMapOf(\n \"first\" to \"Jane\",\n \"last\" to \"Doe\",\n \"born\" to 1990\n )\n \n db.collection(\"users\")\n .add(user)\n .addOnSuccessListener { documentReference ->\n Log.d(TAG, \"DocumentSnapshot added with ID: ${documentReference.id}\")\n }\n .addOnFailureListener { e ->\n Log.w(TAG, \"Error adding document\", e)\n }\n }\n }\n <\/code><\/pre>\n4. Reading Data and Real-time Updates<\/h2>\n
4.1 Example of Reading Data<\/h3>\n
private fun getUser() {\n db.collection(\"users\")\n .get()\n .addOnSuccessListener { documents ->\n for (document in documents) {\n Log.d(TAG, \"${document.id} => ${document.data}\")\n }\n }\n .addOnFailureListener { exception ->\n Log.w(TAG, \"Error getting documents: \", exception)\n }\n }\n <\/code><\/pre>\n4.2 Example of Real-time Updates<\/h3>\n
addSnapshotListener<\/code> method:<\/p>\nprivate fun listenToUsers() {\n db.collection(\"users\")\n .addSnapshotListener { snapshots, e ->\n if (e != null) {\n Log.w(TAG, \"Listen failed.\", e)\n return@addSnapshotListener\n }\n\n if (snapshots != null) {\n for (doc in snapshots.documentChanges) {\n if (doc.type == DocumentChange.Type.ADDED) {\n Log.d(TAG, \"New city: ${doc.document.data}\")\n }\n \/\/ Other types can also be handled (MODIFIED, REMOVED, etc.)\n }\n }\n }\n }\n <\/code><\/pre>\n5. Modifying and Deleting Data<\/h2>\n
5.1 Example of Modifying Data<\/h3>\n
private fun updateUser(userId: String) {\n val userUpdates = hashMapOf(\n \"last\" to \"Smith\", \/\/ Change last name\n )\n\n db.collection(\"users\").document(userId)\n .update(userUpdates)\n .addOnSuccessListener {\n Log.d(TAG, \"User successfully updated!\")\n }\n .addOnFailureListener { e ->\n Log.w(TAG, \"Error updating document\", e)\n }\n }\n <\/code><\/pre>\n5.2 Example of Deleting Data<\/h3>\n
private fun deleteUser(userId: String) {\n db.collection(\"users\").document(userId)\n .delete()\n .addOnSuccessListener {\n Log.d(TAG, \"User successfully deleted!\")\n }\n .addOnFailureListener { e ->\n Log.w(TAG, \"Error deleting document\", e)\n }\n }\n <\/code><\/pre>\n6. Setting Up Security Rules<\/h2>\n
6.1 Default Security Rules<\/h3>\n
rules_version = '2';\n service cloud.firestore {\n match \/databases\/{database}\/documents {\n match \/users\/{userId} {\n allow read, write: if request.auth != null;\n }\n }\n }\n <\/code><\/pre>\n7. Conclusion<\/h2>\n
References<\/h2>\n