除了本文推薦的幾種方式,強烈推薦 OkHttp
目前JAVA實作HTTP請求的方法用的最多的有兩種:一種是通過HTTPClient這種第三方的開源架構去實作。
HTTPClient對HTTP的封裝性比較不錯,通過它基本上能夠滿足我們大部分的需求。
HttpClient3.1 是 org.apache.commons.httpclient下操作遠端 url的工具包,雖然已不再更新,但實作工作中使用httpClient3.1的代碼還是很多,HttpClient4.5是org.apache.http.client下操作遠端 url的工具包,最新的;
另一種則是通過HttpURLConnection去實作,HttpURLConnection是JAVA的标準類,是JAVA比較原生的一種實作方式。
自己在工作中三種方式都用到過,總結一下分享給大家,也友善自己以後使用,話不多說上代碼。
第一種方式:java原生HttpURLConnection
package com.powerX.httpClient;
import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.io.OutputStream;
import java.net.HttpURLConnection;
import java.net.MalformedURLException;
import java.net.URL;
public class HttpClient {
public static String doGet(String httpurl) {
HttpURLConnection connection = null;
InputStream is = null;
BufferedReader br = null;
String result = null;// 傳回結果字元串
try {
// 建立遠端url連接配接對象
URL url = new URL(httpurl);
// 通過遠端url連接配接對象打開一個連接配接,強轉成httpURLConnection類
connection = (HttpURLConnection) url.openConnection();
// 設定連接配接方式:get
connection.setRequestMethod("GET");
// 設定連接配接主機伺服器的逾時時間:15000毫秒
connection.setConnectTimeout(15000);
// 設定讀取遠端傳回的資料時間:60000毫秒
connection.setReadTimeout(60000);
// 發送請求
connection.connect();
// 通過connection連接配接,擷取輸入流
if (connection.getResponseCode() == 200) {
is = connection.getInputStream();
// 封裝輸入流is,并指定字元集
br = new BufferedReader(new InputStreamReader(is, "UTF-8"));
// 存放資料
StringBuffer sbf = new StringBuffer();
String temp = null;
while ((temp = br.readLine()) != null) {
sbf.append(temp);
sbf.append("\r\n");
}
result = sbf.toString();
}
} catch (MalformedURLException e) {
e.printStackTrace();
} catch (IOException e) {
e.printStackTrace();
} finally {
// 關閉資源
if (null != br) {
try {
br.close();
} catch (IOException e) {
e.printStackTrace();
}
}
if (null != is) {
try {
is.close();
} catch (IOException e) {
e.printStackTrace();
}
}
connection.disconnect();// 關閉遠端連接配接
}
return result;
}
public static String doPost(String httpUrl, String param) {
HttpURLConnection connection = null;
InputStream is = null;
OutputStream os = null;
BufferedReader br = null;
String result = null;
try {
URL url = new URL(httpUrl);
// 通過遠端url連接配接對象打開連接配接
connection = (HttpURLConnection) url.openConnection();
// 設定連接配接請求方式
connection.setRequestMethod("POST");
// 設定連接配接主機伺服器逾時時間:15000毫秒
connection.setConnectTimeout(15000);
// 設定讀取主機伺服器傳回資料逾時時間:60000毫秒
connection.setReadTimeout(60000);
// 預設值為:false,當向遠端伺服器傳送資料/寫資料時,需要設定為true
connection.setDoOutput(true);
// 預設值為:true,目前向遠端服務讀取資料時,設定為true,該參數可有可無
connection.setDoInput(true);
// 設定傳入參數的格式:請求參數應該是 name1=value1&name2=value2 的形式。
connection.setRequestProperty("Content-Type", "application/x-www-form-urlencoded");
// 設定鑒權資訊:Authorization: Bearer da3efcbf-0845-4fe3-8aba-ee040be542c0
connection.setRequestProperty("Authorization", "Bearer da3efcbf-0845-4fe3-8aba-ee040be542c0");
// 通過連接配接對象擷取一個輸出流
os = connection.getOutputStream();
// 通過輸出流對象将參數寫出去/傳輸出去,它是通過位元組數組寫出的
os.write(param.getBytes());
// 通過連接配接對象擷取一個輸入流,向遠端讀取
if (connection.getResponseCode() == 200) {
is = connection.getInputStream();
// 對輸入流對象進行包裝:charset根據工作項目組的要求來設定
br = new BufferedReader(new InputStreamReader(is, "UTF-8"));
StringBuffer sbf = new StringBuffer();
String temp = null;
// 循環周遊一行一行讀取資料
while ((temp = br.readLine()) != null) {
sbf.append(temp);
sbf.append("\r\n");
}
result = sbf.toString();
}
} catch (MalformedURLException e) {
e.printStackTrace();
} catch (IOException e) {
e.printStackTrace();
} finally {
// 關閉資源
if (null != br) {
try {
br.close();
} catch (IOException e) {
e.printStackTrace();
}
}
if (null != os) {
try {
os.close();
} catch (IOException e) {
e.printStackTrace();
}
}
if (null != is) {
try {
is.close();
} catch (IOException e) {
e.printStackTrace();
}
}
// 斷開與遠端位址url的連接配接
connection.disconnect();
}
return result;
}
}
第二種方式:apache HttpClient3.1
package com.powerX.httpClient;
import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.io.UnsupportedEncodingException;
import java.util.Iterator;
import java.util.Map;
import java.util.Map.Entry;
import java.util.Set;
import org.apache.commons.httpclient.DefaultHttpMethodRetryHandler;
import org.apache.commons.httpclient.HttpClient;
import org.apache.commons.httpclient.HttpStatus;
import org.apache.commons.httpclient.NameValuePair;
import org.apache.commons.httpclient.methods.GetMethod;
import org.apache.commons.httpclient.methods.PostMethod;
import org.apache.commons.httpclient.params.HttpMethodParams;
public class HttpClient3 {
public static String doGet(String url) {
// 輸入流
InputStream is = null;
BufferedReader br = null;
String result = null;
// 建立httpClient執行個體
HttpClient httpClient = new HttpClient();
// 設定http連接配接主機服務逾時時間:15000毫秒
// 先擷取連接配接管理器對象,再擷取參數對象,再進行參數的指派
httpClient.getHttpConnectionManager().getParams().setConnectionTimeout(15000);
// 建立一個Get方法執行個體對象
GetMethod getMethod = new GetMethod(url);
// 設定get請求逾時為60000毫秒
getMethod.getParams().setParameter(HttpMethodParams.SO_TIMEOUT, 60000);
// 設定請求重試機制,預設重試次數:3次,參數設定為true,重試機制可用,false相反
getMethod.getParams().setParameter(HttpMethodParams.RETRY_HANDLER, new DefaultHttpMethodRetryHandler(3, true));
try {
// 執行Get方法
int statusCode = httpClient.executeMethod(getMethod);
// 判斷傳回碼
if (statusCode != HttpStatus.SC_OK) {
// 如果狀态碼傳回的不是ok,說明失敗了,列印錯誤資訊
System.err.println("Method faild: " + getMethod.getStatusLine());
} else {
// 通過getMethod執行個體,擷取遠端的一個輸入流
is = getMethod.getResponseBodyAsStream();
// 包裝輸入流
br = new BufferedReader(new InputStreamReader(is, "UTF-8"));
StringBuffer sbf = new StringBuffer();
// 讀取封裝的輸入流
String temp = null;
while ((temp = br.readLine()) != null) {
sbf.append(temp).append("\r\n");
}
result = sbf.toString();
}
} catch (IOException e) {
e.printStackTrace();
} finally {
// 關閉資源
if (null != br) {
try {
br.close();
} catch (IOException e) {
e.printStackTrace();
}
}
if (null != is) {
try {
is.close();
} catch (IOException e) {
e.printStackTrace();
}
}
// 釋放連接配接
getMethod.releaseConnection();
}
return result;
}
public static String doPost(String url, Map<String, Object> paramMap) {
// 擷取輸入流
InputStream is = null;
BufferedReader br = null;
String result = null;
// 建立httpClient執行個體對象
HttpClient httpClient = new HttpClient();
// 設定httpClient連接配接主機伺服器逾時時間:15000毫秒
httpClient.getHttpConnectionManager().getParams().setConnectionTimeout(15000);
// 建立post請求方法執行個體對象
PostMethod postMethod = new PostMethod(url);
// 設定post請求逾時時間
postMethod.getParams().setParameter(HttpMethodParams.SO_TIMEOUT, 60000);
NameValuePair[] nvp = null;
// 判斷參數map集合paramMap是否為空
if (null != paramMap && paramMap.size() > 0) {// 不為空
// 建立鍵值參數對象數組,大小為參數的個數
nvp = new NameValuePair[paramMap.size()];
// 循環周遊參數集合map
Set<Entry<String, Object>> entrySet = paramMap.entrySet();
// 擷取疊代器
Iterator<Entry<String, Object>> iterator = entrySet.iterator();
int index = 0;
while (iterator.hasNext()) {
Entry<String, Object> mapEntry = iterator.next();
// 從mapEntry中擷取key和value建立鍵值對象存放到數組中
try {
nvp[index] = new NameValuePair(mapEntry.getKey(),
new String(mapEntry.getValue().toString().getBytes("UTF-8"), "UTF-8"));
} catch (UnsupportedEncodingException e) {
e.printStackTrace();
}
index++;
}
}
// 判斷nvp數組是否為空
if (null != nvp && nvp.length > 0) {
// 将參數存放到requestBody對象中
postMethod.setRequestBody(nvp);
}
// 執行POST方法
try {
int statusCode = httpClient.executeMethod(postMethod);
// 判斷是否成功
if (statusCode != HttpStatus.SC_OK) {
System.err.println("Method faild: " + postMethod.getStatusLine());
}
// 擷取遠端傳回的資料
is = postMethod.getResponseBodyAsStream();
// 封裝輸入流
br = new BufferedReader(new InputStreamReader(is, "UTF-8"));
StringBuffer sbf = new StringBuffer();
String temp = null;
while ((temp = br.readLine()) != null) {
sbf.append(temp).append("\r\n");
}
result = sbf.toString();
} catch (IOException e) {
e.printStackTrace();
} finally {
// 關閉資源
if (null != br) {
try {
br.close();
} catch (IOException e) {
e.printStackTrace();
}
}
if (null != is) {
try {
is.close();
} catch (IOException e) {
e.printStackTrace();
}
}
// 釋放連接配接
postMethod.releaseConnection();
}
return result;
}
}
第三種方式:apache httpClient4.5
package com.powerX.httpClient;
import java.io.IOException;
import java.io.UnsupportedEncodingException;
import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import java.util.Map.Entry;
import java.util.Set;
import org.apache.http.HttpEntity;
import org.apache.http.NameValuePair;
import org.apache.http.client.ClientProtocolException;
import org.apache.http.client.config.RequestConfig;
import org.apache.http.client.entity.UrlEncodedFormEntity;
import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.message.BasicNameValuePair;
import org.apache.http.util.EntityUtils;
public class HttpClient4 {
public static String doGet(String url) {
CloseableHttpClient httpClient = null;
CloseableHttpResponse response = null;
String result = "";
try {
// 通過址預設配置建立一個httpClient執行個體
httpClient = HttpClients.createDefault();
// 建立httpGet遠端連接配接執行個體
HttpGet httpGet = new HttpGet(url);
// 設定請求頭資訊,鑒權
httpGet.setHeader("Authorization", "Bearer da3efcbf-0845-4fe3-8aba-ee040be542c0");
// 設定配置請求參數
RequestConfig requestConfig = RequestConfig.custom().setConnectTimeout(35000)// 連接配接主機服務逾時時間
.setConnectionRequestTimeout(35000)// 請求逾時時間
.setSocketTimeout(60000)// 資料讀取逾時時間
.build();
// 為httpGet執行個體設定配置
httpGet.setConfig(requestConfig);
// 執行get請求得到傳回對象
response = httpClient.execute(httpGet);
// 通過傳回對象擷取傳回資料
HttpEntity entity = response.getEntity();
// 通過EntityUtils中的toString方法将結果轉換為字元串
result = EntityUtils.toString(entity);
} catch (ClientProtocolException e) {
e.printStackTrace();
} catch (IOException e) {
e.printStackTrace();
} finally {
// 關閉資源
if (null != response) {
try {
response.close();
} catch (IOException e) {
e.printStackTrace();
}
}
if (null != httpClient) {
try {
httpClient.close();
} catch (IOException e) {
e.printStackTrace();
}
}
}
return result;
}
public static String doPost(String url, Map<String, Object> paramMap) {
CloseableHttpClient httpClient = null;
CloseableHttpResponse httpResponse = null;
String result = "";
// 建立httpClient執行個體
httpClient = HttpClients.createDefault();
// 建立httpPost遠端連接配接執行個體
HttpPost httpPost = new HttpPost(url);
// 配置請求參數執行個體
RequestConfig requestConfig = RequestConfig.custom().setConnectTimeout(35000)// 設定連接配接主機服務逾時時間
.setConnectionRequestTimeout(35000)// 設定連接配接請求逾時時間
.setSocketTimeout(60000)// 設定讀取資料連接配接逾時時間
.build();
// 為httpPost執行個體設定配置
httpPost.setConfig(requestConfig);
// 設定請求頭
httpPost.addHeader("Content-Type", "application/x-www-form-urlencoded");
// 封裝post請求參數
if (null != paramMap && paramMap.size() > 0) {
List<NameValuePair> nvps = new ArrayList<NameValuePair>();
// 通過map內建entrySet方法擷取entity
Set<Entry<String, Object>> entrySet = paramMap.entrySet();
// 循環周遊,擷取疊代器
Iterator<Entry<String, Object>> iterator = entrySet.iterator();
while (iterator.hasNext()) {
Entry<String, Object> mapEntry = iterator.next();
nvps.add(new BasicNameValuePair(mapEntry.getKey(), mapEntry.getValue().toString()));
}
// 為httpPost設定封裝好的請求參數
try {
httpPost.setEntity(new UrlEncodedFormEntity(nvps, "UTF-8"));
} catch (UnsupportedEncodingException e) {
e.printStackTrace();
}
}
try {
// httpClient對象執行post請求,并傳回響應參數對象
httpResponse = httpClient.execute(httpPost);
// 從響應對象中擷取響應内容
HttpEntity entity = httpResponse.getEntity();
result = EntityUtils.toString(entity);
} catch (ClientProtocolException e) {
e.printStackTrace();
} catch (IOException e) {
e.printStackTrace();
} finally {
// 關閉資源
if (null != httpResponse) {
try {
httpResponse.close();
} catch (IOException e) {
e.printStackTrace();
}
}
if (null != httpClient) {
try {
httpClient.close();
} catch (IOException e) {
e.printStackTrace();
}
}
}
return result;
}
}
有時候我們在使用post請求時,可能傳入的參數是json或者其他格式,此時我們則需要更改請求頭及參數的設定資訊,以httpClient4.5為例,更改下面兩列配置:
httpPost.setEntity(new StringEntity("你的json串")); httpPost.addHeader("Content-Type", "application/json")。