对于最新的稳定版本,请使用 Spring Data MongoDB 4.5.2spring-doc.cadn.net.cn

自定义转换

以下弹簧示例Converter实现从String到自定义Emailvalue 对象:spring-doc.cadn.net.cn

@ReadingConverter
public class EmailReadConverter implements Converter<String, Email> {

  public Email convert(String source) {
    return Email.valueOf(source);
  }
}

如果您编写一个Converter其源类型和目标类型是原生类型,我们无法确定是否应该将其视为读取或写入转换器。 将转换器实例注册为两者可能会导致不良结果。 例如,一个Converter<String, Long>是模棱两可的,尽管尝试将所有String实例转换为Long写作时的实例。 为了让您强制基础设施仅注册单向转换器,我们提供了@ReadingConverter@WritingConverter要在转换器实现中使用的注释。spring-doc.cadn.net.cn

转换器需要显式注册,因为实例不会从类路径或容器扫描中获取,以避免向转换服务进行不必要的注册以及此类注册产生的副作用。转换器注册于CustomConversions作为中央工具,允许根据源和目标类型注册和查询已注册的转换器。spring-doc.cadn.net.cn

CustomConversions附带一组预定义的转换器注册:spring-doc.cadn.net.cn

局部时态类型的默认转换器(例如LocalDateTimejava.util.Date)依赖于系统默认时区设置在这些类型之间进行转换。您可以通过注册自己的转换器来覆盖默认转换器。

转换器消歧义

通常,我们检查Converter它们从中转换到的源和目标类型的实现。 根据其中一个是否是底层数据访问 API 可以本地处理的类型,我们将转换器实例注册为读取或写入转换器。 以下示例显示了写入转换器和读取转换器(请注意,区别在于Converter):spring-doc.cadn.net.cn

// Write converter as only the target type is one that can be handled natively
class MyConverter implements Converter<Person, String> { … }

// Read converter as only the source type is one that can be handled natively
class MyConverter implements Converter<String, Person> { … }

基于类型的转换器

影响映射结果的最简单方法是通过@Field注解。 这允许使用非 MongoDB 类型,例如BigDecimal在域模型中,同时保留本机中的值org.bson.types.Decimal128格式。spring-doc.cadn.net.cn

示例 1.显式目标类型映射
public class Payment {

  @Id String id; (1)

  @Field(targetType = FieldType.DECIMAL128) (2)
  BigDecimal value;

  Date date; (3)

}
{
  "_id"   : ObjectId("5ca4a34fa264a01503b36af8"), (1)
  "value" : NumberDecimal(2.099), (2)
  "date"   : ISODate("2019-04-03T12:11:01.870Z") (3)
}
1 表示有效ObjectId会自动转换。看如何_id在映射图层中处理字段了解详情。
2 所需的目标类型显式定义为Decimal128翻译为NumberDecimal.否则,BigDecimal值将被截断为String.
3 Date值由 MongoDB 驱动程序本身处理,并存储为ISODate.

上面的代码片段对于提供简单的类型提示很方便。为了对映射过程进行更细粒度的控制, 您可以使用MongoConverter实现,例如MappingMongoConverter.spring-doc.cadn.net.cn

MappingMongoConverter在尝试映射对象本身之前,检查是否有任何 Spring 转换器可以处理特定类。要“劫持”法线贴图策略MappingMongoConverter,也许为了提高性能或其他自定义映射需求,您首先需要创建 SpringConverter接口,然后将其注册到MappingConverter.spring-doc.cadn.net.cn

有关 Spring 类型转换服务的更多信息,请参阅此处的参考文档。

写作转换器

以下示例显示了ConverterPersonorg.bson.Document:spring-doc.cadn.net.cn

import org.springframework.core.convert.converter.Converter;

import org.bson.Document;

public class PersonWriteConverter implements Converter<Person, Document> {

  public Document convert(Person source) {
    Document document = new Document();
    document.put("_id", source.getId());
    document.put("name", source.getFirstName());
    document.put("age", source.getAge());
    return document;
  }
}

阅读转换器

以下示例显示了ConverterDocument设置为Person对象:spring-doc.cadn.net.cn

public class PersonReadConverter implements Converter<Document, Person> {

  public Person convert(Document source) {
    Person p = new Person((ObjectId) source.get("_id"), (String) source.get("name"));
    p.setAge((Integer) source.get("age"));
    return p;
  }
}

注册转换器

class MyMongoConfiguration extends AbstractMongoClientConfiguration {

	@Override
	public String getDatabaseName() {
		return "database";
	}

	@Override
	protected void configureConverters(MongoConverterConfigurationAdapter adapter) {
		adapter.registerConverter(new com.example.PersonReadConverter());
		adapter.registerConverter(new com.example.PersonWriteConverter());
	}
}