如何向Firestore添加带有自定义ID的数据？

以下是自动生成文档ID的Firestore写入代码：

db.collection("users")
                .add(user)
                .addOnSuccessListener(new OnSuccessListener<DocumentReference>() {
                    @Override
                    public void onSuccess(DocumentReference documentReference) {
                        Log.d(TAG, "DocumentSnapshot added with ID: " + documentReference.getId());
                    }
                })
                .addOnFailureListener(new OnFailureListener() {
                    @Override
                    public void onFailure(@NonNull Exception e) {
                        Log.w(TAG, "Error adding document", e);
                    }
                });

• 上述代码会自动生成文档ID。

自定义文档ID的实现方式 #

要向Firestore写入带自定义ID的数据，只需替换add()方法为**指定文档ID后调用set()**的逻辑，具体实现如下：

完整代码示例 #

// 定义自定义文档ID，建议使用业务场景中的唯一标识（如用户ID、手机号等）
String customDocumentId = "user_123456";

db.collection("users")
        .document(customDocumentId) // 明确指定自定义文档ID
        .set(user)
        .addOnSuccessListener(new OnSuccessListener<Void>() {
            @Override
            public void onSuccess(Void unused) {
                Log.d(TAG, "文档写入成功，自定义ID：" + customDocumentId);
            }
        })
        .addOnFailureListener(new OnFailureListener() {
            @Override
            public void onFailure(@NonNull Exception e) {
                Log.w(TAG, "写入自定义ID文档失败", e);
            }
        });

核心要点 #

• 指定文档ID：通过document(customDocumentId)方法传入自定义的ID字符串，Firestore会将数据写入对应ID的文档。
• 数据写入逻辑：set(user)会直接写入数据，若该ID的文档已存在，会覆盖原有内容；如果需要保留原有字段仅更新新数据，可使用set(user, SetOptions.merge())。
• ID唯一性：自定义ID必须保证在集合内唯一，重复ID会覆盖已有文档，建议使用业务中天然唯一的标识（如用户UID、手机号）作为文档ID。

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