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

连接到 MongoDB

使用 MongoDB 和 Spring 时，首要任务之一是创建一个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 的可移植DataAccessExceptionhierarchy 中，数据访问类使用@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和 是 Getting started 部分中显示的列表之间的唯一区别。 用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 Server 第 3 代在连接到 DB 时更改了身份验证模型。 因此，某些可用于身份验证的配置选项不再有效。 您应该使用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 的配置中使用的用户名和密码凭据包含保留字符（如:或%@,. 以下示例显示了编码的凭证：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>