Spring Type Conversion _ Spring Framework6.1.13中文文档(官方文档中文翻译)|Spring 教程 —

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

转换器 SPI

实现类型转换逻辑的 SPI 简单且强类型，如下所示接口定义显示：spring-doc.cn

package org.springframework.core.convert.converter;

public interface Converter<S, T> {

	T convert(S source);
}

要创建自己的转换器，请实现接口并参数化为要转换的源类型和要转换的类型。您还可以透明地应用这样的 converter （如果需要转换为的数组或集合，前提是委托数组或集合 converter 也已注册（默认情况下已注册）。ConverterSTSTDefaultConversionServicespring-doc.cn

对于对的每次调用，保证 source 参数不为 null。如果转换失败，您可以抛出任何未经检查的异常。具体来说，它应该抛出一个 an 来报告一个无效的源值。请注意确保您的实现是线程安全的。convert(S)ConverterIllegalArgumentExceptionConverterspring-doc.cn

包中提供了几种转换器实现，如一种便利。其中包括从字符串到数字和其他常见类型的转换器。下面的清单显示了该类，这是一个典型的实现：core.convert.supportStringToIntegerConverterspring-doc.cn

package org.springframework.core.convert.support;

final class StringToInteger implements Converter<String, Integer> {

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

用`ConverterFactory`

当您需要集中整个类层次结构的转换逻辑时（例如，在 Convert from to Objects 时），您可以实施，如下例所示：StringEnumConverterFactoryspring-doc.cn

package org.springframework.core.convert.converter;

public interface ConverterFactory<S, R> {

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

将 S 参数化为要转换的起始类型，将 R 参数化为定义基本类型您可以转换为的类的范围。然后实施，其中 T 是 R 的子类。getConverter(Class<T>)spring-doc.cn

以为例：StringToEnumConverterFactoryspring-doc.cn

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`

当您需要复杂的实现时，请考虑使用接口。使用更灵活但类型不太强的签名 than ，a 支持在多个源和目标类型。此外，还提供了 source 和 target 字段 context 中，您可以在实施转化逻辑时使用。这样的上下文允许类型转换由字段注释或在字段签名。以下清单显示了的接口定义：ConverterGenericConverterConverterGenericConverterGenericConverterGenericConverterspring-doc.cn

package org.springframework.core.convert.converter;

public interface GenericConverter {

	public Set<ConvertiblePair> getConvertibleTypes();

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

要实现， have 返回支持的 source→target 类型对。然后 implement 来包含您的转换逻辑。源提供访问保存要转换的值的 source 字段。目标提供对要设置转换值的目标字段的访问。GenericConvertergetConvertibleTypes()convert(Object, TypeDescriptor, TypeDescriptor)TypeDescriptorTypeDescriptorspring-doc.cn

一个很好的例子是在 Java 数组之间转换的转换器和一个集合。这样的 an 内省了声明目标集合类型，用于解析集合的元素类型。这样，每个元素转换为 collection 元素类型，然后再将 collection 在 target 字段上设置。GenericConverterArrayToCollectionConverterspring-doc.cn

因为是一个更复杂的 SPI 接口，所以你应该使用它只在你需要的时候。偏爱或基本型转换需求。GenericConverterConverterConverterFactory

用`ConditionalGenericConverter`

有时，您希望 a 仅在特定条件成立时运行。为例如，您可能希望仅在存在特定注释时运行在 target 字段上，或者您可能希望仅在特定方法时运行（例如方法）在 Target 类上定义。是和接口的联合，允许您定义此类自定义匹配条件：ConverterConverterConverterstatic valueOfConditionalGenericConverterGenericConverterConditionalConverterspring-doc.cn

public interface ConditionalConverter {

	boolean matches(TypeDescriptor sourceType, TypeDescriptor targetType);
}

public interface ConditionalGenericConverter extends GenericConverter, ConditionalConverter {
}

a 的一个很好的例子是 that convert 在持久实体标识符和实体引用之间。仅当目标实体类型声明静态查找器方法（例如，）时，此类才可能匹配。您可以在的实现中执行此类 finder 方法检查。ConditionalGenericConverterIdToEntityConverterIdToEntityConverterfindAccount(Long)matches(TypeDescriptor, TypeDescriptor)spring-doc.cn

因为是一个更复杂的 SPI 接口，所以你应该使用它只在你需要的时候。偏爱或基本型转换需求。GenericConverterConverterConverterFactory

The API`ConversionService`

ConversionService定义一个统一的 API，用于在运行。转换器通常在以下 Facade 接口后面运行：spring-doc.cn

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);
}

大多数实现还实现了，该提供用于注册转换器的 SPI。在内部，实现委托其注册的转换器来执行类型转换逻辑。ConversionServiceConverterRegistryConversionServicespring-doc.cn

包中提供了健壮的实现。通用实现是否适合在大多数环境中使用。提供便捷的工厂创建通用配置。ConversionServicecore.convert.supportGenericConversionServiceConversionServiceFactoryConversionServicespring-doc.cn

配置`ConversionService`

A 是无状态对象，旨在在 application 中实例化 startup 的 URL，然后在多个线程之间共享。在 Spring 应用程序中，您通常为每个 Spring 容器（或）配置一个实例。 Spring 会拾取它，并在 type 转换需要由框架执行。您还可以将其注入到任何 bean 中并直接调用它。ConversionServiceConversionServiceApplicationContextConversionServiceConversionServicespring-doc.cn

如果 no 注册到 Spring，则基于原始 - 系统。ConversionServicePropertyEditor

要向 Spring 注册默认值，请添加以下 bean 定义其中为：ConversionServiceidconversionServicespring-doc.cn

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

默认值可以在字符串、数字、枚举、集合、映射和其他常见类型。要使用 own' custom converters，请设置属性。属性值可以实现任何、或接口。ConversionServiceconvertersConverterConverterFactoryGenericConverterspring-doc.cn

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

在 Spring MVC 应用程序中使用 a 也很常见。参见 Spring MVC 一章中的转换和格式化。ConversionServicespring-doc.cn

在某些情况下，您可能希望在转换过程中应用格式。有关使用的详细信息，请参阅 FormatterRegistry SPI 。FormattingConversionServiceFactoryBeanspring-doc.cn

如果 no 注册到 Spring，则基于原始 - 系统。ConversionServicePropertyEditor

以编程方式使用`ConversionService`

要以编程方式使用实例，您可以注入对就像你对任何其他豆子所做的那样。以下示例显示了如何执行此操作：ConversionServicespring-doc.cn

Javaspring-doc.cn
Kotlinspring-doc.cn

@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(...)
	}
}

对于大多数使用案例，您可以使用指定，但不适用于更复杂的类型，例如参数化元素的集合。例如，如果要以编程方式将 a of 转换为 a of，您需要提供源类型和目标类型的正式定义。converttargetTypeListIntegerListStringspring-doc.cn

幸运的是，提供了各种选项来简化操作，如下例所示：TypeDescriptorspring-doc.cn

Javaspring-doc.cn
Kotlinspring-doc.cn

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

请注意，会自动注册适用于大多数环境。这包括集合转换器、标量转换器和基本 -to- 转换器。您可以注册相同的转换器 with any 通过对类使用 static 方法。DefaultConversionServiceObjectStringConverterRegistryaddDefaultConvertersDefaultConversionServicespring-doc.cn

值类型的转换器被重新用于数组和集合，因此有无需创建特定的转换器即可从 a of 转换为 of ，前提是标准集合处理是合适的。CollectionSCollectionTspring-doc.cn

转换器 SPI

用ConverterFactory

用GenericConverter

用ConditionalGenericConverter

The APIConversionService

配置ConversionService