Pengkodean URL Java untuk parameter string kueri

Katakanlah saya punya URL

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

dan saya memiliki kueri yang dimasukkan oleh pengguna seperti:

kata acak £ 500 bank $

Saya ingin hasilnya menjadi URL yang disandikan dengan benar:

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

Apa cara terbaik untuk mencapai ini? Saya mencoba URLEncoderdan membuat objek URI / URL tetapi tidak satupun yang benar.

URLEncoderadalah cara untuk pergi. Anda hanya perlu mengingat untuk menyandikan hanya nama dan / atau nilai parameter string kueri individual, bukan keseluruhan URL, yang pasti bukan karakter pemisah parameter string kueri &atau karakter pemisah nilai-nilai parameter =.

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

Perhatikan bahwa spasi dalam parameter kueri diwakili oleh +, bukan %20, yang sah secara sah. The %20biasanya digunakan untuk mewakili ruang di URI sendiri (bagian sebelum URI-string kueri karakter pemisah ?), tidak dalam query string (bagian setelah ?).

Perhatikan juga bahwa ada tiga encode()metode. Satu tanpa Charsetsebagai argumen kedua dan lainnya dengan Stringsebagai argumen kedua yang melempar pengecualian diperiksa. Yang tanpa Charsetargumen sudah usang. Jangan pernah menggunakannya dan selalu tentukan Charsetargumennya. The javadoc bahkan secara eksplisit menganjurkan untuk menggunakan UTF-8 encoding, sebagaimana diamanatkan oleh RFC3986 dan W3C .

Semua karakter lain tidak aman dan pertama-tama dikonversi menjadi satu atau lebih byte menggunakan beberapa skema penyandian. Kemudian setiap byte diwakili oleh string 3-karakter "% xy", di mana xy adalah representasi heksadesimal dua digit dari byte. Skema pengkodean yang disarankan untuk digunakan adalah UTF-8 . Namun, untuk alasan kompatibilitas, jika penyandian tidak ditentukan, maka penyandian standar platform digunakan.

Lihat juga:

• Apa yang harus diketahui setiap pengembang web tentang penyandian URL

Saya tidak akan menggunakan URLEncoder. Selain salah nama ( URLEncodertidak ada hubungannya dengan URL), tidak efisien (ia menggunakan StringBufferBuilder dan melakukan beberapa hal lain yang lambat) Ini juga terlalu mudah untuk mengacaukannya.

Sebaliknya saya akan menggunakan URIBuilderatau Spring's org.springframework.web.util.UriUtils.encodeQueryatau Commons ApacheHttpClient . Alasannya adalah Anda harus melarikan diri nama parameter kueri (yaitu jawaban BalusC q) berbeda dari nilai parameter.

Satu-satunya downside ke atas (yang saya temukan dengan menyakitkan) adalah URL bukan subset sebenarnya dari URI .

Kode sampel:

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

Karena saya hanya menautkan ke jawaban lain, saya menandai ini sebagai wiki komunitas. Jangan ragu untuk mengedit.

Anda harus terlebih dahulu membuat URI seperti:

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

Kemudian konversikan Uri ke string ASCII:

urlStr=uri.toASCIIString();

Sekarang string url Anda benar-benar dikodekan terlebih dahulu kami melakukan pengkodean url sederhana dan kemudian kami mengubahnya menjadi ASCII String untuk memastikan tidak ada karakter di luar US-ASCII yang tersisa dalam string. Inilah yang dilakukan browser.

Guava 15 sekarang telah menambahkan satu set escapers URL langsung .

Pustaka Komponen Apache Http menyediakan opsi yang rapi untuk membuat dan menyandikan param query -

Dengan penggunaan HttpComponents 4.x - URLEncodedUtils

Untuk penggunaan HttpClient 3.x - EncodingUtil

Berikut adalah metode yang dapat Anda gunakan dalam kode Anda untuk mengonversi string url dan memetakan parameter ke string url yang disandikan yang berisi parameter kueri.

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

Cetakan

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

Apa yang terjadi disini?

1. Pisahkan URL menjadi bagian-bagian struktural. Gunakan java.net.URL untuk itu.

2. Encode setiap bagian struktural dengan benar!

3. Gunakan IDN.toASCII(putDomainNameHere)untuk Punycode menyandikan nama host!

4. Gunakan java.net.URI.toASCIIString()untuk persen-encode, NFC dikodekan unicode - (lebih baik NFKC!). Untuk info lebih lanjut, lihat: Cara menyandikan URL ini dengan benar

Dalam beberapa kasus, disarankan untuk memeriksa apakah url sudah dikodekan . Juga ganti ruang yang disandikan '+' dengan ruang yang disandikan '% 20'.

Berikut adalah beberapa contoh yang juga akan berfungsi dengan baik

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

Solusi melewati sekitar 100 dari testcases yang disediakan oleh Web Plattform Tests .

Di android saya akan menggunakan kode ini:

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

Dimana Uriaandroid.net.Uri

Dalam kasus saya, saya hanya perlu melewatkan seluruh url dan mengkodekan hanya nilai dari setiap parameter. Saya tidak menemukan kode umum untuk melakukannya (!!) jadi saya membuat metode kecil ini untuk melakukan pekerjaan:

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

Ini menggunakan org.apache.commons.lang3.StringUtils

1. Gunakan ini ： URLEncoder.encode (permintaan, StandardCharsets.UTF_8.displayName ()); atau ini: URLEncoder.encode (permintaan, "UTF-8");

2. Anda dapat menggunakan kode follwing.

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