spring-cloud-feign - 假装客户端支持可选的请求参数

Question

Feign客户端是否支持可选的请求参数？

例如，我有一个端点，但我没有找到一种方法来使用 feign 客户端实际使 param1 可选。

@GetMapping(path = "endpoint1")
ResponseEntity request(@RequestParam(name = "param1", required = false, defaultValue = "key") String param1){}

Answer 1

由于您使用的是 Spring Cloud Feign，我发现实现可选参数的最简单方法是使用 DTO，并可选择实现构建器模式(Lombok 可以帮助减少冗长)。

DTO 将使请求中的参数成为可选参数(当为 null 时)，而不是方法签名。方法的可选参数应该是 - 几乎 - 不可能的，但一些 alternatives can be found here .

构建器模式将使初始化参数可选(或强制)details can be found here .该构建器还可用于设置默认值。 Lombok details can be found here .或者，构建器可以手动构建。 Starting at wikipedia . Some example pure Java code .

代码可能如下所示:

@GetMapping(path = "/endpoint1") //Not starting with / does not look ok...
ResponseEntity request(@SpringQueryMap MyDTO);

//MyDTO

import lombok.Builder;
import lombok.Getter;

@Getter
@Builder
public class MyDTO {

  private String param1;
  private String param2;
  private String param3;
}

//when using

request(MyDTO.Builder().build()); //use all defaults
request(MyDTO.Builder().param1("foo").build()); //param1 set, all other defaults
request(MyDTO.Builder().param1("foo").param2("bar").build()); //param1 and param2 set