Firebase cloud firestore

Firebase是一家实时后端数据库创业公司，它能帮助开发者很快的写出Web端和移动端的应用，无需管理基础架构，快速构建您的应用。自2014年10月Google收购Firebase以来，用户可以在更方便地使用Firebase的同时，结合Google的云服务。

Cloud Firestore 官方文档

Cloud Firestore 和 Realtime Database进行对比

Cloud Firestore 是firebase提供的新型数据库，相比于Realtime Database更直观的展现数据，更快的查询，功能列强大
都支持离线模式
实时数据库和 Cloud Firestore 都是 NoSQL 数据库。
实时数据库将数据存储为一个大型 JSON 树，Cloud Firestore 将数据存储为文档集合。

数据模型

文档 - 在 Cloud Firestore中，存储单元是文档。文档是一个轻量级记录，包含映射到值的字段。每个文档都用一个名称进行标识
集合 - 文档存在于集合中，而集合只是文档的容器
您无需“创建”或“删除”集合。在集合中创建第一个文档之后，集合才会存在。如果删除集合中的所有文档，集合将不再存在。
所以文档结构可以是coll/doc/subcoll/subdoc 可以一直嵌套
[图片上传失败...(image-c8ba6a-1592561180755)]

向 Cloud Firestore 添加数据

在集合中设置文档的数据，并明确指定一个文档标识符
向集合添加新文档。在这种情况下，Cloud Firestore 会自动生成文档标识符。
在文档下面添加相应的数据

举个例子，例如先自定义对象

data class User(val name: String, val age: Int)

往firestore建立的document michat/users/ 目录下写入具体数据，此时指定了文档id为users

val mDocRef = FirebaseFirestore.getInstance().collection("michat").document("users")
mDocRef.set(User(nameView.text.toString(), ageView.text.toString().toInt()))
                .addOnSuccessListener {
                    Log.d("FirstFragment", "save success......")
                    Toast.makeText(context, "save success", Toast.LENGTH_LONG).show()
                }
                .addOnFailureListener {
                    Log.d("FirstFragment", "save failed......$it")
                    Toast.makeText(context, "save failed", Toast.LENGTH_LONG).show()
                }

如果有时无法为文档指定有意义的 ID，让 Cloud Firestore 为您自动生成 ID 会比较方便。您可以通过调用 add() 来实现此目的：

// Add a new document with a generated id.
val data = hashMapOf(
        "name" to "Tokyo",
        "country" to "Japan"
)

db.collection("cities")
    .add(data)
    .addOnSuccessListener { documentReference ->
        Log.d(TAG, "DocumentSnapshot written with ID: ${documentReference.id}")
    }
    .addOnFailureListener { e ->
        Log.w(TAG, "Error adding document", e)
    }

如果是只更新某个字段，而不是全覆盖，也是支持的

mDocRef.update("name", "wangbin-update")

递增数值
您可以递增或递减数字字段值，如以下示例所示。递增或递减操作会在字段的当前值基础上增加或减少给定数量。如果该字段不存在或者当前字段值不是数值，则相应操作会将该字段设置为给定值。这点在动态配置时非常灵活

mDocRef.update("age", FieldValue.increment(10))

使用 Cloud Firestore 获取数据

获取单个文档，如获取nearby
先定义nearby对象用来解析数据

class NearBy : Serializable {
    var ad: Ad? = null
    var alias: String = ""
    override fun toString(): String {
        return "${ad?.flag}, ${ad?.index}, $alias"
    }
}

class Ad : Serializable {
    var flag: Boolean = false
    var index: String = ""
}

通过get来成功获取firestore上的nearby文档

val docRef = FirebaseFirestore.getInstance().collection("michat").document("nearby")
        fetchBtn.setOnClickListener {
            docRef.get().addOnSuccessListener {
                if (it.exists()) {
                    val result = it.toObject(NearBy::class.java)
                    Log.d("FirstFragment", "fetch success......$result")
                    desTv.text = "fetch result:$result"
                    Toast.makeText(context, "fetch success", Toast.LENGTH_LONG).show()
                }
            }
                .addOnFailureListener {
                    Log.d("FirstFragment", "fetch failed......$it")
                    Toast.makeText(context, "fetch failed", Toast.LENGTH_LONG).show()
                }
        }

从集合中获取多个文档
您还可以查询某个集合中的文档，从而使用一个请求检索多个文档。例如，您可以使用 where() 来查询满足特定条件的所有文档，然后使用 get() 检索结果：

FirebaseFirestore.getInstance().collection("michat")
            .whereEqualTo("alias", "test").get()
            .addOnSuccessListener {
                Log.d("FirstFragment", "query success result:$it")
                it.forEach { queryDocumentSnapshot ->
                    Log.d("FirstFragment", "query success result:$queryDocumentSnapshot")
                }
            }
            .addOnFailureListener {
                Log.d("FirstFragment", "query failed result:$it")
            }

就能查出包含文档nearby的集合

支持数据库查询排序

简单查询如上面whereEqualTo
复合查询whereEqualTo("state", "CO").whereEqualTo("name", "Denver")
对数据进行排序citiesRef.whereGreaterThan("population", 100000).orderBy("population").limit(2)，只返回人口超过100000的前两个城市

使用 Cloud Firestore 获取实时更新

如实时监听cloud firestore的变化，可以文档设置监听

val docRef = FirebaseFirestore.getInstance().collection("michat").document("nearby")
// 监听某一document的变化
 val registration = docRef.addSnapshotListener(object : EventListener<DocumentSnapshot>{
            override fun onEvent(documentSnapshot: DocumentSnapshot?, exception: FirebaseFirestoreException?) {
                val result = documentSnapshot?.toObject(NearBy::class.java)
                Log.d("FirstFragment", "onEvent listener result$result")
                desTv.text = "fetch result:$result"
            }

        })

这样就可以设置对文档nearby这一层级的监听。对于实时性非常高的场景，就可以使用监听;通过documentSnapshot.metadata.isFromCache来判断数据是来自本地缓存或者是来自服务器

分离监听器
当不再需要监听数据时，您必须分离监听器，以便停止调用事件回调函数。这样客户端可以停止使用带宽来接收更新。例如

registration.remove()

离线访问数据

对于 Android 版和 iOS 版应用，离线持久化默认为启用状态。如需停用持久化，请将 PersistenceEnabled 选项设置为 false
也可以在初始化的时候停用离线持久化

val settings = FirebaseFirestoreSettings.Builder()
        .setPersistenceEnabled(true)
        .build()
db.firestoreSettings = settings

当设备在线时会优先从网络获取文档；如果您在设备离线时获取文档，Cloud Firestore 会从缓存中返回数据。如果缓存不包含该文档的数据，或该文档不存在，则 get 调用会返回一个错误。
配置缓存大小
启用持久化后，Cloud Firestore 会缓存从后端接收的每个文档以便离线访问。Cloud Firestore 为缓存大小设置默认阈值。超出默认值后，Cloud Firestore 会定期尝试清理较旧的未使用文档。您可以配置不同的缓存大小阈值，也可以完全停用清理过程：

// The default cache size threshold is 100 MB. Configure "setCacheSizeBytes"
// for a different threshold (minimum 1 MB) or set to "CACHE_SIZE_UNLIMITED"
// to disable clean-up.
val settings = FirebaseFirestoreSettings.Builder()
        .setCacheSizeBytes(FirebaseFirestoreSettings.CACHE_SIZE_UNLIMITED)
        .build()
db.firestoreSettings = settings

codelab:
https://codelabs.developers.google.com/codelabs/firestore-android/