การเข้ารหัส URL Java ของพารามิเตอร์สตริงการสืบค้น

บอกว่าฉันมี URL

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

และฉันมีแบบสอบถามที่ป้อนโดยผู้ใช้เช่น:

คำสุ่ม£ 500 ธนาคาร $

ฉันต้องการให้ผลลัพธ์เป็น URL ที่เข้ารหัสอย่างถูกต้อง:

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

อะไรคือวิธีที่ดีที่สุดในการบรรลุเป้าหมายนี้? ฉันลองURLEncoderและสร้างวัตถุ URI / URL แต่ไม่มีสิ่งใดที่ออกมาถูกต้องนัก

URLEncoderเป็นวิธีที่จะไป คุณจะต้องเก็บไว้ในใจที่จะเข้ารหัสเพียงการสอบถามบุคคลชื่อพารามิเตอร์สตริงและ / หรือมูลค่าไม่ URL ทั้งหมดเพื่อตรวจสอบว่าไม่สตริงแบบสอบถามคั่นพารามิเตอร์ตัวละครมิได้พารามิเตอร์ค่าชื่อตัวละครที่คั่น&=

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

โปรดทราบว่าช่องว่างในพารามิเตอร์การสืบค้นจะถูกแทนด้วย+ไม่ใช่%20ซึ่งถูกต้องตามกฎหมาย โดย%20ปกติจะใช้เพื่อแสดงช่องว่างใน URI ตัวเอง (ส่วนก่อนอักขระตัวคั่นสตริง URI- แบบสอบถาม?) ไม่ใช่ในสตริงแบบสอบถาม (ส่วนหลัง?)

โปรดทราบว่ามีสามencode()วิธี หนึ่งรายการที่ไม่มีCharsetอาร์กิวเมนต์ที่สองและอีกStringอาร์กิวเมนต์ที่สองซึ่งเป็นข้อยกเว้นที่เลือก อันที่ไม่มีการCharsetโต้แย้งถูกคัดค้าน ห้ามใช้และระบุCharsetอาร์กิวเมนต์เสมอ Javadocแม้อย่างชัดเจนแนะนำให้ใช้การเข้ารหัส UTF-8 ได้รับคำสั่งจากRFC3986และW3C

อักขระอื่น ๆ ทั้งหมดไม่ปลอดภัยและถูกแปลงเป็นไบต์ตั้งแต่หนึ่งไบต์ขึ้นไปโดยใช้รูปแบบการเข้ารหัสบางส่วน จากนั้นแต่ละไบต์จะถูกแทนด้วยสตริงอักขระ 3 ตัว "% xy" โดยที่ xy คือการแสดงเลขฐานสิบหกสองหลักของไบต์ แนะนำโครงการการเข้ารหัสเพื่อใช้เป็น UTF-8 อย่างไรก็ตามสำหรับเหตุผลด้านความเข้ากันได้หากไม่ได้ระบุการเข้ารหัสดังนั้นจะใช้การเข้ารหัสเริ่มต้นของแพลตฟอร์ม

ดูสิ่งนี้ด้วย:

• สิ่งที่นักพัฒนาเว็บทุกคนต้องรู้เกี่ยวกับการเข้ารหัส URL

URLEncoderฉันจะไม่ใช้ นอกเหนือจากการตั้งชื่ออย่างไม่ถูกต้อง ( URLEncoderไม่มีส่วนเกี่ยวข้องกับ URL) ประสิทธิภาพ (ใช้ตัวสร้างStringBufferแทนและทำสิ่งอื่น ๆ สองสามอย่างที่ช้า) นอกจากนี้ยังง่ายเกินไปที่จะทำให้เสีย

แต่ผมจะใช้URIBuilderหรือฤดูใบไม้ผลิorg.springframework.web.util.UriUtils.encodeQueryHttpClientหรือคอมมอนส์อาปาเช่ เหตุผลที่คุณต้องหลีกเลี่ยงชื่อพารามิเตอร์การสืบค้น (เช่นคำตอบของ BalusC q) แตกต่างจากค่าพารามิเตอร์

เพียงข้อเสียในการข้างต้น (ที่ผมพบว่าการเจ็บปวด) คือ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 เหลืออยู่ในสตริง นี่เป็นวิธีที่เบราว์เซอร์ทำ

ฝรั่ง 15 ได้เพิ่มในขณะนี้ชุดของ escapers

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()การเข้ารหัสเปอร์เซ็นต์เข้ารหัส Unicode Unicode - (ดีกว่าน่าจะเป็น 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$"
}

วิธีการแก้ปัญหาผ่านไปประมาณ 100 ของ testcases ที่ได้รับจากการทดสอบเว็บ Plattform

ใน 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 (แบบสอบถาม, StandardCharsets.UTF_8.displayName ()); หรือสิ่งนี้: URLEncoder.encode (แบบสอบถาม, "UTF-8");

2. คุณสามารถใช้รหัส 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);