HttpURLConnection學習

轉自 http://www.blogjava.net/jjshcc/archive/2010/07/21/326762.html

HttpURLConnection學習

最常用的Http請求無非是get和post，get請求可以獲取靜態頁面，也可以把參數放在URL字串後面，傳遞給servlet，post與get的不同之處在於post的參數不是放在URL字串裏面，而是放在http請求的正文內。
在Java中可以使用HttpURLConnection發起這兩種請求，瞭解此類，對於瞭解soap，和編寫servlet的自動測試代碼都有很大的幫助。
下面的代碼簡單描述瞭如何使用HttpURLConnection發起這兩種請求，以及傳遞參數的方法：

public class HttpInvoker {

    public static final String GET_URL = "http://localhost:8080/welcome1";

    public static final String POST_URL = "http://localhost:8080/welcome1";

    public static void readContentFromGet() throws IOException {
        // 拼湊get請求的URL字串，使用URLEncoder.encode對特殊和不可見字符進行編碼
        String getURL = GET_URL + "?username="
                + URLEncoder.encode("fat man", "utf-8");
        URL getUrl = new URL(getURL);
        // 根據拼湊的URL，打開連接，URL.openConnection函數會根據URL的類型，
        // 返回不同的URLConnection子類的對象，這裏URL是一個http，因此實際返回的是HttpURLConnection
        HttpURLConnection connection = (HttpURLConnection) getUrl
                .openConnection();
        // 進行連接，但是實際上get request要在下一句的connection.getInputStream()函數中才會真正發到
        // 服務器
        connection.connect();
        // 取得輸入流，並使用Reader讀取
        BufferedReader reader = new BufferedReader(new InputStreamReader(
                connection.getInputStream()));
        System.out.println("=============================");
        System.out.println("Contents of get request");
        System.out.println("=============================");
        String lines;
        while ((lines = reader.readLine()) != null) {
            System.out.println(lines);
        }
        reader.close();
        // 斷開連接
        connection.disconnect();
        System.out.println("=============================");
        System.out.println("Contents of get request ends");
        System.out.println("=============================");
    }

    public static void readContentFromPost() throws IOException {
        // Post請求的url，與get不同的是不需要帶參數
        URL postUrl = new URL(POST_URL);
        // 打開連接
        HttpURLConnection connection = (HttpURLConnection) postUrl
                .openConnection();
        // Output to the connection. Default is
        // false, set to true because post
        // method must write something to the
        // connection
        // 設置是否向connection輸出，因爲這個是post請求，參數要放在
        // http正文內，因此需要設爲true
        connection.setDoOutput(true);
        // Read from the connection. Default is true.
        connection.setDoInput(true);
        // Set the post method. Default is GET
        connection.setRequestMethod("POST");
        // Post cannot use caches
        // Post 請求不能使用緩存
        connection.setUseCaches(false);
        // This method takes effects to
        // every instances of this class.
        // URLConnection.setFollowRedirects是static函數，作用於所有的URLConnection對象。
        // connection.setFollowRedirects(true);

        // This methods only
        // takes effacts to this
        // instance.
        // URLConnection.setInstanceFollowRedirects是成員函數，僅作用於當前函數
        connection.setInstanceFollowRedirects(true);
        // Set the content type to urlencoded,
        // because we will write
        // some URL-encoded content to the
        // connection. Settings above must be set before connect!
        // 配置本次連接的Content-type，配置爲application/x-www-form-urlencoded的
        // 意思是正文是urlencoded編碼過的form參數，下面我們可以看到我們對正文內容使用URLEncoder.encode
        // 進行編碼
        connection.setRequestProperty("Content-Type",
                "application/x-www-form-urlencoded");
        // 連接，從postUrl.openConnection()至此的配置必須要在connect之前完成，
        // 要注意的是connection.getOutputStream會隱含的進行connect。
        connection.connect();
        DataOutputStream out = new DataOutputStream(connection
                .getOutputStream());
        // The URL-encoded contend
        // 正文，正文內容其實跟get的URL中'?'後的參數字符串一致
        String content = "firstname=" + URLEncoder.encode("一個大肥人", "utf-8");
        // DataOutputStream.writeBytes將字符串中的16位的unicode字符以8位的字符形式寫道流裏面
        out.writeBytes(content); 

        out.flush();
        out.close(); // flush and close
        BufferedReader reader = new BufferedReader(new InputStreamReader(
                connection.getInputStream()));
        String line;
        System.out.println("=============================");
        System.out.println("Contents of post request");
        System.out.println("=============================");
        while ((line = reader.readLine()) != null) {
            System.out.println(line);
        }
        System.out.println("=============================");
        System.out.println("Contents of post request ends");
        System.out.println("=============================");
        reader.close();
        connection.disconnect();
    }

    /** *//**
     * @param args
     */
    public static void main(String[] args) {
        // TODO Auto-generated method stub
        try {
            readContentFromGet();
            readContentFromPost();
        } catch (IOException e) {
            // TODO Auto-generated catch block
            e.printStackTrace();
        }
    }

}

上面的readContentFromGet()函數產生了一個get請求，傳給servlet一個username參數，值爲"fat man"。
readContentFromPost()函數產生了一個post請求，傳給servlet一個firstname參數，值爲"一個大肥人"。
HttpURLConnection.connect函數，實際上只是建立了一個與服務器的tcp連接，並沒有實際發送http請求。無論是post還是get，http請求實際上直到HttpURLConnection.getInputStream()這個函數裏面才正式發送出去。

在readContentFromPost() 中，順序是重中之重，對connection對象的一切配置（那一堆set函數）都必須要在connect()函數執行之前完成。而對 outputStream的寫操作，又必須要在inputStream的讀操作之前。這些順序實際上是由http請求的格式決定的。

http 請求實際上由兩部分組成，一個是http頭，所有關於此次http請求的配置都在http頭裏面定義，一個是正文content，在connect()函 數裏面，會根據HttpURLConnection對象的配置值生成http頭，因此在調用connect函數之前，就必須把所有的配置準備好。

緊接着http頭的是http請求的正文，正文的內容通過outputStream寫入，實際上outputStream不是一個網絡流，充其量是個字符串流，往裏面寫入的東西不會立即發送到網絡，而是在流關閉後，根據輸入的內容生成http正文。

至 此，http請求的東西已經準備就緒。在getInputStream()函數調用的時候，就會把準備好的http請求正式發送到服務器了，然後返回一個 輸入流，用於讀取服務器對於此次http請求的返回信息。由於http請求在getInputStream的時候已經發送出去了（包括http頭和正 文），因此在getInputStream()函數之後對connection對象進行設置（對http頭的信息進行修改）或者寫入 outputStream（對正文進行修改）都是沒有意義的了，執行這些操作會導致異常的發生
上節說道，post請求的OutputStream實際上不是網絡流，而是寫入內存，在getInputStream中才真正把寫道流裏面的內容作爲正文 與根據之前的配置生成的http request頭合併成真正的http request，並在此時才真正向服務器發送。

HttpURLConnection.setChunkedStreamingMode 函數可以改變這個模式，設置了ChunkedStreamingMode後，不再等待OutputStream關閉後生成完整的http request一次過發送，而是先發送http request頭，正文內容則是網路流的方式實時傳送到服務器。實際上是不告訴服務器http正文的長度，這種模式適用於向服務器傳送較大的或者是不容易 獲取長度的數據，如文件。 

public static void readContentFromChunkedPost() throws IOException {
        URL postUrl = new URL(POST_URL);
        HttpURLConnection connection = (HttpURLConnection) postUrl
                .openConnection();
        connection.setDoOutput(true);
        connection.setDoInput(true);
        connection.setRequestMethod("POST");
        connection.setUseCaches(false);
        connection.setInstanceFollowRedirects(true);
        connection.setRequestProperty("Content-Type",
                "application/x-www-form-urlencoded");
        /**//*
         * 與readContentFromPost()最大的不同，設置了塊大小爲5字節
         */
        connection.setChunkedStreamingMode(5);
        connection.connect();
        /**//*
         * 注意，下面的getOutputStream函數工作方式於在readContentFromPost()裏面的不同
         * 在readContentFromPost()裏面該函數仍在準備http request，沒有向服務器發送任何數據
         * 而在這裏由於設置了ChunkedStreamingMode，getOutputStream函數會根據connect之前的配置
         * 生成http request頭，先發送到服務器。
         */
        DataOutputStream out = new DataOutputStream(connection
                .getOutputStream());
        String content = "firstname=" + URLEncoder.encode("一個大肥人                                                                               " +
                "                                          " +
                "asdfasfdasfasdfaasdfasdfasdfdasfs", "utf-8");
        out.writeBytes(content); 

        out.flush();
        out.close(); // 到此時服務器已經收到了完整的http request了，而在readContentFromPost()函數裏，要等到下一句服務器才能收到http請求。
        BufferedReader reader = new BufferedReader(new InputStreamReader(
                connection.getInputStream()));
        
        out.flush();
        out.close(); // flush and close
        String line;
        System.out.println("=============================");
        System.out.println("Contents of post request");
        System.out.println("=============================");
        while ((line = reader.readLine()) != null) {
            System.out.println(line);
        }
        System.out.println("=============================");
        System.out.println("Contents of post request ends");
        System.out.println("=============================");
        reader.close();
        connection.disconnect();
    }