spring-cloud-feign 客户端和 @RequestParam 与 Date 类型

Question

这次我在使用声明式 REST 客户端，在一些 Spring Boot 应用程序中进行 Feign。

我想要实现的是调用我的 REST API 之一，如下所示：

@RequestMapping(value = "/customerslastvisit", method = RequestMethod.GET)
    public ResponseEntity customersLastVisit(
            @RequestParam(value = "from", required = true) @DateTimeFormat(iso = DateTimeFormat.ISO.DATE) Date from,
            @RequestParam(value = "to", required = true) @DateTimeFormat(iso = DateTimeFormat.ISO.DATE) Date to) {

如您所见，API 接受使用 from 和 to 日期参数格式的调用，如 (yyyy-MM-dd)

为了调用该 API，我准备了以下@FeignClient：

@FeignClient("MIIA-A")
public interface InboundACustomersClient {
    @RequestMapping(method = RequestMethod.GET, value = "/customerslastvisit")
    ResponseEntity customersLastVisit(
            @RequestParam(value = "from", required = true) @DateTimeFormat(iso = DateTimeFormat.ISO.DATE) Date from,
            @RequestParam(value = "to", required = true) @DateTimeFormat(iso = DateTimeFormat.ISO.DATE) Date to);
}

一般来说，几乎是复制粘贴。现在在我的启动应用程序的某个地方，我使用它：

DateFormat formatter = new SimpleDateFormat("dd/MM/yyyy");
ResponseEntity response = inboundACustomersClient.customersLastVisit(formatter.parse(formatter.format(from)),
        formatter.parse(formatter.format(to)));

而且，我得到的是

嵌套异常是 org.springframework.core.convert.ConversionFailedException: 失败 从类型 [java.lang.String] 转换为类型 [@org.springframework.web.bind.annotation.RequestParam @org.springframework.format.annotation.DateTimeFormat java.util.Date] 价值 'Sun May 03 00:00:00 CEST 2015';

嵌套异常是 java.lang.IllegalArgumentException: Unable to 解析“2015 年 5 月 3 日星期日 00:00:00 CEST”

所以，问题是，我对请求做错了什么，它在发送到我的 API 之前没有解析为“仅限日期”格式？或者可能是纯粹的 Feign lib 问题？

Answer 1

feign 客户端现在（2020 年 12 月）使用上面原始问题中的语法和 java.time.LocalDate 作为参数可以正常工作。也就是说，您可以使用：

  @FeignClient(name = "YOUR-SERVICE")
  interface ClientSpec {
    @RequestMapping(value = "/api/something", method = RequestMethod.GET)
    String doSomething(
        @RequestParam("startDate") 
        @DateTimeFormat(iso = DateTimeFormat.ISO.DATE) 
        LocalDate startDate);
  }

Answer 2

您可以只使用扩展器对象。

 /**
 * @see com.x.y.z.rest.configuration.SomeController#search(Integer, Integer, Date, Date)
 */
@RequestLine("GET /configuration/{customerId}?&startDate={startDate}")
Set<AnObject> searchSomething(@Param("customerId") Integer customerId, @Param(value = "startDate", expander = FeignDateExpander.class) Date startDate);


public class FeignDateExpander implements Param.Expander {

@Override
public String expand(Object value) {
    Date date = (Date)value;
    return new SimpleDateFormat("yyyy-MM-dd HH:mm:ss").format(date);
}
}

Answer 3

这是一个线程安全的解决方案，不会在您的 spring 世界中注册默认日期格式化程序。但请记住，此格式化程序将作为新的默认值用于所有 feign 客户端，并且您实际上应该使用 joda 日期时间或新的 java 日期时间：

@Configuration
public class FeignFormatterRegister implements FeignFormatterRegistrar {

    @Override
    public void registerFormatters(FormatterRegistry registry) {
        registry.addFormatter(new DateFormatter());
    }

    /*
     * SimpleDateFormat is not thread safe!
     * consider using joda time or java8 time instead
     */
    private static class DateFormatter implements Formatter<Date> {
        static final ThreadLocal<SimpleDateFormat> FORMAT = ThreadLocal.withInitial(
                () -> new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ss.SSSZ")
        );

        @Override
        public Date parse(String text, Locale locale) throws ParseException {
            return FORMAT.get().parse(text);
        }

        @Override
        public String print(Date date, Locale locale) {
            return FORMAT.get().format(date);
        }
    }
}

Answer 4

另一个简单的解决方案是使用默认的接口方法进行日期到字符串的转换，比如

@RequestMapping(value = "/path", method = GET)
List<Entity> byDate(@RequestParam("date") String date);

default List<Entity> date(Date date) {
    return date(new SimpleDateFormat("dd.MM.yyyy").format(validityDate));
}

Answer 5

您应该创建并注册一个 feign 格式化程序来自定义日期格式

@Component
public class DateFormatter implements Formatter<Date> {

    SimpleDateFormat formatter = new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ss.SSSZ");

    @Override
    public Date parse(String text, Locale locale) throws ParseException {
        return formatter.parse(text);
    }

    @Override
    public String print(Date date, Locale locale) {
        return formatter.format(date);
    }
}


@Configuration
public class FeignFormatterRegister implements FeignFormatterRegistrar {

    @Override
    public void registerFormatters(FormatterRegistry registry) {
        registry.addFormatter(new DateFormatter());
    }
}