带有 JSON 数组参数的 GetMapping

Question

我正在使用 FeignClient 和 GetMapping 与外部系统进行交互。
我的 GetMapping 定义为：

   @GetMapping(value = "/path/to/endpoint?fields=[\"nm\",\"label\"]")
   public String hitEndpoint() {}

调试显示正在调用端点：

https://url/path/to/endpoint?fields=[%22nm%22&fields=%22label%22]

这是失败的，因为端点需要字段参数的有效 json：

https://url/path/to/endpoint?fields=[%22nm%22,%22label%22]

如何说服 GetMapping 正确提出请求？

谢谢你的帮助。

Answer 1

尽管我认为将JSON作为POST方法的主体传递给您的控制器会更好。 但是，如果您坚持这样做，我可以向您提出 2 个解决方案：

第一个解决方案

将您的JSON数组编码为百分比编码，以便您可以通过URL发送它。

例如，您的数组将如下所示：

["nm","label"] -> %5B%22nm%22%2C%22label%22%5D

我使用这个在线工具对其进行编码。

第二种解决方案

1. 将您的数组编码为Base64并通过 URL GET到您的控制器。
2. 在控制器中解码给定的Base64字符串并将其解析为JSON数组。

Answer 2

无需在 URL 中定义 Array 参数，使用 spring，您可以如下定义 API，并借助@RequestParam注释的强大功能，您可以定义您希望在 URL 中接收数组作为参数

@RequestMapping(value = "/path-to-endpoint", method = RequestMethod.GET)
    public ResponseEntity<YourResponseDTO> yourMethodName(
@RequestParam("ids") List<Long> arrayParam) {
        // Return successful response
        return new ResponseEntity<>(service.yourServiceMethod(requestDTO), HttpStatus.OK);
    }

然后您可以使用以下 URL 调用您的GET端点：

/path-to-endpoint?ids=1,2,3,4