SpringCloud Feign传递Date参数时差问题的解决方案

1、前言

      使用SpringCloud的朋友，再试传递Date参数的时候，有没有遇到时间差的问题呢。代码如下：

 @GetMapping("/testDate")void testDate(@RequestParam("date") Date date);

关于时间差的问题我们又该使用什么方式去处理呢？

2、原因

     先看一个简单的例子：

第一条打印的结果是正确的，但是当通过d2的转化就会有时差。

首先先说一下为什么会这样测试呢。因为数据Date在数据传输的工程中就会调用toString()的方法。所以Feign调用的时候也就会出现这样的问题。

具体原因是啥呢？

我们看下Date的parse()方法:

parse()方法上有这样一段注释：

大致意思就是：parse()方法是使用会根据时区的偏移量来解析的，如果不指定的时区的话，默认使用本地时间，也就是U.S时区的时间。

通过打印的结果可知：传入的string数据数是CTS标识的日期。

CTS代表的时区其实有四个（Central Standard Time (USA) UT-6:00、Central Standard Time (Australia) UT+9:30、China Standard Time UT+8:00、Cuba Standard Time UT-4:00），同时表示美国，澳大利亚，中国，古巴四个国家的标准时间。

可以看到CST会被当作美国中部的时区Central Standard Time，即JVM认为你传入的时间是美国中部的时间，而当date2调用toString方法的时候，它会检测到系统的时区是中国，就会自动加14个小时（东八区与西六区的时差）

解决方案也很简单，从注释上可以看到。parse()已经过时，替代方法是DateFormat.parse().

3、Feign 参数的处理

      处理是方法有多种。

•       不传递Date参数，直接传递long类型的时间戳，接收端再去转化。
•       直接使用DateFormat直接将时间转化成【yyyy-MM-dd HH:mm:ss】,当成字符串传输，接  收端自行解析。
•       框架处理，自定义以类型转化器

4、框架的处理

4.1 定义类型转化器

@Component
public class DateFormatRegister implements FeignFormatterRegistrar {public DateFormatRegister(){}@Overridepublic void registerFormatters(FormatterRegistry registry) {registry.addConverter(Date.class, String.class, new Date2StringConverter());}private class Date2StringConverter implements Converter<Date,String>{@Overridepublic String convert(Date source) {SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");return sdf.format(source);}}
}

这种定方式，是单向的。只能将Date转化成String。接收端需要与之对应的解析转化器。

解析转化器的配置：

@Configuration
public class String2DateConfig {@Autowiredprivate RequestMappingHandlerAdapter handlerAdapter;/**  增加字符串转日期的功能*/@PostConstructpublic void initEditableValidation() {ConfigurableWebBindingInitializer initializer = (ConfigurableWebBindingInitializer) handlerAdapter.getWebBindingInitializer();if (initializer.getConversionService() != null) {GenericConversionService genericConversionService = (GenericConversionService) initializer.getConversionService();genericConversionService.addConverter(String.class, Date.class, new String2DateConverter());}}private class String2DateConverter implements Converter<String, Date> {@Overridepublic Date convert(String source) {SimpleDateFormat simpleDateFormat = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");try {return simpleDateFormat.parse(source);} catch (ParseException e) {e.printStackTrace();}return null;}}
}

这两种必须都要配置才能做到传输和接受的正确性。

缺少任何一个都会报错:String 不能解析成Date或者Date不能转化成String。

这种配置代码量有点大，作为一个有追求的coder，看起来的还是有点难受的。下来介绍终极解决方案。

4.2 终极解决方案

能不能通过一个【DateFormatRegister】完成配置呢。当然可以。

@Configuration
public class FeignDateFormatRegister implements FeignFormatterRegistrar {@Overridepublic void registerFormatters(FormatterRegistry registry) {registry.addFormatter(dateFormatter());}@Beanpublic DateFormatter dateFormatter(){return new DateFormatter("yyyy-MM-dd HH:mm:ss");}}

搞定。看起来果然简单不少。看些舒服多了。DateFormatter为什么会加注入到Spring容器中呢。因为这个DateFormatter是需要复用的，放在容器中可以一直使用。所以需要Spring的管理。否则配置不会生效。

5、后记

        在使用中会发现 FeignFormatterRegistrar 是针对Feign接口传输定制的Formatter，该Formatter是针对单个参数使用的。JDK8中也可以定制LocalDateTime等类型。

        Feign接口调用会使用Http请求，Get请求会拼接参数发起Http请求。接受参数时，使用FeignFormatterRegistrar 是接收不到参数。需要在 WebMvcConfigurer 注册Formatter，也可以使用@InitBind注解。

参考文档：

SpringCloud Feign 传输Date类型参数存在误差的问题_m0_67621429的博客-CSDN博客