玩转spring mvc入参自定义类型转换和格式化

2020-05-28 00:00:00 参数 接口 转换器 转换 格式化





概述

近小胖哥搞了个小程序,有几个spring mvc 接口传递了时间,时间用java 8 time 相关的api 来直接接收:

当使用根据ISO 8601格式化的参数向任何这些方法发送POST请求时,报出了如下异常:


这是因为默认情况下Spring不能将String参数转换为任何日期或时间对象。下面小胖哥就来带大家来搞一搞如何在spring mvc中进行类型转换和格式化操作,webflux也是同样的机制。多多关注码农小胖哥,更多it知识分享。


在请求级别转换日期参数

其中的一个解决方案是使用@DateTimeFormat 注释注释参数  并提供格式设置模式参数,我们将上面的方法改动一下:

这样,如果使用ISO 8601格式格式化字符串,则字符串将正确转换为日期对象。我们也可以使用自己的转换模式。我们可以在@DateTimeFormat中设置一个pattern参数  :


在应用程序全局转换日期参数

在Spring中处理日期和时间对象转换的另一种方法是提供全局配置。我们可以通过自动化配置类WebMvcAutoConfiguration中找到相关的处理机制:重点是该类的参数:

我们指定了格式就可以自动转换了。通过此约定配置我们可以指定一个统一的处理风格。从spring源码中我们得知在初始化FormattingConversionService类调用了addFormatters(FormatterRegistry registry),我们找到了该方法的具体实现:

我们发现Converter、GenericConverter、Formatter  三种类型的的Spring bean 都可以被自动注入到格式化注册机中去。当然必须注册为spring bean才能在应用中起作用。下面小胖哥就来介绍它们。



转换器

Converter<S,T>是一个函数接口。作用是将泛型S 转换为T,也就是类型转换器,可以实现String 到 Integer,String到LocalDate等不同类型之间的转换。特别指出的是,一定要确保S类型不能为null,而且保证该实现一定是线程安全的。如果你有集中转换的需要可以实现工厂转换器接口ConverterFactory



GenericConverter是两种或更多种类型之间转换的通用转换器接口,为灵活的转换接口,通过上面的片段可以知道,通过构建多个源数据到转换目标的映射对ConvertiblePair可以实现一对多、多对多的转换关系 。


格式化器


Formatter<T>接口用于实现字段格式化逻辑而且是强类型化的,该接口是组合接口。Printer<T>是将对象输出为展示时的字符串,而Parser<T> 则相反将字符串格式化为目标对象,甚至可以结合本地化。比如像上面将yyyy-MM-dd 的字符串格式化为 LocalDate。


总结

我们学习了如何接受Spring MVC请求中的日期参数。而且我们也介绍了如何在局部和全局使用它们,通过延伸探索,我们也知道了它们的一些运行机制,如何的转换类型以及格式化,而且通过实现转换器、格式化器接口 并注入spring bean 就可以工作。可以根据我的介绍实际演练一下。



相关文章