Java-URL-Codierung von Abfragezeichenfolgenparametern

Angenommen, ich habe eine URL

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

und ich habe eine vom Benutzer eingegebene Abfrage wie:

Zufallswort £500 Bank $

Ich möchte, dass das Ergebnis eine richtig codierte URL ist:

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

Was ist der beste Weg, dies zu erreichen? Ich habe es versucht URLEncoder und das Erstellen von URI/URL-Objekten, aber keines davon kommt ganz richtig heraus.

URLEncoder ist der Weg zu gehen. Sie müssen nur daran denken, zu codieren nur der Name und/oder Wert des einzelnen Parameters der Abfragezeichenfolge, nicht die gesamte URL, schon gar nicht das Trennzeichen des Parameters der Abfragezeichenfolge & noch das Parametername-Wert-Trennzeichen =.

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

Wenn Sie immer noch nicht auf Java 10 oder neuer sind, verwenden Sie StandardCharsets.UTF_8.toString() als charset-Argument, oder wenn Sie noch nicht auf Java 7 oder neuer sind, dann verwenden Sie "UTF-8".

Beachten Sie, dass Leerzeichen in Abfrageparametern durch dargestellt werden +nicht %20, was rechtsgültig ist. Die %20 wird normalerweise verwendet, um Leerzeichen im URI selbst darzustellen (der Teil vor dem Trennzeichen der URI-Abfragezeichenfolge ?), nicht in der Abfragezeichenfolge (der Teil nach ?).

Beachten Sie auch, dass es drei gibt encode() Methoden. Einer ohne Charset als zweites Argument und ein weiteres mit String als zweites Argument, das eine überprüfte Ausnahme auslöst. Der ohne Charset Argument ist veraltet. Verwenden Sie es niemals und geben Sie immer die an Charset Streit. Die javadoc empfiehlt sogar ausdrücklich, die UTF-8-Codierung zu verwenden, wie von vorgeschrieben RFC3986 und W3C.

Alle anderen Zeichen sind unsicher und werden zunächst mithilfe eines Codierungsschemas in ein oder mehrere Bytes umgewandelt. 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 URL-Codierung wissen muss

würde ich nicht verwenden URLEncoder. Abgesehen von der falschen Benennung (URLEncoder hat nichts mit URLs zu tun), ineffizient (es verwendet a StringBuffer anstelle von Builder und macht ein paar andere Dinge, die langsam sind) Es ist auch viel zu einfach, es zu vermasseln.

Stattdessen würde ich verwenden URIBuilder oder Frühlings org.springframework.web.util.UriUtils.encodeQuery oder Commons-Apache HttpClient. Der Grund dafür ist, dass Sie den Namen des Abfrageparameters maskieren müssen (dh die Antwort von BalusC q) anders als der Parameterwert.

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

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 verlinke, 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 eine ASCII-Zeichenfolge:

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 ist jetzt hinzugekommen eine Reihe einfacher URL-Escaper.

Die Apache Http-Komponentenbibliothek bietet eine praktische Option zum Erstellen und Codieren von Abfrageparametern –

Verwenden Sie mit HttpComponents 4.x –
URLEncodedUtils

Für die Verwendung von 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);

Drucke

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

Was passiert hier?

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

2. Codieren Sie jedes Strukturteil richtig!

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

4. Verwenden java.net.URI.toASCIIString() Prozentkodierung, NFC-kodierter Unicode – (besser wäre NFKC!). Weitere Informationen finden Sie unter: So codieren Sie diese URL richtig

In einigen Fällen ist es ratsam zu prüfen, ob die URL bereits verschlüsselt ist. Ersetzen Sie außerdem codierte „+“-Leerzeichen durch codierte „%20“-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 bereitgestellten Testfälle Web-Plattform-Tests.

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