MongoDB C#驱动FindOneAndReplace Upsert无法返回有效ObjectId问题

问题现象 #

使用MongoDB C#驱动的FindOneAndReplace方法配合IsUpsert=true执行Upsert操作时，插入的文档ID始终是全零的ObjectId.Empty，但使用InsertOne方法却能正常生成有效ID。

问题代码片段 #

Upsert方法：

public MyDocumentType UpsertOne(MyDocumentType doc)
{
    var options = new FindOneAndReplaceOptions<MyDocumentType>
    {
        IsUpsert = true,
        ReturnDocument = ReturnDocument.After,
    };
    var filter = Builders<MyDocumentType>.Filter.Eq(d => d.Id, doc.Id);
    var upsertedDoc = _collection.FindOneAndReplace(filter, doc, options);
    return doc;
}

Insert方法：

public MyDocumentType InsertOne(MyDocumentType doc)
{
    _collection.InsertOne(doc);
    return doc;
}

测试输出 #

var db = new MongoService();
db.Connect();
var documentWithZeroedId = db.UpsertOne(document);
Console.WriteLine($"Upsert Document ID: {documentWithZeroedId.Id}");

var documentWithValidId = db.InsertOne(document);
Console.WriteLine($"Insert Document ID: {documentWithValidId.Id}");

// 输出：
Connected to Mongo!
Upsert Document ID: 000000000000000000000000
Insert Document ID: 6620b59ca4421c3c294c0b09

原因分析 #

1. InsertOne方法会自动检测文档ID是否为ObjectId.Empty，如果是则自动生成新的ObjectId并赋值给文档对象；
2. FindOneAndReplace在Upsert场景下，是直接将传入的文档对象插入数据库，不会自动为已设置（即使是全零）的ID字段生成新值；
3. 原代码返回的是传入的原始doc对象，而非数据库返回的upsertedDoc，即使数据库端有ID生成逻辑，也无法同步到原始对象。

解决方案 #

方法1：手动生成ObjectId（推荐） #

在执行Upsert前检查ID是否为全零，若未初始化则手动生成新ID，同时返回数据库返回的文档对象：

public MyDocumentType UpsertOne(MyDocumentType doc)
{
    // 检查ID是否未初始化，手动生成新ObjectId
    if (doc.Id == ObjectId.Empty)
    {
        doc.Id = ObjectId.GenerateNewId();
    }

    var options = new FindOneAndReplaceOptions<MyDocumentType>
    {
        IsUpsert = true,
        ReturnDocument = ReturnDocument.After,
    };

    var filter = Builders<MyDocumentType>.Filter.Eq(d => d.Id, doc.Id);
    var upsertedDoc = _collection.FindOneAndReplace(filter, doc, options);
    
    // 返回数据库返回的文档，确保拿到最新状态
    return upsertedDoc ?? doc;
}

方法2：使用更新定义替代全文档替换 #

如果不想手动生成ID，可以使用FindOneAndUpdate配合更新定义，让MongoDB在Upsert时自动生成ID（仅当ID字段未设置时）：

public MyDocumentType UpsertOne(MyDocumentType doc)
{
    // 构建更新字段，而非替换整个文档
    var update = Builders<MyDocumentType>.Update
        .Set(d => d.TopLevelField, doc.TopLevelField)
        .Set(d => d.Values, doc.Values);

    var options = new FindOneAndUpdateOptions<MyDocumentType>
    {
        IsUpsert = true,
        ReturnDocument = ReturnDocument.After,
    };

    var filter = Builders<MyDocumentType>.Filter.Eq(d => d.Id, doc.Id);
    var upsertedDoc = _collection.FindOneAndUpdate(filter, update, options);
    
    return upsertedDoc;
}

关键注意点 #

• 必须返回数据库返回的upsertedDoc对象，而非传入的原始doc，才能获取到数据库生成的ID；
• ObjectId.Empty是判断ID是否未初始化的标准方式。

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