【Spring连载】使用Spring Data访问 MongoDB（一）----快速指南

一、版本要求

Spring Data MongoDB 4.x二进制文件需要JDK级别17及以上版本和Spring Framework 6.1.4及以上版本。
在数据库和驱动程序方面，你需要至少4.x版本的MongoDB和兼容的MongoDB Java驱动程序（4.x或5.x）。

二、Hello World

首先，需要设置一个正在运行的MongoDB服务器。请参考MongoDB安装指南，了解如何启动MongoDB实例。安装后，启动MongoDB通常是运行以下命令:/bin/mongod然后你可以创建一个Person类来持久化:

package org.springframework.data.mongodb.example;

public class Person {

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

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

	public String getId() {
		return id;
	}

	public String getName() {
		return name;
	}

	public int getAge() {
		return age;
	}

	@Override
	public String toString() {
		return "Person [id=" + id + ", name=" + name + ", age=" + age + "]";
	}
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30

你还需要一个主应用程序来运行:

package org.springframework.data.mongodb.example;

import static org.springframework.data.mongodb.core.query.Criteria.*;

import org.springframework.data.mongodb.core.MongoOperations;
import org.springframework.data.mongodb.core.MongoTemplate;

import com.mongodb.client.MongoClients;

public class MongoApplication {

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

		MongoOperations mongoOps = new MongoTemplate(MongoClients.create(), "database");
		mongoOps.insert(new Person("Joe", 34));

		System.out.println(mongoOps.query(Person.class).matching(where("name").is("Joe")).firstValue());

		mongoOps.dropCollection("person");
	}
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21

当你运行主程序时，上面的例子产生如下输出:

10:01:32,265 DEBUG o.s.data.mongodb.core.MongoTemplate - insert Document containing fields: [_class, age, name] in collection: Person
10:01:32,765 DEBUG o.s.data.mongodb.core.MongoTemplate - findOne using query: { "name" : "Joe"} in db.collection: database.Person
Person [id=4ddbba3c0be56b7e1b210166, name=Joe, age=34]
10:01:32,984 DEBUG o.s.data.mongodb.core.MongoTemplate - Dropped collection [database.person]
1
2
3
4

即使在这个简单的例子中，也有值得注意的几点：

• 你可以通过使用标准或反应式（reactive）MongoClient对象和要使用的数据库名称来实例化Spring Mongo的中心助手类MongoTemplate。
• mapper针对标准POJO对象工作，而不需要任何额外的元数据（尽管你可以选择提供这些信息，参见这里）。
• 约定（Conventions）用于处理id字段，将其存储在数据库中时转换为ObjectId。
• 映射约定可以使用字段访问。请注意，Person类只有getter。
• 如果构造函数参数名称与存储文档的字段名称匹配，则它们用于实例化对象

三、连接到MongoDB

使用MongoDB和Spring的第一个任务是使用IoC容器创建MongoClient对象。有两种主要方法可以做到这一点，要么使用基于Java的bean元数据，要么使用使用基于XML的bean元数据。
对于那些不熟悉如何使用基于Java的bean元数据而不是基于XML的元数据来配置Spring容器的人，请参阅此处参考文档中的高级介绍以及此处的详细文档。

3.1 注册一个mongodb实例

下面展示了注册一个MongoClient实例的示例:
使用Java注册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");
   }
}
1
2
3
4
5
6
7
8
9
10

使用XML注册MongoClient

<?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>
1
2
3
4
5
6
7
8
9
10
11
12
13
14

这种方法允许你使用标准MongoClient实例，容器使用Spring的MongoClientFactoryBean/ReactiveMongoClientFactoryBean。与直接实例化MongoClient实例相比，FactoryBean还有一个额外的优势，即还为容器提供了ExceptionTranslator实现，该实现将MongoDB异常转换为Spring的可移植DataAccessException层次结构中的异常，用于@Repository注解的数据访问类。Spring的DAO支持特性中描述了这种层次结构和@Repository的使用。

以下示例显示了一个基于Java的bean元数据示例，该元数据支持@Repository注释类上的异常转换：

通过MongoClientFactoryBean/ReactiveMongoClientFactoryBean注册MongoClient

3.2 MongoDatabaseFactory接口

3.3 注册一个MongoDatabaseFactory或ReactiveMongoDatabaseFactory