此版本仍在开发中,尚未被视为稳定版本。对于最新的稳定版本,请使用 Spring Data Cassandra 4.4.0! |
自定义转化
下面的 Spring 示例Converter
implementation 从String
到自定义Email
value 对象:
@ReadingConverter
public class EmailReadConverter implements Converter<String, Email> {
public Email convert(String source) {
return Email.valueOf(source);
}
}
如果您编写Converter
其 source 和 target type 是 native 类型,我们无法确定我们应该将其视为 reading 还是 writing 转换器。
将转换器实例注册为两者可能会导致不需要的结果。
例如,Converter<String, Long>
是模棱两可的,尽管尝试全部转换可能没有意义String
实例转换为Long
实例。
为了让您强制基础设施仅以一种方式注册转换器,我们提供了@ReadingConverter
和@WritingConverter
在 converter implementation 中使用的 annotations。
转换器需要进行显式注册,因为不会从 Classpath 或容器扫描中选取实例,以避免向 conversion 服务进行不必要的注册以及此类注册产生的副作用。转换器注册为CustomConversions
作为中央工具,允许根据源和目标类型注册和查询已注册的转换器。
CustomConversions
附带一组预定义的转换器注册:
-
JSR-310 用于
java.time
,java.util.Date
和String
类型。
本地时间类型的默认转换器(例如LocalDateTime 自java.util.Date ) 依赖于系统默认时区设置在这些类型之间进行转换。您可以通过注册自己的转换器来覆盖默认转换器。 |
转换器消歧义
通常,我们会检查Converter
它们转换的源类型和目标类型的实现。
根据其中之一是否是底层数据访问 API 可以本地处理的类型,我们将转换器实例注册为读取或写入转换器。
以下示例显示了 writing- 和 read 转换器(请注意,区别在于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> { … }
使用自定义转换器覆盖默认映射
要对 Map 过程进行更精细的控制,您可以注册 SpringConverters
跟CassandraConverter
实现,例如MappingCassandraConverter
.
MappingCassandraConverter
首先检查是否有任何 SpringConverters
可以在尝试映射对象本身之前处理特定类。
要 “'劫持'” 的法线映射策略MappingCassandraConverter
(可能是为了提高性能或其他自定义映射需求),您需要创建 Spring 的实现Converter
接口并将其注册到MappingCassandraConverter
.
使用已注册的 Spring 转换器进行保存
您可以将转换和保存合并到一个过程中,基本上使用转换器进行保存。
以下示例使用Converter
要将Person
object 设置为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);
}
}
}
使用 Spring 转换器读取
与组合保存和转换的方式类似,您也可以组合读取和转换。
以下示例使用Converter
这会将java.lang.String
转换为Person
object 替换为 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;
}
}
注册 Spring ConvertersCassandraConverter
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...
}