Spring中的ConversionService源碼解析

更新時間：2023年11月30日 09:45:16 作者：啊幾

這篇文章主要介紹了Spring中的ConversionService源碼解析,ConversionService是類型轉換服務的接口,從名字就可以看出ConverterRegistry是要實現(xiàn)轉換器注冊表的接口,添加和移除Converter和GenericConverter,需要的朋友可以參考下

ConversionService是什么

ConversionService是類型轉換服務的接口，最涉及的類有以下：

在這里插入圖片描述

學習類型轉換服務之前我們先看看各個接口是做什么的

ConversionService接口

ConversionService接口的方法很簡單，就是判斷是否可以兩種類型是否可以轉換，和轉換方法

在這里插入圖片描述

ConversionRegistry接口

從名字就可以看出ConverterRegistry是要實現(xiàn)轉換器注冊表的接口，添加和移除Converter和GenericConverter。

在這里插入圖片描述

FormatterRegistry接口

FormatterRegistry接口是ConverterRegistry的子接口

在這里插入圖片描述

在學這個接口之前要先了解Formatter是什么？

Formatter是什么？

Formatter是一種用于格式化和解析對象的接口，它可以將一個對象轉化為字符串，或將一個字符串轉化為特定類型的對象。在Spring MVC中，F(xiàn)ormatter通常用于將HTTP請求中的參數(shù)綁定到Java對象上，或將Java對象轉化為HTTP響應中的數(shù)據(jù)。

在這里插入圖片描述

Formatter接口繼承了Printer和Parse兩個接口

public interface Printer<T> {

	String print(T object, Locale locale);
	
}

public interface Parser<T> {

	T parse(String text, Locale locale) throws ParseException;

}

Printer接口就是對象轉換為String類型的接口，Parse接口就是將String類型轉換為特定類型對象的接口。在Spring中Formatter接口的實現(xiàn)也是非常多

在這里插入圖片描述

所以如果不需要使用String類型和對象類型的轉換，使用GenericConversionService或DefaultConversionService就可以了

ConfigurableConversionService接口

ConfigurableConversionService繼承了ConversionService和ConversionRegistry接口，從類型轉換服務涉及的類可以看出ConversionService類型轉換服務都是需要和ConverterRegistry轉換器注冊表接口配合使用的。所以ConversionService的實現(xiàn)類都是實現(xiàn)了ConfigurableConversionService接口的。

在這里插入圖片描述

Converter和GenericConverter的區(qū)別

Converter是一個通用的類型轉換器，它可以將一個類型轉換為另一個類型。它只能轉換一種類型，因此需要為每種類型都定義一個Converter。

GenericConverter是一個更通用的類型轉換器，它可以將多種類型轉換為多種類型。它可以處理多種不同的類型轉換場景，因此可以減少定義Converter的數(shù)量。GenericConverter可以在轉換過程中使用類型信息來決定如何轉換。

總的來說，Converter適用于單一類型轉換，而GenericConverter適用于多種類型轉換。 GenericConversionService也提供了一個內部類ConverterAdapter，用來將Converter適配成GenericConverter，這里用了適配器模式

ConversionService的各個實現(xiàn)類有什么區(qū)別？又該如何選擇呢？

首先看DefaultFormattingConversionService的構造方法，里面通過DefaultConversionService的靜態(tài)方法添加了默認的一些Converter還有一些默認的Formatter，可以猜測到DefaultFormattingConversionService比DefaultConversionService多添加了默認的Formatter

public DefaultFormattingConversionService(
			@Nullable StringValueResolver embeddedValueResolver, boolean registerDefaultFormatters) {

		if (embeddedValueResolver != null) {
			setEmbeddedValueResolver(embeddedValueResolver);
		}
		DefaultConversionService.addDefaultConverters(this);
		if (registerDefaultFormatters) {
			addDefaultFormatters(this);
		}
	}

下面是默認添加的一些Converter

	public static void addDefaultConverters(ConverterRegistry converterRegistry) {
		addScalarConverters(converterRegistry);
		addCollectionConverters(converterRegistry);

		converterRegistry.addConverter(new ByteBufferConverter((ConversionService) converterRegistry));
		converterRegistry.addConverter(new StringToTimeZoneConverter());
		converterRegistry.addConverter(new ZoneIdToTimeZoneConverter());
		converterRegistry.addConverter(new ZonedDateTimeToCalendarConverter());

		converterRegistry.addConverter(new ObjectToObjectConverter());
		converterRegistry.addConverter(new IdToEntityConverter((ConversionService) converterRegistry));
		converterRegistry.addConverter(new FallbackObjectToStringConverter());
		converterRegistry.addConverter(new ObjectToOptionalConverter((ConversionService) converterRegistry));
	}

下面是默認添加的一些Formatter

	public static void addDefaultFormatters(FormatterRegistry formatterRegistry) {
		// Default handling of number values
		formatterRegistry.addFormatterForFieldAnnotation(new NumberFormatAnnotationFormatterFactory());

		// Default handling of monetary values
		if (jsr354Present) {
			formatterRegistry.addFormatter(new CurrencyUnitFormatter());
			formatterRegistry.addFormatter(new MonetaryAmountFormatter());
			formatterRegistry.addFormatterForFieldAnnotation(new Jsr354NumberFormatAnnotationFormatterFactory());
		}

		// Default handling of date-time values

		// just handling JSR-310 specific date and time types
		new DateTimeFormatterRegistrar().registerFormatters(formatterRegistry);

		if (jodaTimePresent) {
			// handles Joda-specific types as well as Date, Calendar, Long
			new org.springframework.format.datetime.joda.JodaTimeFormatterRegistrar().registerFormatters(formatterRegistry);
		}
		else {
			// regular DateFormat-based Date, Calendar, Long converters
			new DateFormatterRegistrar().registerFormatters(formatterRegistry);
		}
	}

所以如果要使用Spring自帶的一些Formatter和Converter可以使用DefaultFormattingConversionService比DefaultConversionService，如果不需要可以使用FormatterConversionService或GenericConversionService。

ConversionService的使用示例

	public static void main(String[] args) {

		AnnotationConfigApplicationContext applicationContext = new AnnotationConfigApplicationContext(AppConfig.class);
		UserService userService = (UserService) applicationContext.getBean("userService");

		FormattingConversionService conversionService = new DefaultFormattingConversionService();
		
		//String -> ArrayList
		System.out.println(conversionService.convert("1,2,3,4", ArrayList.class));
		
		//boolean -> String
		System.out.println(conversionService.convert(true,String.class));
		
		//自定義了一個格式化器，OrderService -> String ,String -> OrderService
		conversionService.addFormatter(new Formatter<OrderService>() {
			private ObjectMapper objectMapper = new ObjectMapper();
			@Override
			public String print(OrderService object, Locale locale) {
				try {
					return objectMapper.writeValueAsString(object);
				} catch (JsonProcessingException e) {
					throw new RuntimeException(e);
				}
			}

			@Override
			public OrderService parse(String text, Locale locale) throws ParseException {
				try {
					return  objectMapper.readValue(text,OrderService.class);
				} catch (JsonProcessingException e) {
					throw new RuntimeException(e);
				}
			}
		});
		String result = conversionService.convert(userService.getOrderService(),String.class);
		System.out.println(result);
		OrderService orderService = conversionService.convert(result, OrderService.class);
		System.out.println(orderService);
	}

測試結果