我们的外部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
s而不是@RequestParam
s 的解决方案:
@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
s与特殊字符一起使用?看起来像是春天的虫子?
同时,我将尝试对其进行调试以了解问题出在哪里。
首先,它不是Spring中的错误。这些类似于spring的注释(@RequestParam
,@RequestMapping
等等spring-web
)的主要目标是在服务器端的Spring MVC控制器中使用它们,而不是为请求创建url。
对于Feign客户,还有另一个库,spring-cloud-openfeign
它允许您将它们放在Feign Client中以进行请求映射,而不是原始的Feign注释(如@RequestLine
,@Param
等等)。SpringMvcContract
对此负责,并且在Spring应用程序中默认使用它。但这只是为了方便使用Spring的Feign的特定开发人员群体,因此这不是更改这些批注的签名或为其添加一些新设置的理由。
关于所描述的问题-似乎没有任何“官方”方法可以禁用url编码,即使您使用原始Feign注释进行请求映射-目前(版本10.7.4),您也只能使用斜杠(检查此问题,例如)。
我进行了进一步的调查,得出以下几点:
RequestInterceptor
(通过反射,fe),但这实际上是没有意义的,因为在应用所有拦截器之后,将构建请求,此刻,它会再次对括号进行隐式编码(请检查在引擎盖,基本上使用queryTemplate.toString()
,然后使用UriUtils类的方法对括号进行编码)Client
,实际上我在这一步设法修复了该URL。我从标准继承了一个类Client.Default
,注册了该类,而不是原始的自动配置的类,然后在实际调用客户端之前做了工作(当然,对于不同的客户端fe可以这样做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的问题不太重要。