Firestore：如何在Java自定义模型类中正确存储文档ID？

我之前也纠结过这个问题，确实Firestore官方文档里没明确说明怎么在Java自定义对象里优雅存储自动生成的文档ID，还得避免数据冗余。经过几次尝试，我找到了下面这个靠谱的实现方案：

关键是用Firestore的@Exclude注解来控制字段的存储行为，确保documentId只在我们的Java对象里存在，不会被写到Firestore的文档数据中（毕竟文档本身已经有ID了，存进去就是冗余）：

import com.google.firebase.firestore.Exclude;

public class Note {
    @Exclude // 这个注解是核心！
    private String documentId;
    private String title;
    private String description;

    // Firestore要求必须有公共无参构造函数
    public Note() {}

    // 创建对象时不用传documentId，因为是自动生成的
    public Note(String title, String description) {
        this.title = title;
        this.description = description;
    }

    // Getter和Setter方法
    @Exclude // 如果注解加在字段上，这里也可以不加，不过我习惯一起加上更明确
    public String getDocumentId() {
        return documentId;
    }

    public void setDocumentId(String documentId) {
        this.documentId = documentId;
    }

    public String getTitle() {
        return title;
    }

    public void setTitle(String title) {
        this.title = title;
    }

    public String getDescription() {
        return description;
    }

    public void setDescription(String description) {
        this.description = description;
    }
}

写入Firestore时 #

先生成带自动ID的文档引用，把ID赋值给对象后再写入：

// 初始化Firestore实例（假设已经配置好）
FirebaseFirestore db = FirebaseFirestore.getInstance();

// 创建Note对象，无需指定documentId
Note newNote = new Note("Firestore笔记", "如何优雅存储文档ID");

// 生成自动ID的文档引用
DocumentReference noteRef = db.collection("notes").document();

// 把自动生成的ID赋值给Note对象
newNote.setDocumentId(noteRef.getId());

// 写入Firestore，此时documentId字段会被@Exclude忽略，不会存到文档里
noteRef.set(newNote)
        .addOnSuccessListener(aVoid -> System.out.println("笔记写入成功"))
        .addOnFailureListener(e -> System.err.println("写入失败：" + e.getMessage()));

读取Firestore文档时 #

从快照里获取文档ID，再赋值给对应的Java对象：

db.collection("notes").get()
        .addOnCompleteListener(task -> {
            if (task.isSuccessful()) {
                for (QueryDocumentSnapshot document : task.getResult()) {
                    // 把文档转成Note对象
                    Note note = document.toObject(Note.class);
                    // 手动把文档ID赋值给对象
                    note.setDocumentId(document.getId());
                    // 现在note对象就同时包含了文档数据和对应的ID，方便后续操作
                    System.out.println("笔记ID：" + note.getDocumentId() + "，标题：" + note.getTitle());
                }
            } else {
                System.err.println("读取失败：" + task.getException().getMessage());
            }
        });

• 避免冗余：Firestore文档本身的ID已经是唯一标识，不需要再把它存到文档的字段里，节省存储空间也更规范。
• 使用方便：Java对象里保留documentId字段，后续不管是更新、删除还是展示数据，都可以直接从对象里获取ID，不用再单独处理文档引用。

内容的提问来源于stack exchange，提问作者Florian Walther