Spring feign 客户端中@QueryParam 名称中的特殊字符

Question

我们的一个外部 API 使用带有特殊字符的查询参数名称（不要问我为什么，我不知道）。我的这个 API 的假客户端方法声明如下：

@GetMapping("/v1/user/{userId}/orders")
List<Order> getOrders(
    @PathVariable("userId") String userId,
    @RequestParam("page[number]") Integer pageNumber,
    @RequestParam("page[size]") Integer pageSize);

正如我提到的，请求参数包含特殊字符[和]. 我正在使用 Spock 进行测试，我想像这样设置 Wiremock 存根：

wiremock.stubFor(
  get(urlPathMatching('/v1/users/' + userId + '/orders'))
    .withQueryParam("page[number]", new EqualToPattern("1"))
    .withQueryParam("page[size]", new AnythingPattern())
    .willReturn(
      status(200)
        .withHeader("Content-type", "application/json")
        .withBody("""[]""")
    ))

但我得到：

--------------------------------------------------------------------------------------------------
| Closest stub                        | Request                                                  |
--------------------------------------------------------------------------------------------------
                                      |
GET                                   | GET
/v1/users/123/orders                  | /v1/users/123/orders?page%5Bnumber%5D=%7Bpage%5Bnumber%5
                                      | D%7D&page%5Bsize%5D=%7Bpage%5Bsize%5D%7D
                                      |
Query: page[number] = 1               |                                 <<<<< Query is not present
Query: page[size] [anything] (always) |                                 <<<<< Query is not present
                                      |
--------------------------------------------------------------------------------------------------

经过大量的试验和错误，我想出了一个在 feign client 方法中使用@PathVariables 而不是@RequestParams的解决方案：

@GetMapping("/v1/users/{userId}/orders?page[number]={pageNumber}&page[size]={pageSize}")
List<Order> getOrders(
    @PathVariable("userId") String userId,
    @PathVariable("pageNumber") Integer pageNumber,
    @PathVariable("pageSize") Integer pageSize);

并在 Wiremock 中编码所有查询参数

wiremock.stubFor(
    get(urlPathMatching('/v1/users/' + userId + '/orders'))
    .withQueryParam("page%5Bnumber%5D", new EqualToPattern("1"))
    .withQueryParam("page%5Bsize%5D", new AnythingPattern())
    .willReturn(
        status(200)
        .withHeader("Content-type", "application/json")
        .withBody("""[]""")
    ))

然后它起作用了。但它看起来像是一种黑客攻击。使用可选的查询参数也是有问题的。

有没有办法将@RequestParams 与特殊字符一起使用？它看起来像Spring中的一个错误？

同时，我将尝试调试它以了解问题出在哪里。

Answer 1

首先，这不是Spring的一个bug。这些类似 spring 的注释（来自 的 等）的主要目标@RequestParam是@RequestMapping在spring-web服务器端的 Spring MVC 控制器中使用它们，而不是为请求创建 url。

对于 Feign 客户端，还有另一个库 ，它spring-cloud-openfeign允许您将它们放在 Feign 客户端中进行请求映射，而不是原始的 Feign 注释（例如等）。负责它，并且在 Spring 应用程序中默认使用它。但这只是为了方便使用 Feign 和 Spring 的特定开发人员群体，因此并不是更改这些注释的签名或添加一些新设置的理由。@RequestLine@ParamSpringMvcContract

关于所描述的问题 - 似乎没有任何“官方”方法来禁用 url 编码，即使您使用原始 Feign 注释进行请求映射 - 目前（版本 10.7.4），您只能对斜杠执行此操作（例如，检查这个问题）。

我进行了一些进一步的调查并得出以下几点：

1. 在构建请求查询模板时，您无法手动设置编码选项，因为它只是硬编码的（请查看UriTemplate和QueryTemplate源代码）。
2. 您实际上可以稍后通过编写自己的RequestInterceptor（通过反射，fe）来修复构造的 url，但这实际上是没有意义的，因为在应用所有拦截器之后，请求被构建，并且此刻，它再次隐式编码括号（检查在hood，基本上它使用queryTemplate.toString()它，在使用UriUtils类的方法时依次对括号进行编码）
3. 创建请求后，开始执行Client，我实际上在这一步修复了url。我从标准继承了一个类Client.Default，注册了它而不是原来的自动配置类，然后在实际调用客户端之前完成了我的工作（ofc 可以对不同的客户端 fe，for 执行相同的操作LoadBalancerFeignClient）：

import feign.Client;
import feign.Request;
import feign.Response;
import org.springframework.stereotype.Component;
import org.springframework.util.ReflectionUtils;

import java.io.IOException;
import java.lang.reflect.Field;

@Component
public class MyClient implements Client {

    private Client delegate;

    public MyClient() {
        this.delegate = new Client.Default(null, null);
    }

    @Override
    public Response execute(Request request, Request.Options options) throws IOException {
        fixRequestUrlIfPossible(request);
        return delegate.execute(request, options);
    }

    private void fixRequestUrlIfPossible(Request request) {
        try {
            Field urlField = ReflectionUtils.findField(Request.class, "url");
            urlField.setAccessible(true);

            String encodedUrl = (String) urlField.get(request);
            String url = encodedUrl.replace("%5B", "[").replace("%5D", "]");
            urlField.set(request, url);
        } catch (Exception e) {
            /*NOP*/
        }
    }
}

但由于反射，它很容易出错（在 Feign 的更高版本中可能会停止工作）。

所以，这取决于你——如果你不害怕做这种事情，就使用这种方法。其实我更喜欢你的版本。主要问题是：您的真实服务器是否能够处理带有编码括号的请求？在我看来，Wiremock 的问题不太重要。