Spring Boot操作MongoDB如何更新数组中匹配条件的元素字段

需求场景 #

更新MongoDB集合文档中users数组内，username为指定值（示例为"Mark"）的元素对应的availability字段，不需要提前知道目标元素在数组中的索引位置。

待操作的MongoDB文档结构 #

{
  "name": "test meeting",
  "url": "temporary_url",
  "timezone": "pacific",
  "startTime": 8,
  "endTime": 21,
  "users": [
    {
      "username": "Mark",
      "password": "Caddy",
      "availability": { 
        // 待更新目标字段，内部为对象数组
      }
    },
    {
      "username": "Bill",
      "password": "Bobby",
      "availability": {
        // 对象数组
      }
    }
  ],
  "_class": "com.dcproduction.meetapp.classes.Meeting"
}

原有代码问题 #

原有代码只有手动写死数组索引（例如填0）时才能正常执行更新，无法适配目标元素位置不固定的场景：

Query query = new Query();
    query.addCriteria(
        new Criteria().andOperator(
            Criteria.where("name").is("test meeting"),
            Criteria.where("users.[WHAT GOES HERE?]username").is("Mark")));

    
Update testUpdate = new Update();
testUpdate.set("users[WHAT GOES HERE].availability", some_data);

UpdateResult updateResult = mongoTemplate.updateFirst(query, testUpdate, Meeting.class);

实现方法 #

直接使用MongoDB原生提供的位置操作符$替换占位符即可，该操作符会自动定位到查询条件中匹配的数组元素下标，无需手动指定索引。

修正后可运行代码 #

Query query = new Query();
query.addCriteria(
    new Criteria().andOperator(
        Criteria.where("name").is("test meeting"),
        // 直接通过数组名.内嵌字段名匹配数组内任意元素的对应属性，不需要加索引
        Criteria.where("users.username").is("Mark")
    )
);

Update testUpdate = new Update();
// 用$代替硬编码的数组索引，代表查询条件匹配到的第一个数组元素
testUpdate.set("users.$.availability", some_data);

UpdateResult updateResult = mongoTemplate.updateFirst(query, testUpdate, Meeting.class);

扩展场景：更新数组内所有匹配条件的元素 #

如果业务场景中同一个父文档的users数组可能存在多个同名用户，需要批量更新所有匹配元素，可以使用MongoDB 3.6+版本支持的过滤位置操作符$[<identifier>]配合arrayFilters实现：

Query query = new Query(Criteria.where("name").is("test meeting"));
Update testUpdate = new Update();
// 定义数组元素占位标识user
testUpdate.set("users.$[user].availability", some_data);
// 配置元素过滤规则，匹配所有username为Mark的数组元素
testUpdate.filterArray(Criteria.where("user.username").is("Mark"));

UpdateResult updateResult = mongoTemplate.updateMulti(query, testUpdate, Meeting.class);

注意事项 #

• 基础位置操作符$一次只会更新匹配查询条件的第一个数组元素
• 使用$操作符时，查询条件必须包含对应数组字段的匹配规则，否则无法正确定位目标元素
• 过滤位置操作符需要MongoDB服务端版本3.6及以上，Spring Data MongoDB版本2.1及以上支持

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