说我有一个网址
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);
当您仍然不在 Java 10 或更高版本上时,请使用StandardCharsets.UTF_8.toString()
charset 参数,或者当您仍然不在 Java 7 或更高版本上时,请使用"UTF-8"
.
请注意,查询参数中的空格由+
, not表示%20
,这是合法有效的。%20
通常用于表示 URI 本身中的空格(URI 查询字符串分隔符之前的部分)?
,而不是查询字符串中的空格(之后的部分?
)。
另请注意,共有三种encode()
方法。一个没有Charset
作为第二个参数,另一个String
作为第二个参数引发检查异常。不推荐使用没有Charset
参数的。永远不要使用它并始终指定Charset
参数。javadoc甚至明确建议使用RFC3986和W3C规定的 UTF-8编码。
所有其他字符都是不安全的,并且首先使用某种编码方案将其转换为一个或多个字节。然后每个字节由 3 个字符的字符串“%xy”表示,其中 xy 是字节的两位十六进制表示。推荐使用的编码方案是 UTF-8。但是,出于兼容性原因,如果未指定编码,则使用平台的默认编码。
我不会使用URLEncoder
. 除了被错误地命名(URLEncoder
与 URL 无关),效率低下(它使用 aStringBuffer
而不是 Builder 并且做一些其他很慢的事情)它也太容易搞砸了。
相反,我会使用SpringURIBuilder
或Commons Apache。原因是您必须以不同于参数值的方式转义查询参数名称(即 BalusC 的答案)。org.springframework.web.util.UriUtils.encodeQuery
HttpClient
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
由于我只是链接到其他答案,因此我将其标记为社区 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 组件库为构建和编码查询参数提供了一个简洁的选项 -
使用 HttpComponents 4.x 使用 - URLEncodedUtils
对于 HttpClient 3.x 使用 - EncodingUtil
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.使用Punycode对主机名进行编码IDN.toASCII(putDomainNameHere)
!
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 Platform Tests提供的大约 100 个测试用例。
您可以在代码中使用以下方法将 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;
}
使用 Spring 的 UriComponentsBuilder:
UriComponentsBuilder
.fromUriString(url)
.build()
.encode()
.toUri()
在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
您可以使用以下代码。
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);