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

Question

说我有一个URL

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

我有一个用户输入的查询,例如:

随机字500英镑银行$

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

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

实现这一目标的最佳方法是什么？我尝试URLEncoder并创建了URI/URL对象,但它们都没有完全正确.

Answer 1

URLEncoder应该是要走的路.您只需要记住只编码单个查询字符串参数名称和/或值,而不是整个URL,肯定不是查询字符串参数分隔符,&也不是参数名称 - 值分隔符=.

String q = "random word £500 bank $";
String url = "http://example.com/query?q=" + URLEncoder.encode(q, "UTF-8");

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

另请注意,有两种encode()方法.一个没有charset论证,另一个没有.没有charset参数的那个被弃用了.永远不要使用它,并始终指定charset参数.在javadoc中甚至明确建议使用UTF-8编码,通过的授权RFC3986和W3C.

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

也可以看看:

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

Answer 2

我不会用URLEncoder.除了错误的命名(URLEncoder与URL无关),效率低下(它使用的是StringBuffer代替Builder而且做了一些其他慢的事情)它也太容易搞砸了.

相反,我会使用URIBuilder或Spring org.springframework.web.util.UriUtils.encodeQuery或Commons ApacheHttpClient.原因是您必须以q不同于参数值的方式转义查询参数名称(即BalusC的答案).

上面唯一的缺点(我痛苦地发现)是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

由于我只是链接到其他答案,我将其标记为社区维基.随意编辑.

Answer 3

您需要首先创建一个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之外的字符不会保留在字符串中.这正是浏览器的作用.

Answer 4

Guava 15现在添加了一组简单的URL转发器.

Answer 5

使用Spring的UriComponentsBuilder：

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

Answer 6

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 Plattform Tests提供的大约 100 个测试用例。

Answer 7

Apache Http Components库为构建和编码查询参数提供了一个简洁的选项 -

使用HttpComponents 4.x使用 - URLEncodedUtils

对于HttpClient 3.x使用 - EncodingUtil

Answer 8

这是您可以在代码中使用的方法,将url字符串和参数映射转换为包含查询参数的有效编码url字符串.

String addQueryStringToUrlString(String url, final Map<Object, Object> parameters) throws UnsupportedEncodingException {
    if (parameters == null) {
        return url;
    }

    for (Map.Entry<Object, Object> parameter : parameters.entrySet()) {

        final String encodedKey = URLEncoder.encode(parameter.getKey().toString(), "UTF-8");
        final String encodedValue = URLEncoder.encode(parameter.getValue().toString(), "UTF-8");

        if (!url.contains("?")) {
            url += "?" + encodedKey + "=" + encodedValue;
        } else {
            url += "&" + encodedKey + "=" + encodedValue;
        }
    }

    return url;
}