如何使用kotlin数据类获取Firestore文档的文档ID

Question

我有kotlin数据类

data class Client(

    val name: String = "",
    val email: String = "",
    val phone: String ="") {
constructor():this("","","")}

我让firestore将数据填充到类中很好,但是我不知道如何将文档id放入数据类而不必在文档本身中设置它.这可能吗？

Answer 1

是的,使用可以获得id而不存储它DocumentSnapshot.我将尝试在此构建完整的示例.

我创建了一个通用的Model类来保存id:

@IgnoreExtraProperties
public class Model {
    @Exclude
    public String id;

    public <T extends Model> T withId(@NonNull final String id) {
        this.id = id;
        return (T) this;
    }
}

然后用任何模型扩展它,不需要实现任何东西:

public class Client extends Model

如果我在这里有客户列表,尝试查询列表以仅获得客户age == 20:

clients.whereEqualTo("age", 20)
        .get()
        .addOnCompleteListener(new OnCompleteListener<QuerySnapshot>() {
            @Override
            public void onComplete(@NonNull Task<QuerySnapshot> task) {
                if (task.isSuccessful()) {
                    for (DocumentSnapshot documentSnapshot : task.getResult().getDocuments()) {
                        // here you can get the id. 
                        Client client = document.toObject(client.class).withId(document.getId());
                       // you can apply your actions...
                    }
                } else {

                }
            }
        });

如果您正在使用EventListener,您还可以获得如下ID:

clients.addSnapshotListener(new EventListener<QuerySnapshot>() {
    @Override
    public void onEvent(QuerySnapshot documentSnapshots, FirebaseFirestoreException e) {
        for (DocumentChange change : documentSnapshots.getDocumentChanges()) {
            // here you can get the id. 
                        Client client = document.toObject(client.class).withId(document.getId());
                       // you can apply your actions...
        }
    }
});

documentSnapshot.getId()) 将在不将id保存到文档中的情况下获取集合中Document的id.

使用Model不会让你编辑任何模型,也不要忘记使用 @IgnoreExtraProperties

Answer 2

很棒的解决方案。看起来 Firestore 想出了一种向模型添加注释的方法来解决这个问题。

你可以这样做：

@DocumentId
val documentId: String

然后 Firestore 将在调用toObjector时生成该字段toObjects。当您.set()在 Firestore 中查看文档时，它将排除此字段。

Answer 3

我刚刚改进了@iCediCe的解决方案，并向DocumentSnapshot和QuerySnapshot添加了方法。

interface HasId {
    var id : String
}

inline fun <reified T : HasId> DocumentSnapshot.toObjectWithId(): T {
    return this.toObject(T::class.java)!!.also {
        it.id = this.id
    }
}

inline fun <reified T : HasId> QuerySnapshot.toObjectsWithId(): List<T> {
    return this.documents.map {
        it.toObjectWithId<T>()
    }
}

和用法：

data class User(
    @get:Exclude
    override var id: String,
    ...
): HasId


val user = documentSnapshot.toObjectWithId<User>()
val users = querySnapshot.toObjectsWithId<User>()

Answer 4

这是我解决问题的方法。

data class Client(
    val name: String = "",
    val email: String = "",
    val phone: String ="",
    @get:Exclude var id: String = "") {
constructor():this("","","")
}

我在ID上使用@get：Exclude来确保在保存时不会将ID发送到Firestore，然后在获取客户端列表时执行此操作：

snapshot.documents.mapTo(list) {
            var obj = it.toObject(Client::class.java)
            obj.id = it.id
            obj
        }

将新对象的ID设置为文档引用的ID。

Answer 5

我通过在QueryDocumentSnapshot上创建扩展方法来解决此问题，如下所示：

inline fun <reified T : HasId>QueryDocumentSnapshot.toObjectWithId(): T {
    val model = this.toObject(T::class.java)
    model.id = this.id
    return  model
}

现在，我可以像这样映射（看起来很干净）：
myModelWithId = it.toObjectWithId<MyModel>()

为此，我制作了一个简单的hasId接口，模型需要实现该接口：

interface HasId{
    var id : String
}

@IgnoreExtraProperties
data class MyModel(
        @get:Exclude override var id : String    = "",
        val data                     : String    = "",

): Serializable, HasId