mongodb是开源的nosql文档数据库,spring boot提供的起步配置包括spring-boot-starter-data-mongodb和spring-boot-starter-data-mongodb-reactive。使用自动注入org.springframework.data.mongodb.MongoDbFactory到service当中,在默认情况下会使用mongodb://localhost/test来连接本地mongodb;更改默认mongodb连接可以在属性文件中添加spring.data.mongodb.uri=mongodb://user:secret@hostname:port;如果使用2.X以上版本的mongodb,可以使用属性指定host和port,例如:
#spring.data.mongodb.host=192.168.152.133
#spring.data.mongodb.port=27017
如果自定义MongoClient,这两个属性会自动配置到MongoDbFactory当中。也支持com.mongodb.MongoClient和com.mongodb.client.MongoClient。
如果使用Mongo 3.0的驱动,以上两个属性不会支持,在这种情况下需要使用spring.data.mongodb.uri。
如果spring.data.mongodb.port没有使用,就会使用默认的27017的端口。
如果不使用Spring data Mongo,可以使用com.mongodb.MongoClient代替MongoDbFactory。
使用spring连接MongoDb可以使用基于Java配置和xml的方式,分别介绍如下。
使用Java配置方式
使用Mongo driver API创建MongoClient实例
@Configuration
public class MongoDbConfiguration {
@Bean
public MongoClient getMongoClient(){
return new MongoClient(new ServerAddress(
new InetSocketAddress("192.168.152.133", 27017)));
}
}
这个方法使用Spring容器的MongoClientFactoryBean创建MongoClient实例。相对于直接创建MongoClient对象,FactoryBean具有几个优势,添加ExceptionTranslator实现,将MongoDb的异常转化为DataAccessException层次结构中的异常,用于使用@Repository注释注释的数据访问类。以上内容可以通过如下示例实现:
@Configuration
public class AppConfig {
public @Bean MongoClientFactoryBean mongo() {
MongoClientFactoryBean mongo = new MongoClientFactoryBean();
mongo.setHost("localhost");
return mongo;
}
}
使用XML配置方式
使用<bean/>标签注册MongoDb实例,并配置连接参数:
<?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:context="http://www.springframework.org/schema/context"
xmlns:mongo="http://www.springframework.org/schema/data/mongo"
xsi:schemaLocation=
"http://www.springframework.org/schema/context
http://www.springframework.org/schema/context/spring-context.xsd
http://www.springframework.org/schema/data/mongo http://www.springframework.org/schema/data/mongo/spring-mongo.xsd
http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans.xsd">
<!-- Default bean name is 'mongo' -->
<mongo:mongo-client host="localhost" port="27017">
<mongo:client-options connections-per-host="8"
threads-allowed-to-block-for-connection-multiplier="4"
connect-timeout="1000"
max-wait-time="1500}"
auto-connect-retry="true"
socket-keep-alive="true"
socket-timeout="1500"
slave-ok="true"
write-number="1"
write-timeout="0"
write-fsync="true"/>
</mongo:mongo-client>
</beans>
MongoDbFactory接口
Spring提供了MongoDbFactory接口,通过该接口可以访问指定MongoDb数据库的所有功能。使用Java配置MongoDbFactory
@Bean
public MongoDbFactory getMongoDbFactory(MongoClient mongoClient){
return new SimpleMongoDbFactory(mongoClient,"mongo");
}
version3 的MongoDB server改变了连接数据库的认证模型,需要使用MongoClient配置选项来配置MongoCredential提供认证数据。
@Configuration
public class ConfigurationWithCredentials extends AbstractMongoConfiguration{
@Bean
public MongoClient mongoClient() {
// TODO Auto-generated method stub
return new MongoClient(new ServerAddress("192.168.152.133", 27017),
MongoCredential.createCredential("username", "mongo", "12345678".toCharArray()), null);
}
@Override
protected String getDatabaseName() {
// TODO Auto-generated method stub
return "mongo";
}
}
MongoTemplate
MongoTemplate提供方便操作用于创建,更新,删除和查询MongoDb文档,并提供领域对象到MongoDb对象的映射。MongoTemplate是一个线程安全的可重用对象。
MongoDb中的对象到领域对象的映射是通过MongoConverter实例的代理实现,Spring提供MappingMongoConverter对象实现,也可以实现自己的转换器。
MongoTemplate实现MongoOperations接口,其方法的命名和MongoDb驱动中的方法命名大致相同。唯一不同的地方是MongoOperations可以传递领域对象代替Document对象,而且MongoOperations可以在查询,更新时使用流式API。
实例化MongoTemplate:
@Bean
public MongoTemplate getMongoTemplate(MongoClient mongoClient){
//new MongoTemplate(getMongoDbFactory(getMongoClient()));
return new MongoTemplate(mongoClient, "mongo");
}
在service中使用MongoTemplate,通过@Autowired自动注入。
@Autowired
private MongoTemplate mongoTemplate;
执行添加操作:
MongoPerson person = new MongoPerson("zhongzhong", 23);
this.mongoTemplate.insert(person);
执行更新操作:
System.out.println(this.mongoTemplate.findOne(query(where("name").is("zhongzhong")), MongoPerson.class));
执行删除操作:
MongoPerson person = this.mongoTemplate.findOne(query(where("name").is("zhongzhong")), MongoPerson.class);
DeleteResult result = this.mongoTemplate.remove(person);
MongoConverter通过识别(通过约定)Id属性名称,在String和存储在数据库中的ObjectId之间进行隐式转换。
mongoDB要求所有的文档都有_id属性,如果没有提供就会由驱动自动分配一个ObjectId。当使用MappingMongoconverter的时候,需要遵从如下规则:
1,使用@id(org.springframework.data.annotation.Id)注解的属性或则字段映射到_id;
2,没有使用注解就将名称为id的属性映射到_id。
类型映射
MappingMongoConverter使用MongoTypeMapper和DefaultMongoTypeMapper作为主要实现。默认会在document对象中的_class下保存类的全限定名称。例如:
public class Sample {
Contact value;
}
public abstract class Contact { … }
public class Person extends Contact { … }
Sample sample = new Sample();
sample.value = new Person();
mongoTemplate.save(sample);
{
"value" : { "_class" : "com.acme.Person" },
"_class" : "com.acme.Sample"
}
自定义类型映射
继承DefaultMongoTypeMapper:
public class MyTypeConverter extends DefaultMongoTypeMapper{
@Override
public TypeInformation<?> readType(Bson source) {
// TODO Auto-generated method stub
return super.readType(source);
}
@Override
public <T> TypeInformation<? extends T> readType(Bson source,
TypeInformation<T> basicType) {
// TODO Auto-generated method stub
return super.readType(source, basicType);
}
@Override
public void writeType(Class<?> type, Bson dbObject) {
// TODO Auto-generated method stub
super.writeType(type, dbObject);
}
@Override
public void writeType(TypeInformation<?> info, Bson sink) {
// TODO Auto-generated method stub
super.writeType(info, sink);
}
}
使用mongoConfig配置类继承AbstractMongoConfiguration,并设置MappingMongoConverter.setTypeMapper(...)
@Bean
public MongoTypeMapper getMyMongoTypeMapper(){
return new MyTypeConverter();
}
@Bean
public MappingMongoConverter mappingMongoConverter() throws Exception {
MappingMongoConverter mmc = super.mappingMongoConverter();
mmc.setTypeMapper(getMyMongoTypeMapper());
return mmc;
}
MongoDb 事物
MongoDB在版本4及以上支持事物,事物构建在session之上,所以需要一个活跃的ClientSession。除非显示指定MongoTransactionManager在应用上下文中,否则默认事物是不启用的。可以使用setSessionSynchronization(ALWAYS)参与正在进行的非本地MongoDB事物。
使用MongoTransactionManager,在应用上下文中注册。
@Bean
public MongoTransactionManager getMongoTransactionManager(){
return new MongoTransactionManager(getMongoDbFactory(mongoClient()));
}
在方法中使用@Transactional注解。