Spring 类型转换

core.convert 包提供了通用的类型转换系统。该系统定义了一个 SPI 用于实现类型转换逻辑，以及一个 API 用于在运行时执行类型转换。在 Spring 容器中，你可以使用该系统作为 PropertyEditor 实现的替代方案，将外部化的 bean 属性值字符串转换为所需的属性类型。你也可以在应用程序中任何需要类型转换的地方使用公共 API。

Converter SPI

用于实现类型转换逻辑的 SPI 简单且类型安全，如下面的接口定义所示

package org.springframework.core.convert.converter;

public interface Converter<S, T> {

	T convert(S source);
}

要创建自己的转换器，请实现 Converter 接口，并将 S 参数化为要从转换的类型，将 T 参数化为要转换为的类型。如果需要将 S 的集合或数组转换为 T 的数组或集合，只要注册了委托数组或集合转换器（DefaultConversionService 默认会注册），此类转换器也可以透明地应用。

对于每次调用 convert(S)，保证源参数不为空。如果转换失败，你的 Converter 可以抛出任何非受检异常。特别是，它应该抛出 IllegalArgumentException 以报告无效的源值。请注意确保你的 Converter 实现是线程安全的。

core.convert.support 包中提供了一些转换器实现以方便使用。其中包括字符串到数字和其他常见类型的转换器。下面的列表显示了 StringToInteger 类，它是一个典型的 Converter 实现

package org.springframework.core.convert.support;

final class StringToInteger implements Converter<String, Integer> {

	public Integer convert(String source) {
		return Integer.valueOf(source);
	}
}

使用 ConverterFactory

当需要集中处理整个类层次结构的转换逻辑时（例如，将 String 转换为 Enum 对象时），可以实现 ConverterFactory，如下面的示例所示

package org.springframework.core.convert.converter;

public interface ConverterFactory<S, R> {

	<T extends R> Converter<S, T> getConverter(Class<T> targetType);
}

将 S 参数化为要从转换的类型，将 R 参数化为定义可以转换为的类的范围的基础类型。然后实现 getConverter(Class<T>)，其中 T 是 R 的子类。

考虑将 StringToEnumConverterFactory 作为示例

package org.springframework.core.convert.support;

final class StringToEnumConverterFactory implements ConverterFactory<String, Enum> {

	public <T extends Enum> Converter<String, T> getConverter(Class<T> targetType) {
		return new StringToEnumConverter(targetType);
	}

	private final class StringToEnumConverter<T extends Enum> implements Converter<String, T> {

		private Class<T> enumType;

		public StringToEnumConverter(Class<T> enumType) {
			this.enumType = enumType;
		}

		public T convert(String source) {
			return (T) Enum.valueOf(this.enumType, source.trim());
		}
	}
}

使用 GenericConverter

当需要复杂的 Converter 实现时，请考虑使用 GenericConverter 接口。与 Converter 相比，GenericConverter 具有更灵活但类型不那么严格的签名，支持在多种源类型和目标类型之间进行转换。此外，GenericConverter 提供源字段和目标字段的上下文，可在实现转换逻辑时使用。此类上下文允许根据字段注解或字段签名上声明的泛型信息来驱动类型转换。下面的列表显示了 GenericConverter 的接口定义

package org.springframework.core.convert.converter;

public interface GenericConverter {

	public Set<ConvertiblePair> getConvertibleTypes();

	Object convert(Object source, TypeDescriptor sourceType, TypeDescriptor targetType);
}

要实现 GenericConverter，让 getConvertibleTypes() 返回支持的源→目标类型对。然后实现 convert(Object, TypeDescriptor, TypeDescriptor) 以包含你的转换逻辑。源 TypeDescriptor 提供对存储要转换的值的源字段的访问。目标 TypeDescriptor 提供对要设置转换后值的目标字段的访问。

GenericConverter 的一个很好的示例是 Java 数组和集合之间的转换器。此类 ArrayToCollectionConverter 会检查声明目标集合类型的字段，以解析集合的元素类型。这使得源数组中的每个元素在集合被设置到目标字段之前被转换为集合元素类型。

由于 GenericConverter 是一个更复杂的 SPI 接口，只有在你需要时才应该使用它。对于基本的类型转换需求，优先选择 Converter 或 ConverterFactory。

使用 ConditionalGenericConverter

有时，你希望 Converter 仅在特定条件成立时运行。例如，你可能希望 Converter 仅在目标字段上存在特定注解时运行，或者仅在目标类上定义了特定方法（例如静态 valueOf 方法）时运行 Converter。ConditionalGenericConverter 是 GenericConverter 和 ConditionalConverter 接口的并集，允许你定义此类自定义匹配条件

public interface ConditionalConverter {

	boolean matches(TypeDescriptor sourceType, TypeDescriptor targetType);
}

public interface ConditionalGenericConverter extends GenericConverter, ConditionalConverter {
}

ConditionalGenericConverter 的一个很好的示例是 IdToEntityConverter，它在持久化实体标识符和实体引用之间进行转换。此类 IdToEntityConverter 可能仅在目标实体类型声明了静态查找方法（例如 findAccount(Long)）时才匹配。你可以在 matches(TypeDescriptor, TypeDescriptor) 的实现中执行此类查找方法检查。

ConversionService API

ConversionService 定义了一个统一的 API，用于在运行时执行类型转换逻辑。转换器通常在以下外观接口后面运行

package org.springframework.core.convert;

public interface ConversionService {

	boolean canConvert(Class<?> sourceType, Class<?> targetType);

	<T> T convert(Object source, Class<T> targetType);

	boolean canConvert(TypeDescriptor sourceType, TypeDescriptor targetType);

	Object convert(Object source, TypeDescriptor sourceType, TypeDescriptor targetType);
}

大多数 ConversionService 实现还实现了 ConverterRegistry，它提供了一个用于注册转换器的 SPI。在内部，ConversionService 实现委托给其注册的转换器来执行类型转换逻辑。

core.convert.support 包中提供了一个健壮的 ConversionService 实现。GenericConversionService 是适用于大多数环境的通用实现。ConversionServiceFactory 提供了一个方便的工厂，用于创建常见的 ConversionService 配置。

配置 ConversionService

ConversionService 是一个无状态对象，设计用于在应用程序启动时实例化，然后在多个线程之间共享。在 Spring 应用中，你通常为每个 Spring 容器（或 ApplicationContext）配置一个 ConversionService 实例。Spring 会获取该 ConversionService 并在框架需要执行类型转换时使用它。你也可以将此 ConversionService 注入到你的任何 bean 中并直接调用它。

如果没有向 Spring 注册 ConversionService，将使用原始的基于 PropertyEditor 的系统。

要向 Spring 注册一个默认的 ConversionService，添加以下 id 为 conversionService 的 bean 定义

<bean id="conversionService"
	class="org.springframework.context.support.ConversionServiceFactoryBean"/>

默认的 ConversionService 可以转换字符串、数字、枚举、集合、Map 和其他常见类型。要用你自己的自定义转换器补充或覆盖默认转换器，请设置 converters 属性。属性值可以实现 Converter、ConverterFactory 或 GenericConverter 接口中的任何一个。

<bean id="conversionService"
		class="org.springframework.context.support.ConversionServiceFactoryBean">
	<property name="converters">
		<set>
			<bean class="example.MyCustomConverter"/>
		</set>
	</property>
</bean>

在 Spring MVC 应用中使用 ConversionService 也很常见。请参阅 Spring MVC 章中的转换和格式化。

在某些情况下，你可能希望在转换期间应用格式化。有关使用 FormattingConversionServiceFactoryBean 的详细信息，请参阅FormatterRegistry SPI。

编程式使用 ConversionService

要编程式地使用 ConversionService 实例，你可以像注入任何其他 bean 一样注入对它的引用。以下示例显示了如何操作

  • Java

  • Kotlin

@Service
public class MyService {

	private final ConversionService conversionService;

	public MyService(ConversionService conversionService) {
		this.conversionService = conversionService;
	}

	public void doIt() {
		this.conversionService.convert(...)
	}
}
@Service
class MyService(private val conversionService: ConversionService) {

	fun doIt() {
		conversionService.convert(...)
	}
}

对于大多数用例，你可以使用指定 targetType 的 convert 方法，但它不适用于更复杂的类型，例如参数化元素的集合。例如，如果要编程式地将 Integer 列表转换为 String 列表，则需要提供源类型和目标类型的正式定义。

幸运的是，TypeDescriptor 提供了各种选项来使操作变得简单，如下面的示例所示

  • Java

  • Kotlin

DefaultConversionService cs = new DefaultConversionService();

List<Integer> input = ...
cs.convert(input,
	TypeDescriptor.forObject(input), // List<Integer> type descriptor
	TypeDescriptor.collection(List.class, TypeDescriptor.valueOf(String.class)));
val cs = DefaultConversionService()

val input: List<Integer> = ...
cs.convert(input,
		TypeDescriptor.forObject(input), // List<Integer> type descriptor
		TypeDescriptor.collection(List::class.java, TypeDescriptor.valueOf(String::class.java)))

请注意，DefaultConversionService 会自动注册适用于大多数环境的转换器。这包括集合转换器、标量转换器和基本的 Object 到 String 转换器。你可以使用 DefaultConversionService 类上的静态 addDefaultConverters 方法将相同的转换器注册到任何 ConverterRegistry 中。

值类型的转换器会重用于数组和集合，因此假设标准集合处理是合适的，则无需创建特定的转换器来将 S 集合转换为 T 集合。