跳到主要内容
版本:5.1.1

自定义转换

Doubao 中英对照 Type based Converter Custom Conversions

以下 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 注解,供在转换器实现中使用。

转换器需要显式注册,因为其实例不会从 classpath 或容器扫描中被拾取,以避免在转换服务中发生意外注册以及由此类注册带来的副作用。转换器通过 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 目标类型。这允许您在领域模型中使用 BigDecimal 等非 MongoDB 类型,同时以例如 String 格式持久化值。

示例 1. 显式目标类型映射

public class Payment {

@Id String id; 1

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

Date date; 3

}
{
"_id" : ObjectId("5ca4a34fa264a01503b36af8"), 1
"value" : "2.099", 2
"date" : ISODate("2019-04-03T12:11:01.870Z") 3
}
  • 表示有效 ObjectId 的 String _id 值会自动转换。有关详细信息,请参阅映射层如何处理 _id 字段。

  • 所需的目标类型被显式定义为 String。否则。

  • Date 值由 MongoDB 驱动程序本身处理,并以 ISODate 形式存储。

上面的代码片段便于提供简单的类型提示。要对映射过程进行更细粒度的控制,您可以向 MongoConverter 实现(例如 MappingMongoConverter)注册 Spring 转换器。

MappingMongoConverter 会先检查是否有任何 Spring 转换器可以处理某个特定类,然后才尝试映射该对象本身。要「劫持」MappingMongoConverter 的正常映射策略(也许是为了提高性能或满足其他自定义映射需求),您首先需要创建 Spring Converter 接口的实现,然后将其注册到 MappingConverter。

备注

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

写入转换器​

以下示例展示了一个 Converter 的实现,它将 Person 对象转换为 org.bson.Document:

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

读取转换器​

以下示例展示了一个 Converter 的实现,它将 Document 转换为 Person 对象:

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

大数字格式​

MongoDB 早期版本不支持 BigDecimal 等大数值。为了持久化 BigDecimal 和 BigInteger 值,Spring Data MongoDB 会将值转换为其 String 表示形式。由于查询、更新等采用词法比较而非数值比较,这种方法存在若干缺点。

借助 MongoDB Server 3.4,org.bson.types.Decimal128 为 BigDecimal 和 BigInteger 提供了原生表示。从 Spring Data MongoDB 5.0 起,这些类型不再有默认表示,转换需要显式配置。您可以注册多种格式(第一种为默认格式),并仍通过在 MongoCustomConversions 中配置 BigDecimalRepresentation(即 MongoCustomConversions.create(config → config.bigDecimal(BigDecimalRepresentation.STRING, BigDecimalRepresentation.DECIMAL128)))来保留先前的行为。这允许您通过 @Field(targetType = DECIMAL128) 使用显式存储类型格式,同时将默认转换保持为 String。只要这些值不被持久化,选择不使用任何所提供的表示形式也是有效的。

备注

非常大的值虽然是有效的 BigDecimal 或 BigInteger,但在其存储原生表示形式中可能会超过 org.bson.types.Decimal128 的最大位长度。