原文：https://jasonzhong.github.io/2017/01/26/Android-%E6%B5%85%E6%9E%90-HttpURLConnection/

前言

Linus Benedict Torvalds : RTFSC – Read The Funning Source Code

概述

HttpURLConnection是一種多用途、輕量極的HTTP客戶端，使用它來進(jìn)行HTTP操作可以適用于大多數(shù)的應(yīng)用程序傅瞻。

HttpURLConnection相對于HttpClient的優(yōu)點(diǎn)：

使用

使用這個類應(yīng)該跟從以下步驟:

Step 1

Obtain a new HttpURLConnection by calling URL.openConnection() and casting the result to HttpURLConnection. 獲得一個新的HttpURLConnection類應(yīng)該調(diào)用URL.openConnection()并且將結(jié)果強(qiáng)轉(zhuǎn)成HttpURLConnection類照藻。

Step 2

Prepare the request. The primary property of a request is its URI. Request headers may also include metadata such as credentials, preferred content types, and session cookies.準(zhǔn)備一個request免钻。這個request主要屬性是它的URI彼水。Request的頭部將會包含一些元數(shù)據(jù)例如憑證，首選內(nèi)容類型和會話Cookie极舔。

Step 3

Optionally upload a request body. Instances must be configured with setDoOutput(true) if they include a request body. Transmit data by writing to the stream returned by getOutputStream().可選上傳的request內(nèi)容凤覆。如果它包含一個request內(nèi)容，實(shí)例必須配置為setDoOutput(true)拆魏。通過寫入getOutputStream()返回的流來傳輸數(shù)據(jù)盯桦。

Step 4

Read the response. Response headers typically include metadata such as the response body's content type and length, modified dates and session cookies. The response body may be read from the stream returned by getInputStream(). If the response has no body, that method returns an empty stream.讀取響應(yīng)。響應(yīng)標(biāo)頭通常包括元數(shù)據(jù)稽揭，例如響應(yīng)正文的內(nèi)容類型和長度，修改日期和會話Cookie肥卡。 響應(yīng)主體可以從getInputStream()返回的流中讀取溪掀。 如果響應(yīng)沒有正文，那么該方法將返回一個空流步鉴。

Step 5

Disconnect. Once the response body has been read, the HttpURLConnection should be closed by calling disconnect(). Disconnecting releases the resources held by a connection so they may be closed or reused.斷開鏈接揪胃。一旦響應(yīng)內(nèi)容被讀取，HttpURLConnection應(yīng)該要被關(guān)閉用disconnect()函數(shù)氛琢。斷開連接釋放連接持有的資源喊递，以便它們可以被關(guān)閉或重用。

例子

URL url = new URL("http://www.android.com/");
HttpURLConnection urlConnection = (HttpURLConnection) url.openConnection();
try {
  InputStream in = new BufferedInputStream(urlConnection.getInputStream());
  readStream(in);
} finally {
  urlConnection.disconnect();
}

返回值

針對鏈接的屬性一些定義：

通用首部字段

請求首部字段

響應(yīng)首部字段

實(shí)體首部字段

詳細(xì)使用

Get操作

private void requestGet(HashMap<String, String> paramsMap) {
    try {
        String baseUrl = "https://baidu.com/";
        StringBuilder tempParams = new StringBuilder();
        int pos = 0;
        for (String key : paramsMap.keySet()) {
            if (pos > 0) {
                tempParams.append("&");
            }
            tempParams.append(String.format("%s=%s", key, URLEncoder.encode(paramsMap.get(key),"utf-8")));
            pos++;
        }
        String requestUrl = baseUrl + tempParams.toString();
        // 新建一個URL對象
        URL url = new URL(requestUrl);
        // 打開一個HttpURLConnection連接
        HttpURLConnection urlConn = (HttpURLConnection) url.openConnection();
        // 設(shè)置連接主機(jī)超時時間
        urlConn.setConnectTimeout(5 * 1000);
        // 設(shè)置從主機(jī)讀取數(shù)據(jù)超時
        urlConn.setReadTimeout(5 * 1000);
        // 設(shè)置是否使用緩存  默認(rèn)是true
        urlConn.setUseCaches(true);
        // 設(shè)置為Post請求
        urlConn.setRequestMethod("GET");
        // urlConn設(shè)置請求頭信息
        // 設(shè)置請求中的媒體類型信息阳似。
        urlConn.setRequestProperty("Content-Type", "application/json");
        // 設(shè)置客戶端與服務(wù)連接類型
        urlConn.addRequestProperty("Connection", "Keep-Alive");
        // 開始連接
        urlConn.connect();
        // 判斷請求是否成功
        if (urlConn.getResponseCode() == 200) {
            // 獲取返回的數(shù)據(jù)
            String result = streamToString(urlConn.getInputStream());
            Log.e(TAG, "Get方式請求成功骚勘，result--->" + result);
        } else {
            Log.e(TAG, "Get方式請求失敗");
        }
        // 關(guān)閉連接
        urlConn.disconnect();
    } catch (Exception e) {
        Log.e(TAG, e.toString());
    }
}

Post操作

private void requestPost(HashMap<String, String> paramsMap) {
    try {
        String baseUrl = "https://baidu.com/";
        // 合成參數(shù)
        StringBuilder tempParams = new StringBuilder();
        int pos = 0;
        for (String key : paramsMap.keySet()) {
            if (pos > 0) {
                tempParams.append("&");
            }
            tempParams.append(String.format("%s=%s", key,  URLEncoder.encode(paramsMap.get(key),"utf-8")));
            pos++;
        }
        String params =tempParams.toString();
        // 請求的參數(shù)轉(zhuǎn)換為byte數(shù)組
        byte[] postData = params.getBytes();
        // 新建一個URL對象
        URL url = new URL(baseUrl);
        // 打開一個HttpURLConnection連接
        HttpURLConnection urlConn = (HttpURLConnection) url.openConnection();
        // 設(shè)置連接超時時間
        urlConn.setConnectTimeout(5 * 1000);
        // 設(shè)置從主機(jī)讀取數(shù)據(jù)超時
        urlConn.setReadTimeout(5 * 1000);
        // Post請求必須設(shè)置允許輸出 默認(rèn)false
        urlConn.setDoOutput(true);
        // 設(shè)置請求允許輸入 默認(rèn)是true
        urlConn.setDoInput(true);
        // Post請求不能使用緩存
        urlConn.setUseCaches(false);
        // 設(shè)置為Post請求
        urlConn.setRequestMethod("POST");
        // 設(shè)置本次連接是否自動處理重定向
        urlConn.setInstanceFollowRedirects(true);
        // 配置請求Content-Type
        urlConn.setRequestProperty("Content-Type", "application/json");
        // 開始連接
        urlConn.connect();
        // 發(fā)送請求參數(shù)
        DataOutputStream dos = new DataOutputStream(urlConn.getOutputStream());
        dos.write(postData);
        dos.flush();
        dos.close();
        // 判斷請求是否成功
        if (urlConn.getResponseCode() == 200) {
            // 獲取返回的數(shù)據(jù)
            String result = streamToString(urlConn.getInputStream());
            Log.e(TAG, "Post方式請求成功，result--->" + result);
        } else {
            Log.e(TAG, "Post方式請求失敗");
        }
        // 關(guān)閉連接
        urlConn.disconnect();
    } catch (Exception e) {
        Log.e(TAG, e.toString());
    }
}

download操作

private void downloadFile(String fileUrl){
    try {
        // 新建一個URL對象
        URL url = new URL(fileUrl);
        // 打開一個HttpURLConnection連接
        HttpURLConnection urlConn = (HttpURLConnection) url.openConnection();
        // 設(shè)置連接主機(jī)超時時間
        urlConn.setConnectTimeout(5 * 1000);
        // 設(shè)置從主機(jī)讀取數(shù)據(jù)超時
        urlConn.setReadTimeout(5 * 1000);
        // 設(shè)置是否使用緩存  默認(rèn)是true
        urlConn.setUseCaches(true);
        // 設(shè)置為Post請求
        urlConn.setRequestMethod("GET");
        // urlConn設(shè)置請求頭信息
        // 設(shè)置請求中的媒體類型信息撮奏。
        urlConn.setRequestProperty("Content-Type", "application/json");
        // 設(shè)置客戶端與服務(wù)連接類型
        urlConn.addRequestProperty("Connection", "Keep-Alive");
        // 開始連接
        urlConn.connect();
        // 判斷請求是否成功
        if (urlConn.getResponseCode() == 200) {
            String filePath="";
            File  descFile = new File(filePath);
            FileOutputStream fos = new FileOutputStream(descFile);;
            byte[] buffer = new byte[1024];
            int len;
            InputStream inputStream = urlConn.getInputStream();
            while ((len = inputStream.read(buffer)) != -1) {
                // 寫到本地
                fos.write(buffer, 0, len);
            }
        } else {
            Log.e(TAG, "文件下載失敗");
        }
        // 關(guān)閉連接
        urlConn.disconnect();
    } catch (Exception e) {
        Log.e(TAG, e.toString());
    }
}

上傳操作

private void upLoadFile(String filePath, HashMap<String, String> paramsMap) {
    try {
        String baseUrl = "https://baidu.com/uploadFile";
        File file = new File(filePath);
        // 新建url對象
        URL url = new URL(baseUrl);
        // 通過HttpURLConnection對象,向網(wǎng)絡(luò)地址發(fā)送請求
        HttpURLConnection urlConn = (HttpURLConnection) url.openConnection();
        // 設(shè)置該連接允許讀取
        urlConn.setDoOutput(true);
        // 設(shè)置該連接允許寫入
        urlConn.setDoInput(true);
        // 設(shè)置不能適用緩存
        urlConn.setUseCaches(false);
        // 設(shè)置連接超時時間
        urlConn.setConnectTimeout(5 * 1000);   // 設(shè)置連接超時時間
        // 設(shè)置讀取超時時間
        urlConn.setReadTimeout(5 * 1000);   // 讀取超時
        // 設(shè)置連接方法post
        urlConn.setRequestMethod("POST");
        // 設(shè)置維持長連接
        urlConn.setRequestProperty("connection", "Keep-Alive");
        // 設(shè)置文件字符集
        urlConn.setRequestProperty("Accept-Charset", "UTF-8");
        // 設(shè)置文件類型
        urlConn.setRequestProperty("Content-Type", "multipart/form-data; boundary=" + "*****");
        String name = file.getName();
        DataOutputStream requestStream = new DataOutputStream(urlConn.getOutputStream());
        requestStream.writeBytes("--" + "*****" + "\r\n");
        // 發(fā)送文件參數(shù)信息
        StringBuilder tempParams = new StringBuilder();
        tempParams.append("Content-Disposition: form-data; name=\"" + name + "\"; filename=\"" + name + "\"; ");
        int pos = 0;
        int size = paramsMap.size();
        for (String key : paramsMap.keySet()) {
            tempParams.append( String.format("%s=\"%s\"", key, paramsMap.get(key), "utf-8"));
            if (pos < size-1) {
                tempParams.append("; ");
            }
            pos++;
        }
        tempParams.append("\r\n");
        tempParams.append("Content-Type: application/octet-stream\r\n");
        tempParams.append("\r\n");
        String params = tempParams.toString();
        requestStream.writeBytes(params);
        //發(fā)送文件數(shù)據(jù)
        FileInputStream fileInput = new FileInputStream(file);
        int bytesRead;
        byte[] buffer = new byte[1024];
        DataInputStream in = new DataInputStream(new FileInputStream(file));
        while ((bytesRead = in.read(buffer)) != -1) {
            requestStream.write(buffer, 0, bytesRead);
        }
        requestStream.writeBytes("\r\n");
        requestStream.flush();
        requestStream.writeBytes("--" + "*****" + "--" + "\r\n");
        requestStream.flush();
        fileInput.close();
        int statusCode = urlConn.getResponseCode();
        if (statusCode == 200) {
            // 獲取返回的數(shù)據(jù)
            String result = streamToString(urlConn.getInputStream());
            Log.e(TAG, "上傳成功俏讹，result--->" + result);
        } else {
            Log.e(TAG, "上傳失敗");
        }
    } catch (IOException e) {
        Log.e(TAG, e.toString());
    }
}

Request部分

Responses 部分

注意點(diǎn)

1. HttpURLConnection的connect()函數(shù)币狠，實(shí)際上只是建立了一個與服務(wù)器的tcp連接游两，并沒有實(shí)際發(fā)送http請求。 無論是post還是get漩绵，http請求實(shí)際上直到HttpURLConnection的getInputStream()這個函數(shù)里面才正式發(fā)送出去贱案。
2. 在用POST方式發(fā)送URL請求時，URL請求參數(shù)的設(shè)定順序是重中之重止吐，對connection對象的一切配置(那一堆set函數(shù)) 都必須要在connect()函數(shù)執(zhí)行之前完成宝踪。而對outputStream的寫操作，又必須要在inputStream的讀操作之前碍扔。這些順序?qū)嶋H上是由http請求的格式?jīng)Q定的瘩燥。
3. http請求實(shí)際上由兩部分組成，一個是http頭不同，所有關(guān)于此次http請求的配置都在http頭里面定義厉膀， 一個是正文content。connect()函數(shù)會根據(jù)HttpURLConnection對象的配置值生成http頭部信息二拐，因此在調(diào)用connect函數(shù)之前站蝠，就必須把所有的配置準(zhǔn)備好。
4. 在http頭后面緊跟著的是http請求的正文卓鹿，正文的內(nèi)容是通過outputStream流寫入的菱魔，實(shí)際上outputStream不是一個網(wǎng)絡(luò)流，充其量是個字符串流吟孙，往里面寫入的東西不會立即發(fā)送到網(wǎng)絡(luò)澜倦， 而是存在于內(nèi)存緩沖區(qū)中，待outputStream流關(guān)閉時杰妓，根據(jù)輸入的內(nèi)容生成http正文藻治。至此，http請求的東西已經(jīng)全部準(zhǔn)備就緒巷挥。在getInputStream()函數(shù)調(diào)用的時候桩卵，就會把準(zhǔn)備好的http請求 正式發(fā)送到服務(wù)器了，然后返回一個輸入流，用于讀取服務(wù)器對于此次http請求的返回信息雏节。由于http 請求在getInputStream的時候已經(jīng)發(fā)送出去了(包括http頭和正文)胜嗓，因此在getInputStream()函數(shù) 之后對connection對象進(jìn)行設(shè)置(對http頭的信息進(jìn)行修改)或者寫入outputStream(對正文進(jìn)行修改)都是沒有意義的了，執(zhí)行這些操作會導(dǎo)致異常的發(fā)生钩乍。