4. 上新了Spring，全新一代类型转换机制

分享、成长，拒绝浅藏辄止。关注公众号【 BAT的乌托邦】，回复关键字 专栏有Spring技术栈、中间件等小而美的 原创专栏供以免费学习。本文已被 https://www.yourbatman.cn 收录。

✍前言

你好，我是YourBatman。
上篇文章 介绍完了Spring类型转换早期使用的PropertyEditor详细介绍，关于PropertyEditor现存的资料其实还蛮少的，希望这几篇文章能弥补这块空白，贡献一份微薄之力。
如果你也吐槽过PropertyEditor不好用，那么本文将对会有帮助。Spring自3.0版本开始自建了一套全新类型转换接口，这就是本文的主要内容，接下来逐步展开。

说明：Spring自3.0后笑傲群雄，进入大一统。Java从此步入Spring的时代

版本约定

• Spring Framework：5.3.1
• Spring Boot：2.4.0

✍正文

在了解新一代的转换接口之前，先思考一个问题：Spring为何要自己造一套轮子呢？ 一向秉承不重复造轮子原则的Spring，不是迫不得已的话是不会去动他人奶酪的，毕竟互利共生才能长久。类型转换，作为Spring框架的基石，扮演着异常重要的角色，因此对其可扩展性、可维护性、高效性均有很高要求。
基于此，我们先来了解下PropertyEditor设计上到底有哪些缺陷/不足（不能满足现代化需求），让Spring“被迫”走上了自建道路。

PropertyEditor设计缺陷

前提说明：本文指出它的设计缺陷，只讨论把它当做类型转换器在转换场景下存在的一些缺陷。

1. 职责不单一：该接口有非常多的方法，但只用到2个而已
2. 类型不安全：setValue()方法入参是Object，getValue()返回值是Object，依赖于约定好的类型强转，不安全
3. 线程不安全：依赖于setValue()后getValue()，实例是线程不安全的
4. 语义不清晰：从语义上根本不能知道它是用于类型转换的组件
5. 只能用于String类型：它只能进行String <-> 其它类型的转换，而非更灵活的Object <-> Object

PropertyEditor存在这五宗“罪”，让Spring决定自己设计一套全新API用于专门服务于类型转换，这就是本文标题所述：新一代类型转换Converter、ConverterFactory、GenericConverter。

关于PropertyEditor在Spring中的详情介绍，请参见文章： 3. 搞定收工，PropertyEditor就到这

新一代类型转换

为了解决PropertyEditor作为类型转换方式的设计缺陷，Spring 3.0版本重新设计了一套类型转换接口，有3个核心接口：

1. Converter：Source -> Target类型转换接口，适用于1:1转换
2. ConverterFactory：Source -> R类型转换接口，适用于1:N转换
3. GenericConverter：更为通用的类型转换接口，适用于N:N转换
4. 注意：就它没有泛型约束，因为是通用

另外，还有一个条件接口ConditionalConverter，可跟上面3个接口搭配组合使用，提供前置条件判断验证。
这套接口，解决了PropertyEditor做类型转换存在的所有缺陷，且具有非常高的灵活性和可扩展性。下面进入详细了解。

Converter

将源类型S转换为目标类型T。

@FunctionalInterface
public interface Converter {
 T convert(S source);}

它是个函数式接口，接口定义非常简单。适合1:1转换场景：可以将任意类型 转换为 任意类型。它的实现类非常多，部分截图如下：

值得注意的是：几乎所有实现类的访问权限都是default/private，只有少数几个是public公开的，下面我用代码示例来“近距离”感受一下。

代码示例

/**
 * Converter：1:1
 */@Test
public void test() {
 System.out.println("----------------StringToBooleanConverter---------------"); Converter converter = new StringToBooleanConverter();
 // trueValues.add("true"); // trueValues.add("on"); // trueValues.add("yes"); // trueValues.add("1"); System.out.println(converter.convert("true")); System.out.println(converter.convert("1"));
 // falseValues.add("false"); // falseValues.add("off"); // falseValues.add("no"); // falseValues.add("0"); System.out.println(converter.convert("FalSe")); System.out.println(converter.convert("off")); // 注意：空串返回的是null
 System.out.println(converter.convert(""));
 System.out.println("----------------StringToCharsetConverter---------------"); Converter converter2 = new StringToCharsetConverter(); // 中间横杠非必须，但强烈建议写上   不区分大小写
 System.out.println(converter2.convert("uTf-8")); System.out.println(converter2.convert("utF8"));}

运行程序，正常输出：

----------------StringToBooleanConverter---------------
true
true
false
false
null
----------------StringToCharsetConverter---------------
UTF-8
UTF-8

说明：StringToBooleanConverter/StringToCharsetConverter访问权限都是default，外部不可直接使用。此处为了做示例用到一个小技巧 -> 将Demo的报名调整为和转换器的一样，这样就可以直接访问。
关注点：true/on/yes/1都能被正确转换为true的，且对于英文字母来说一般都不区分大小写，增加了容错性（包括Charset的转换）。

不足

Converter用于解决1:1的任意类型转换，因此它必然存在一个不足：解决1:N转换问题需要写N遍，造成重复冗余代码。
譬如：输入是字符串，它可以转为任意数字类型，包括byte、short、int、long、double等等，如果用Converter来转换的话每个类型都得写个转换器，想想都麻烦有木有。
Spring早早就考虑到了该场景，提供了相应的接口来处理，它就是ConverterFactory。

ConverterFactory

从名称上看它代表一个转换工厂：可以将对象S转换为R的所有子类型，从而形成1:N的关系。

该接口描述为xxxFactory是非常合适的，很好的表达了1:N的关系

public interface ConverterFactory {
  Converter getConverter(Class targetType);}

它同样也是个函数式接口。该接口的实现类并不多，Spring Framework共提供了5个内建实现（访问权限全部为default）：

以StringToNumberConverterFactory为例看看实现的套路：

final class StringToNumberConverterFactory implements ConverterFactory {
 @Override public  Converter getConverter(Class targetType) { return new StringToNumber(targetType); }
 // 私有内部类：实现Converter接口。用泛型边界约束一类类型
 private static final class StringToNumber implements Converter {
 private final Class targetType; public StringToNumber(Class targetType) { this.targetType = targetType; }
 @Override public T convert(String source) { if (source.isEmpty()) { return null; } return NumberUtils.parseNumber(source, this.targetType); } }
}

由点知面，ConverterFactory作为Converter的工厂，对Converter进行包装，从而达到屏蔽内部实现的目的，对使用者友好，这不正是工厂模式的优点么，符合xxxFactory的语义。但你需要清除的是，工厂内部实现其实也是通过众多if else之类的去完成的，本质上并无差异。

代码示例

/**
 * ConverterFactory：1:N
 */@Test
public void test2() {
 System.out.println("----------------StringToNumberConverterFactory---------------"); ConverterFactory converterFactory = new StringToNumberConverterFactory(); // 注意：这里不能写基本数据类型。如int.class将抛错
 System.out.println(converterFactory.getConverter(Integer.class).convert("1").getClass()); System.out.println(converterFactory.getConverter(Double.class).convert("1.1").getClass()); System.out.println(converterFactory.getConverter(Byte.class).convert("0x11").getClass());}

运行程序，正常输出：

----------------StringToNumberConverterFactory---------------
class java.lang.Integer
class java.lang.Double
class java.lang.Byte

关注点：数字类型的字符串，是可以被转换为任意Java中的数字类型的，String(1) -> Number(N)。这便就是ConverterFactory的功劳，它能处理这一类转换问题。

不足

既然有了1:1、1:N，自然就有N:N。比如集合转换、数组转换、Map到Map的转换等等，这些N:N的场景，就需要借助下一个接口GenericConverter来实现。

GenericConverter

它是一个通用的转换接口，用于在两个或多个类型之间进行转换。相较于前两个，这是最灵活的SPI转换器接口，但也是最复杂的。

public interface GenericConverter {
 Set getConvertibleTypes(); Object convert(Object source, TypeDescriptor sourceType, TypeDescriptor targetType); // 普通POJO
 final class ConvertiblePair { private final Class sourceType; private final Class targetType; }}

该接口并非函数式接口，虽然方法不多但稍显复杂。现对出现的几个类型做简单介绍：

• ConvertiblePair：维护sourceType和targetType的POJO

  • getConvertibleTypes()方法返回此Pair的Set集合。由此也能看出该转换器是可以支持N:N的（大多数情况下只写一对值而已，也有写多对的）

• TypeDescriptor：类型描述。该类专用于Spring的类型转换场景，用于描述from or to的类型

  • 比单独的Type类型强大，内部借助了ResolvableType来解决泛型议题

GenericConverter的内置实现也比较多，部分截图如下：

ConditionalGenericConverter是GenericConverter和条件接口ConditionalConverter的组合，作用是在执行GenericConverter转换时增加一个 前置条件判断方法。
转换器 | 描述 | 示例

ArrayToArrayConverter	数组转数组Object[] -> Object[]	["1","2"] -> [1,2]
ArrayToCollectionConverter	数组转集合 Object[] -> Collection	同上
CollectionToCollectionConverter	数组转集合 Collection -> Collection	同上
StringToCollectionConverter	字符串转集合String -> Collection	1,2 -> [1,2]
StringToArrayConverter	字符串转数组String -> Array	同上
MapToMapConverter	Map -> Map(需特别注意：key和value都支持转换才行)	略
CollectionToStringConverter	集合转字符串Collection -> String	[1,2] -> 1,2
ArrayToStringConverter	委托给CollectionToStringConverter完成	同上
--	--	--
StreamConverter	集合/数组 <-> Stream互转	集合/数组类型 -> Stream类型
IdToEntityConverter	ID->Entity的转换	传入任意类型ID -> 一个Entity实例
ObjectToObjectConverter	很复杂的对象转换，任意对象之间	obj -> obj
FallbackObjectToStringConverter	上个转换器的兜底，调用Obj.toString()转换	obj -> String

说明：分割线下面的4个转换器比较特殊，字面上不好理解其实际作用，比较“高级”。它们如果能被运用在日常工作中可以 事半功弎，因此放在在下篇文章专门给你介绍
下面以CollectionToCollectionConverter为例分析此转换器的“复杂”之处：

final class CollectionToCollectionConverter implements ConditionalGenericConverter {
 private final ConversionService conversionService; public CollectionToCollectionConverter(ConversionService conversionService) { this.conversionService = conversionService; }
 // 集合转集合：如String集合转为Integer集合
 @Override public Set getConvertibleTypes() { return Collections.singleton(new ConvertiblePair(Collection.class, Collection.class)); }}

这是唯一构造器，必须传入ConversionService：元素与元素之间的转换是依赖于conversionService转换服务去完成的，最终完成集合到集合的转换。

CollectionToCollectionConverter：
 @Override public boolean matches(TypeDescriptor sourceType, TypeDescriptor targetType) { return ConversionUtils.canConvertElements(sourceType.getElementTypeDescriptor(), targetType.getElementTypeDescriptor(), this.conversionService); }```
判断能否转换的依据：集合里的**元素与元素之间**是否能够转换，底层依赖于`ConversionService#canConvert()`这个API去完成判断。
接下来再看**最复杂**的转换方法：

CollectionToCollectionConverter：
@Override public Object convert(Object source, TypeDescriptor sourceType, TypeDescriptor targetType) { if (source == null) { return null; } Collection sourceCollection = (Collection) source;
// 判断：这些情况下，将不用执行后续转换动作了，直接返回即可
boolean copyRequired = !targetType.getType().isInstance(source); if (!copyRequired && sourceCollection.isEmpty()) { return source; } TypeDescriptor elementDesc = targetType.getElementTypeDescriptor(); if (elementDesc == null && !copyRequired) { return source; }
Collection