说我有一个URL

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

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

随机词£500银行$

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

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

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


当前回答

下面是一个方法,您可以在代码中使用该方法将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;
}

其他回答

使用此项: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”);

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

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

如果您还没有使用Java 10或更高版本,请使用StandardCharsets.UTF_8.toString()作为字符集参数,或者如果您还未使用Java 7或更高的版本,则使用“UTF-8”。


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

还要注意,有三种encode()方法。一个没有Charset作为第二个参数,另一个使用String作为第二参数,这会引发选中的异常。不推荐使用不带Charset参数的。永远不要使用它,并始终指定Charset参数。javadoc甚至明确建议使用RFC3986和W3C规定的UTF-8编码。

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

另请参见:

每个web开发人员都必须了解URL编码

在我的例子中,我只需要传递整个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");
}

它使用Apache Commons的org.Apache.mons.lang3.StringUtils。

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

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

对于HttpComponents 4.x,使用:

URLEncodedUtils公司

对于HttpClient 3.x,请使用:

编码Util