Encodage d'URL Java des paramètres de chaîne de requête

Question

Dire que j'ai une URL

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

et j'ai une requête entrée par l'utilisateur telle que :

mot aléatoire £500 banque $

Je veux que le résultat soit une URL correctement encodée :

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

Quelle est la meilleure façon d'atteindre cela ? J'ai essayé URLEncoder et la création des objets URI/URL mais aucun d'entre eux ne fonctionne tout à fait correctement.

Answer 1

URLEncoder est la voie à suivre. Vous devez simplement vous rappeler d'encoder seulement le nom du paramètre de requête individuel et/ou sa valeur, pas l'URL entière, certainement pas le caractère séparateur des paramètres de requête & ni le caractère séparateur du nom de paramètre-valeur =.

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

Si vous n'êtes toujours pas sur Java 10 ou plus récent, alors utilisez StandardCharsets.UTF_8.toString() comme argument de jeu de caractères, ou si vous n'êtes toujours pas sur Java 7 ou plus récent, alors utilisez "UTF-8".

---

Remarquez que les espaces dans les paramètres de requête sont représentés par +, pas par %20, ce qui est parfaitement valide. Le %20 est généralement utilisé pour représenter les espaces dans l'URI lui-même (la partie avant le caractère séparateur de chaîne de requête d'URI ?), pas dans la chaîne de requête (la partie après ?).

Remarquez également qu'il y a trois méthodes encode(). Une sans Charset en tant que deuxième argument et une autre avec String comme deuxième argument qui lance une exception vérifiée. Celle sans argument Charset est obsolète. Ne l'utilisez jamais et spécifiez toujours l'argument Charset. Même la javadoc recommande explicitement d'utiliser l'encodage UTF-8, tel que prescrit par RFC3986 et W3C.

Tous les autres caractères sont considérés comme non sécurisés et sont d'abord convertis en un ou plusieurs octets en utilisant un certain schéma d'encodage. Ensuite, chaque octet est représenté par la chaîne de 3 caractères "%xy", où xy est la représentation hexadécimale à deux chiffres de l'octet. Le schéma d'encodage recommandé à utiliser est UTF-8. Cependant, pour des raisons de compatibilité, si un codage n'est pas spécifié, alors le codage par défaut de la plate-forme est utilisé.

Voir aussi :

• Ce que chaque développeur web doit savoir sur l'encodage d'URL

Answer 2

Je n'utiliserais pas URLEncoder. En plus d'être mal nommé (URLEncoder n'a rien à voir avec les URL), inefficace (il utilise un StringBuffer au lieu de Builder et fait quelques autres choses qui sont lentes) Il est aussi trop facile de faire des erreurs.

À la place, j'utiliserais URIBuilder ou Spring's org.springframework.web.util.UriUtils.encodeQuery ou Commons Apache HttpClient. La raison en est que vous devez échapper les noms des paramètres de la requête (c.-à-d. la réponse de BalusC q) différemment de la valeur du paramètre.

Le seul inconvénient de ce qui précède (que j'ai découvert douloureusement) est que les URL ne sont pas un vrai sous-ensemble des URI.

Code d'exemple:

import org.apache.http.client.utils.URIBuilder;

URIBuilder ub = new URIBuilder("http://example.com/query");
ub.addParameter("q", "mot aléatoire £500 banque \$");
String url = ub.toString();

// Résultat: http://example.com/query?q=mot+al%C3%A9atoire+%C2%A3500+banque+%24

Answer 3

Vous devez d'abord créer une URI comme suit:

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

Ensuite, convertissez cette URI en une chaîne ASCII:

urlStr = uri.toASCIIString();

Maintenant, votre chaîne d'URL est complètement encodée. Tout d'abord, nous avons effectué un simple encodage d'URL puis nous l'avons converti en une chaîne ASCII pour nous assurer qu'aucun caractère en dehors de l'US-ASCII ne restait dans la chaîne. C'est exactement ce que font les navigateurs.

Answer 4

Guava 15 a maintenant ajouté un ensemble d'échappements d'URL simples.

Answer 5

Il s'agit d'une solution supplémentaire et non particulière (qui a déjà été répondue). Si quelqu'un souhaite remplacer des symboles spécifiques ou des espaces blancs, il peut simplement utiliser ce qui suit :-

String strUrl = getResources().getString(R.string.ipaddress)
            + "/index.php?action=passengerRegistration&name=" + strname
            + "&gender=" + strgender + "&location=" + strLocation
            + "&phoneNo=" + strphoneno + "&password=" + strPwd + "&email="
            + stremail;

strRegUrl = strRegUrl.replaceAll(" ", "%20");

comme votre nom contient un espace blanc "hello name"

alors ce sera "hello%20name" ce qui ne posera pas de problème !

de même, nous pouvons cibler des symboles spécifiques aussi ! :)