|
此版本仍在开发中，尚未被视为稳定版。如需最新稳定版本，请使用 Spring Data MongoDB 5.0.4！ |
对象映射
MappingMongoConverter 提供了丰富的映射支持。
该转换器持有一个元数据模型，该模型提供了完整的功能集，用于将领域对象映射到 MongoDB 文档。
映射元数据模型通过在您的领域对象上使用注解进行填充。
然而，该基础设施并不仅限于将注解作为元数据信息的唯一来源。
MappingMongoConverter 还允许您遵循一组约定，在不提供任何额外元数据的情况下将对象映射到文档。
本节介绍了 MappingMongoConverter 的功能，包括基础知识、如何使用约定将对象映射到文档，以及如何通过基于注解的映射元数据来覆盖这些约定。
对象映射基础
本节介绍 Spring Data 对象映射、对象创建、字段和属性访问、可变性与不可变性的基础知识。 请注意，本节仅适用于不使用底层数据存储对象映射（如 JPA）的 Spring Data 模块。 此外，请务必查阅特定于存储的章节，以了解特定于存储的对象映射内容，例如索引、自定义列名或字段名等。
Spring Data 对象映射的核心职责是创建领域对象的实例，并将存储原生的数据结构映射到这些对象上。 这意味着我们需要两个基本步骤：
-
通过使用公开的构造函数之一来创建实例。
-
实例填充以实例化所有公开的属性。
对象创建
Spring Data 会自动尝试检测持久化实体的构造函数，以用于实例化该类型的对象。 解析算法的工作方式如下：
-
如果存在一个使用
@PersistenceCreator注解的静态工厂方法，则会使用该方法。 -
如果只有一个构造函数，则使用该构造函数。
-
如果存在多个构造函数，并且恰好有一个被标注为
@PersistenceCreator，那么将使用该构造函数。 -
如果该类型是一个 Java
Record，则使用其规范构造函数。 -
如果存在无参构造函数，则会使用它。 其他构造函数将被忽略。
值解析假定构造函数/工厂方法的参数名称与实体的属性名称相匹配，即解析过程将如同要填充该属性一样进行，包括映射中的所有自定义设置（例如不同的数据存储列名或字段名等）。
这也要求类文件中包含参数名称信息，或者在构造函数上存在 @ConstructorProperties 注解。
可以通过使用 Spring Framework 的 @Value 注解并结合特定于存储的 SpEL 表达式来自定义值解析。
有关更多详细信息，请参阅关于特定于存储的映射的相关章节。
属性填充
一旦实体实例被创建，Spring Data 就会填充该类中所有其余的持久化属性。 除非标识符属性已经由实体的构造函数填充（即通过其构造函数参数列表传入），否则将首先填充标识符属性，以便解析循环对象引用。 之后，所有尚未通过构造函数填充的非瞬态（non-transient）属性都会被设置到实体实例上。 为此，我们使用以下算法：
-
如果该属性是不可变的，但提供了一个
with…方法（见下文），我们将使用该with…方法创建一个包含新属性值的新实体实例。 -
如果定义了属性访问（即通过 getter 和 setter 进行访问），我们将调用 setter 方法。
-
如果该属性是可变的，我们会直接设置字段。
-
如果该属性是不可变的，我们将使用构造函数（由持久化操作调用，参见对象创建）来创建该实例的一个副本。
-
默认情况下，我们直接设置字段值。
让我们来看一下以下实体：
class Person {
private final @Id Long id; (1)
private final String firstname, lastname; (2)
private final LocalDate birthday;
private final int age; (3)
private String comment; (4)
private @AccessType(Type.PROPERTY) String remarks; (5)
private @Transient String summary; (6)
static Person of(String firstname, String lastname, LocalDate birthday) { (7)
return new Person(null, firstname, lastname, birthday,
Period.between(birthday, LocalDate.now()).getYears());
}
Person(Long id, String firstname, String lastname, LocalDate birthday, int age) { (7)
this.id = id;
this.firstname = firstname;
this.lastname = lastname;
this.birthday = birthday;
this.age = age;
}
Person withId(Long id) { (1)
return new Person(id, this.firstname, this.lastname, this.birthday, this.age);
}
void setRemarks(String remarks) { (5)
this.remarks = remarks;
}
}| 1 | 标识符属性是 final 的，但在构造函数中被设为 null。
该类提供了一个 withId(…) 方法，用于设置标识符，例如当实例被插入到数据存储中并生成了标识符时。
原始的 Person 实例保持不变，因为会创建一个新的实例。
对于其他由存储管理、但在持久化操作中可能需要更改的属性，通常也采用相同的模式。
Wither 方法是可选的，因为持久化构造函数（参见第6节）实际上是一个拷贝构造函数，设置该属性会被转换为创建一个应用了新标识符值的新实例。 |
| 2 | firstname 和 lastname 属性是普通的不可变属性，可能通过 getter 方法对外暴露。 |
| 3 | age 属性是一个不可变的派生属性，它源自 birthday 属性。
按照所示的设计，数据库中的值将优先于默认值，因为 Spring Data 会使用唯一声明的构造函数。
即使本意是优先采用计算得出的值，该构造函数也必须将 age 作为参数（即使可能忽略它），否则属性填充步骤会尝试设置 age 字段，但由于该字段不可变且不存在 with… 方法，从而导致失败。 |
| 4 | comment 属性是可变的，通过直接设置其字段进行赋值。 |
| 5 | remarks 属性是可变的，通过调用其 setter 方法进行赋值。 |
| 6 | summary属性是瞬态的，并且由于使用了@Transient注解，不会被持久化。
Spring Data 不使用 Java 的transient关键字来排除属性的持久化，因为transient属于 Java 序列化框架的一部分。
请注意，该属性可以与持久化构造函数一起使用，但其值将默认为null（如果属性类型是原始类型，则为其对应的原始初始值）。 |
| 7 | 该类提供了一个工厂方法和一个构造函数用于对象创建。
这里的核心思想是使用工厂方法而非额外的构造函数，以避免通过 @PersistenceCreator 进行构造函数消歧。
相反，属性的默认值处理在工厂方法内部完成。
如果你想让 Spring Data 使用该工厂方法进行对象实例化，请使用 @PersistenceCreator 注解该方法。 |
通用建议
-
尽量使用不可变对象 — 不可变对象的创建非常直接，因为实例化对象只需调用其构造函数即可。 此外，这样做可以避免在你的领域对象中充斥着大量 setter 方法，从而防止客户端代码随意修改对象的状态。 如果你确实需要这些 setter 方法，建议将其设为包级私有（package protected），以便只有有限数量的同包类才能调用它们。 仅通过构造函数进行对象实例化，比通过属性赋值的方式快多达 30%。
-
提供一个包含所有参数的构造函数 — 即使你无法或不希望将实体建模为不可变值，仍然建议提供一个接收实体所有属性（包括可变属性）作为参数的构造函数，因为这样可以让对象映射跳过属性填充步骤，从而实现最佳性能。
-
使用工厂方法替代重载构造函数，以避免
@PersistenceCreator— 由于需要全参数构造函数以实现最佳性能，我们通常希望暴露更多针对特定应用场景的构造函数，这些构造函数会省略自动生成的标识符等内容。 采用静态工厂方法来暴露这些全参数构造函数的变体，是一种既定的设计模式。 -
请确保遵守相关约束条件，以允许使用所生成的实例化器和属性访问器类 —
-
若要生成标识符，仍应使用 final 字段结合全参数持久化构造函数（推荐）或
with…方法 — -
使用 Lombok 避免样板代码 — 由于持久化操作通常需要一个包含所有参数的构造函数，其声明往往会变成繁琐的样板代码，即重复地将参数赋值给字段。通过使用 Lombok 的
@AllArgsConstructor注解，可以很好地避免这种情况。
覆盖属性
Java 允许对领域类进行灵活的设计，其中子类可以定义一个与其超类中已声明的同名属性。 请考虑以下示例：
public class SuperType {
private CharSequence field;
public SuperType(CharSequence field) {
this.field = field;
}
public CharSequence getField() {
return this.field;
}
public void setField(CharSequence field) {
this.field = field;
}
}
public class SubType extends SuperType {
private String field;
public SubType(String field) {
super(field);
this.field = field;
}
@Override
public String getField() {
return this.field;
}
public void setField(String field) {
this.field = field;
// optional
super.setField(field);
}
}两个类都使用可赋值类型定义了一个 field。然而，SubType 会遮蔽（shadow）SuperType.field。
根据类的设计，使用构造函数可能是设置 SuperType.field 的唯一默认方法。
或者，也可以在 setter 方法中调用 super.setField(…) 来设置 field 中的 SuperType。
所有这些机制在某种程度上都会产生冲突，因为这些属性具有相同的名称，却可能代表两个不同的值。
如果类型不可赋值，Spring Data 会跳过父类的属性。
也就是说，只有当被重写的属性类型可赋值给其父类属性类型时，才会被注册为重写；否则，父类属性将被视为瞬态（transient）。
我们通常建议使用不同的属性名称。
Spring Data 模块通常支持被重写的属性持有不同的值。 从编程模型的角度来看，有几点需要注意：
-
应持久化哪些属性（默认为所有已声明的属性）？ 您可以通过使用
@Transient注解来排除某些属性。 -
如何在您的数据存储中表示属性？ 对不同的值使用相同的字段/列名通常会导致数据损坏，因此您应使用显式的字段/列名对至少其中一个属性进行注解。
-
使用
@AccessType(PROPERTY)是不可行的，因为通常无法在不对 setter 实现做进一步假设的情况下设置超类属性。
Kotlin 支持
Spring Data 适配了 Kotlin 的特性，以支持对象的创建和变更。
Kotlin 对象创建
Kotlin 类支持被实例化，所有类默认都是不可变的，并且需要显式声明属性以定义可变属性。
Spring Data 会自动尝试检测持久化实体的构造函数，以用于实例化该类型的对象。 解析算法的工作方式如下：
-
如果存在一个使用
@PersistenceCreator注解的构造函数，则会使用该构造函数。 -
如果该类型是一个Kotlin 数据类，则使用其主构造函数。
-
如果存在一个使用
@PersistenceCreator注解的静态工厂方法，则会使用该方法。 -
如果只有一个构造函数，则使用该构造函数。
-
如果存在多个构造函数，并且恰好有一个被标注为
@PersistenceCreator，那么将使用该构造函数。 -
如果该类型是一个 Java
Record，则使用其规范构造函数。 -
如果存在无参构造函数，则会使用它。 其他构造函数将被忽略。
考虑以下 data 类 Person：
data class Person(val id: String, val name: String)上面的类会编译成一个带有显式构造函数的典型类。我们可以通过添加另一个构造函数并使用 @PersistenceCreator 注解来定制此类，以指明首选的构造函数：
data class Person(var id: String, val name: String) {
@PersistenceCreator
constructor(id: String) : this(id, "unknown")
}Kotlin 通过允许在未提供参数时使用默认值来支持参数的可选性。
当 Spring Data 检测到一个带有参数默认值的构造函数时，如果数据存储未提供该值（或仅返回 null），它就会省略这些参数，从而让 Kotlin 能够应用参数默认值。请考虑以下对 name 参数应用默认值的类：
data class Person(var id: String, val name: String = "unknown")每当 name 参数不在结果中，或者其值为 null 时，name 将默认为 unknown。
Spring Data 不支持委托属性。映射元数据会过滤 Kotlin 数据类中的委托属性。
在其他所有情况下，您可以通过使用 @Transient 注解属性来排除委托属性的合成字段。 |
Kotlin 数据类的属性填充
在 Kotlin 中，所有类默认都是不可变的，需要显式声明属性才能定义可变属性。
请考虑以下 data 类 Person：
data class Person(val id: String, val name: String)该类实际上是不可变的。
它允许创建新实例，因为 Kotlin 会生成一个 copy(…) 方法，该方法通过复制现有对象的所有属性值并应用作为方法参数提供的属性值来创建新的对象实例。
Kotlin 重写属性
Kotlin 允许声明属性重写，以在子类中修改属性。
open class SuperType(open var field: Int)
class SubType(override var field: Int = 1) :
SuperType(field) {
}这种安排会导致两个名为field的属性。
Kotlin 会为每个类中的每个属性生成属性访问器（getter 和 setter）。
实际上，代码看起来如下所示：
public class SuperType {
private int field;
public SuperType(int field) {
this.field = field;
}
public int getField() {
return this.field;
}
public void setField(int field) {
this.field = field;
}
}
public final class SubType extends SuperType {
private int field;
public SubType(int field) {
super(field);
this.field = field;
}
public int getField() {
return this.field;
}
public void setField(int field) {
this.field = field;
}
}SubType 上的 getter 和 setter 方法仅设置 SubType.field，而不会设置 SuperType.field。
在这种情况下，使用构造函数是设置 SuperType.field 的唯一默认方法。
虽然可以向 SubType 添加一个方法，通过 SuperType.field 来设置 this.SuperType.field = …，但这超出了所支持的约定范围。
属性重写在一定程度上会造成冲突，因为这些属性名称相同，却可能代表两个不同的值。
我们通常建议使用不同的属性名称。
Spring Data 模块通常支持被重写的属性持有不同的值。 从编程模型的角度来看，有几点需要注意：
-
应持久化哪些属性（默认为所有已声明的属性）？ 您可以通过使用
@Transient注解来排除某些属性。 -
如何在您的数据存储中表示属性？ 对不同的值使用相同的字段/列名通常会导致数据损坏，因此您应使用显式的字段/列名对至少其中一个属性进行注解。
-
使用
@AccessType(PROPERTY)是不可行的，因为无法设置超类属性。
Kotlin 值类
Kotlin 值类（Value Classes）旨在构建更具表达力的领域模型，以显式地体现底层概念。 Spring Data 能够读取和写入使用值类定义属性的类型。
考虑以下领域模型：
@JvmInline
value class EmailAddress(val theAddress: String) (1)
data class Contact(val id: String, val name:String, val emailAddress: EmailAddress) (2)| 1 | 一个具有不可为空值类型的简单值类。 |
| 2 | 使用 EmailAddress 值类定义属性的数据类。 |
| 使用非基本值类型的不可为空属性在编译后的类中会被展平为该值类型。 可为空的基本值类型或值类型中的可为空值类型则以其包装类型表示，这会影响值类型在数据库中的表示方式。 |
基于约定的映射
MappingMongoConverter 在未提供额外映射元数据时，有一些将对象映射到文档的约定。
这些约定如下：
-
短 Java 类名按照以下方式映射到集合名称。 类
com.bigbank.SavingsAccount映射到集合名称savingsAccount。 -
所有嵌套对象都以嵌套对象的形式存储在文档中，而非以 DBRef 的形式存储。
-
该转换器使用向其注册的任何 Spring 转换器，以覆盖对象属性到文档字段和值的默认映射。
-
对象的字段用于与文档中的字段相互转换。 不会使用公共的
JavaBean属性。 -
如果你有一个唯一的非零参数构造函数，且其构造函数参数名称与文档的顶层字段名称相匹配，则使用该构造函数。否则，将使用无参构造函数。如果存在多个非零参数构造函数，则会抛出异常。
如何_id字段在映射层中处理。
MongoDB 要求所有文档都必须包含一个 _id 字段。如果您未提供该字段，驱动程序将自动分配一个具有生成值的 ObjectId。_id 字段可以是除数组以外的任意类型，只要其值是唯一的即可。驱动程序原生支持所有基本类型和 Date 类型。在使用 MappingMongoConverter 时，有一些特定规则用于控制 Java 类中的属性如何映射到 _id 字段。
以下说明了哪个字段将映射到文档的 _id 字段：
-
一个被注释的字段
@Id(org.springframework.data.annotation.Id) 将被映射到_id字段。
此外，文档字段的名称可以通过以下方式自定义：@Field注解，在这种情况下，文档将不包含字段_id. -
一个未使用注解但名为
id的字段将被映射到_id字段。
| 字段定义 | MongoDB 中生成的 Id 字段名 |
|---|---|
|
|
|
|
|
|
|
|
|
|
以下说明了将对映射到 _id 文档字段的属性执行何种类型转换（如果有的话）。
-
如果在 Java 类中声明了一个名为
id的字段，其类型为 String 或 BigInteger，则在可能的情况下，该字段将被转换并存储为 ObjectId。 ObjectId 作为字段类型也是有效的。 如果您在应用程序中为id指定了一个值，则到 ObjectId 的转换由 MongoDB 驱动程序完成。 如果指定的id值无法转换为 ObjectId，则该值将按原样存储在文档的_id字段中。 这一点同样适用于使用@Id注解标注的字段。 -
如果 Java 类中的某个字段使用
@MongoId注解，则该字段将按照其实际类型进行转换并存储。 除非@MongoId明确声明了所需的字段类型，否则不会进行其他转换。 如果未为id字段提供值，系统将创建一个新的ObjectId并将其转换为该属性的类型。 -
如果 Java 类中的某个字段使用
@MongoId(FieldType.…)进行注解，系统将尝试把该字段的值转换为所声明的FieldType。 如果未为id字段提供值，系统将创建一个新的ObjectId并将其转换为所声明的类型。 -
如果 Java 类中名为
id的字段未声明为 String、BigInteger 或 ObjectID 类型，则应在应用程序中为其赋值，以便该值能以原始形式存储到文档的_id字段中。 -
如果 Java 类中没有名为
id的字段，则驱动程序将自动生成一个隐式的_id字段，但该字段不会映射到 Java 类的任何属性或字段上。
在执行查询和更新操作时，MongoTemplate 将使用转换器来处理 Query 和 Update 对象的转换，其转换规则与上述保存文档的规则一致，因此您在查询中使用的字段名称和类型将能够与领域类中的内容相匹配。
数据映射与类型转换
Spring Data MongoDB 支持所有可以表示为 BSON（MongoDB 的内部文档格式）的类型。 除了这些类型之外，Spring Data MongoDB 还提供了一组内置转换器，用于映射额外的类型。 您可以提供自己的转换器来调整类型转换。 有关更多详细信息，请参阅 自定义转换 - 覆盖默认映射。
内置类型转换：
| 类型 | 类型转换 | 示例 |
|---|---|---|
|
原生 |
|
|
原生 |
|
|
原生 |
|
|
原生 |
|
|
原生 |
|
|
原生 |
|
|
原生 |
|
|
原生 |
|
|
原生 |
|
数组， |
原生 |
|
|
原生 |
|
|
原生 |
|
|
原生 |
|
|
原生 |
|
|
转换器 |
|
|
转换器 |
|
|
原生 |
|
|
原生 |
|
|
转换器 |
|
|
转换器 |
|
|
转换器 |
|
|
转换器 |
|
|
转换器 |
|
|
原生 |
|
|
转换器 |
|
|
转换器 / 原生（Java 8）[1] |
|
|
转换器 / 原生（Java 8）[2] |
|
|
转换器 |
|
|
转换器 |
|
|
转换器 |
|
|
转换器 |
|
|
转换器 |
|
|
转换器 |
|
|
转换器 |
|
|
转换器 |
|
|
转换器 |
|
|
转换器 |
|
|
转换器 |
|
|
转换器 |
|
|
集合处理
集合处理取决于 MongoDB 返回的实际值。
通常，如果你使用构造函数创建方式，就可以获取到要设置的值。 如果查询响应未提供属性值，属性填充可以使用默认的初始化值。 |
映射配置
除非显式配置，否则在创建 MappingMongoConverter 时，默认会自动创建一个 MongoTemplate 的实例。
您可以自行创建 MappingMongoConverter 的实例。
这样做可以指定您的领域类在类路径中的位置，以便 Spring Data MongoDB 能够提取元数据并构建索引。
此外，通过创建自己的实例，您还可以注册 Spring 转换器，用于将特定类与数据库之间进行映射。
你可以使用基于 Java 或基于 XML 的元数据来配置 MappingMongoConverter、com.mongodb.client.MongoClient 以及 MongoTemplate。
以下示例展示了相关配置：
-
Java
-
XML
@Configuration
public class MongoConfig extends AbstractMongoClientConfiguration {
@Override
public String getDatabaseName() {
return "database";
}
// the following are optional
@Override
public String getMappingBasePackage() { (1)
return "com.bigbank.domain";
}
@Override
void configureConverters(MongoConverterConfigurationAdapter adapter) { (2)
adapter.registerConverter(new org.springframework.data.mongodb.test.PersonReadConverter());
adapter.registerConverter(new org.springframework.data.mongodb.test.PersonWriteConverter());
}
@Bean
public LoggingEventListener<MongoMappingEvent> mappingEventsListener() {
return new LoggingEventListener<MongoMappingEvent>();
}
}| 1 | 映射基础包定义了用于扫描实体的根路径，这些实体用于预初始化 MappingContext。
默认情况下，使用配置类所在的包。 |
| 2 | 为特定的领域类型配置额外的自定义转换器，以使用您的自定义实现替换这些类型的默认映射过程。 |
<?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-3.0.xsd">
<!-- Default bean name is 'mongo' -->
<mongo:mongo-client host="localhost" port="27017"/>
<mongo:db-factory dbname="database" mongo-ref="mongoClient"/>
<!-- by default look for a Mongo object named 'mongo' - default name used for the converter is 'mappingConverter' -->
<mongo:mapping-converter base-package="com.bigbank.domain">
<mongo:custom-converters>
<mongo:converter ref="readConverter"/>
<mongo:converter>
<bean class="org.springframework.data.mongodb.test.PersonWriteConverter"/>
</mongo:converter>
</mongo:custom-converters>
</mongo:mapping-converter>
<bean id="readConverter" class="org.springframework.data.mongodb.test.PersonReadConverter"/>
<!-- set the mapping converter to be used by the MongoTemplate -->
<bean id="mongoTemplate" class="org.springframework.data.mongodb.core.MongoTemplate">
<constructor-arg name="mongoDbFactory" ref="mongoDbFactory"/>
<constructor-arg name="mongoConverter" ref="mappingConverter"/>
</bean>
<bean class="org.springframework.data.mongodb.core.mapping.event.LoggingEventListener"/>
</beans>AbstractMongoClientConfiguration 要求您实现一些方法，以定义一个 com.mongodb.client.MongoClient 并提供数据库名称。
AbstractMongoClientConfiguration 还包含一个名为 getMappingBasePackage(…) 的方法，您可以重写该方法，以告知转换器在何处扫描带有 @Document 注解的类。
您可以通过重写 customConversionsConfiguration 方法向转换器中添加额外的转换器。
MongoDB 的原生 JSR-310 支持可通过 MongoConverterConfigurationAdapter.useNativeDriverJavaTimeCodecs() 启用。
前面的示例中还展示了一个 LoggingEventListener，它会记录发布到 Spring MongoMappingEvent 基础设施上的 ApplicationContextEvent 实例。
|
Java 时间类型
我们建议使用上述描述的通过 |
AbstractMongoClientConfiguration 创建一个 MongoTemplate 实例，并将其以名称 mongoTemplate 注册到容器中。 |
base-package 属性用于指定扫描带有 @org.springframework.data.mongodb.core.mapping.Document 注解的类的位置。
|
如果你想依赖Spring Boot来引导配置Data MongoDB，但又希望覆盖某些配置项，你可能需要暴露相应类型的Bean。
例如，对于自定义转换，你可以选择注册一个 |
基于元数据的映射
为了充分利用 Spring Data MongoDB 支持中的对象映射功能，您应该使用 @Document 注解来标注您的映射对象。
尽管映射框架并不强制要求此注解（即使没有任何注解，您的 POJO 也能被正确映射），但它能让类路径扫描器发现并预处理您的领域对象，从而提取必要的元数据。
如果您不使用此注解，那么在首次存储领域对象时，应用程序会略微影响性能，因为映射框架需要构建其内部元数据模型，以了解您领域对象的属性以及如何持久化它们。
以下示例展示了一个领域对象：
@Document
public class Person {
@Id
private ObjectId id;
@Indexed
private Integer ssn;
private String firstName;
@Indexed
private String lastName;
}@Id 注解告诉映射器你希望将哪个属性用作 MongoDB 的 _id 字段，而 @Indexed 注解则指示映射框架在文档的该属性上调用 createIndex(…) 方法，从而加快查询速度。
自动索引创建仅对带有 @Document 注解的类型执行。 |
| 自动索引创建默认是禁用的，需要通过配置启用（参见索引创建）。 |
映射注解概述
MappingMongoConverter 可以使用元数据来驱动对象到文档的映射。 以下注解可用：
-
@Id：应用于字段级别，用于标记用作标识目的的字段。 -
@MongoId：在字段级别上使用，用于标记作为标识用途的字段。 接受一个可选的FieldType参数，以自定义 ID 的转换方式。 -
@Document：在类级别上使用，表示该类是映射到数据库的候选对象。 您可以指定用于存储数据的集合名称。 -
@DBRef：应用于字段，表示该字段应使用 com.mongodb.DBRef 进行存储。 -
@DocumentReference：应用于字段，表示该字段应作为指向另一文档的引用进行存储。 这可以是一个单一值（默认为 id），也可以是通过转换器提供的Document。 -
@Indexed：在字段级别上使用，用于描述如何对该字段进行索引。 -
@CompoundIndex（可重复）：在类型级别上应用，用于声明复合索引。 -
@GeoSpatialIndexed：应用于字段级别，用于描述如何对该字段进行地理空间索引。 -
@TextIndexed：应用于字段级别，用于标记该字段应包含在文本索引中。 -
@HashIndexed：在字段级别应用，用于在哈希索引中对分片集群中的数据进行分区。 -
@Language：应用于字段级别，用于为文本索引设置语言覆盖属性。 -
@Transient：默认情况下，所有字段都会被映射到文档中。 此注解用于将其所标注的字段排除在数据库存储之外。 瞬态（Transient）属性不能在持久化构造函数中使用，因为转换器无法为构造函数参数生成一个值。 -
@PersistenceCreator：标记一个特定的构造函数或static工厂方法（即使是包级私有的），用于从数据库实例化对象。 构造函数参数通过名称映射到所检索 Document 中的键值。 -
@Value：此注解是 Spring 框架的一部分。在映射框架中，它可以应用于构造函数参数。 这允许你使用 Spring 表达式语言（SpEL）语句，在从数据库检索到某个键的值之后、用于构造领域对象之前，对该值进行转换。 为了引用给定文档的某个属性，必须使用类似如下的表达式：@Value("#root.myProperty")，其中root指向给定文档的根。 -
@Field：在字段级别使用，可用于描述该字段在 MongoDB BSON 文档中所表示的名称和类型，从而允许其名称和类型与类中的字段名及属性类型不同。 -
@Version：应用于字段级别，用于乐观锁，并在保存操作时检查是否发生修改。 初始值为zero（对于基本类型为one），每次更新时会自动递增。
映射元数据基础设施定义在一个独立的、与技术无关的 spring-data-commons 项目中。 MongoDB 支持中使用了特定的子类，以支持基于注解的元数据。 如果有需求，也可以采用其他策略。
这是一个更复杂映射的示例
@Document
@CompoundIndex(name = "age_idx", def = "{'lastName': 1, 'age': -1}")
public class Person<T extends Address> {
@Id
private String id;
@Indexed(unique = true)
private Integer ssn;
@Field("fName")
private String firstName;
@Indexed
private String lastName;
private Integer age;
@Transient
private Integer accountTotal;
@DBRef
private List<Account> accounts;
private T address;
public Person(Integer ssn) {
this.ssn = ssn;
}
@PersistenceCreator
public Person(Integer ssn, String firstName, String lastName, Integer age, T address) {
this.ssn = ssn;
this.firstName = firstName;
this.lastName = lastName;
this.age = age;
this.address = address;
}
public String getId() {
return id;
}
// no setter for Id. (getter is only exposed for some unit testing)
public Integer getSsn() {
return ssn;
}
// other getters/setters omitted
}|
你甚至可以考虑使用自己定义的自定义注解。 |
特殊字段名称
一般来说，MongoDB 使用点（.）字符作为嵌套文档或数组的路径分隔符。
这意味着在查询（或更新语句）中，像 a.b.c 这样的键会指向如下所示的对象结构：
{
'a' : {
'b' : {
'c' : …
}
}
}因此，直到 MongoDB 5.0 版本之前，字段名不得包含点号 (.).
使用一个MappingMongoConverter#setMapKeyDotReplacement允许在存储时绕过某些限制Map通过将写入时的点替换为另一个字符来构建结构。
converter.setMapKeyDotReplacement("-");
// ...
source.map = Map.of("key.with.dot", "value")
converter.write(source,...) // -> map : { 'key-with-dot', 'value' }随着 MongoDB 5.0 的发布，此限制已Document包含特殊字符的字段名已被移除。
我们强烈建议阅读更多关于在字段名中使用点号的限制说明，详见MongoDB 参考文档.
允许在Map结构请设置preserveMapKeys关于MappingMongoConverter.
使用 @Field 注解可以通过两种方式自定义字段名称以处理点号（.）。
-
@Field(name = "a.b")：该名称被视为一个路径。 操作期望嵌套对象结构，例如{ a : { b : … } }。 -
@Field(name = "a.b", fieldNameType = KEY)：该名称将被原样视为字段名。 操作期望文档中存在一个字段，其值格式为{ 'a.b' : ….. }
|
由于点字符（.）在 MongoDB 查询和更新语句中的特殊性质，包含点号的字段名无法被直接引用，因此不能用于派生查询方法中。
请考虑以下 其原始表示形式如下所示 由于我们无法直接针对 查询名称中包含点号（.）的字段
更新名称中包含点号的字段
上述示例展示了一个简单的情况，其中特殊字段位于文档的顶层。 嵌套层级的增加会提高与该字段交互所需的聚合表达式的复杂性。 |
自定义对象构建
映射子系统允许通过使用 @PersistenceCreator 注解标注构造函数来定制对象的构造方式。
构造函数参数所使用的值按以下方式解析：
-
如果一个参数使用
@Value注解进行标注，则会计算给定的表达式，并将结果用作该参数的值。 -
如果 Java 类型具有一个属性，其名称与输入文档中的给定字段相匹配，则使用该属性的信息来选择合适的构造函数参数，以将输入字段的值传递给该参数。 这仅在 Java
.class文件中包含参数名称信息时才有效，而该信息可以通过使用调试信息编译源代码，或在 Java 8 中使用 javac 的新-parameters命令行选项来实现。 -
否则，将抛出一个
MappingException，表明给定的构造函数参数无法被绑定。
class OrderItem {
private @Id String id;
private int quantity;
private double unitPrice;
OrderItem(String id, @Value("#root.qty ?: 0") int quantity, double unitPrice) {
this.id = id;
this.quantity = quantity;
this.unitPrice = unitPrice;
}
// getters/setters ommitted
}
Document input = new Document("id", "4711");
input.put("unitPrice", 2.5);
input.put("qty",5);
OrderItem item = converter.read(OrderItem.class, input);@Value 参数的 quantity 注解中的 SpEL 表达式在给定的属性路径无法解析时，会回退到值 0。 |
更多关于使用 @PersistenceCreator 注解的示例可以在 MappingMongoConverterUnitTests 测试套件中找到。
映射框架事件
在整个映射过程的生命周期中会触发事件。 这在生命周期事件部分中有详细说明。
在您的 Spring ApplicationContext 中声明这些 Bean 后，每当事件被分发时，它们就会被调用。