วิธีใช้ java.net.URLConnection เพื่อเริ่มและจัดการคำขอ HTTP


1948

ใช้java.net.URLConnectionถูกถามเกี่ยวกับที่นี่มักจะสวยและออราเคิลกวดวิชาเป็นเกินไปรัดกุมเกี่ยวกับมัน

บทช่วยสอนนั้นโดยทั่วไปจะแสดงวิธีการเริ่มคำขอ GET และอ่านการตอบสนอง มันไม่ได้อธิบายว่าจะใช้ที่ใดในที่อื่น ๆ เพื่อดำเนินการตามคำขอ POST ตั้งค่าส่วนหัวคำขออ่านส่วนหัวตอบสนองจัดการกับคุกกี้ส่งแบบฟอร์ม HTML อัปโหลดไฟล์ ฯลฯ

ดังนั้นฉันjava.net.URLConnectionจะใช้เพื่อดำเนินการและจัดการคำขอ HTTP "ขั้นสูง" ได้อย่างไร

คำตอบ:


2711

ก่อนอื่นขอสงวนสิทธิ์ก่อน: ตัวอย่างรหัสที่โพสต์เป็นตัวอย่างพื้นฐานทั้งหมด คุณจะต้องจัดการกับจิ๊บจ๊อยIOExceptionและRuntimeExceptionเหมือนNullPointerException, ArrayIndexOutOfBoundsExceptionและภริยาตัวเอง


เตรียมความพร้อม

ก่อนอื่นเราต้องรู้อย่างน้อยที่สุด URL และชุดอักขระ พารามิเตอร์เป็นทางเลือกและขึ้นอยู่กับข้อกำหนดของฟังก์ชัน

String url = "http://example.com";
String charset = "UTF-8";  // Or in Java 7 and later, use the constant: java.nio.charset.StandardCharsets.UTF_8.name()
String param1 = "value1";
String param2 = "value2";
// ...

String query = String.format("param1=%s&param2=%s", 
     URLEncoder.encode(param1, charset), 
     URLEncoder.encode(param2, charset));

พารามิเตอร์แบบสอบถามจะต้องอยู่ในรูปแบบและได้รับการตัดแบ่งโดยname=value &คุณจะได้ตามปกตินอกจากนี้ยังเข้ารหัส URLพารามิเตอร์การค้นหาที่มี charset URLEncoder#encode()ระบุโดยใช้

String#format()เป็นเพียงเพื่อความสะดวกสบาย ฉันชอบเมื่อฉันต้องการตัวดำเนินการเรียงต่อกันสตริง+มากกว่าสองครั้ง


การยิงHTTP GETคำขอด้วยพารามิเตอร์การสืบค้น (ทางเลือก)

มันเป็นงานที่ไม่สำคัญ มันเป็นวิธีการร้องขอเริ่มต้น

URLConnection connection = new URL(url + "?" + query).openConnection();
connection.setRequestProperty("Accept-Charset", charset);
InputStream response = connection.getInputStream();
// ...

สตริงแบบสอบถามใด ๆ ควรจะตัดแบ่งไปยัง URL ?โดยใช้ Accept-Charsetส่วนหัวอาจแบะท่าเซิร์ฟเวอร์สิ่งที่เข้ารหัสพารามิเตอร์ที่อยู่ใน. ถ้าคุณไม่ส่งสตริงแบบสอบถามใด ๆ แล้วคุณสามารถออกจากAccept-Charsetส่วนหัวออกไป หากคุณไม่ต้องการตั้งค่าส่วนหัวใด ๆ คุณสามารถใช้URL#openStream()วิธีลัดได้

InputStream response = new URL(url).openStream();
// ...

ทั้งสองวิธีถ้าด้านอื่น ๆ เป็นHttpServletแล้วของวิธีการที่จะถูกเรียกและพารามิเตอร์จะสามารถใช้ได้โดยdoGet()HttpServletRequest#getParameter()

สำหรับวัตถุประสงค์ในการทดสอบคุณสามารถพิมพ์เนื้อหาการตอบสนองไปยัง stdout ได้ดังต่อไปนี้:

try (Scanner scanner = new Scanner(response)) {
    String responseBody = scanner.useDelimiter("\\A").next();
    System.out.println(responseBody);
}

การส่งคำร้องขอHTTP POSTด้วยพารามิเตอร์เคียวรี

การตั้งค่าURLConnection#setDoOutput()ไปtrueโดยปริยายกำหนดวิธีการร้องขอไปยังโพสต์ HTTP POST มาตรฐานเป็นแบบฟอร์มบนเว็บที่เป็นประเภทapplication/x-www-form-urlencodedนั้นสตริงการสืบค้นจะถูกเขียนไปยังร่างกายร้องขอ

URLConnection connection = new URL(url).openConnection();
connection.setDoOutput(true); // Triggers POST.
connection.setRequestProperty("Accept-Charset", charset);
connection.setRequestProperty("Content-Type", "application/x-www-form-urlencoded;charset=" + charset);

try (OutputStream output = connection.getOutputStream()) {
    output.write(query.getBytes(charset));
}

InputStream response = connection.getInputStream();
// ...

หมายเหตุ: เมื่อใดก็ตามที่คุณต้องการส่งแบบฟอร์ม HTML โดยทางโปรแกรมอย่าลืมที่จะใส่name=valueคู่ของ<input type="hidden">องค์ประกอบใด ๆลงในสตริงการสืบค้นและแน่นอนว่ายังเป็นname=valueคู่ของ<input type="submit">องค์ประกอบที่คุณต้องการ "กด" โดยทางโปรแกรม (เพราะ ที่มักจะใช้ในฝั่งเซิร์ฟเวอร์เพื่อแยกความแตกต่างถ้ากดปุ่มและถ้าเป็นเช่นนั้นอันไหน)

นอกจากนี้คุณยังสามารถส่งข้อมูลที่ได้รับURLConnectionไปHttpURLConnectionและใช้มันHttpURLConnection#setRequestMethod()แทน แต่ถ้าคุณกำลังพยายามที่จะใช้การเชื่อมต่อสำหรับการส่งออกที่คุณยังคงต้องชุดไปURLConnection#setDoOutput()true

HttpURLConnection httpConnection = (HttpURLConnection) new URL(url).openConnection();
httpConnection.setRequestMethod("POST");
// ...

ทั้งสองวิธีถ้าด้านอื่น ๆ เป็นHttpServletแล้วของวิธีการที่จะถูกเรียกและพารามิเตอร์จะสามารถใช้ได้โดยdoPost()HttpServletRequest#getParameter()


ยิงคำขอ HTTP จริง ๆ

คุณสามารถดำเนินการตามคำขอ HTTP อย่างชัดเจนด้วยURLConnection#connect()แต่คำขอจะถูกเรียกใช้ตามคำขอโดยอัตโนมัติเมื่อคุณต้องการรับข้อมูลใด ๆ เกี่ยวกับการตอบกลับ HTTP เช่นเนื้อความการตอบสนองที่ใช้URLConnection#getInputStream()เป็นต้น ตัวอย่างข้างต้นทำอย่างนั้นดังนั้นการconnect()โทรจึงไม่จำเป็นจริง ๆ


การรวบรวมข้อมูลการตอบกลับ HTTP

  1. สถานะการตอบกลับ HTTP :

    คุณต้องการHttpURLConnectionที่นี่ โยนก่อนถ้าจำเป็น

    int status = httpConnection.getResponseCode();
  2. ส่วนหัวการตอบสนอง HTTP :

    for (Entry<String, List<String>> header : connection.getHeaderFields().entrySet()) {
        System.out.println(header.getKey() + "=" + header.getValue());
    }
  3. การเข้ารหัสการตอบสนอง HTTP :

    เมื่อContent-Typeมีcharsetพารามิเตอร์ตัวเนื้อหาการตอบสนองจะเป็นข้อความตามและเราต้องการประมวลผลเนื้อหาการตอบสนองด้วยการเข้ารหัสอักขระที่ระบุฝั่งเซิร์ฟเวอร์แล้ว

    String contentType = connection.getHeaderField("Content-Type");
    String charset = null;
    
    for (String param : contentType.replace(" ", "").split(";")) {
        if (param.startsWith("charset=")) {
            charset = param.split("=", 2)[1];
            break;
        }
    }
    
    if (charset != null) {
        try (BufferedReader reader = new BufferedReader(new InputStreamReader(response, charset))) {
            for (String line; (line = reader.readLine()) != null;) {
                // ... System.out.println(line) ?
            }
        }
    } else {
        // It's likely binary content, use InputStream/OutputStream.
    }

การบำรุงรักษาเซสชั่น

เซสชั่นฝั่งเซิร์ฟเวอร์มักจะได้รับการสนับสนุนโดยคุกกี้ เว็บฟอร์มบางรูปแบบต้องการให้คุณเข้าสู่ระบบและ / หรือถูกติดตามโดยเซสชัน คุณสามารถใช้CookieHandlerAPI เพื่อดูแลคุกกี้ คุณจำเป็นต้องเตรียมความพร้อมCookieManagerกับCookiePolicyการACCEPT_ALLก่อนที่จะส่งการร้องขอ HTTP ทั้งหมด

// First set the default cookie manager.
CookieHandler.setDefault(new CookieManager(null, CookiePolicy.ACCEPT_ALL));

// All the following subsequent URLConnections will use the same cookie manager.
URLConnection connection = new URL(url).openConnection();
// ...

connection = new URL(url).openConnection();
// ...

connection = new URL(url).openConnection();
// ...

โปรดทราบว่าสิ่งนี้เป็นที่ทราบกันดีว่าไม่สามารถทำงานได้อย่างถูกต้องในทุกสถานการณ์ ถ้ามันล้มเหลวสำหรับคุณแล้วที่ดีที่สุดคือการรวบรวมและตั้งค่าส่วนหัวของคุกกี้ด้วยตนเอง คุณจำเป็นต้องคว้าทั้งหมดSet-Cookieส่วนหัวจากการตอบกลับของการเข้าสู่ระบบหรือGETคำขอแรกแล้วส่งผ่านคำขอต่อมา

// Gather all cookies on the first request.
URLConnection connection = new URL(url).openConnection();
List<String> cookies = connection.getHeaderFields().get("Set-Cookie");
// ...

// Then use the same cookies on all subsequent requests.
connection = new URL(url).openConnection();
for (String cookie : cookies) {
    connection.addRequestProperty("Cookie", cookie.split(";", 2)[0]);
}
// ...

split(";", 2)[0]จะมีการกำจัดของคุณลักษณะคุกกี้ซึ่งไม่เกี่ยวข้องสำหรับฝั่งเซิร์ฟเวอร์เช่นexpires, pathฯลฯ นอกจากนี้คุณยังสามารถใช้cookie.substring(0, cookie.indexOf(';'))split()แทน


โหมดการสตรีม

HttpURLConnectionจะได้โดยเริ่มต้นบัฟเฟอร์ทั้งconnection.setRequestProperty("Content-Length", contentLength);ร่างกายคำขอก่อนที่จะส่งข้อความจริงโดยไม่คำนึงถึงว่าคุณได้กำหนดความยาวของเนื้อหาการแก้ไขตัวเองโดยใช้ สิ่งนี้อาจทำให้เกิดOutOfMemoryExceptionเมื่อใดก็ตามที่คุณส่งคำขอ POST ขนาดใหญ่ไปพร้อม ๆ กัน (เช่นการอัปโหลดไฟล์) HttpURLConnection#setFixedLengthStreamingMode()เพื่อหลีกเลี่ยงนี้คุณต้องการที่จะตั้งค่า

httpConnection.setFixedLengthStreamingMode(contentLength);

แต่หากไม่ทราบความยาวของเนื้อหาล่วงหน้าจริงๆคุณสามารถใช้ประโยชน์จากโหมดสตรีมมิ่งแบบหนา ๆ ได้โดยตั้งค่าHttpURLConnection#setChunkedStreamingMode()ตามความเหมาะสม นี้จะตั้งค่าTransfer-Encodingส่วนหัวHTTP chunkedซึ่งจะบังคับให้ร่างกายร้องขอถูกส่งเป็นชิ้น ตัวอย่างด้านล่างจะส่งเนื้อหาเป็นหน่วยจำนวน 1KB

httpConnection.setChunkedStreamingMode(1024);

User-Agent

อาจเกิดขึ้นได้ว่าคำขอส่งคืนการตอบสนองที่ไม่คาดคิดในขณะที่ทำงานได้ดีกับเว็บเบราว์เซอร์จริง ฝั่งเซิร์ฟเวอร์อาจปิดกั้นคำขอตามUser-Agentส่วนหัวคำขอ ความURLConnectionตั้งใจโดยค่าเริ่มต้นกำหนดให้เป็นJava/1.6.0_19ที่ส่วนสุดท้ายเห็นได้ชัดว่าเป็นรุ่น JRE คุณสามารถลบล้างสิ่งนี้ได้ดังนี้:

connection.setRequestProperty("User-Agent", "Mozilla/5.0 (Windows NT 6.1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/41.0.2228.0 Safari/537.36"); // Do as if you're using Chrome 41 on Windows 7.

ใช้สตริง User-Agent จากเบราว์เซอร์ที่ผ่านมา


การจัดการข้อผิดพลาด

หากรหัสตอบกลับ HTTP คือ4nn(ข้อผิดพลาดไคลเอ็นต์) หรือ5nn(ข้อผิดพลาดเซิร์ฟเวอร์) คุณอาจต้องการอ่านHttpURLConnection#getErrorStream()เพื่อดูว่าเซิร์ฟเวอร์ได้ส่งข้อมูลข้อผิดพลาดที่เป็นประโยชน์หรือไม่

InputStream error = ((HttpURLConnection) connection).getErrorStream();

หากรหัสตอบกลับ HTTP คือ -1 แสดงว่ามีบางอย่างผิดปกติกับการเชื่อมต่อและการจัดการการตอบกลับ การHttpURLConnectionใช้งานอยู่ใน JREs ที่ค่อนข้างเก่าด้วยการเชื่อมต่ออย่างต่อเนื่อง คุณอาจต้องการที่จะปิดโดยการตั้งค่าสถานที่ให้บริการระบบhttp.keepAlive falseคุณสามารถทำสิ่งนี้โดยทางโปรแกรมในตอนเริ่มต้นแอปพลิเคชันของคุณโดย:

System.setProperty("http.keepAlive", "false");

กำลังอัพโหลดไฟล์

โดยปกติคุณจะใช้การmultipart/form-dataเข้ารหัสสำหรับเนื้อหา POST แบบผสม (ข้อมูลไบนารีและตัวละคร) การเข้ารหัสเป็นในรายละเอียดเพิ่มเติมที่อธิบายไว้ในRFC2388

String param = "value";
File textFile = new File("/path/to/file.txt");
File binaryFile = new File("/path/to/file.bin");
String boundary = Long.toHexString(System.currentTimeMillis()); // Just generate some unique random value.
String CRLF = "\r\n"; // Line separator required by multipart/form-data.
URLConnection connection = new URL(url).openConnection();
connection.setDoOutput(true);
connection.setRequestProperty("Content-Type", "multipart/form-data; boundary=" + boundary);

try (
    OutputStream output = connection.getOutputStream();
    PrintWriter writer = new PrintWriter(new OutputStreamWriter(output, charset), true);
) {
    // Send normal param.
    writer.append("--" + boundary).append(CRLF);
    writer.append("Content-Disposition: form-data; name=\"param\"").append(CRLF);
    writer.append("Content-Type: text/plain; charset=" + charset).append(CRLF);
    writer.append(CRLF).append(param).append(CRLF).flush();

    // Send text file.
    writer.append("--" + boundary).append(CRLF);
    writer.append("Content-Disposition: form-data; name=\"textFile\"; filename=\"" + textFile.getName() + "\"").append(CRLF);
    writer.append("Content-Type: text/plain; charset=" + charset).append(CRLF); // Text file itself must be saved in this charset!
    writer.append(CRLF).flush();
    Files.copy(textFile.toPath(), output);
    output.flush(); // Important before continuing with writer!
    writer.append(CRLF).flush(); // CRLF is important! It indicates end of boundary.

    // Send binary file.
    writer.append("--" + boundary).append(CRLF);
    writer.append("Content-Disposition: form-data; name=\"binaryFile\"; filename=\"" + binaryFile.getName() + "\"").append(CRLF);
    writer.append("Content-Type: " + URLConnection.guessContentTypeFromName(binaryFile.getName())).append(CRLF);
    writer.append("Content-Transfer-Encoding: binary").append(CRLF);
    writer.append(CRLF).flush();
    Files.copy(binaryFile.toPath(), output);
    output.flush(); // Important before continuing with writer!
    writer.append(CRLF).flush(); // CRLF is important! It indicates end of boundary.

    // End of multipart/form-data.
    writer.append("--" + boundary + "--").append(CRLF).flush();
}

หากอีกด้านหนึ่งเป็น a วิธีการHttpServletของมันdoPost()จะถูกเรียกใช้และชิ้นส่วนจะพร้อมใช้งานโดยHttpServletRequest#getPart()(หมายเหตุไม่ใช่ getParameter()เช่นนั้นเป็นต้น!) อย่างไรก็ตามgetPart()วิธีการนี้ค่อนข้างใหม่มันถูกนำมาใช้ใน Servlet 3.0 (Glassfish 3, Tomcat 7, ฯลฯ ) ก่อน Servlet 3.0 ทางเลือกที่ดีที่สุดของคุณคือใช้Apache Commons FileUploadเพื่อแยกวิเคราะห์multipart/form-dataคำขอ ดูคำตอบนี้สำหรับตัวอย่างของทั้งวิธี FileUpload และ Servelt 3.0


การจัดการกับเว็บไซต์ HTTPS ที่ไม่น่าเชื่อถือหรือกำหนดค่าผิดพลาด

บางครั้งคุณจำเป็นต้องเชื่อมต่อ HTTPS URL อาจเป็นเพราะคุณกำลังเขียน web scraper ในกรณีดังกล่าวคุณอาจเผชิญjavax.net.ssl.SSLException: Not trusted server certificateกับไซต์ HTTPS บางแห่งที่ไม่ได้ทำการรับรอง SSL เป็นปัจจุบันหรือjava.security.cert.CertificateException: No subject alternative DNS name matching [hostname] foundหรือjavax.net.ssl.SSLProtocolException: handshake alert: unrecognized_nameในบางเว็บไซต์ HTTPS ที่กำหนดค่าไม่ถูกต้อง

staticinitializer ที่เรียกใช้ครั้งเดียวต่อไปนี้ในคลาส scraper เว็บของคุณควรHttpsURLConnectionผ่อนปรนให้มากขึ้นสำหรับไซต์ HTTPS เหล่านั้นและไม่ทิ้งข้อยกเว้นเหล่านั้นอีกต่อไป

static {
    TrustManager[] trustAllCertificates = new TrustManager[] {
        new X509TrustManager() {
            @Override
            public X509Certificate[] getAcceptedIssuers() {
                return null; // Not relevant.
            }
            @Override
            public void checkClientTrusted(X509Certificate[] certs, String authType) {
                // Do nothing. Just allow them all.
            }
            @Override
            public void checkServerTrusted(X509Certificate[] certs, String authType) {
                // Do nothing. Just allow them all.
            }
        }
    };

    HostnameVerifier trustAllHostnames = new HostnameVerifier() {
        @Override
        public boolean verify(String hostname, SSLSession session) {
            return true; // Just allow them all.
        }
    };

    try {
        System.setProperty("jsse.enableSNIExtension", "false");
        SSLContext sc = SSLContext.getInstance("SSL");
        sc.init(null, trustAllCertificates, new SecureRandom());
        HttpsURLConnection.setDefaultSSLSocketFactory(sc.getSocketFactory());
        HttpsURLConnection.setDefaultHostnameVerifier(trustAllHostnames);
    }
    catch (GeneralSecurityException e) {
        throw new ExceptionInInitializerError(e);
    }
}

คำสุดท้าย

Apache HttpComponents HttpClientเป็นมากสะดวกสบายมากขึ้นในนี้ทั้งหมด :)


แยกและแยก HTML

หากสิ่งที่คุณต้องการคือการแยกและการแยกข้อมูลจาก HTML ให้ใช้โปรแกรมแยกวิเคราะห์ HTML เช่นJsoup


119
คุณควรวางลิงก์ apache ก่อนดังนั้นผู้คนที่กำลังมองหาวิธีแก้ปัญหาจะพบมันได้เร็วขึ้น)
ZeissS

40
@ivanceras: หากคุณไม่สามารถต้มข้อมูลตามคำตอบนี้ได้โปรดกดAsk Questionปุ่มที่ด้านบนขวา
BalusC

3
@Brais: โปรดอ่านข้อมูลจำเพาะ --ส่วนหนึ่งไม่ได้เป็นส่วนหนึ่งของตัวเองเขตแดน มันเป็นเพียงสตริงคั่น ฉันย้อนกลับการแก้ไขที่ไม่ถูกต้องของคุณ
BalusC

7
@ BalusC ขอบคุณมากสำหรับการสอนที่สมบูรณ์แบบ โปรดใส่หัวข้อเช่น "การปิดสตรีม / การเชื่อมต่อ" ฉันสับสนมากเกี่ยวกับว่าเมื่อใดและจะปิดการสตรีม / การเชื่อมต่อใด

10
ส่วนที่น่าเศร้าคือบน Android ไม่แนะนำให้ใช้ Apache HttpClientตอนนี้และHttpURLConnectionโหดร้าย android-developers.blogspot.in/2011/09/…
yati sagade

91

เมื่อทำงานกับ HTTP มันจะมีประโยชน์มากกว่าที่จะอ้างถึงHttpURLConnectionมากกว่าคลาสพื้นฐานURLConnection(เนื่องจากURLConnectionเป็นคลาสนามธรรมเมื่อคุณขอURLConnection.openConnection()ใช้ HTTP URL นั่นคือสิ่งที่คุณจะได้กลับไป)

จากนั้นคุณสามารถแทนที่จะใช้URLConnection#setDoOutput(true)วิธีการตั้งค่าคำขอเป็นPOSTโดยปริยายแทนhttpURLConnection.setRequestMethod("POST")ซึ่งบางคนอาจพบว่าเป็นธรรมชาติมากขึ้น (และยังอนุญาตให้คุณระบุวิธีการร้องขออื่น ๆ เช่นPUT , DELETE , ... )

นอกจากนี้ยังมีค่าคงที่ HTTP ที่เป็นประโยชน์เพื่อให้คุณสามารถ:

int responseCode = httpURLConnection.getResponseCode();

if (responseCode == HttpURLConnection.HTTP_OK) {

1
setDoOutPut จริงเป็นปัญหาของฉันซึ่งทำให้ GET ของฉันเป็น POST ขอบคุณ
Patrick Kafka

22
หากคุณพยายามเขียนข้อมูลไปยังเอาต์พุตสตรีมคุณจะต้องตั้งค่าsetDoOutput()เป็นtrueอย่างอื่นข้อยกเว้นจะถูกโยนทิ้ง (แม้ว่าคุณจะsetRequestMethod("POST")) ต้องมีความชัดเจน: การตั้งค่าURLConnection#setDoOutput(true)ไปtrueโดยปริยายกำหนดวิธีการร้องขอไปยังโพสต์ แต่การตั้งค่าhttpURLConnection.setRequestMethod("POST")ที่โพสต์ไม่ได้ตั้งค่าโดยปริยายไปsetDoOutput() true
Tony Chan

54

ได้รับแรงบันดาลใจจากคำถามนี้และคำถามอื่น ๆ เกี่ยวกับ SO ฉันได้สร้างโอเพนซอร์ซพื้นฐานแบบ http-client ขั้นต่ำที่รวบรวมเทคนิคส่วนใหญ่ที่พบที่นี่

google-http-java-clientยังเป็นแหล่งข้อมูลโอเพ่นซอร์สที่ยอดเยี่ยม


ฉันแค่คิดเหมือนกัน แต่มันอาจจะดีถ้ามี barebones / simple Java library ที่ใช้เฉพาะ URLConnection code ดังที่แสดงไว้ที่นี่ซึ่ง encapsulate โค้ดเพื่อวิธีที่ง่ายกว่าในการทำ HTTP GET, POST, ฯลฯ จากนั้นไลบรารีสามารถรวบรวม & บรรจุเป็น JAR และ อิมพอร์ต / ใช้ในโค้ด Java หรือไฟล์คลาสซอร์สสามารถรวมในโปรเจ็กต์ Java หากไม่ต้องการ JAR ภายนอก สิ่งนี้สามารถทำได้กับไลบรารี่อื่น ๆ เช่น Apache เป็นต้น แต่ก็มีความเจ็บปวดมากกว่าเมื่อเปรียบเทียบกับไลบรารี่ไฟล์ 1 ไฟล์ที่ใช้ URLConnection
David

rapidvaluesolutions.com/tech_blog/…สนับสนุน HttpURLC การเชื่อมต่อผ่าน HttpClient
Ravindra babu

24

ฉันขอแนะนำให้คุณดูที่รหัสในkevinsawicki / http-requestโดยทั่วไปมันเป็น wrapper ด้านบนของHttpUrlConnectionมันให้ API ที่ง่ายกว่ามากในกรณีที่คุณเพียงแค่ต้องการทำคำขอในตอนนี้หรือคุณสามารถดูที่แหล่งที่มา ( ไม่ใหญ่เกินไป) ในการดูว่าการเชื่อมต่อได้รับการจัดการอย่างไร

ตัวอย่าง: สร้างGETคำขอด้วยประเภทเนื้อหาapplication/jsonและพารามิเตอร์การสืบค้นบางส่วน:

// GET http://google.com?q=baseball%20gloves&size=100
String response = HttpRequest.get("http://google.com", true, "q", "baseball gloves", "size", 100)
        .accept("application/json")
        .body();
System.out.println("Response was: " + response);

24

มี 2 ​​ตัวเลือกที่คุณสามารถทำได้ด้วย HTTP URL Hits: GET / POST

รับคำขอ: -

HttpURLConnection.setFollowRedirects(true); // defaults to true

String url = "https://name_of_the_url";
URL request_url = new URL(url);
HttpURLConnection http_conn = (HttpURLConnection)request_url.openConnection();
http_conn.setConnectTimeout(100000);
http_conn.setReadTimeout(100000);
http_conn.setInstanceFollowRedirects(true);
System.out.println(String.valueOf(http_conn.getResponseCode()));

คำขอโพสต์: -

HttpURLConnection.setFollowRedirects(true); // defaults to true

String url = "https://name_of_the_url"
URL request_url = new URL(url);
HttpURLConnection http_conn = (HttpURLConnection)request_url.openConnection();
http_conn.setConnectTimeout(100000);
http_conn.setReadTimeout(100000);
http_conn.setInstanceFollowRedirects(true);
http_conn.setDoOutput(true);
PrintWriter out = new PrintWriter(http_conn.getOutputStream());
if (urlparameter != null) {
   out.println(urlparameter);
}
out.close();
out = null;
System.out.println(String.valueOf(http_conn.getResponseCode()));

3
คุณสามารถดูการตอบสนอง JSON จริงได้อย่างไร
Sora

21

ฉันก็ได้รับแรงบันดาลใจจากคำตอบนี้เช่นกัน

ฉันมักจะอยู่ในโครงการที่ฉันต้องทำ HTTP และฉันอาจไม่ต้องการพึ่งพาบุคคลที่สามจำนวนมาก (ซึ่งนำผู้อื่นมาด้วยและอื่น ๆ เป็นต้น)

ฉันเริ่มเขียนโปรแกรมอรรถประโยชน์ของตัวเองตามบทสนทนานี้ (ไม่ใช่ที่ที่ทำได้):

package org.boon.utils;


import java.io.IOException;
import java.io.InputStream;
import java.net.HttpURLConnection;
import java.net.URL;
import java.net.URLConnection;
import java.util.Map;

import static org.boon.utils.IO.read;

public class HTTP {

จากนั้นมีเพียงวิธีการมัดหรือแบบคงที่

public static String get(
        final String url) {

    Exceptions.tryIt(() -> {
        URLConnection connection;
        connection = doGet(url, null, null, null);
        return extractResponseString(connection);
    });
    return null;
}

public static String getWithHeaders(
        final String url,
        final Map<String, ? extends Object> headers) {
    URLConnection connection;
    try {
        connection = doGet(url, headers, null, null);
        return extractResponseString(connection);
    } catch (Exception ex) {
        Exceptions.handle(ex);
        return null;
    }
}

public static String getWithContentType(
        final String url,
        final Map<String, ? extends Object> headers,
        String contentType) {
    URLConnection connection;
    try {
        connection = doGet(url, headers, contentType, null);
        return extractResponseString(connection);
    } catch (Exception ex) {
        Exceptions.handle(ex);
        return null;
    }
}
public static String getWithCharSet(
        final String url,
        final Map<String, ? extends Object> headers,
        String contentType,
        String charSet) {
    URLConnection connection;
    try {
        connection = doGet(url, headers, contentType, charSet);
        return extractResponseString(connection);
    } catch (Exception ex) {
        Exceptions.handle(ex);
        return null;
    }
}

จากนั้นโพสต์ ...

public static String postBody(
        final String url,
        final String body) {
    URLConnection connection;
    try {
        connection = doPost(url, null, "text/plain", null, body);
        return extractResponseString(connection);
    } catch (Exception ex) {
        Exceptions.handle(ex);
        return null;
    }
}

public static String postBodyWithHeaders(
        final String url,
        final Map<String, ? extends Object> headers,
        final String body) {
    URLConnection connection;
    try {
        connection = doPost(url, headers, "text/plain", null, body);
        return extractResponseString(connection);
    } catch (Exception ex) {
        Exceptions.handle(ex);
        return null;
    }
}



public static String postBodyWithContentType(
        final String url,
        final Map<String, ? extends Object> headers,
        final String contentType,
        final String body) {

    URLConnection connection;
    try {
        connection = doPost(url, headers, contentType, null, body);


        return extractResponseString(connection);


    } catch (Exception ex) {
        Exceptions.handle(ex);
        return null;
    }


}


public static String postBodyWithCharset(
        final String url,
        final Map<String, ? extends Object> headers,
        final String contentType,
        final String charSet,
        final String body) {

    URLConnection connection;
    try {
        connection = doPost(url, headers, contentType, charSet, body);


        return extractResponseString(connection);


    } catch (Exception ex) {
        Exceptions.handle(ex);
        return null;
    }


}

private static URLConnection doPost(String url, Map<String, ? extends Object> headers,
                                    String contentType, String charset, String body
                                    ) throws IOException {
    URLConnection connection;/* Handle output. */
    connection = new URL(url).openConnection();
    connection.setDoOutput(true);
    manageContentTypeHeaders(contentType, charset, connection);

    manageHeaders(headers, connection);


    IO.write(connection.getOutputStream(), body, IO.CHARSET);
    return connection;
}

private static void manageHeaders(Map<String, ? extends Object> headers, URLConnection connection) {
    if (headers != null) {
        for (Map.Entry<String, ? extends Object> entry : headers.entrySet()) {
            connection.setRequestProperty(entry.getKey(), entry.getValue().toString());
        }
    }
}

private static void manageContentTypeHeaders(String contentType, String charset, URLConnection connection) {
    connection.setRequestProperty("Accept-Charset", charset == null ? IO.CHARSET : charset);
    if (contentType!=null && !contentType.isEmpty()) {
        connection.setRequestProperty("Content-Type", contentType);
    }
}

private static URLConnection doGet(String url, Map<String, ? extends Object> headers,
                                    String contentType, String charset) throws IOException {
    URLConnection connection;/* Handle output. */
    connection = new URL(url).openConnection();
    manageContentTypeHeaders(contentType, charset, connection);

    manageHeaders(headers, connection);

    return connection;
}

private static String extractResponseString(URLConnection connection) throws IOException {
/* Handle input. */
    HttpURLConnection http = (HttpURLConnection)connection;
    int status = http.getResponseCode();
    String charset = getCharset(connection.getHeaderField("Content-Type"));

    if (status==200) {
        return readResponseBody(http, charset);
    } else {
        return readErrorResponseBody(http, status, charset);
    }
}

private static String readErrorResponseBody(HttpURLConnection http, int status, String charset) {
    InputStream errorStream = http.getErrorStream();
    if ( errorStream!=null ) {
        String error = charset== null ? read( errorStream ) :
            read( errorStream, charset );
        throw new RuntimeException("STATUS CODE =" + status + "\n\n" + error);
    } else {
        throw new RuntimeException("STATUS CODE =" + status);
    }
}

private static String readResponseBody(HttpURLConnection http, String charset) throws IOException {
    if (charset != null) {
        return read(http.getInputStream(), charset);
    } else {
        return read(http.getInputStream());
    }
}

private static String getCharset(String contentType) {
    if (contentType==null)  {
        return null;
    }
    String charset = null;
    for (String param : contentType.replace(" ", "").split(";")) {
        if (param.startsWith("charset=")) {
            charset = param.split("=", 2)[1];
            break;
        }
    }
    charset = charset == null ?  IO.CHARSET : charset;

    return charset;
}

คุณได้รับความคิด ....

นี่คือการทดสอบ:

static class MyHandler implements HttpHandler {
    public void handle(HttpExchange t) throws IOException {

        InputStream requestBody = t.getRequestBody();
        String body = IO.read(requestBody);
        Headers requestHeaders = t.getRequestHeaders();
        body = body + "\n" + copy(requestHeaders).toString();
        t.sendResponseHeaders(200, body.length());
        OutputStream os = t.getResponseBody();
        os.write(body.getBytes());
        os.close();
    }
}


@Test
public void testHappy() throws Exception {

    HttpServer server = HttpServer.create(new InetSocketAddress(9212), 0);
    server.createContext("/test", new MyHandler());
    server.setExecutor(null); // creates a default executor
    server.start();

    Thread.sleep(10);


    Map<String,String> headers = map("foo", "bar", "fun", "sun");

    String response = HTTP.postBodyWithContentType("http://localhost:9212/test", headers, "text/plain", "hi mom");

    System.out.println(response);

    assertTrue(response.contains("hi mom"));
    assertTrue(response.contains("Fun=[sun], Foo=[bar]"));


    response = HTTP.postBodyWithCharset("http://localhost:9212/test", headers, "text/plain", "UTF-8", "hi mom");

    System.out.println(response);

    assertTrue(response.contains("hi mom"));
    assertTrue(response.contains("Fun=[sun], Foo=[bar]"));

    response = HTTP.postBodyWithHeaders("http://localhost:9212/test", headers, "hi mom");

    System.out.println(response);

    assertTrue(response.contains("hi mom"));
    assertTrue(response.contains("Fun=[sun], Foo=[bar]"));


    response = HTTP.get("http://localhost:9212/test");

    System.out.println(response);


    response = HTTP.getWithHeaders("http://localhost:9212/test", headers);

    System.out.println(response);

    assertTrue(response.contains("Fun=[sun], Foo=[bar]"));



    response = HTTP.getWithContentType("http://localhost:9212/test", headers, "text/plain");

    System.out.println(response);

    assertTrue(response.contains("Fun=[sun], Foo=[bar]"));



    response = HTTP.getWithCharSet("http://localhost:9212/test", headers, "text/plain", "UTF-8");

    System.out.println(response);

    assertTrue(response.contains("Fun=[sun], Foo=[bar]"));

    Thread.sleep(10);

    server.stop(0);


}

@Test
public void testPostBody() throws Exception {

    HttpServer server = HttpServer.create(new InetSocketAddress(9220), 0);
    server.createContext("/test", new MyHandler());
    server.setExecutor(null); // creates a default executor
    server.start();

    Thread.sleep(10);


    Map<String,String> headers = map("foo", "bar", "fun", "sun");

    String response = HTTP.postBody("http://localhost:9220/test", "hi mom");

    assertTrue(response.contains("hi mom"));


    Thread.sleep(10);

    server.stop(0);


}

@Test(expected = RuntimeException.class)
public void testSad() throws Exception {

    HttpServer server = HttpServer.create(new InetSocketAddress(9213), 0);
    server.createContext("/test", new MyHandler());
    server.setExecutor(null); // creates a default executor
    server.start();

    Thread.sleep(10);


    Map<String,String> headers = map("foo", "bar", "fun", "sun");

    String response = HTTP.postBodyWithContentType("http://localhost:9213/foo", headers, "text/plain", "hi mom");

    System.out.println(response);

    assertTrue(response.contains("hi mom"));
    assertTrue(response.contains("Fun=[sun], Foo=[bar]"));

    Thread.sleep(10);

    server.stop(0);


}

คุณสามารถหาที่พักได้ที่นี่:

https://github.com/RichardHightower/boon

เป้าหมายของฉันคือการให้สิ่งที่คนทั่วไปอยากทำในแบบที่ง่ายขึ้นอีกหน่อยแล้ว ....


2
มันเป็นเรื่องแปลกที่ในdoPostวิธีการที่มีcharsetพารามิเตอร์ที่ใช้ส่วนหัวคำขอชุด แต่แล้วข้อมูลจะถูกเขียนด้วยบาง IO.CHARSETcharset แมลง?
Vit Khudenko

21

ปรับปรุง

ลูกค้า HTTP ใหม่มาพร้อมกับ Java 9 jdk.incubator.httpclientแต่เป็นส่วนหนึ่งของการบ่มเพาะโมดูลชื่อ โมดูลศูนย์บ่มเพาะเป็นวิธีการวาง API ที่ไม่ใช่ครั้งสุดท้ายไว้ในมือของนักพัฒนาในขณะที่ APIs จะไปสู่ขั้นตอนสุดท้ายหรือลบออกในการเปิดตัวในอนาคต

ใน Java 9 คุณสามารถส่งGETคำขอเช่น:

// GET
HttpResponse response = HttpRequest
    .create(new URI("http://www.stackoverflow.com"))
    .headers("Foo", "foovalue", "Bar", "barvalue")
    .GET()
    .response();

จากนั้นคุณสามารถตรวจสอบการคืนHttpResponse:

int statusCode = response.statusCode();
String responseBody = response.body(HttpResponse.asString());

เนื่องจากไคลเอนต์ HTTP ใหม่นี้อยู่ใน java.httpclient jdk.incubator.httpclientโมดูลคุณควรประกาศการขึ้นต่อกันนี้ในmodule-info.javaไฟล์ของคุณ:

module com.foo.bar {
    requires jdk.incubator.httpclient;
}

1
อัพเดตเพิ่มเติม: โมดูลไม่มีสถานะการฟักตัว ตอนนี้เป็นjava.net.httpไม่ใช่ jdk.incubator.httpclient
VGR

17

ตอนแรกฉันถูกเข้าใจผิดโดยบทความนี้ซึ่งโปรดปรานHttpClientที่โปรดปราน

ต่อมาฉันได้รับรู้ว่าHttpURLConnectionจะอยู่ห่างจากบทความนี้

ตามบล็อก Google :

ไคลเอนต์ Apache HTTP มีข้อบกพร่องน้อยลงใน Eclair และ Froyo มันเป็นตัวเลือกที่ดีที่สุดสำหรับการเปิดตัวเหล่านี้ สำหรับ Gingerbread การเชื่อมต่อ HttpURLC เป็นตัวเลือกที่ดีที่สุด API ที่เรียบง่ายและมีขนาดเล็กทำให้เหมาะอย่างยิ่งสำหรับ Android

การบีบอัดและแคชการตอบสนองที่โปร่งใสลดการใช้เครือข่ายปรับปรุงความเร็วและประหยัดแบตเตอรี่ แอปพลิเคชันใหม่ควรใช้ HttpURLConnection เป็นที่ที่เราจะใช้พลังงานของเราไปข้างหน้า

หลังจากอ่านบทความนี้และคำถามสแต็คอื่น ๆ เกี่ยวกับโฟลว์ฉันเชื่อว่าHttpURLConnectionจะคงอยู่ต่อไปอีกนาน

บางส่วนของคำถาม SE ที่นิยมHttpURLConnections:

บน Android ทำการร้องขอ POST ด้วยข้อมูลฟอร์มที่เข้ารหัส URL โดยไม่ใช้ UrlEncodedFormEntity

HttpPost ใช้งานได้ในโครงการ Java ไม่ใช่ใน Android


15

นอกจากนี้ยังมีOkHttpซึ่งเป็นไคลเอนต์ HTTP ที่มีประสิทธิภาพโดยค่าเริ่มต้น:

  • การสนับสนุน HTTP / 2 ช่วยให้คำขอทั้งหมดไปยังโฮสต์เดียวกันแบ่งปันซ็อกเก็ต
  • การรวมการเชื่อมต่อช่วยลดเวลาในการตอบสนองการร้องขอ (ถ้าไม่มี HTTP / 2)
  • GZIP โปร่งใสจะลดขนาดการดาวน์โหลด
  • แคชตอบสนองหลีกเลี่ยงเครือข่ายอย่างสมบูรณ์สำหรับคำขอซ้ำ

สร้างตัวอย่างแรกของOkHttpClient:

OkHttpClient client = new OkHttpClient();

จากนั้นเตรียมGETคำขอของคุณ:

Request request = new Request.Builder()
      .url(url)
      .build();

ในที่สุดใช้OkHttpClientในการส่งเตรียมRequest:

Response response = client.newCall(request).execute();

สำหรับรายละเอียดเพิ่มเติมคุณสามารถอ่านเอกสารของ OkHttp


14

คุณยังสามารถใช้ JdkRequestจากjcabi-http (ฉันเป็นนักพัฒนาซอฟต์แวร์) ซึ่งทำงานทั้งหมดให้คุณตกแต่ง HttpURLConnection การส่งคำขอ HTTP และการแยกวิเคราะห์คำตอบ:

String html = new JdkRequest("http://www.google.com").fetch().body();

ตรวจสอบโพสต์บล็อกนี้สำหรับข้อมูลเพิ่มเติม: http://www.yegor256.com/2014/04/11/jcabi-http-intro.html


1
คุณจัดการกับคุกกี้อย่างไร
Dejell

โดยการใช้ไซต์ของเรา หมายความว่าคุณได้อ่านและทำความเข้าใจนโยบายคุกกี้และนโยบายความเป็นส่วนตัวของเราแล้ว
Licensed under cc by-sa 3.0 with attribution required.