Sorgu dizesi parametrelerinin Java URL kodlaması

Bir URL'm olduğunu söyle

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

ve kullanıcı tarafından girilen bir sorgu var gibi:

rastgele kelime £ 500 banka $

Sonucun doğru kodlanmış bir URL olmasını istiyorum:

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

Bunu başarmanın en iyi yolu nedir? URLEncoderURI / URL nesneleri oluşturmayı denedim ama hiçbiri doğru çıkmadı.

URLEncodergitmek için bir yoldur. Sorgu dizesi parametre ayırıcı karakterini veya parametre adı-değer ayırıcı karakterini değil, yalnızca URL'yi değil, yalnızca tek tek sorgu dizesi parametre adını ve / veya değerini kodlamayı aklınızda bulundurmanız gerekir .&=

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

Sorgu parametrelerindeki boşlukların , meşru olarak geçerli olan ile temsil +edilmediğini unutmayın %20. %20Genellikle URI kendisi (URI sorgu dizesi ayırıcı karakteri önceki kısım boşluk temsil etmek kullanılacak olan ?değil, sorgu dizesindeki) (kısmen sonra ?).

Ayrıca üç encode()yöntem olduğunu unutmayın . Biri Charsetikinci bağımsız değişken ve diğeri Stringikinci bağımsız değişken olarak kontrol edilen bir istisna atar. Olmadan bir Charsetargüman kullanımdan kaldırıldı. Asla kullanmayın ve her zaman Charsetargümanı belirtin . Javadoc emrince bile açıkça, UTF-8 kodlaması kullanmak önerir RFC3986 ve W3C .

Diğer tüm karakterler güvensizdir ve önce bazı kodlama şeması kullanılarak bir veya daha fazla bayta dönüştürülür. Daha sonra her bayt, 3 karakterlik "% xy" dizesi ile temsil edilir; burada xy, baytın iki basamaklı onaltılı gösterimidir. Kullanılması önerilen kodlama şeması UTF-8'dir . Bununla birlikte, uyumluluk nedeniyle, bir kodlama belirtilmezse, platformun varsayılan kodlaması kullanılır.

Ayrıca bakınız:

• Her web geliştiricisinin URL kodlaması hakkında bilmesi gerekenler

Ben kullanmazdım URLEncoder. Yanlış adlandırılmasının yanı sıra ( URLEncoderURL'lerle hiçbir ilgisi yoktur), verimsiz ( StringBufferOluşturucu yerine kullanılır ve yavaş olan birkaç şey daha yapar) Vidalamak da çok kolay.

Bunun yerine URIBuilderveya Spring's org.springframework.web.util.UriUtils.encodeQueryveya Commons Apache kullanırdımHttpClient . Bunun nedeni, sorgu parametrelerinin adından (yani BalusC'nin yanıtı q) parametre değerinden farklı olarak kaçmak zorunda olmanızdır .

Yukarıdaki (sadece acıyla öğrendim) olumsuz sadece URL'leri URI gerçek bir alt kümesi değildir .

Basit kod:

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

Sadece diğer cevaplara bağladığım için bunu bir topluluk wiki'si olarak işaretledim. Düzenlemek için çekinmeyin.

Önce aşağıdaki gibi bir URI oluşturmanız gerekir:

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

Sonra bu Uri'yi ASCII dizesine dönüştürün:

urlStr=uri.toASCIIString();

Şimdi url dizeniz tamamen kodlanmış, önce basit url kodlaması yaptık ve sonra US-ASCII dışında hiçbir karakterin dizede kalmadığından emin olmak için ASCII String'e dönüştürdük. Tarayıcılar tam da böyle yapar.

Guava 15 şimdi bir dizi basit URL escaper'ı ekledi .

Apache Http Components kütüphanesi, sorgu parametrelerini oluşturmak ve kodlamak için temiz bir seçenek sunar -

HttpComponents ile 4.x kullanımı - URLEncodedUtils

HttpClient 3.x kullanımı için - EncodingUtil

Kodunuzda bir URL dizesini ve parametre haritasını sorgu parametrelerini içeren geçerli bir kodlanmış URL dizesine dönüştürmek için kullanabileceğiniz bir yöntem.

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

Baskılar

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

Burada ne oluyor?

1. URL'yi yapısal parçalara ayırın. Bunun için kullanın java.net.URL .

2. Her yapısal parçayı uygun şekilde kodlayın!

3. Ana makine adını kodlamak IDN.toASCII(putDomainNameHere)için Punycode kullanın !

4.java.net.URI.toASCIIString() Yüzde kodlamak için kullanın , NFC kodlu unicode - (daha iyi NFKC olurdu!). Daha fazla bilgi için bkz. Bu URL nasıl doğru şekilde kodlanır?

Bazı durumlarda, URL'nin zaten kodlanmış olup olmadığını kontrol etmeniz önerilir . Ayrıca '+' kodlu boşlukları '% 20' kodlu boşluklarla değiştirin.

Ayrıca düzgün çalışacak bazı örnekler

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

Çözüm, Web Plattform Tests tarafından sağlanan yaklaşık 100 test senaryosundan geçmektedir .

Android'de bu kodu kullanırsınız:

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

Nerede Uribirandroid.net.Uri

Benim durumumda sadece tüm url geçmek ve sadece her parametrenin değerini kodlamak gerekiyordu. Bunu yapmak için ortak bir kod bulamadık (!!) bu yüzden iş yapmak için bu küçük yöntemi yarattı:

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 kullanır

1. Bu ： URLEncoder.encode (sorgu, StandardCharsets.UTF_8.displayName ()); ya da bu: URLEncoder.encode (sorgu, "UTF-8");

2. Aşağıdaki kodları kullanabilirsiniz.

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