通过前两篇文章的介绍已经非常熟悉Spirng 3.0全新一代的类型转换机制了,它提供的三种类型转换器(Converter、ConverterFactory、GenericConverter),分别可处理1:1、1:N、N:N的类型转换。按照Spring的设计习惯,必有一个注册中心来统一管理,负责它们的注册、删除等,它就是ConverterRegistry
。
对于ConverterRegistry
在文首多说一句:我翻阅了很多博客文章介绍它时几乎无一例外的提到有查找的功能,但实际上是没有的。Spring设计此API接口并没有暴露其查找功能,选择把最为复杂的查找匹配逻辑私有化,目的是让开发者使可无需关心,细节之处充分体现了Spring团队API设计的卓越能力。
另外,内建的绝大多数转换器访问权限都是default/private,那么如何使用它们,以及屏蔽各种转换器的差异化呢?为此,Spring提供了一个统一类型转换服务,它就是ConversionService
。
版本约定
-
Spring Framework:5.3.1
-
Spring Boot:2.4.0
?正文
ConverterRegistry和ConversionService的关系密不可分,前者为后者提供转换器管理支撑,后者面向使用者提供服务。本文涉及到的接口/类有:
-
ConverterRegistry
:转换器注册中心。负责转换器的注册、删除
-
ConversionService
:统一的类型转换服务。属于面向开发者使用的门面接口
-
ConfigurableConversionService
:上两个接口的组合接口
-
GenericConversionService
:上个接口的实现,实现了注册管理、转换服务的几乎所有功能,是个实现类而非抽象类
-
DefaultConversionService
:继承自GenericConversionService
,在其基础上注册了一批默认转换器(Spring内建),从而具备基础转换能力,能解决日常绝大部分场景
ConverterRegistry
Spring 3.0引入的转换器注册中心,用于管理新一套的转换器们。
public interface ConverterRegistry {
void addConverter(Converter<?, ?> converter);
<S, T> void addConverter(Class<S> sourceType, Class<T> targetType, Converter<? super S, ? extends T> converter);
void addConverter(GenericConverter converter);
void addConverterFactory(ConverterFactory<?, ?> factory);
void removeConvertible(Class<?> sourceType, Class<?> targetType);
}
它的继承树如下:
ConverterRegistry有子接口FormatterRegistry,它属于格式化器的范畴,故不放在本文讨论。但仍旧属于本系列专题内容,会在接下来的几篇内容里介入,敬请关注。
ConversionService
面向使用者的统一类型转换服务。换句话说:站在使用层面,你只需要知道ConversionService
接口API的使用方式即可,并不需要关心其内部实现机制,可谓对使用者非常友好。
public interface ConversionService {
boolean canConvert(Class<?> sourceType, Class<?> targetType);
boolean canConvert(TypeDescriptor sourceType, TypeDescriptor targetType);
<T> T convert(Object source, Class<T> targetType);
Object convert(Object source, TypeDescriptor sourceType, TypeDescriptor targetType);
}
它的继承树如下:
可以看到ConversionService和ConverterRegistry的继承树殊途同归,都直接指向了ConfigurableConversionService
这个分支,下面就对它进行介绍。
ConfigurableConversionService
ConversionService
和ConverterRegistry
的组合接口,自己并未新增任何接口方法。
public interface ConfigurableConversionService extends ConversionService, ConverterRegistry {
}
它的继承树可参考上图。接下来就来到此接口的直接实现类GenericConversionService。
GenericConversionService
对ConfigurableConversionService
接口提供了完整实现的实现类。换句话说:ConversionService和ConverterRegistry接口的功能均通过此类得到了实现,所以它是本文重点。
该类很有些值得学习的地方,可以细品,在我们自己设计程序时加以借鉴。
public class GenericConversionService implements ConfigurableConversionService {
private final Converters converters = new Converters();
private final Map<ConverterCacheKey, GenericConverter> converterCache = new ConcurrentReferenceHashMap<ConverterCacheKey, GenericConverter>(64);
}
它用两个成员变量来管理转换器们,其中converterCache是缓存用于加速查找,因此更为重要的便是Converters喽。
Converters是GenericConversionService
的内部类,用于管理(添加、删除、查找)转换器们。也就说对ConverterRegistry
接口的实现最终是委托给它去完成的,它是整个转换服务正常work的内核,下面我们对它展开详细叙述。
1、内部类Converters
它管理所有转换器,包括添加、删除、查找。
GenericConversionService:
private static class Converters {
private final Set<GenericConverter> globalConverters = new LinkedHashSet<GenericConverter>();
private final Map<ConvertiblePair, ConvertersForPair> converters = new LinkedHashMap<ConvertiblePair, ConvertersForPair>(36);
}
说明:这里使用的集合/Map均为LinkedHashXXX
,都是有序的(存入顺序和遍历取出顺序保持一致)
用这两个集合/Map存储着注册进来的转换器们,他们的作用分别是:
- ConvertiblePair:表示一对,包含sourceType和targetType
- ConvertersForPair:这一对对应的转换器们(因为能处理一对的可能存在多个转换器),内部使用一个双端队列Deque来存储,保证顺序
- 小细节:Spring 5之前使用LinkedList,之后使用Deque(实际为ArrayDeque)存储陕西省老医协生殖医学医院
final class ConvertiblePair {
private final Class<?> sourceType;
private final Class<?> targetType;
}
private static class ConvertersForPair {
private final Deque<GenericConverter> converters = new ArrayDeque<>(1);
}
添加add
public void add(GenericConverter converter) {
Set<ConvertiblePair> convertibleTypes = converter.getConvertibleTypes();
if (convertibleTypes == null) {
...
} else {
...
}
}
在此之前需要了解个前提:对于三种转换器Converter、ConverterFactory、GenericConverter
在添加到Converters之前都统一被适配为了GenericConverter
,这样做的目的是方便统一管理。对应的两个适配器是ConverterAdapter和ConverterFactoryAdapter,它俩都是ConditionalGenericConverter的内部类。
添加的逻辑被我用伪代码简化后其实非常简单,无非就是一个非此即彼的关系而已:
陕西省老医协生殖医学医院
删除remove
public void remove(Class<?> sourceType, Class<?> targetType) {
this.converters.remove(new ConvertiblePair(sourceType, targetType));
}
移除逻辑非常非常的简单,这得益于添加时候做了统一适配的抽象。
查找find
@Nullable
public GenericConverter find(TypeDescriptor sourceType, TypeDescriptor targetType) {
List<Class<?>> sourceCandidates = getClassHierarchy(sourceType.getType());
List<Class<?>> targetCandidates = getClassHierarchy(targetType.getType());
for (Class<?> sourceCandidate : sourceCandidates) {
for (Class<?> targetCandidate : targetCandidates) {
ConvertiblePair convertiblePair = new ConvertiblePair(sourceCandidate, targetCandidate);
...
}
}
return null;
}
查找逻辑也并不复杂,有两个关键点需要关注:
- 也就是说转换器支持的类型若是父类/接口,那么也能够处理器子类
2、管理转换器(ConverterRegistry)
了解了Converters
之后再来看GenericConversionService
是如何管理转换器,就如鱼得水,一目了然了。
添加
为了方便使用者调用,ConverterRegistry接口提供了三个添加方法,这里一一给与实现。
说明:暴露给调用者使用的API接口使用起来应尽量的方便,重载多个是个有效途径。内部做适配、归口即可,用户至上
@Override
public void addConverter(Converter<?, ?> converter) {
ResolvableType[] typeInfo = getRequiredTypeInfo(converter.getClass(), Converter.class);
...
// converter适配为GenericConverter添加
addConverter(new ConverterAdapter(converter, typeInfo[0], typeInfo[1]));
}
@Override
public <S, T> void addConverter(Class<S> sourceType, Class<T> targetType, Converter<? super S, ? extends T> converter) {
addConverter(new ConverterAdapter(converter, ResolvableType.forClass(sourceType), ResolvableType.forClass(targetType)));
}
@Override
public void addConverter(GenericConverter converter) {
this.converters.add(converter);
invalidateCache();
}
前两个方法都会调用到第三个方法上,每调用一次addConverter()
方法都会清空缓存,也就是converterCache.clear()
。所以动态添加转换器对性能是有损的,因此使用时候需稍加注意一些。
查找
ConverterRegistry接口并未直接提供查找方法,而只是在实现类内部做了实现。提供一个钩子方法用于查找给定sourceType/targetType对的转换器。
@Nullable
protected GenericConverter getConverter(TypeDescriptor sourceType, TypeDescriptor targetType) {
ConverterCacheKey key = new ConverterCacheKey(sourceType, targetType);
GenericConverter converter = this.converterCache.get(key);
if (converter != null) {
...
}
converter = this.converters.find(sourceType, targetType);
if (converter == null) {
converter = getDefaultConverter(sourceType, targetType);
}
...
return null;
}
抹平差异,统一类型转换服务 ConversionService
原文:https://www.cnblogs.com/guangdonglxl196/p/14202298.html