Rest 客户端中 LHS 括号格式参数传递指南

在 Rest 客户端中使用 LHS 括号格式传递参数

简介

在使用某些 API 时，需要使用 LHS 括号（即左中括号）传递参数。例如，CMS Strapi API 就要求使用这种格式。本文将探讨如何使用 Spring Boot 3.2.2 中的内置 RestClient 和 HttpExchange 接口实现 LHS 括号格式的参数传递。

HttpExchange 接口

HttpExchange 接口用于声明 RESTful Web 服务的 HTTP 交换。对于需要传递 LHS 括号格式参数的 API，可以修改 HttpExchange 接口如下：

@HttpExchange("/categories")
public interface CategoryClient {

    @GetExchange
    StrapiResponse<List<Category>> find(@RequestParam(name = "pagination", multiValue = true) Pagination[] pagination);

}

CategoryRequest 记录类

CategoryRequest 记录类表示要发送的 HTTP 请求。将 @RequestParam 注解与 multiValue = true 一起使用以支持 LHS 括号格式：

public record CategoryRequest(@RequestParam(name = "pagination", multiValue = true) Pagination[] pagination) {
}

Pagination 记录类

Pagination 记录类表示分页参数：

public record Pagination(Integer page, Integer pageSize) {
}

构建请求

使用 MultiValueMap 来构建带有 LHS 括号格式参数的请求：

MultiValueMap<String, String> params = new LinkedMultiValueMap<>();
params.add("pagination[page]", "1");
params.add("pagination[pageSize]", "10");

StrapiResponse<List<Category>> response = categoryClient.find(new CategoryRequest(params));

结论

通过使用 @RequestParam(name = "", multiValue = true) 选项以及构建请求时使用 MultiValueMap，可以轻松地在 Rest 客户端中实现 LHS 括号格式的参数传递。这种方法既灵活又易于使用，对于与需要这种格式的 API 集成至关重要。

常见问题解答

1. 为什么需要使用 LHS 括号格式？

   • 某些 API 要求使用 LHS 括号格式来传递参数，例如 CMS Strapi API。

2. 如何使用 Spring Boot 3.2.2 实现 LHS 括号格式的参数传递？

   • 使用 @RequestParam(name = "", multiValue = true) 选项和 MultiValueMap。

3. 在使用 LHS 括号格式时需要注意什么？

   • 确保参数顺序与 API 预期的一致，并且参数类型匹配。

4. 使用 LHS 括号格式有哪些优势？

   • 简化了与需要这种格式的 API 的集成。

5. LHS 括号格式与其他参数传递格式有什么区别？

   • LHS 括号格式允许使用多个值表示单个请求参数，而其他格式只能传递单个值。