使用UriComponentsBuilder对查询参数进行编码

Question

我正在努力理解URIComponentsBuilder的行为。我想用它来编码查询参数中的URL，但它似乎只转义%字符，而不转义其他必要的字符，如&。

查询参数中根本没有编码的URL示例：

UriComponentsBuilder.fromUri("http://example.com/endpoint")
                    .queryParam("query", "/path?foo=foo&bar=bar")
                    .build();

输出：http://example.com/endpoint?query=/path？foo=foo&bar=bar

这是不正确的，因为未编码的&会导致bar=bar被解释为/endpoint而不是/path的查询参数。

但是，如果使用包含%字符的输入：：

UriComponentsBuilder.fromUri("http://example.com/endpoint")
                    .queryParam("query", "/path?foo=%20bar")
                    .build();

输出：http://example.com/endpoint?query=/path？foo=%2520bar

%字符被转义。

URIComponentsBuilder自动转义%字符，但不转义其他保留字符，这似乎不一致。

使用URIComponentsBuilder将URL编码为查询参数的正确过程是什么？

Answer 1

在您的示例中，builduricomponents对象没有编码或规范化。要确保应用编码：

>

通过调用encode()方法（另请参阅normalize()方法）对其进行编码：

UriComponents u = UriComponentsBuilder.fromHttpUrl("http://example.com/endpoint")
  .queryParam("query", "/path?foo=foo&bar=bar")
  .build()
  .encode(); 
// http://example.com/endpoint?query=/path?foo%3Dfoo%26bar%3Dbar

如果用于构造uricomponents的参数已经编码，请使用build(true)方法

UriComponents u = UriComponentsBuilder.fromHttpUrl("http://example.com/endpoint")
  .queryParam("query", "/path?foo=foo&bar=bar")
  .build(true);
// IllegalArgumentException: Invalid character '=' for QUERY_PARAM in "/path?foo=foo&bar=bar"

在hoodHierarchicalUricomponents.encode(String)方法下执行实际的编码。在几次内部调用之后，它调用HierarchicalUricomponents.EncodeBytes(Byte[],HierarchicalUricomponents.Type)，其中HierarchicalUricomponents.Type枚举控制URL的哪个部分中允许使用哪些字符。此检查基于RFC 3986。简而言之，spring对URL的每一部分都有自己的编码逻辑。