跳到主要内容

自定义转换

ChatGPT-4o-mini 中英对照 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);
  }
}
java

如果你编写一个 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> { … }
java

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

为了更精细地控制映射过程，您可以使用 CassandraConverter 实现（如 MappingCassandraConverter）注册 Spring Converters。

MappingCassandraConverter 首先检查是否有任何 Spring Converters 可以处理特定的类，然后再尝试映射对象本身。要“劫持” MappingCassandraConverter 的正常映射策略（可能是为了提高性能或其他自定义映射需求），您需要创建一个 Spring Converter 接口的实现并将其注册到 MappingCassandraConverter。

使用注册的 Spring 转换器进行保存​

你可以将转换和保存结合在一个过程中，基本上是使用转换器来进行保存。

以下示例使用 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);
		}
	}
}
java

使用 Spring 转换器读取​

类似于你可以将保存和转换结合起来，你也可以将读取和转换结合起来。

以下示例使用一个 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;
	}
}
java

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

}
java