跳到主要内容
版本：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> { … }

用自定义转换器覆盖默认映射​

为了对映射过程进行更细粒度的控制，您可以向 CassandraConverter 实现（如 MappingCassandraConverter）注册 Spring Converter。

MappingCassandraConverter 在尝试映射对象本身之前，会先检查是否有任何 Spring Converter 能处理特定的类。要“劫持”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;
	}
}

向 CassandraConverter 注册 Spring 转换器​

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...

}