自定义转换

以下 Spring Converter 实现示例将从 String 转换为自定义 Email 值对象

@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 注解，用于在转换器实现中使用。

转换器需要显式注册，因为实例不会从类路径或容器扫描中获取，以避免与转换服务进行意外注册以及由此产生的副作用。转换器与 CustomConversions 注册，作为允许基于源类型和目标类型注册和查询已注册转换器的中心设施。

CustomConversions 附带一组预定义的转换器注册

  • JSR-310 转换器用于在 java.time、java.util.Date 和 String 类型之间进行转换。

本地时间类型（例如 LocalDateTime 到 java.util.Date）的默认转换器依赖于系统默认时区设置来在这些类型之间进行转换。您可以通过注册自己的转换器来覆盖默认转换器。

转换器歧义消除

通常，我们检查 Converter 实现以了解它们转换的源类型和目标类型。根据其中一个类型是否为底层数据访问 API 可以原生处理的类型，我们将转换器实例注册为读取转换器或写入转换器。以下示例显示了一个写入转换器和一个读取转换器（注意区别在于 Converter 上限定符的顺序）

// 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 目标类型。这允许在域模型中使用非 MongoDB 类型（如 BigDecimal），同时以原生 org.bson.types.Decimal128 格式持久化值。

示例 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 值会自动转换。有关详细信息，请参阅 映射层中如何处理 _id 字段。
2 所需的 target 类型被显式定义为 Decimal128，它转换为 NumberDecimal。否则，BigDecimal 值将被转换为 String。
3 Date 值由 MongoDB 驱动程序本身处理，并存储为 ISODate。

上面的代码片段对于提供简单的类型提示非常有用。为了更细粒度地控制映射过程，您可以将 Spring 转换器与 MongoConverter 实现（如 MappingMongoConverter）一起注册。

MappingMongoConverter 会在尝试映射对象本身之前检查是否有任何 Spring 转换器可以处理特定类。为了“劫持”MappingMongoConverter 的正常映射策略，例如为了提高性能或其他自定义映射需求，您首先需要创建一个 Spring Converter 接口的实现，然后将其注册到 MappingConverter 中。

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

编写转换器

以下示例展示了将 Person 对象转换为 org.bson.Document 的 Converter 实现。

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;
  }
}

读取转换器

以下示例展示了将 Document 转换为 Person 对象的 Converter 实现。

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());
	}
}