此版本仍在开发中,尚不被认为是稳定的。对于最新的稳定版本,请使用 Spring Data Cassandra 4.5.2! |
自定义转换
以下弹簧示例Converter
实现从String
到自定义Email
value 对象:
@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> { … }
使用自定义转换器覆盖默认映射
要对映射过程进行更细粒度的控制,您可以注册 SpringConverters
跟CassandraConverter
实现,例如MappingCassandraConverter
.
MappingCassandraConverter
首先检查是否有任何 SpringConverters
可以在尝试映射对象本身之前处理特定类。
要“劫持”法线贴图策略,请MappingCassandraConverter
(可能是为了提高性能或其他自定义映射需求),您需要创建 SpringConverter
接口并将其注册到MappingCassandraConverter
.
使用注册的弹簧转换器进行保存
您可以将转换和保存结合在一个过程中,基本上使用转换器进行保存。
以下示例使用Converter
将Person
对java.lang.String
与Jackson 2:
class PersonWriteConverter implements Converter<Person, String> {
public String convert(Person source) {
try {
return new ObjectMapper().writeValueAsString(source);
} catch (IOException e) {
throw new IllegalStateException(e);
}
}
}
使用弹簧转换器读取
与将保存和转换结合起来的方式类似,您也可以将读取和转换结合起来。
以下示例使用Converter
将java.lang.String
变成一个Person
对象与 Jackson 2:
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;
}
}
注册弹簧转换器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...
}