Question

说我有一个网址

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

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

随机字500英镑银行$

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

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甚至明确建议按照RFC3986和W3C的要求使用UTF-8编码。

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

另见：

What every web developer must know about URL encoding

Answer 2

我不会使用URLEncoder。除了错误命名（URLEncoder与URL无关），效率低下（它使用StringBuffer代替Builder而且做了其他一些很慢的事情）它也很容易搞砸它起来。

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

上述唯一的缺点（我痛苦地发现）是URL's are not a true subset of URI's。

示例代码：

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现已添加a set of straightforward URL escapers。

Answer 5

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

使用HttpComponents 4.x使用 - URLEncodedUtils

对于HttpClient 3.x使用 - EncodingUtil

Answer 6

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

Answer 7

使用以下标准Java解决方案（通过Web Plattform Tests提供的大约100个测试用例）：

0。 Test if URL is already encoded。将'+'编码空格替换为'％20'编码空格。

1。将网址拆分为结构部分。使用java.net.URL即可。

2。正确编码每个结构部件！

3。使用IDN.toASCII(putDomainNameHere)对Punycode编码主机名！

4. 使用java.net.URI.toASCIIString()百分比编码，NFC编码的unicode - （更好的是NFKC！）。有关详细信息，请参阅：How to encode properly this 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$

以下是一些也可以正常使用的示例

{
      "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$"
}

Answer 8

就我而言，我只需要传递整个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

Answer 9

我为您的问题找到了一个简单的解决方案。我也想使用编码的URL，但没有任何帮助。

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

使用String示例=“随机单词£500 bank $”；你可以在下面的代码。

String example = "random word £500 bank $";
String URL = "http://example.com/query?q=" + example.replaceAll(" ","%20");

Answer 10

在android中我会使用这段代码：

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

Uri是android.net.Uri

的位置

Answer 11

使用Spring的UriComponentsBuilder：

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

Answer 12

使用此：URLEncoder.encode（query，StandardCharsets.UTF_8.displayName（））; 或者：URLEncoder.encode（查询，＆＃34; UTF-8＆＃34;）;

您可以使用以下代码。

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);

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

12 个答案:

另见：