对于最新的稳定版本,请使用 Spring Data MongoDB 4.4.0! |
配置
您可以使用以下配置来创建和注册MongoTemplate
,如下例所示:
MongoClient
对象并启用 Spring 的异常转换支持-
Imperative
-
Reactive
-
XML
@Configuration
class ApplicationConfiguration {
@Bean
MongoClient mongoClient() {
return MongoClients.create("mongodb://localhost:27017");
}
@Bean
MongoOperations mongoTemplate(MongoClient mongoClient) {
return new MongoTemplate(mongoClient, "geospatial");
}
}
@Configuration
class ReactiveApplicationConfiguration {
@Bean
MongoClient mongoClient() {
return MongoClients.create("mongodb://localhost:27017");
}
@Bean
ReactiveMongoOperations mongoTemplate(MongoClient mongoClient) {
return new ReactiveMongoTemplate(mongoClient, "geospatial");
}
}
<mongo:mongo-client host="localhost" port="27017" />
<bean id="mongoTemplate" class="org.springframework.data.mongodb.core.MongoTemplate">
<constructor-arg ref="mongoClient" />
<constructor-arg name="databaseName" value="geospatial" />
</bean>
有几个重载的构造函数MongoTemplate
和ReactiveMongoTemplate
:
-
MongoTemplate(MongoClient mongo, String databaseName)
:采用MongoClient
object 和要作的默认数据库名称。 -
MongoTemplate(MongoDatabaseFactory mongoDbFactory)
:采用一个 MongoDbFactory 对象,该对象封装了MongoClient
对象、数据库名称以及用户名和密码。 -
MongoTemplate(MongoDatabaseFactory mongoDbFactory, MongoConverter mongoConverter)
:添加MongoConverter
用于映射。
在创建MongoTemplate
/ ReactiveMongoTemplate
是默认的WriteResultCheckingPolicy
,WriteConcern
,ReadPreference
以及下面列出的其他内容。
默认读取首选项
如果未通过 Query 定义其他首选项,则默认读取首选项将应用于读取作。
WriteResultChecking 策略
在开发过程中,如果com.mongodb.WriteResult
从任何 MongoDB作返回都包含错误。在开发过程中忘记执行此作,然后最终得到一个看起来运行成功的应用程序,而实际上,数据库并未根据您的预期进行修改,这是很常见的。您可以设置WriteResultChecking
的属性MongoTemplate
设置为以下值之一:EXCEPTION
或NONE
,以抛出Exception
或不执行任何作。默认使用WriteResultChecking
的值NONE
.
默认 WriteConcern
如果尚未通过驱动程序在更高级别(如com.mongodb.client.MongoClient
),则可以设置com.mongodb.WriteConcern
属性,该MongoTemplate
用于写入作。如果WriteConcern
属性,则默认为 MongoDB 驱动程序的 DB 或 Collection 设置中设置的 URL。
WriteConcernResolver (写入关注解析器)
对于更高级的情况,您希望设置不同的WriteConcern
值(对于 REMOVE、UPDATE、INSERT 和 Save作),一个名为WriteConcernResolver
可以配置MongoTemplate
.因为MongoTemplate
用于持久化 POJO,则WriteConcernResolver
允许您创建一个策略,该策略可以将特定的 POJO 类映射到WriteConcern
价值。下面的清单显示了WriteConcernResolver
接口:
public interface WriteConcernResolver {
WriteConcern resolve(MongoAction action);
}
您可以使用MongoAction
参数来确定WriteConcern
值或使用 Template 本身的值作为默认值。MongoAction
包含要写入的集合名称,则java.lang.Class
POJO 中,皈依的Document
、作 (REMOVE
,UPDATE
,INSERT
,INSERT_LIST
或SAVE
) 以及其他一些上下文信息。
以下示例显示了两组不同的类WriteConcern
设置:
public class MyAppWriteConcernResolver implements WriteConcernResolver {
@Override
public WriteConcern resolve(MongoAction action) {
if (action.getEntityType().getSimpleName().contains("Audit")) {
return WriteConcern.ACKNOWLEDGED;
} else if (action.getEntityType().getSimpleName().contains("Metadata")) {
return WriteConcern.JOURNALED;
}
return action.getDefaultWriteConcern();
}
}
发布实体生命周期事件
该模板发布生命周期事件。 如果没有侦听器,则可以禁用此功能。
@Bean
MongoOperations mongoTemplate(MongoClient mongoClient) {
MongoTemplate template = new MongoTemplate(mongoClient, "geospatial");
template.setEntityLifecycleEventsEnabled(false);
// ...
}
配置 EntityCallbacks
嵌套到生命周期事件时,模板会调用 EntityCallbacks,可以通过模板 API 设置(如果未自动配置)。
-
Imperative
-
Reactive
@Bean
MongoOperations mongoTemplate(MongoClient mongoClient) {
MongoTemplate template = new MongoTemplate(mongoClient, "...");
template.setEntityCallbacks(EntityCallbacks.create(...));
// ...
}
@Bean
ReactiveMongoOperations mongoTemplate(MongoClient mongoClient) {
ReactiveMongoTemplate template = new ReactiveMongoTemplate(mongoClient, "...");
template.setEntityCallbacks(ReactiveEntityCallbacks.create(...));
// ...
}