|
此版本仍在开发中,尚未被视为稳定版。如需最新稳定版本,请使用 Spring Data MongoDB 5.0.4! |
自定义转换
以下是一个 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 注解,可在转换器实现中使用。
转换器需要显式注册,因为不会从类路径或容器扫描中自动发现其实例,以避免意外注册到转换服务(Conversion Service)中,从而防止由此类注册引发的副作用。转换器通过 CustomConversions 进行注册,该类作为核心设施,支持基于源类型和目标类型注册转换器并查询已注册的转换器。
CustomConversions 自带一组预定义的转换器注册项:
-
用于在
java.time、java.util.Date和String类型之间进行转换的 JSR-310 转换器。
用于本地时间类型(例如 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),同时以 String 格式持久化值。
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)
}
| 1 | 代表有效 ObjectId 的字符串 id 值会被自动转换。详情请参见 映射层中如何处理 _id 字段。 |
| 2 | 目标类型被显式定义为String。
否则。 |
| 3 | 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 起,这些类型不再有默认的表示方式,必须显式配置转换逻辑。
您可以通过在 BigDecimalRepresentation 中配置 MongoCustomConversions 来注册多种格式(第一个为默认格式),从而保留之前的行为,例如:
MongoCustomConversions.create(config → config.bigDecimal(BigDecimalRepresentation.STRING, BigDecimalRepresentation.DECIMAL128))。
这样,您可以在保持默认转换为字符串的同时,通过 @Field(targetType = DECIMAL128) 使用显式的存储类型格式。
只要这些值未被持久化,不选择任何提供的表示形式也是有效的。
|
非常大的数值,即使它们是有效的 |