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

2022-08-31 04:03:39

假设我有网址

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

并且我有用户输入的查询,例如:

随机字 £500 银行 $

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

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

实现这一目标的最佳方法是什么?我尝试创建URI / URL对象,但没有一个出来是正确的。URLEncoder


答案 1

URLEncoder是要走的路。您只需要记住对单个查询字符串参数名称和/或值进行编码,而不是对整个URL进行编码,当然不是查询字符串参数分隔符字符,也不是参数名称-值分隔符字符。&=

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

如果您仍然不使用 Java 10 或更高版本,则用作字符集参数,或者当您仍然不在 Java 7 或更高版本上时,请使用 .StandardCharsets.UTF_8.toString()"UTF-8"


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

另请注意,有三种方法。一个没有作为第二个参数,另一个参数作为第二个参数,这会引发一个检查异常。不带参数的那个已被弃用。切勿使用它,并始终指定参数。javadoc甚至明确建议使用UTF-8编码,这是RFC3986W3C所要求的。encode()CharsetStringCharsetCharset

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

另请参阅:


答案 2

我不会使用.除了被错误地命名(与URL无关),效率低下(它使用a而不是Builder并做一些其他一些缓慢的事情)它也太容易搞砸了。URLEncoderURLEncoderStringBuffer

相反,我会使用URIBuilderSpring的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。随意编辑。