Spring Mongodb—MongoTemplate详解及示例代码

时间：2025-04-22 09:15:57

Doker官网：Doker 多克

一、概述

MongoTemplate类位于包中，是Spring mongodb支持的中心类，为与数据库交互提供了丰富的功能集。该模板提供了创建、更新、删除和查询MongoDB文档的方便操作，并提供了域对象和MongoDB文档之间的映射。

MongoDB文档和域类之间的映射是通过委托给MongoConverter接口的实现来完成的。Spring提供了MappingMongoConverter，但您也可以编写自己的转换器。有关更多详细信息，请参阅“自定义转换-覆盖默认映射”。

MongoTemplate类实现了MongoOperations接口。在尽可能多的情况下，MongoOperations上的方法以MongoDB驱动程序Collection对象上可用的方法命名，以使习惯于驱动程序API的现有MongoDB开发人员熟悉该API。例如，您可以找到find、findAndModify、findAndReplace、findOne、insert、remove、save、update和updateMulti等方法。设计目标是尽可能容易地在基本MongoDB驱动程序和MongoOperations的使用之间进行转换。这两个API之间的一个主要区别是，MongoOperations可以传递域对象，而不是Document。此外，MongoOperations为查询、标准和更新操作提供了流畅的API，而不是填充文档来指定这些操作的参数。

MongoTemplate使用的默认转换器实现是MappingMongoConverter。虽然MappingMongoConverter可以使用额外的元数据来指定对象到文档的映射，但它也可以通过使用一些映射ID和集合名称的约定来转换不包含额外元数据的对象。“映射”一章对这些约定以及映射注释的使用进行了解释。

MongoTemplate的另一个核心功能是将MongoDB Java驱动程序抛出的异常转换为Spring的可移植数据访问异常层次结构。有关更多信息，请参阅“异常翻译”。

MongoTemplate提供了许多方便的方法来帮助您轻松执行常见任务。但是，如果您需要直接访问MongoDB驱动程序API，可以使用几种Execute回调方法之一。execute回调为您提供了对或对象的引用。有关更多信息，请参阅“执行回调”部分。

下一节包含如何在Spring容器的上下文中使用MongoTemplate的示例。

二、实例化MongoTemplate

在文件的 dependencies 元素中加入以下内容。


<dependencies>

  <!-- other dependency elements omitted -->

  <dependency>
    <groupId></groupId>
    <artifactId>spring-data-mongodb</artifactId>
    <version>4.1.0-SNAPSHOT</version>
  </dependency>

</dependencies>

您可以使用以下配置来创建和注册MongoTemplate的实例，如下例所示：


@Configuration
class AppConfig {

  @Bean
  MongoClient mongoClient() {
      return ("mongodb://localhost:27017");
  }

  @Bean
  MongoTemplate mongoTemplate(MongoClient mongoClient) {
      return new MongoTemplate(mongoClient, "geospatial");
  }
}

MongoTemplate有几个重载的构造函数：

  • MongoTemplate（MongoClient-mongo，String-databaseName）：使用MongoClient对象和默认的数据库名称进行操作。

  • MongoTemplate（MongoDatabaseFactory mongoDbFactory）：采用一个MongoDB Factory对象，该对象封装了MongoClient对象、数据库名称以及用户名和密码。

  • MongoTemplate（MongoDB数据库工厂mongoDbFactory，MongoConverter MongoConverter）：添加一个MongoConver用于映射。

创建MongoTemplate时可能要设置的其他可选财产是默认的WriteResultCheckingPolicy、WriteConcern和ReadPreference财产。

三、写入结果检查策略

如果尚未通过更高级别的驱动程序（如）指定，则可以设置MongoTemplate用于写入操作的属性。如果未设置WriteConcern属性，则默认为MongoDB驱动程序的DB或Collection设置中设置的属性。

四、WriteConcern

WriteConcern描述了从MongoDB请求的对独立mongod或副本集或分片集群的写入操作的确认级别。在分片集群中，mongos实例将把写关注传递给分片

如果尚未通过更高级别的驱动程序（如）指定，则可以设置MongoTemplate用于写入操作的属性。如果未设置WriteConcern属性，则默认为MongoDB驱动程序的DB或Collection设置中设置的属性。

五、WriteConcernResolver

对于更高级的情况，如果您希望在每个操作的基础上设置不同的WriteConcern值（用于删除、更新、插入和保存操作），可以在MongoTemplate上配置一个名为WriteConcernResolver的策略接口。由于MongoTemplate用于持久化POJO，因此WriteConcernResolver允许您创建一个策略，该策略可以将特定的POJO类映射到WriteConcern值。以下列表显示了WriteConcernResolver接口：


public interface WriteConcernResolver {
  WriteConcern resolve(MongoAction action);
}

您可以使用MongoAction参数来确定WriteConcern值，也可以使用Template本身的值作为默认值。MongoAction包含要写入的集合名称、POJO的、转换后的Document、操作（REMOVE、UPDATE、INSERT、INSERT_LIST或SAVE）以及其他一些上下文信息。以下示例显示了两组获得不同WriteConcern设置的类：


private class MyAppWriteConcernResolver implements WriteConcernResolver {

  public WriteConcern resolve(MongoAction action) {
    if (().getSimpleName().contains("Audit")) {
      return ;
    } else if (().getSimpleName().contains("Metadata")) {
      return WriteConcern.JOURNAL_SAFE;
    }
    return ();
  }
}

六、保存、更新和删除文档

MongoTemplate允许您保存、更新和删除域对象，并将这些对象映射到存储在 MongoDB 中的文档。

考虑下面的示例：


public class Person {

  private String id;
  private String name;
  private int age;

  public Person(String name, int age) {
     = name;
     = age;
  }

  public String getId() {
    return id;
  }
  public String getName() {
    return name;
  }
  public int getAge() {
    return age;
  }

  @Override
  public String toString() {
    return "Person [, name=" + name + ", age=" + age + "]";
  }

}

给定上例中的Person类，您可以保存、更新和删除对象，如下例所示：


package ;

import static ;
import static ;
import static ;

import ;

import ;
import ;
import ;
import ;
import ;

import ;

public class MongoApp {

  private static final Log log = ();

  public static void main(String[] args) {

    MongoOperations mongoOps = new MongoTemplate(new SimpleMongoClientDbFactory((), "database"));

    Person p = new Person("Joe", 34);

    // Insert is used to initially store the object into the database.
    (p);
    ("Insert: " + p);

    // Find
    p = ((), );
    ("Found: " + p);

    // Update
    (query(where("name").is("Joe")), update("age", 35), );
    p = (query(where("name").is("Joe")), );
    ("Updated: " + p);

    // Delete
    (p);

    // Check that deletion worked
    List<Person> people =  ();
    ("Number of people = : " + ());


    ();
  }
}

前面的示例将生成以下日志输出（包括来自MongoTemplate的调试消息）：


DEBUG :  80 - Analyzing class class  for index information.
DEBUG : 632 - insert Document containing fields: [_class, age, name] in collection: person
INFO               :  30 - Insert: Person [id=4ddc6e784ce5b1eba3ceaf5c, name=Joe, age=34]
DEBUG :1246 - findOne using query: { "_id" : { "$oid" : "4ddc6e784ce5b1eba3ceaf5c"}} in : 
INFO               :  34 - Found: Person [id=4ddc6e784ce5b1eba3ceaf5c, name=Joe, age=34]
DEBUG : 778 - calling update using query: { "name" : "Joe"} and update: { "$set" : { "age" : 35}} in collection: person
DEBUG :1246 - findOne using query: { "name" : "Joe"} in : 
INFO               :  39 - Updated: Person [id=4ddc6e784ce5b1eba3ceaf5c, name=Joe, age=35]
DEBUG : 823 - remove using query: { "id" : "4ddc6e784ce5b1eba3ceaf5c"} in collection: person
INFO               :  46 - Number of people = : 0
DEBUG : 376 - Dropped collection []

MongoConverter通过识别（通过约定）Id属性名称，导致存储在数据库中的String和ObjectId之间的隐式转换。

前面示例中使用的查询语法在“查询文档”一节中有更详细的解释。

大家好，我是Doker品牌的Sinbad,欢迎点赞和评论,您的鼓励是我们持续更新的动力！欢迎加微信进入技术群聊！

相关文章