Java-URL-Codierung von Abfragezeichenfolgenparametern

Angenommen, ich habe eine URL

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

und ich habe eine vom Benutzer eingegebene Abfrage wie:

zufälliges Wort £ 500 Bank $

Ich möchte, dass das Ergebnis eine ordnungsgemäß codierte URL ist:

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

Was ist der beste Weg, um dies zu erreichen? Ich habe versucht URLEncoder, URI / URL-Objekte zu erstellen, aber keines davon ist ganz richtig.

URLEncoderist der Weg zu gehen. Sie müssen nur berücksichtigen, dass Sie nur den Namen und / oder den Wert der einzelnen Abfragezeichenfolgenparameter codieren , nicht die gesamte URL, ganz sicher nicht das Trennzeichen für die Abfragezeichenfolgenparameter &oder das Trennzeichen für den Parameternamen-Wert =.

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

Beachten Sie, dass Leerzeichen in Abfrageparametern durch +nicht dargestellt werden %20, was rechtmäßig gültig ist. Das %20wird normalerweise verwendet, um Leerzeichen im URI selbst (dem Teil vor dem Trennzeichen für die URI-Abfragezeichenfolge ?) und nicht in der Abfragezeichenfolge (dem Teil danach ?) darzustellen .

Beachten Sie auch, dass es drei encode()Methoden gibt. Eines ohne Charsetals zweites Argument und eines mit Stringals zweitem Argument, das eine geprüfte Ausnahme auslöst. Der ohne CharsetArgument ist veraltet. Verwenden Sie es niemals und geben Sie immer das CharsetArgument an. Das Javadoc empfiehlt sogar ausdrücklich die Verwendung der UTF-8-Codierung, wie von RFC3986 und W3C vorgeschrieben .

Alle anderen Zeichen sind unsicher und werden zuerst mithilfe eines Codierungsschemas in ein oder mehrere Bytes konvertiert. Dann wird jedes Byte durch die 3-stellige Zeichenfolge "% xy" dargestellt, wobei xy die zweistellige hexadezimale Darstellung des Bytes ist. Das empfohlene Codierungsschema ist UTF-8 . Wenn jedoch aus Kompatibilitätsgründen keine Codierung angegeben ist, wird die Standardcodierung der Plattform verwendet.

Siehe auch:

• Was jeder Webentwickler über die URL-Codierung wissen muss

Ich würde nicht verwenden URLEncoder. Abgesehen davon, dass es falsch benannt ist ( URLEncoderhat nichts mit URLs zu tun), ineffizient ist (es verwendet ein StringBufferanstelle von Builder und macht ein paar andere Dinge, die langsam sind). Es ist auch viel zu einfach, es zu vermasseln.

Stattdessen würde ich URIBuilderoder Spring's org.springframework.web.util.UriUtils.encodeQueryoder Commons Apache verwendenHttpClient . Der Grund dafür ist, dass Sie den Namen der Abfrageparameter (dh die Antwort von BalusC q) anders als den Parameterwert maskieren müssen .

Der einzige Nachteil des oben Gesagten (den ich schmerzhaft herausgefunden habe) ist, dass URLs keine echte Teilmenge von URIs sind .

Beispielcode:

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

Da ich nur auf andere Antworten verweise, habe ich dies als Community-Wiki markiert. Fühlen Sie sich frei zu bearbeiten.

Sie müssen zuerst einen URI erstellen wie:

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

Konvertieren Sie dann diesen Uri in einen ASCII-String:

urlStr=uri.toASCIIString();

Jetzt ist Ihre URL-Zeichenfolge vollständig codiert. Zuerst haben wir eine einfache URL-Codierung durchgeführt und sie dann in eine ASCII-Zeichenfolge konvertiert, um sicherzustellen, dass keine Zeichen außerhalb von US-ASCII in der Zeichenfolge verbleiben. Genau so machen es Browser.

Guava 15 hat jetzt eine Reihe einfacher URL-Escaper hinzugefügt .

Die Apache Http Components-Bibliothek bietet eine übersichtliche Option zum Erstellen und Codieren von Abfrageparametern.

Verwenden Sie mit HttpComponents 4.x - URLEncodedUtils

Verwenden Sie für HttpClient 3.x - EncodingUtil

Hier ist eine Methode, die Sie in Ihrem Code verwenden können, um eine URL-Zeichenfolge und eine Zuordnung von Parametern in eine gültige codierte URL-Zeichenfolge zu konvertieren, die die Abfrageparameter enthält.

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

Druckt

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

Was passiert hier?

1. Teilen Sie die URL in Strukturteile auf. Verwenden java.net.URL Sie dafür.

2. Codieren Sie jedes Bauteil richtig!

3. Verwenden Sie Punycode, um den Hostnamen IDN.toASCII(putDomainNameHere)zu codieren!

4. Verwenden Sie java.net.URI.toASCIIString(), um NFC-codierten Unicode in Prozent zu codieren - (besser wäre NFKC!). Weitere Informationen finden Sie unter: So codieren Sie diese URL richtig

In einigen Fällen ist es ratsam zu überprüfen, ob die URL bereits verschlüsselt ist . Ersetzen Sie auch '+' codierte Leerzeichen durch '% 20' codierte Leerzeichen.

Hier sind einige Beispiele, die auch richtig funktionieren

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

Die Lösung besteht rund 100 der von Web Plattform Tests bereitgestellten Testfälle .

In Android würde ich diesen Code verwenden:

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

Wo Uriist einandroid.net.Uri

In meinem Fall musste ich nur die gesamte URL übergeben und nur den Wert der einzelnen Parameter codieren. Ich habe keinen gemeinsamen Code dafür gefunden (!!), also habe ich diese kleine Methode erstellt, um den Job zu erledigen:

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

Es verwendet org.apache.commons.lang3.StringUtils

1. Verwenden Sie Folgendes: URLEncoder.encode (Abfrage, StandardCharsets.UTF_8.displayName ()); oder dies: URLEncoder.encode (Abfrage "UTF-8");

2. Sie können den folgenden Code verwenden.

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