|
对于最新的稳定版本,请使用 Spring Data Cassandra 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> { … }
使用自定义转换器覆盖默认映射
若要对映射过程进行更细粒度的控制,您可以将 Spring 的 Converters 注册到 CassandraConverter 实现类中,例如 MappingCassandraConverter。
MappingCassandraConverter 在尝试自行映射对象之前,会首先检查是否有任何 Spring Converters 能够处理特定的类。
若要“接管”MappingCassandraConverter 的常规映射策略(可能是为了提升性能或满足其他自定义映射需求),您需要创建一个 Spring Converter 接口的实现类,并将其注册到 MappingCassandraConverter 中。
使用注册的 Spring 转换器进行保存
你可以将转换和保存结合在一个过程中,基本上使用转换器来完成保存操作。
以下示例使用 Converter 通过 Jackson 2 将 Person 对象转换为 java.lang.String:
class PersonWriteConverter implements Converter<Person, String> {
public String convert(Person source) {
try {
return new ObjectMapper().writeValueAsString(source);
} catch (IOException e) {
throw new IllegalStateException(e);
}
}
}
使用 Spring 转换器进行读取
与保存和转换可以结合使用类似,你也可以将读取和转换结合起来。
以下示例使用了一个 Converter,它利用 Jackson 2 将 java.lang.String 转换为 Person 对象:
class PersonReadConverter implements Converter<String, Person> {
public Person convert(String source) {
if (StringUtils.hasText(source)) {
try {
return new ObjectMapper().readValue(source, Person.class);
} catch (IOException e) {
throw new IllegalStateException(e);
}
}
return null;
}
}
注册 Spring 转换器与CassandraConverter
Spring Data for Apache Cassandra 的 Java 配置提供了一种便捷的方式来注册 Spring Converter 实例:MappingCassandraConverter。
以下配置代码片段展示了如何手动注册转换器以及如何配置 CustomConversions:
@Configuration
public class ConverterConfiguration extends AbstractCassandraConfiguration {
@Override
public CassandraCustomConversions customConversions() {
return CassandraCustomConversions.create(config -> {
config.registerConverter(new PersonReadConverter()));
config.registerConverter(new PersonWriteConverter()));
});
}
// other methods omitted...
}