クエリ文字列パラメータのJava URLエンコーディング

私がURLを持っていると言います

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

そして、私はユーザーによって入力されたクエリを持っています：

ランダムワード£500バンク$

結果を適切にエンコードされたURLにしたい：

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

これを達成するための最良の方法は何ですか？URLEncoderURI / URLオブジェクトを作成してみましたが、どれも正しく機能しません。

URLEncoder行く方法です。URL全体ではなく、個々のクエリ文字列パラメーターの名前または値、あるいはその両方のみをエンコードすることだけを念頭に置く必要があります。クエリ文字列パラメーターの区切り文字&やパラメーターの名前と値の区切り文字は含めないでください=。

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

クエリパラメータのスペース+は%20、ではなくで表されることに注意してください。%20URI自体（URIクエリ文字列の区切り文字の前の部分にスペース表すために使用される通常?）、ないクエリ文字列（後の部分では?）。

また、3つのencode()方法があることに注意してください。1つCharsetは2番目の引数なしで、もう1つは2番目の引数Stringとしてあり、チェックされた例外をスローします。Charset引数のないものは非推奨です。絶対に使用せず、常にCharset引数を指定してください。Javadocはさえ明確で義務付けとして、UTF-8エンコーディングを使用することをお勧めしますRFC3986およびW3C。

他のすべての文字は安全ではなく、いくつかのエンコードスキームを使用して最初に1バイト以上に変換されます。次に、各バイトは3文字の文字列「％xy」で表されます。ここで、xyはバイトの2桁の16進数表現です。使用が推奨されるコード化スキームはUTF-8です。ただし、互換性の理由から、エンコーディングが指定されていない場合は、プラットフォームのデフォルトのエンコーディングが使用されます。

以下も参照してください。

• すべてのWeb開発者がURLエンコーディングについて知っておくべきこと

私は使用しませんURLEncoder。誤って名前が付けられる（URLEncoderURLとは関係ありません）以外にも、非効率的です（StringBufferビルダーの代わりに使用し、他にいくつかの遅い処理を行います）。

代わりにURIBuilder、Spring org.springframework.web.util.UriUtils.encodeQueryまたはCommons Apacheを使用しHttpClientます。その理由qは、パラメーター値とは異なる方法でクエリパラメーター名（つまりBalusCの回答）をエスケープする必要があるためです。

上記の唯一の欠点（私が痛々しいことに気付いた）は、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

他の回答にリンクしているだけなので、これをコミュニティウィキとしてマークしました。自由に編集してください。

まず、次のような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 Componentsライブラリは、クエリパラメータを構築およびエンコードするための優れたオプションを提供します-

- HttpComponents 4.xの使用により URLEncodedUtils

HttpClientを3.xの使用のために- EncodingUtil

以下は、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;
}

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.ホスト名IDN.toASCII(putDomainNameHere)をPunycodeエンコードするために使用します！

4.java.net.URI.toASCIIString()パーセントエンコード、NFCエンコードユニコードに使用します（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プラットフォームテストによって提供される約100のテストケースに合格します。

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を使用します

1. これを使用してください：URLEncoder.encode（query、StandardCharsets.UTF_8.displayName（））; またはthis：URLEncoder.encode（query、 "UTF-8"）;

2. 次のコードを使用できます。

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