Codifica URL Java dei parametri della stringa di query

Di 'che ho un URL

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

e ho inserito una query dall'utente come:

parola casuale £ 500 banca $

Voglio che il risultato sia un URL codificato correttamente:

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

Qual è il modo migliore per raggiungere questo obiettivo? Ho provato a URLEncodercreare oggetti URI / URL, ma nessuno di questi è uscito nel modo giusto.

URLEncoderè la strada da percorrere. Devi solo ricordare di codificare solo il nome e / o il valore del singolo parametro della stringa di query, non l'intero URL, di sicuro non il carattere di separazione dei parametri della stringa di query &né il carattere di separazione nome-valore del parametro =.

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

Si noti che gli spazi nei parametri della query sono rappresentati +, non %20, che è legittimamente valido. Di %20solito deve essere usato per rappresentare gli spazi nell'URI stesso (la parte prima del carattere separatore della stringa di query URI ?), non nella stringa di query (la parte dopo ?).

Si noti inoltre che esistono tre encode()metodi. Uno senza Charsetsecondo argomento e un altro Stringcome secondo argomento che genera un'eccezione controllata. Quello senza Charsetargomento è deprecato. Non usarlo mai e specificare sempre l' Charsetargomento. Il javadoc raccomanda anche esplicitamente di utilizzare la codifica UTF-8, come richiesto dalla RFC3986 e W3C .

Tutti gli altri caratteri non sono sicuri e vengono prima convertiti in uno o più byte utilizzando uno schema di codifica. Quindi ogni byte è rappresentato dalla stringa di 3 caratteri "% xy", dove xy è la rappresentazione esadecimale a due cifre del byte. Lo schema di codifica consigliato da utilizzare è UTF-8 . Tuttavia, per motivi di compatibilità, se non viene specificata una codifica, viene utilizzata la codifica predefinita della piattaforma.

Guarda anche:

• Ciò che ogni sviluppatore Web deve sapere sulla codifica URL

Non vorrei usare URLEncoder. Oltre ad essere erroneamente chiamato ( URLEncodernon ha nulla a che fare con gli URL), inefficiente (usa un StringBufferinvece di Builder e fa un paio di altre cose che sono lente) È anche troppo facile da rovinare.

Invece avrei usato URIBuildero Primavera org.springframework.web.util.UriUtils.encodeQueryo Commons ApacheHttpClient . Il motivo è che devi evitare il nome dei parametri della query (ovvero la risposta di BalusC q) in modo diverso rispetto al valore del parametro.

L'unico aspetto negativo di quanto sopra (che ho scoperto dolorosamente) è che gli URL non sono un sottoinsieme vero di URI .

Codice di esempio:

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

Dal momento che sto solo collegando ad altre risposte, l'ho contrassegnato come wiki della comunità. Sentiti libero di modificare.

Devi prima creare un URI come:

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

Quindi converti quell'Uri in stringa ASCII:

urlStr=uri.toASCIIString();

Ora la tua stringa url è completamente codificata prima abbiamo fatto una semplice codifica url e poi l'abbiamo convertita in stringa ASCII per assicurarci che nessun carattere al di fuori di US-ASCII rimanga nella stringa. Questo è esattamente come fanno i browser.

Guava 15 ha ora aggiunto una serie di semplici escapers URL .

La libreria Apache Http Components offre un'opzione accurata per la creazione e la codifica di parametri di query:

Con HttpComponents 4.x utilizzare - URLEncodedUtils

Per HttpClient 3.x utilizzare - EncodingUtil

Ecco un metodo che puoi usare nel tuo codice per convertire una stringa url e una mappa di parametri in una stringa url codificata valida contenente i parametri della query.

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

stampe

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

Cosa sta succedendo qui?

1. Suddividere l'URL in parti strutturali. Usalo java.net.URL per questo.

2. Codificare correttamente ogni parte strutturale!

3. Utilizzare IDN.toASCII(putDomainNameHere)per Punycode codificare il nome host!

4. Usare java.net.URI.toASCIIString()per codificare in percentuale, Unicode con codifica NFC - (meglio sarebbe NFKC!). Per maggiori informazioni vedi: Come codificare correttamente questo URL

In alcuni casi è consigliabile verificare se l'URL è già codificato . Sostituisci anche gli spazi codificati '+' con spazi codificati '% 20'.

Ecco alcuni esempi che funzioneranno correttamente

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

La soluzione supera circa 100 testcase forniti da Web Plattform Test .

In Android vorrei usare questo codice:

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

Dov'è Uriaandroid.net.Uri

Nel mio caso, dovevo solo passare l'intero URL e codificare solo il valore di ciascun parametro. Non ho trovato un codice comune per farlo (!!), quindi ho creato questo piccolo metodo per fare il lavoro:

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

Utilizza org.apache.commons.lang3.StringUtils

1. Utilizzare questo ： URLEncoder.encode (query, StandardCharsets.UTF_8.displayName ()); o questo: URLEncoder.encode (query, "UTF-8");

2. Puoi usare il codice seguente.

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