MongoTemplate中setOnInsert與set方法的深度解析

在Spring Data MongoDB的MongoTemplate中，setOnInsert和set方法都是在更新文檔時使用的，但它們在處理upsert操作（即，如果文檔不存在則插入，存在則更新）時扮演著截然不同的角色。

核心區別：操作的觸發時機

setOnInsert和set最核心的區別在于它們執行的條件：

• set(): 無論操作是更新現有文檔還是插入新文檔，set()方法指定的字段都會被設置或更新。
• setOnInsert(): setOnInsert()方法指定的字段僅在upsert操作導致新文檔被插入時才會被設置。如果upsert操作匹配到了現有文檔并進行更新，那么setOnInsert()中的設置將被忽略。

可以簡單地理解為，setOnInsert是為新插入的文檔設置一個初始值或默認值，而set則是對文檔進行常規的更新。

使用場景與代碼示例

setOnInsert和set通常與upsert: true選項結合使用。 upsert為true意味著，如果查詢條件沒有找到匹配的文檔，MongoDB將會創建一個新的文檔。

場景示例： 假設我們有一個products集合，我們希望在產品首次被添加到數據庫時設置一個默認的庫存數量（defaultQty），同時在每次更新時都更新產品的名稱（item）。

使用MongoTemplate實現：

import org.springframework.data.mongodb.core.MongoTemplate;
import org.springframework.data.mongodb.core.query.Criteria;
import org.springframework.data.mongodb.core.query.Query;
import org.springframework.data.mongodb.core.query.Update;// ...public void upsertProduct(MongoTemplate mongoTemplate, String productId, String itemName) {Query query = new Query(Criteria.where("_id").is(productId));Update update = new Update().set("item", itemName).setOnInsert("defaultQty", 100);mongoTemplate.upsert(query, update, "products");
}

操作結果分析:

• 當productId對應的文檔不存在時：

  • upsert操作會創建一個新的文檔。
  • set("item", itemName)會被執行，新文檔的item字段被設置為itemName。
  • setOnInsert("defaultQty", 100)也會被執行，新文檔的defaultQty字段被設置為100。
  • 最終插入的文檔為：{ "_id": productId, "item": "newItemName", "defaultQty": 100 }

• 當productId對應的文檔已存在時：

  • upsert操作會匹配到現有的文檔。
  • set("item", itemName)會被執行，現有文檔的item字段被更新為新的itemName。
  • setOnInsert("defaultQty", 100)將被忽略，因為沒有發生插入操作。
  • 如果原文檔是{ "_id": productId, "item": "oldItemName", "defaultQty": 50 }，更新后的文檔將是{ "_id": productId, "item": "newItemName", "defaultQty": 50 }。

注意事項

• 字段不能重復: 在同一個Update對象中，同一個字段不能同時出現在set()和setOnInsert()中，否則會引發錯誤。
• upsert是關鍵: setOnInsert的效果完全依賴于upsert操作。如果upsert為false（默認情況），setOnInsert將永遠不會生效。

總結

總的來說，set和setOnInsert為在MongoTemplate中執行upsert操作提供了強大的靈活性：

方法	描述	使用場景
set()	無論文檔是插入還是更新，都設置或更新指定的字段。	需要對字段進行常規更新，不論其是否存在。
setOnInsert()	僅在upsert操作插入新文檔時設置指定的字段。	為新創建的文檔設置創建時間、初始狀態、默認值等一次性屬性。