此版本仍在开发中，尚未被视为稳定版。如需最新稳定版本，请使用 Spring Data MongoDB 5.0.4！spring-doc.cadn.net.cn

连接到 MongoDB

在使用 MongoDB 和 Spring 时，首要任务之一是使用 IoC 容器创建一个 MongoClient 对象。 主要有两种方式可以实现这一点：一种是使用基于 Java 的 Bean 元数据，另一种是使用基于 XML 的 Bean 元数据。spring-doc.cadn.net.cn

对于那些不熟悉如何使用基于 Java 的 Bean 元数据（而非基于 XML 的元数据）来配置 Spring 容器的用户，请参阅参考文档中的此处的高级介绍，以及此处的详细说明。

注册 Mongo 实例

以下示例展示了如何注册一个 MongoClient 实例：spring-doc.cadn.net.cn

注册 MongoClient
@Configuration
public class AppConfig {

  /*
   * Use the standard Mongo driver API to create a com.mongodb.client.MongoClient instance.
   */
   public @Bean com.mongodb.client.MongoClient mongoClient() {
       return com.mongodb.client.MongoClients.create("mongodb://localhost:27017");
   }
}
@Configuration
public class AppConfig {

  /*
   * Use the standard Mongo driver API to create a com.mongodb.client.MongoClient instance.
   */
   public @Bean com.mongodb.reactivestreams.client.MongoClient mongoClient() {
       return com.mongodb.reactivestreams.client.MongoClients.create("mongodb://localhost:27017");
   }
}
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:mongo="http://www.springframework.org/schema/data/mongo"
xsi:schemaLocation=
"
http://www.springframework.org/schema/data/mongo https://www.springframework.org/schema/data/mongo/spring-mongo.xsd
http://www.springframework.org/schema/beans
https://www.springframework.org/schema/beans/spring-beans.xsd">

    <!-- Default bean name is 'mongo' -->
    <mongo:mongo-client host="localhost" port="27017"/>

</beans>

此方法允许您使用标准的 MongoClient 实例，容器将使用 Spring 的 MongoClientFactoryBean/ReactiveMongoClientFactoryBean。 与直接实例化 MongoClient 实例相比，FactoryBean 的额外优势在于它还为容器提供了一个 ExceptionTranslator 实现，该实现将 MongoDB 异常转换为 Spring 可移植的 DataAccessException 层次结构中的异常，适用于标注了 @Repository 注解的数据访问类。 此层次结构以及 @Repository 的使用在 Spring 的 DAO 支持功能 中有所描述。spring-doc.cadn.net.cn

以下示例展示了一个基于 Java 的 bean 元数据示例，该元数据支持对带有 @Repository 注解的类进行异常转换：spring-doc.cadn.net.cn

通过 MongoClient / MongoClientFactoryBean 注册一个 ReactiveMongoClientFactoryBean
@Configuration
public class AppConfig {

    /*
     * Factory bean that creates the com.mongodb.client.MongoClient instance
     */
     public @Bean MongoClientFactoryBean mongo() {
          MongoClientFactoryBean mongo = new MongoClientFactoryBean();
          mongo.setHost("localhost");
          return mongo;
     }
}
@Configuration
public class AppConfig {

    /*
     * Factory bean that creates the com.mongodb.reactivestreams.client.MongoClient instance
     */
     public @Bean ReactiveMongoClientFactoryBean mongo() {
          ReactiveMongoClientFactoryBean mongo = new ReactiveMongoClientFactoryBean();
          mongo.setHost("localhost");
          return mongo;
     }
}

要在其他 MongoClient 类或您自己的类中访问由 FactoryBean 创建的 @Configuration 对象，请使用 private @Autowired MongoClient mongoClient; 字段。spring-doc.cadn.net.cn

MongoDatabaseFactory 接口

虽然 MongoClient 是 MongoDB 驱动程序 API 的入口点，但要连接到特定的 MongoDB 数据库实例，还需要额外的信息，例如数据库名称以及可选的用户名和密码。 有了这些信息，您就可以获取一个 MongoDatabase 对象，并访问特定 MongoDB 数据库实例的所有功能。 Spring 提供了 org.springframework.data.mongodb.core.MongoDatabaseFactory 和 org.springframework.data.mongodb.core.ReactiveMongoDatabaseFactory 接口（如下列所示），用于引导建立与数据库的连接：spring-doc.cadn.net.cn

public interface MongoDatabaseFactory {

  MongoDatabase getDatabase() throws DataAccessException;

  MongoDatabase getDatabase(String dbName) throws DataAccessException;
}
public interface ReactiveMongoDatabaseFactory {

  Mono<MongoDatabase> getDatabase() throws DataAccessException;

  Mono<MongoDatabase> getDatabase(String dbName) throws DataAccessException;
}

以下各节展示了如何使用基于 Java 或基于 XML 的元数据，通过容器来配置 MongoDatabaseFactory 接口的实例。 随后，您可以使用该 MongoDatabaseFactory / ReactiveMongoDatabaseFactory 实例来配置 MongoTemplate / ReactiveMongoTemplate。spring-doc.cadn.net.cn

你可以像下面这样在标准 Java 代码中使用它们，而不必使用 IoC 容器来创建模板的实例：spring-doc.cadn.net.cn

public class MongoApplication {

  public static void main(String[] args) throws Exception {

    MongoOperations mongoOps = new MongoTemplate(new SimpleMongoClientDatabaseFactory(MongoClients.create(), "database"));

    // ...
  }
}

加粗的代码突出了 SimpleMongoClientDbFactory 的使用，这也是与入门章节中所示代码清单的唯一区别。 当选择 SimpleMongoClientDbFactory 作为首选入口点时，请使用 com.mongodb.client.MongoClient。spring-doc.cadn.net.cn

public class ReactiveMongoApplication {

  public static void main(String[] args) throws Exception {

    ReactiveMongoOperations mongoOps = new MongoTemplate(new SimpleReactiveMongoDatabaseFactory(MongoClients.create(), "database"));

    // ...
  }
}

注册一个MongoDatabaseFactory / ReactiveMongoDatabaseFactory

要向容器注册一个 MongoDatabaseFactory / ReactiveMongoDatabaseFactory 实例，您编写的代码与上一节中强调的内容非常相似。 以下清单展示了一个简单的示例：spring-doc.cadn.net.cn

@Configuration
public class MongoConfiguration {

  @Bean
  public MongoDatabaseFactory mongoDatabaseFactory() {
    return new SimpleMongoClientDatabaseFactory(MongoClients.create(), "database");
  }
}
@Configuration
public class ReactiveMongoConfiguration {

  @Bean
  public ReactiveMongoDatabaseFactory mongoDatabaseFactory() {
    return new SimpleReactiveMongoDatabaseFactory(MongoClients.create(), "database");
  }
}

MongoDB 第三代服务器在连接数据库时更改了身份验证模型。 因此，一些用于身份验证的配置选项不再有效。 您应使用 MongoClient 特有的选项，通过 MongoCredential 设置凭据以提供身份验证数据，如下例所示：spring-doc.cadn.net.cn

@Configuration
public class MongoAppConfig extends AbstractMongoClientConfiguration {

  @Override
  public String getDatabaseName() {
    return "database";
  }

  @Override
  protected void configureClientSettings(Builder builder) {

    builder
        .credential(MongoCredential.createCredential("name", "db", "pwd".toCharArray()))
        .applyToClusterSettings(settings  -> {
          settings.hosts(singletonList(new ServerAddress("127.0.0.1", 27017)));
        });
  }
}
<mongo:db-factory dbname="database" />

在基于 XML 的配置中使用的用户名和密码凭证，如果包含保留字符（例如 :、%、@ 或 ,），则必须进行 URL 编码。 以下示例展示了经过编码的凭证： m0ng0@dmin:mo_res:bw6},Qsdxx@admin@database → m0ng0%40dmin:mo_res%3Abw6%7D%2CQsdxx%40admin@database 更多详细信息，请参见RFC 3986 第 2.2 节。spring-doc.cadn.net.cn

如果你需要在用于创建 com.mongodb.client.MongoClient 的 SimpleMongoClientDbFactory 实例上配置额外的选项，可以引用一个已存在的 bean，如下例所示。为了展示另一种常见的使用模式，以下代码清单展示了属性占位符的使用，它允许你对配置和 MongoTemplate 的创建进行参数化：spring-doc.cadn.net.cn

@Configuration
@PropertySource("classpath:/com/myapp/mongodb/config/mongo.properties")
public class MongoAppConfig extends AbstractMongoClientConfiguration {

  @Autowired
  Environment env;

  @Override
  public String getDatabaseName() {
    return "database";
  }

  @Override
  protected void configureClientSettings(Builder builder) {

    builder.applyToClusterSettings(settings -> {
    settings.hosts(singletonList(
          new ServerAddress(env.getProperty("mongo.host"), env.getProperty("mongo.port", Integer.class))));
    });

    builder.applyToConnectionPoolSettings(settings -> {

      settings.maxConnectionLifeTime(env.getProperty("mongo.pool-max-life-time", Integer.class), TimeUnit.MILLISECONDS)
          .minSize(env.getProperty("mongo.pool-min-size", Integer.class))
          .maxSize(env.getProperty("mongo.pool-max-size", Integer.class))
          .maintenanceFrequency(10, TimeUnit.MILLISECONDS)
          .maintenanceInitialDelay(11, TimeUnit.MILLISECONDS)
          .maxConnectionIdleTime(30, TimeUnit.SECONDS)
          .maxWaitTime(15, TimeUnit.MILLISECONDS);
    });
  }
}
<context:property-placeholder location="classpath:/com/myapp/mongodb/config/mongo.properties"/>

<mongo:mongo-client host="${mongo.host}" port="${mongo.port}">
  <mongo:client-settings connection-pool-max-connection-life-time="${mongo.pool-max-life-time}"
    connection-pool-min-size="${mongo.pool-min-size}"
    connection-pool-max-size="${mongo.pool-max-size}"
    connection-pool-maintenance-frequency="10"
    connection-pool-maintenance-initial-delay="11"
    connection-pool-max-connection-idle-time="30"
    connection-pool-max-wait-time="15" />
</mongo:mongo-client>

<mongo:db-factory dbname="database" mongo-ref="mongoClient"/>

<bean id="anotherMongoTemplate" class="org.springframework.data.mongodb.core.MongoTemplate">
  <constructor-arg name="mongoDbFactory" ref="mongoDbFactory"/>
</bean>