Java調用外部接口詳解

Java作為一門廣泛應用的編程語言，具有多方面的應用場景，其中調用外部接口是常見的一種。本文將從多個方面詳細闡述在Java中調用外部接口的相關知識。

一、創建 HTTP 連接並發送請求

Java中調用外部接口的第一步就是創建HTTP連接並發送請求。通常情況下，我們使用 java.net.URL 與 java.net.HttpURLConnection類來創建連接。下面是一段示例代碼：

URL url = new URL("http://www.example.com");
HttpURLConnection conn = (HttpURLConnection)url.openConnection();
conn.setRequestMethod("GET");

上面的代碼通過創建URL對象，再使用openConnection()方法創建HTTPURLConnection對象，最後設置請求方法為get方法，來實現HTTP連接的創建並發送請求。

二、設置 HTTP 請求的參數和請求頭信息

在創建HTTP連接並發送請求的過程中，我們還需要設置HTTP請求的參數和請求頭信息。

對於GET請求，我們可以通過構建完整的請求URL來攜帶參數。如下所示：

String urlStr = "http://www.example.com?key=value";
URL url = new URL(urlStr);
HttpURLConnection conn = (HttpURLConnection) url.openConnection();
conn.setRequestMethod("GET");

對於POST請求，我們需要將請求參數封裝在HTTP請求的正文中，並一起發送到服務器端。如下所示：

String urlStr = "http://www.example.com";
URL url = new URL(urlStr);
HttpURLConnection conn = (HttpURLConnection) url.openConnection();
conn.setDoOutput(true);
conn.setRequestMethod("POST");

// 構建請求參數
String param = "key=value";

// 寫入請求正文
OutputStream outputStream = conn.getOutputStream();
outputStream.write(param.getBytes("UTF-8"));
outputStream.flush();
outputStream.close();

請求頭信息可以通過調用 conn.setRequestProperty()方法進行設置。如下所示：

conn.setRequestProperty("Content-Type", "application/json");
conn.setRequestProperty("Accept-Encoding", "gzip, deflate");

三、處理 HTTP 響應結果

一旦發送了HTTP請求，服務器就會對請求進行處理，然後將處理結果返回給客戶端。Java中，我們可以通過 BufferedReader 從 InputStreamReader 中讀取HTTP響應結果。如下所示：

BufferedReader bufferedReader = new BufferedReader(new InputStreamReader(conn.getInputStream()));
StringBuffer stringBuffer = new StringBuffer();
String line;
while ((line = bufferedReader.readLine())!=null){
    stringBuffer.append(line);
}
bufferedReader.close();
String result = stringBuffer.toString();

在處理HTTP響應結果時，還需要注意狀態碼和響應頭信息的獲取。狀態碼可以通過調用 conn.getResponseCode()得到，響應頭信息可以通過調用 conn.getHeaderField()進行獲取。如下所示：

int statusCode = conn.getResponseCode();
String contentType = conn.getHeaderField("Content-Type");

四、使用第三方 HTTP 客戶端庫

雖然Java的標準類庫已經提供了許多HTTP相關的類和接口，但是，如果需要更加方便簡潔地調用外部接口，我們也可以使用第三方HTTP客戶端庫。Apache的HttpClient就是一種非常常見的HTTP客戶端庫。其優點在於可配置性強、API使用簡單、穩定可靠。下面是一段使用HttpClient進行GET請求的示例代碼：

CloseableHttpClient httpClient = HttpClients.createDefault();
HttpGet httpGet = new HttpGet("http://www.example.com");
CloseableHttpResponse response = httpClient.execute(httpGet);
HttpEntity entity = response.getEntity();
String result = EntityUtils.toString(entity);

使用HttpClient進行POST請求也同樣簡單，如下所示：

HttpPost httpPost = new HttpPost("http://www.example.com");
StringEntity stringEntity = new StringEntity("key=value");
httpPost.setEntity(stringEntity);
CloseableHttpResponse response = httpClient.execute(httpPost);

五、集成外部接口調用框架

如果我們需要與某個特定的外部接口進行交互，使用第三方HTTP客戶端庫可能也無法滿足我們的需求。這時，我們可以考慮集成該外部接口的調用框架。不同的外部接口可能需要不同的調用框架，比較常見的框架有Spring Web Services、Apache CXF等。

以Spring Web Services為例，該框架可以幫助我們通過SOAP協議與WebService進行交互。Spring Web Services 2.0以上版本支持使用JavaScript Object Notation (JSON)進行傳輸。

下面是一段使用Spring Web Services進行WebService請求的示例代碼：

Jaxb2Marshaller marshaller = new Jaxb2Marshaller();
marshaller.setContextPath("com.example.webservice");
WebServiceTemplate webServiceTemplate = new WebServiceTemplate(marshaller);
webServiceTemplate.setMessageFactory(new SaajSoapMessageFactory(MessageFactory.newInstance()));
webServiceTemplate.setDefaultUri("http://www.example.com/service");
GetCustomerRequest request = new GetCustomerRequest();
request.setId("123");
GetCustomerResponse response = (GetCustomerResponse) webServiceTemplate.marshalSendAndReceive(request);

六、總結

本文從多個方面詳細闡述了在Java中調用外部接口的相關知識。我們可以通過創建HTTP連接並發送請求、設置HTTP請求的參數和請求頭信息、處理HTTP響應結果、使用第三方HTTP客戶端庫、集成外部接口調用框架等多種方式與外部接口進行交互。