关于spring:5-穿过拥挤的人潮Spring已为你制作好高级赛道

1次阅读

共计 12429 个字符，预计需要花费 32 分钟才能阅读完成。

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

你好，我是 YourBatman。

上篇文章大篇幅把 Spring 全新一代类型转换器介绍完了，曾经至多可能考个及格分。在介绍 Spring 泛滥内建的转换器里，我成心留下一个尾巴，放在本文专门撰文解说。

为了让本人能在“拥挤的人潮中”显得不（更）一（突）样（出），A 哥特意筹备了这几个非凡的转换器助你破局，穿梭拥挤的人潮，踏上 Spring 已为你制作好的高级赛道。

Spring Framework：5.3.1
Spring Boot：2.4.0

本文的焦点将集中在上文留下的 4 个类型转换器上。

StreamConverter：将 Stream 流与汇合 / 数组之间的转换，必要时转换元素类型

这三个比拟非凡，属于“最初的”“兜底类”类型转换器：

ObjectToObjectConverter：通用的将原对象转换为指标对象（通过工厂办法 or 结构器）
IdToEntityConverter：本文重点。给个 ID 主动帮你兑换成一个 Entity 对象
FallbackObjectToStringConverter：将任何对象调用 toString() 转化为 String 类型。当匹配不到任何转换器时，它用于兜底

Spring 新一代类型转换内建了十分多的实现，这些在初始化阶段大都被默认注册进去。注册点在 DefaultConversionService 提供的一个 static 动态工具办法里：

static 静态方法具备与 实例无关性，我集体感觉把该 static 办法放在一个 xxxUtils 里对立治理会更好，放在具体某个组件类里反倒容易产生语义上的误导性

DefaultConversionService：public static void addDefaultConverters(ConverterRegistry converterRegistry) {// 1、增加标量转换器(和数字相干)
        addScalarConverters(converterRegistry);
        // 2、增加解决汇合的转换器
        addCollectionConverters(converterRegistry);

        // 3、增加对 JSR310 工夫类型反对的转换器
        converterRegistry.addConverter(new ByteBufferConverter((ConversionService) converterRegistry));
        converterRegistry.addConverter(new StringToTimeZoneConverter());
        converterRegistry.addConverter(new ZoneIdToTimeZoneConverter());
        converterRegistry.addConverter(new ZonedDateTimeToCalendarConverter());

        // 4、增加兜底转换器（下面解决不了的全交给这几个哥们解决）converterRegistry.addConverter(new ObjectToObjectConverter());
        converterRegistry.addConverter(new IdToEntityConverter((ConversionService) converterRegistry));
        converterRegistry.addConverter(new FallbackObjectToStringConverter());
        converterRegistry.addConverter(new ObjectToOptionalConverter((ConversionService) converterRegistry));
    }

    }

该静态方法用于注册全局的、默认的 转换器们，从而让 Spring 有了根底的转换能力，进而实现绝大部分转换工作。为了不便记忆这个注册流程，我把它绘制成图供以你保留：

特别强调：转换器的注册程序十分重要，这决定了通用转换器的匹配后果（谁在前，优先匹配谁）。

针对这幅图，你可能还会有疑难：

JSR310 转换器只看到 TimeZone、ZoneId 等转换，怎么没看见更为罕用的 LocalDate、LocalDateTime 等这些类型转换呢？难道 Spring 默认是不反对的？
1. 答：当然不是 。这么常见的场景 Spring 怎能会不反对呢？不过与其说这是类型转换，倒不如说是 格式化 更适合。所以会在后 3 篇文章格式化章节在作为重中之重讲述
个别的 Converter 都见名之意，但 StreamConverter 有何作用呢？什么场景下会失效
1. 答：本文讲述
对于兜底的转换器，有何含意？这种极具通用性的转换器作用为何
1. 答：本文讲述

用于实现汇合 / 数组类型到 Stream 类型的互转，这从它反对的Set<ConvertiblePair> 汇合也能看进去：

@Override
public Set<ConvertiblePair> getConvertibleTypes() {Set<ConvertiblePair> convertiblePairs = new HashSet<ConvertiblePair>();
    convertiblePairs.add(new ConvertiblePair(Stream.class, Collection.class));
    convertiblePairs.add(new ConvertiblePair(Stream.class, Object[].class));
    convertiblePairs.add(new ConvertiblePair(Collection.class, Stream.class));
    convertiblePairs.add(new ConvertiblePair(Object[].class, Stream.class));
    return convertiblePairs;
}

它反对的是双向的匹配规定：

/**
 * {@link StreamConverter}
 */
@Test
public void test2() {System.out.println("----------------StreamConverter---------------");
    ConditionalGenericConverter converter = new StreamConverter(new DefaultConversionService());

    TypeDescriptor sourceTypeDesp = TypeDescriptor.valueOf(Set.class);
    TypeDescriptor targetTypeDesp = TypeDescriptor.valueOf(Stream.class);
    boolean matches = converter.matches(sourceTypeDesp, targetTypeDesp);
    System.out.println("是否可能转换：" + matches);

    // 执行转换
    Object convert = converter.convert(Collections.singleton(1), sourceTypeDesp, targetTypeDesp);
    System.out.println(convert);
    System.out.println(Stream.class.isAssignableFrom(convert.getClass()));
}

运行程序，输入：

----------------StreamConverter---------------
是否可能转换：true
java.util.stream.ReferencePipeline$Head@5a01ccaa
true

关注点：底层仍旧依赖 DefaultConversionService 实现元素与元素之间的转换。譬如本例 Set -> Stream 的理论步骤为：

也就是说任何汇合 / 数组类型是先转换为 中间状态 的 List，最终调用 list.stream() 转换为 Stream 流的；若是逆向转换先调用 source.collect(Collectors.<Object>toList()) 把 Stream 转为 List 后，再转为具体的汇合 or 数组类型。

阐明：若 source 是数组类型，那底层理论应用的就是 ArrayToCollectionConverter，留神触类旁通

StreamConverter 它的拜访权限是 default，咱们并不能间接应用到它。通过下面介绍可知 Spring 默认把它注册进了注册中心里，因而面向使用者咱们间接应用转换服务接口 ConversionService 便可。

@Test
public void test3() {System.out.println("----------------StreamConverter 应用场景 ---------------");
    ConversionService conversionService = new DefaultConversionService();
    Stream<Integer> result = conversionService.convert(Collections.singleton(1), Stream.class);

    // 生产
    result.forEach(System.out::println);
    // result.forEach(System.out::println); //stream has already been operated upon or closed
}

运行程序，输入：

----------------StreamConverter 应用场景 ---------------
1

再次特别强调：流只能被读（生产）一次。

因为有了 ConversionService 提供的弱小能力，咱们就能够在基于 Spring/Spring Boot 做二次开发时应用它，进步零碎的通用性和容错性。如：当办法入参是 Stream 类型时，你既能够传入 Stream 类型，也能够是 Collection 类型、数组类型，是不是霎时逼格高了起来。

依照增加转换器的程序，Spring 在最初增加了 4 个通用的转换器用于兜底，你可能平时并不关注它，但它实时就在施展着它的作用。

将源对象转换为指标类型，十分的通用：Object -> Object：

@Override
public Set<ConvertiblePair> getConvertibleTypes() {return Collections.singleton(new ConvertiblePair(Object.class, Object.class));
}

尽管它反对的是 Object -> Object，看似没有限度但其实是有约定条件的：

@Override
public boolean matches(TypeDescriptor sourceType, TypeDescriptor targetType) {return (sourceType.getType() != targetType.getType() &&
            hasConversionMethodOrConstructor(targetType.getType(), sourceType.getType()));
}

是否可能解决的判断逻辑在于 hasConversionMethodOrConstructor 办法，直译为：是否有转换方法或者结构器。代码具体解决逻辑如下截图：

此局部逻辑可分为两个 part 来看：

part1：从缓存中拿到 Member，直接判断 Member 的可用性，可用的话 迅速返回
part2：若 part1 没有返回，就执行三部曲，尝试找到一个适合的 Member，而后放进缓存内（若没有就返回 null）

part1：疾速返回流程

当不是首次进入解决时，会走疾速返回流程。也就是第 0 步 isApplicable 判断逻辑，有这几个关注点：

Member 包含 Method 或者 Constructor
Method：若是 static 静态方法，要求办法的第 1 个入参类型必须是源类型 sourceType；若不是 static 办法，则要求源类型 sourceType 必须是 method.getDeclaringClass() 的子类型 / 雷同类型
Constructor：要求结构器的第 1 个入参类型必须是源类型 sourceType

创立指标对象的实例，此转换器反对两种形式：

通过工厂办法 / 实例办法创立实例（method.invoke(source)）
通过结构器创立实例（ctor.newInstance(source)）

以上 case，在上面均会给出代码示例。

part2：三部曲流程

对于首次解决的转换，就会进入到具体的三部曲逻辑：通过反射尝试找到适合的 Member 用于创立指标实例，也就是上图的 1、2、3 步。

step1：determineToMethod，从 sourceClass 里找实例办法，对办法有如下要求：

办法名必须叫 "to" + targetClass.getSimpleName()，如toPerson()
办法的拜访权限必须是 public
该办法的返回值必须是指标类型或其子类型

step2：determineFactoryMethod，找动态工厂办法，对办法有如下要求：

办法名必须为valueOf(sourceClass) 或者 of(sourceClass) 或者from(sourceClass)
办法的拜访权限必须是 public

step3：determineFactoryConstructor，找结构器，对结构器有如下要求：

存在一个参数，且参数类型是 sourceClass 类型的结构器
结构器的拜访权限必须是 public

特地值得注意的是：此转换器不反对 Object.toString()办法将 sourceType 转换为 java.lang.String。对于 toString()反对，请应用上面介绍的更为兜底的FallbackObjectToStringConverter。

代码示例

实例办法

// sourceClass
@Data
public class Customer {
    private Long id;
    private String address;

    public Person toPerson() {Person person = new Person();
        person.setId(getId());
        person.setName("YourBatman-".concat(getAddress()));
        return person;
    }

}

// tartgetClass
@Data
public class Person {
    private Long id;
    private String name;
}

书写测试用例：

@Test
public void test4() {System.out.println("----------------ObjectToObjectConverter---------------");
    ConditionalGenericConverter converter = new ObjectToObjectConverter();

    Customer customer = new Customer();
    customer.setId(1L);
    customer.setAddress("Peking");

    Object convert = converter.convert(customer, TypeDescriptor.forObject(customer), TypeDescriptor.valueOf(Person.class));
    System.out.println(convert);

    // ConversionService 形式（理论应用形式）ConversionService conversionService = new DefaultConversionService();
    Person person = conversionService.convert(customer, Person.class);
    System.out.println(person);
}

运行程序，输入：

----------------ObjectToObjectConverter---------------
Person(id=1, name=YourBatman-Peking)
Person(id=1, name=YourBatman-Peking)

动态工厂办法

// sourceClass
@Data
public class Customer {
    private Long id;
    private String address;
}

// targetClass
@Data
public class Person {

    private Long id;
    private String name;

    /**
     * 办法名称能够是：valueOf、of、from
     */
    public static Person valueOf(Customer customer) {Person person = new Person();
        person.setId(customer.getId());
        person.setName("YourBatman-".concat(customer.getAddress()));
        return person;
    }
}

测试用例齐全同上，再次运行输入：

----------------ObjectToObjectConverter---------------
Person(id=1, name=YourBatman-Peking)
Person(id=1, name=YourBatman-Peking)

办法名能够为 valueOf、of、from 任意一种，这种命名形式简直是业界不成文的规矩，所以恪守起来也会比拟容易。然而：倡议还是正文写好，避免他人重命名而导致转换失效。

结构器

根本同动态工厂办法示例，略

应用场景

基于本转换器能够实现任意对象 -> 任意对象的转换，只须要遵循办法名 / 结构器默认的所有约定即可，在咱们平时开发书写转换层时是十分有帮忙的，借助 ConversionService 能够解决这一类问题。

对于 Object -> Object 的转换，另外一种形式是自定义Converter<S,T>，而后注册到注册核心。至于到底选哪种适合，这就看具体利用场景喽，本文只是多给你一种抉择

Id(S) –> Entity(T)。通过调用 动态查找办法 将实体 ID 兑换为实体对象。Entity 里的该查找办法须要满足如下条件find[EntityName]([IdType])：

必须是 static 静态方法
办法名必须为find + entityName。如 Person 类的话，那么办法名叫findPerson
办法参数列表必须为 1 个
返回值类型必须是 Entity 类型

阐明：此办法能够不用是 public，但倡议用 public。这样即便 JVM 的 Security 安全级别开启也可能失常拜访

反对的转换 Pair 如下：ID 和 Entity 都能够是 任意类型，能转换就成

@Override
public Set<ConvertiblePair> getConvertibleTypes() {return Collections.singleton(new ConvertiblePair(Object.class, Object.class));
}

判断是否能执行准换的条件是：存在符合条件的 find 办法，且source 能够转换为 ID 类型（留神 source 能转换成 id 类型就成，并非指标类型哦）

@Override
public boolean matches(TypeDescriptor sourceType, TypeDescriptor targetType) {Method finder = getFinder(targetType.getType());
    return (finder != null 
        && this.conversionService.canConvert(sourceType, TypeDescriptor.valueOf(finder.getParameterTypes()[0])));
}

依据 ID 定位到 Entity 实体对象几乎太太太罕用了，使用好此转换器的提供的能力，或者能让你事倍功半，大大减少 反复代码，写出更优雅、更简洁、更易于保护的代码。

代码示例

Entity 实体：筹备好符合条件的 findXXX 办法

@Data
public class Person {

    private Long id;
    private String name;

    /**
     * 依据 ID 定位一个 Person 实例
     */
    public static Person findPerson(Long id) {
        // 个别依据 id 从数据库查，本处通过 new 来模仿
        Person person = new Person();
        person.setId(id);
        person.setName("YourBatman-byFindPerson");
        return person;
    }

}

利用 IdToEntityConverter，书写示例代码：

@Test
public void test() {System.out.println("----------------IdToEntityConverter---------------");
    ConditionalGenericConverter converter = new IdToEntityConverter(new DefaultConversionService());

    TypeDescriptor sourceTypeDesp = TypeDescriptor.valueOf(String.class);
    TypeDescriptor targetTypeDesp = TypeDescriptor.valueOf(Person.class);
    boolean matches = converter.matches(sourceTypeDesp, targetTypeDesp);
    System.out.println("是否可能转换：" + matches);

    // 执行转换
    Object convert = converter.convert("1", sourceTypeDesp, targetTypeDesp);
    System.out.println(convert);
}

运行程序，失常输入：

----------------IdToEntityConverter---------------
是否可能转换：true
Person(id=1, name=YourBatman-byFindPerson)

示例成果为：传入字符串类型的“1”，就能返回失去一个 Person 实例。能够看到，咱们传入的是字符串类型的的 1，而办法入参 id 类型理论为 Long 类型，但因为它们能实现 String -> Long 转换，因而最终还是可能失去一个 Entity 实例的。

应用场景

这个应用场景就比拟多了，须要应用到 findById() 的中央都能够通过它来代替掉。如：

Controller 层：

@GetMapping("/ids/{id}")
public Object getById(@PathVariable Person id) {return id;}

@GetMapping("/ids")
public Object getById(@RequestParam Person id) {return id;}

Tips：在 Controller 层这么写我并不倡议，因为 语义上 没有对齐，势必在代码书写过程中带来肯定的麻烦。

Service 层：

@Autowired
private ConversionService conversionService;

public Object findById(String id){Person person = conversionService.convert(id, Person.class);

    return person;
}

Tips：在 Service 层这么写，我集体感觉还是 OK 的。用类型转换的畛域设计思维代替了自上而下的过程编程思维。

通过简略的调用 Object#toString() 办法将任何反对的类型转换为 String 类型，它作为底层兜底。

@Override
public Set<ConvertiblePair> getConvertibleTypes() {return Collections.singleton(new ConvertiblePair(Object.class, String.class));
}

该转换器反对 CharSequence/StringWriter 等类型，以及所有 ObjectToObjectConverter.hasConversionMethodOrConstructor(sourceClass, String.class) 的类型。

阐明：ObjectToObjectConverter 不解决任何 String 类型的转换，原来都是交给它了

代码示例

略。

将任意类型转换为一个 Optional<T> 类型，它作为 最最最最最 底部的兜底，略微理解下即可。

代码示例

@Test
public void test5() {System.out.println("----------------ObjectToOptionalConverter---------------");
    ConversionService conversionService = new DefaultConversionService();
    Optional<Integer> result = conversionService.convert(Arrays.asList(2), Optional.class);

    System.out.println(result);
}

运行程序，输入：

----------------ObjectToOptionalConverter---------------
Optional[[2]]

应用场景

一个典型的利用场景：在 Controller 中可传可不传的参数中，咱们不仅能够通过 @RequestParam(required = false) Long id 来做，还是能够这么写：@RequestParam Optional<Long> id。

本文是对上文介绍 Spring 全新一代类型转换机制的补充，因为关注得人较少，所以才有机会冲破。

针对于 Spring 注册转换器，须要特地留神如下几点：

注册程序很重要。先注册，先服务（若反对的话）
默认状况下，Spring 会注册大量的内建转换器，从而反对 String/ 数字类型转换、汇合类型转换，这能解决协定层面的大部分转换问题。
1. 如 Controller 层，输出的是 JSON 字符串，可用主动被封装为数字类型、汇合类型等等
2. 如 @Value 注入的是 String 类型，但也能够用数字、汇合类型接管

对于简单的对象 -> 对象类型的转换，个别须要你自定义转换器，或者参照本文的规范写法实现转换。总之：Spring 提供的 ConversionService 专一于类型转换服务，是一个十分十分实用的 API，特地是你正在做基于 Spring 二次开发的状况下。

当然喽，对于 ConversionService 这套机制还并未具体介绍，如何应用？如何运行？如何扩大？带着这三个问题，咱们下篇见。

【Spring 类型转换】系列：

1. 揭秘 Spring 类型转换 – 框架设计的基石
2. Spring 晚期类型转换，基于 PropertyEditor 实现
3. 搞定出工，PropertyEditor 就到这
4. 上新了 Spring，全新一代类型转换机制

【Jackson】系列：

1. 初识 Jackson — 世界上最好的 JSON 库
2. 妈呀，Jackson 原来是这样写 JSON 的
3. 懂了这些，方敢在简历上说会用 Jackson 写 JSON
4. JSON 字符串是如何被解析的？JsonParser 理解一下
5. JsonFactory 工厂而已，还蛮有料，这是我没想到的
6. 二十不惑，ObjectMapper 应用也不再蛊惑
7. Jackson 用树模型解决 JSON 是必备技能，不信你看

【数据校验 Bean Validation】系列：

1. 不吹不擂，第一篇就能晋升你对 Bean Validation 数据校验的认知
2. Bean Validation 申明式校验办法的参数、返回值
3. 站在应用层面，Bean Validation 这些标准接口你须要烂熟于胸
4. Validator 校验器的五大外围组件，一个都不能少
5. Bean Validation 申明式验证四大级别：字段、属性、容器元素、类
6. 自定义容器类型元素验证，类级别验证（多字段联结验证）

【新个性】系列：

IntelliJ IDEA 2020.3 正式公布，年度最初一个版本很讲武德
IntelliJ IDEA 2020.2 正式公布，诸多亮点总有几款能助你提效
[IntelliJ IDEA 2020.1 正式公布，你要的 Almost 都在这！]()
Spring Framework 5.3.0 正式公布，在云原生路上持续发力
Spring Boot 2.4.0 正式公布，全新的配置文件加载机制（不向下兼容）
Spring 扭转版本号命名规定：此举对非英语国家很敌对
JDK15 正式公布，划时代的 ZGC 同时发表转正

【程序人生】系列：

蚂蚁金服上市了，我不想致力了
如果程序员和产品经理都用凡尔赛文学对话 ……
程序人生 | 春风得意马蹄疾，一日看尽长安花

还有诸如【Spring 配置类】【Spring-static】【Spring 数据绑定】【Spring Cloud Netflix】【Feign】【Ribbon】【Hystrix】… 更多原创专栏，关注 BAT 的乌托邦 回复 专栏 二字即可全副获取，也可加我fsx1056342982，交个敌人。

有些 已完结 ，有些 连载中。我是 A 哥(YourBatman)，咱们下期再见

正文完

spring

发表至： spring

2020-12-22

0

关于spring:springbootJunit5测试失败的小问题

关于spring:写的太细了Spring-MVC拦截器的应用建议收藏再看

关于spring:吹爆Alibaba自研的Spring全能笔记建议人手一份

关于spring:Spring-MVC-的实现

关于javascript:VS-Code-调试-js-的两种方法

关于spring:5-穿过拥挤的人潮Spring已为你制作好高级赛道

✍前言

版本约定

✍注释

默认转换器注册状况

StreamConverter

代码示例

应用场景

兜底转换器

ObjectToObjectConverter

part1：疾速返回流程

part2：三部曲流程

代码示例

应用场景

IdToEntityConverter

代码示例

应用场景

FallbackObjectToStringConverter

代码示例

ObjectToOptionalConverter

代码示例

应用场景

✍总结

✔✔✔举荐浏览✔✔✔

站内搜索