查询字符串参数的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是要走的路。您只需要记住仅对单个查询字符串参数名称和/或值进行编码，而不对整个URL 进行编码，请确保对查询字符串参数分隔符&和参数名称-值分隔符都不进行编码=。

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

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

另请注意，有三种encode()方法。一个不Charset带有第二个自变量，另一个不带有String第二个自变量，这将引发已检查的异常。不带Charset参数的不推荐使用。永远不要使用它，并且总是指定Charset参数。在javadoc中甚至明确建议使用UTF-8编码，通过的授权RFC3986和W3C。

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

也可以看看：

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

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

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

上面的唯一缺点（我很痛苦地发现）是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的字符。这正是浏览器的工作方式。

Guava 15现在添加了一组简单的URL逸出器。

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

与HttpComponents 4.x一起使用 -URLEncodedUtils

对于HttpClient 3.x使用 -EncodingUtil

您可以在代码中使用此方法将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;
}

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

在某些情况下，建议检查网址是否已编码。还要用“％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个测试用例。

在android中，我将使用以下代码：

Uri myUI = Uri.parse ("http://example.com/query").buildUpon().appendQueryParameter("q","random word A3500 bank 24").build();

哪里Uri是android.net.Uri

以我为例，我只需要传递整个url并仅对每个参数的值进行编码。我没有找到执行此操作的通用代码（!!），所以我创建了这个小方法来完成这项工作：

public static String encodeUrl(String url) throws Exception {
    if (url == null || !url.contains("?")) {
        return url;
    }

    List<String> list = new ArrayList<>();
    String rootUrl = url.split("\\?")[0] + "?";
    String paramsUrl = url.replace(rootUrl, "");
    List<String> paramsUrlList = Arrays.asList(paramsUrl.split("&"));
    for (String param : paramsUrlList) {
        if (param.contains("=")) {
            String key = param.split("=")[0];
            String value = param.replace(key + "=", "");
            list.add(key + "=" +  URLEncoder.encode(value, "UTF-8"));
        }
        else {
            list.add(param);
        }
    }

    return rootUrl + StringUtils.join(list, "&");
}

public static String decodeUrl(String url) throws Exception {
    return URLDecoder.decode(url, "UTF-8");
}

它使用org.apache.commons.lang3.StringUtils

1. 使用此方法：URLEncoder.encode（query，StandardCharsets.UTF_8.displayName（））; 或this：URLEncoder.encode（query，“ UTF-8”）;

2. 您可以使用以下代码。

   String encodedUrl1 = UriUtils.encodeQuery(query, "UTF-8");//not change 
   String encodedUrl2 = URLEncoder.encode(query, "UTF-8");//changed
   String encodedUrl3 = URLEncoder.encode(query, StandardCharsets.UTF_8.displayName());//changed
   
   System.out.println("url1 " + encodedUrl1 + "\n" + "url2=" + encodedUrl2 + "\n" + "url3=" + encodedUrl3);