Spring 假装客户端中名称@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
|
--------------------------------------------------------------------------------------------------

经过大量的试验和错误，我想出了一个解决方案，在假装客户端方法中使用@PathVariable而不是@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("""[]""")
))

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

有没有办法将@RequestParam与特殊字符一起使用？ 它看起来像春天的虫子？

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

Answer 1

首先，它不是 Spring 中的错误。这些类似 Spring 的注释(@RequestParam、@RequestMappingspring-web等(的主要目标是在服务器端的 Spring MVC 控制器中使用它们，而不是为请求创建 URL。

在 Feign 客户端的情况下，还有另一个库spring-cloud-openfeign，它允许您将它们放在 Feign 客户端中以进行请求映射，而不是原始的 Feign 注释(如@RequestLine、@Param等(。SpringMvcContract负责它，默认情况下在 Spring 应用程序中使用它。但这仅仅是为了方便使用Feign和Spring的特定开发人员群体，所以这不是更改这些注释的签名或添加一些新设置的理由。

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

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

1. 构造请求查询模板时，无法手动设置编码选项，因为它只是硬编码(查看 UriTemplate 和 QueryTemplate 源代码(。
2. 您实际上可以在以后通过编写自己的RequestInterceptor来修复构造的 url(通过反射，例如(，但这实际上毫无意义，因为在应用所有拦截器后，请求被构建并且目前，它再次隐式编码括号(检查引擎盖下发生了什么，基本上它使用queryTemplate.toString()反过来，在使用 UriUtils 类的方法时对括号进行编码(
3. 创建请求后，它由Client开始执行，我实际上设法在此步骤中修复了 url。我从标准Client.Default继承了一个类，注册了它而不是原始的自动配置的类，然后我在实际调用客户端之前完成了我的工作(ofc 可以为不同的客户端做同样的事情，例如，对于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的问题就不那么重要了。