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客户端库、集成外部接口调用框架等多种方式与外部接口进行交互。