说我有一个URL

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

并且用户输入了一个查询,例如:

随机词£500银行$

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

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

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


当前回答

ApacheHttpComponents库为构建和编码查询参数提供了一个简单的选项。

对于HttpComponents 4.x,使用:

URLEncodedUtils公司

对于HttpClient 3.x,请使用:

编码Util

其他回答

使用此项:URLEncoder.encode(查询,StandardCharsets.UTF_8.displayName());或者:URLEncoder.encode(查询,“UTF-8”);您可以使用以下代码。字符串encodedUrl1=UriUtils.encodeQuery(查询,“UTF-8”);//无变化字符串encodedUrl2=URLEncoder.encode(查询,“UTF-8”);//改变字符串encodedUrl3=URLEncoder.encode(查询,StandardCharsets.UTF_8.displayName());//改变System.out.println(“url1”+encodedUrl1+“\n”+“url2”+“encodedUrl2+”\n“+”url3=“+encoded url3”);

使用Spring的UriComponentsBuilder:

UriComponentsBuilder
        .fromUriString(url)
        .build()
        .encode()
        .toUri()

代码

URL url = new URL("http://example.com/query?q=random word £500 bank $");
URI uri = new URI(url.getProtocol(), url.getUserInfo(), IDN.toASCII(url.getHost()), url.getPort(), url.getPath(), url.getQuery(), url.getRef());
String correctEncodedURL = uri.toASCIIString();
System.out.println(correctEncodedURL);

打印

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

这里发生了什么?

1.将URL拆分为结构部分。对其使用java.net.URL。

2.正确编码每个结构部件!

3.使用IDN.toASCII(putDomainNameHere)对主机名进行Punycode编码!

4.使用java.net.URI.toASCIIString()对NFC编码的Unicode进行百分比编码(最好是NFKC!)。有关详细信息,请参阅:如何正确编码此URL

在某些情况下,建议检查URL是否已编码。还将“+”编码空格替换为“%20”编码空格。

下面是一些同样可以正常工作的示例

{
      "in" : "http://نامه‌ای.com/",
     "out" : "http://xn--mgba3gch31f.com/"
},{
     "in" : "http://www.example.com/‥/foo",
     "out" : "http://www.example.com/%E2%80%A5/foo"
},{
     "in" : "http://search.barnesandnoble.com/booksearch/first book.pdf",
     "out" : "http://search.barnesandnoble.com/booksearch/first%20book.pdf"
}, {
     "in" : "http://example.com/query?q=random word £500 bank $",
     "out" : "http://example.com/query?q=random%20word%20%C2%A3500%20bank%20$"
}

该解决方案通过了Web平台测试提供的大约100个测试用例。

我不会使用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

您需要首先创建一个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以外的字符。浏览器就是这样做的。