查询字符串参数的 Java URL 编码

说我有一个网址

http://example.com/query?q=

并且我有一个用户输入的查询，例如：

随机词 £500 银行 $

我希望结果是正确编码的 URL：

http://example.com/query?q=random%20word%20%A3500%20bank%20%24

实现此目标的最佳方法是什么？我尝试了URLEncoder并创建 URI / URL 对象，但是没有一个是正确的。

答案

URLEncoder是必经之路。您只需要记住只对单个查询字符串参数名称和 / 或值&和参数名称 - 值分隔符=都不进行编码。

String q = "random word £500 bank $";
String url = "https://example.com?q=" + URLEncoder.encode(q, StandardCharsets.UTF_8);

当您仍不使用 Java 10 或更高版本时，请使用StandardCharsets.UTF_8.toString()作为 charset 参数，或者当您仍不使用 Java 7 或更高版本时，请使用"UTF-8" 。

请注意，查询参数中的空格由+表示，而不是%20 ，这是合法有效的。 %20通常用于表示 URI 本身（URI 查询字符串分隔符?之前的部分）中的空格，而不是查询字符串（ ?后面的部分）中的空格。

还要注意，有三种encode()方法。一个不带Charset作为第二个参数，另一个不带String作为第二个参数，这将引发一个已检查的异常。不建议Charset参数的参数。永远不要使用它，并且总是指定Charset参数。 Javadoc 甚至明确建议使用 RFC3986和W3C要求的 UTF-8 编码。

所有其他字符都是不安全的，并且首先使用某种编码方案将其转换为一个或多个字节。然后，每个字节由 3 个字符的字符串 “％xy” 表示，其中 xy 是该字节的两位十六进制表示形式。推荐使用的编码方案是 UTF-8 。但是，出于兼容性原因，如果未指定编码，则使用平台的默认编码。

也可以看看：

每个 Web 开发人员必须了解的 URL 编码

我不会使用URLEncoder 。除了被错误地命名（ URLEncoder与 URL 无关）之外，效率低下（它使用StringBuffer代替 Builder，并且执行其他一些很慢的操作）它也很容易弄乱它。

相反，我将使用URIBuilder或Spring 的org.springframework.web.util.UriUtils.encodeQuery或 Commons Apache HttpClient 。原因是您必须以与参数值不同的方式转义查询参数名称（即 BalusC 的答案q

上面的唯一缺点（我很痛苦地发现）是URL 并不是 URI 的真正子集。

样例代码：

import org.apache.http.client.utils.URIBuilder;

URIBuilder ub = new URIBuilder("http://example.com/query");
ub.addParameter("q", "random word £500 bank \$");
String url = ub.toString();

// Result: http://example.com/query?q=random+word+%C2%A3500+bank+%24

由于我只是链接到其他答案，因此将其标记为社区 Wiki。随时编辑。

您需要先创建一个 URI，例如：

String urlStr = "http://www.example.com/CEREC® Materials & Accessories/IPS Empress® CAD.pdf"
URL url= new URL(urlStr);
URI uri = new URI(url.getProtocol(), url.getUserInfo(), url.getHost(), url.getPort(), url.getPath(), url.getQuery(), url.getRef());

然后将该 Uri 转换为 ASCII 字符串：

urlStr=uri.toASCIIString();

现在，您的 url 字符串已完全编码，我们先进行了简单的 url 编码，然后将其转换为 ASCII 字符串，以确保字符串中没有剩余 US-ASCII 的字符。这正是浏览器的工作方式。