java中可以使用3种方式调用api
- HttpURLConnection
- HttpClient
- RestTemplate
这里要讲的是HttpClient的方式。
一.简介
HttpClient是Apache Jakarta Common下的子项目,用来提供高效的、最新的、功能丰富的支持HTTP协议的客户端编程工具包,并且它支持HTTP协议最新的版本和建议。HttpClient已经应用在很多的项目中,比如Apache Jakarta上很著名的另外两个开源项目Cactus和HTMLUnit都使用了HttpClient。
二.特性
1. 基于标准、纯净的java语言。实现了Http1.0和Http1.1
2. 以可扩展的面向对象的结构实现了Http全部的方法(GET, POST, PUT, DELETE, HEAD, OPTIONS, and TRACE)。
3. 支持HTTPS协议。
4. 通过Http代理建立透明的连接。
5. 利用CONNECT方法通过Http代理建立隧道的https连接。
6. Basic, Digest, NTLMv1, NTLMv2, NTLM2 Session, SNPNEGO/Kerberos认证方案。
7. 插件式的自定义认证方案。
8. 便携可靠的套接字工厂使它更容易的使用第三方解决方案。
9. 连接管理器支持多线程应用。支持设置最大连接数,同时支持设置每个主机的最大连接数,发现并关闭过期的连接。
10. 自动处理Set-Cookie中的Cookie。
11. 插件式的自定义Cookie策略。
12. Request的输出流可以避免流中内容直接缓冲到socket服务器。
13. Response的输入流可以有效的从socket服务器直接读取相应内容。
14. 在http1.0和http1.1中利用KeepAlive保持持久连接。
15. 直接获取服务器发送的response code和 headers。
16. 设置连接超时的能力。
17. 实验性的支持http1.1 response caching。
18. 源代码基于Apache License 可免费获取
三.使用方法
使用HttpClient发送请求、接收响应很简单,一般需要如下几步即可。
- 创建HttpClient对象。
- 创建请求方法的实例,并指定请求URL。如果需要发送GET请求,创建HttpGet对象;如果需要发送POST请求,创建HttpPost对象。
- 如果需要发送请求参数,可调用HttpGet、HttpPost共同的setParams(HetpParams params)方法来添加请求参数;对于HttpPost对象而言,也可调用setEntity(HttpEntity entity)方法来设置请求参数。
- 调用HttpClient对象的execute(HttpUriRequest request)发送请求,该方法返回一个HttpResponse。
- 调用HttpResponse的getAllHeaders()、getHeaders(String name)等方法可获取服务器的响应头;调用HttpResponse的getEntity()方法可获取HttpEntity对象,该对象包装了服务器的响应内容。程序可通过该对象获取服务器的响应内容。
- 释放连接。无论执行方法是否成功,都必须释放连接。
四、实例
package cn.sunpaper.studyspringboot.until;
import org.apache.http.HttpEntity;
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.conn.ssl.SSLConnectionSocketFactory;
import org.apache.http.conn.ssl.TrustSelfSignedStrategy;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.message.BasicNameValuePair;
import org.apache.http.ssl.SSLContexts;
import org.apache.http.util.EntityUtils;
import javax.net.ssl.SSLContext;
import java.io.File;
import java.io.FileInputStream;
import java.io.FileNotFoundException;
import java.io.IOException;
import java.security.KeyManagementException;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.cert.CertificateException;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
/**
* HttpClient调用api
* @author Mr.wang
* @date 2022/6/13
* @apiNote
*/
public class HttpClient {
/**
* HttpClient连接SLL
* @throws IOException
*/
public void ssl() throws IOException {
CloseableHttpClient httpClient = null;
String url = "";
File file = null;
try{
KeyStore keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
FileInputStream instream = new FileInputStream(file);
try{
keyStore.load(instream,"123456".toCharArray());
} catch (CertificateException e) {
e.printStackTrace();
} catch (IOException exception) {
exception.printStackTrace();
} catch (NoSuchAlgorithmException e) {
e.printStackTrace();
}finally {
try {
instream.close();
}catch (Exception e){
e.printStackTrace();
}
}
// 相信自己的CA和所有自签名的证书
SSLContext sslContext = SSLContexts.custom().loadTrustMaterial(keyStore, new TrustSelfSignedStrategy()).build();
// 只允许使用TLSv1协议
SSLConnectionSocketFactory sslsf = new SSLConnectionSocketFactory(sslContext, new String[]{"TLSv1"}, null
, SSLConnectionSocketFactory.BROWSER_COMPATIBLE_HOSTNAME_VERIFIER);
httpClient = HttpClients.custom().setSSLSocketFactory(sslsf).build();
HttpGet httpGet = new HttpGet(url);
System.out.println("executing request :"+httpGet.getRequestLine());
CloseableHttpResponse response = httpClient.execute(httpGet);
try{
HttpEntity entity = response.getEntity();
System.out.println("############################################");
System.out.println(response.getStatusLine());
if (entity != null){
System.out.println("Response content length:"+entity.getContentLength());
System.out.println(EntityUtils.toString(entity));
EntityUtils.consume(entity);
}
}catch (Exception e){
e.printStackTrace();
}finally {
response.close();
}
} catch (KeyStoreException | FileNotFoundException | NoSuchAlgorithmException e) {
e.printStackTrace();
} catch (IOException exception) {
exception.printStackTrace();
} catch (KeyManagementException e) {
e.printStackTrace();
}finally {
if (httpClient != null){
try{
httpClient.close();
}catch (Exception e){
e.printStackTrace();
}
}
}
}
/**
* post 方式提交表单(模拟用户登录)
* @param url 访问地址
* @param parmasMap 添加的参数
*/
public void postForm(String url,HashMap<String, Object>parmasMap){
// 创建默认的HTTPClient的实例
CloseableHttpClient httpClient = HttpClients.createDefault();
// 创建httpPost
HttpPost httpPost = new HttpPost(url);
// 创建参数队列
List formparams = new ArrayList<>();
parmasMap.forEach((k,v)->{
formparams.add(new BasicNameValuePair(k,v.toString()));
});
UrlEncodedFormEntity urlEncodedForm;
try{
UrlEncodedFormEntity uefEntity = new UrlEncodedFormEntity(formparams, "utf-8");
httpPost.setEntity(uefEntity);
System.out.println("executing request"+ httpPost.getURI());
CloseableHttpResponse response = httpClient.execute(httpPost);
try{
HttpEntity entity = response.getEntity();
if (entity != null){
System.out.println("####################################");
System.out.println("Response Content:"+EntityUtils.toString(uefEntity));
System.out.println("####################################");
}
}catch (Exception e){
e.printStackTrace();
}finally {
response.close();
}
}catch (Exception e){
e.printStackTrace();
}finally {
try{
httpClient.close();
}catch (Exception e){
e.printStackTrace();
}
}
}
/**
* 发送post 请求访问本地应用并根据传递参数的不同返回不同的结果
* @param url 访问地址
* @param parmasMap 传递的参数
*/
public String post(String url,HashMap<String, Object>parmasMap,HashMap<String, Object>header){
String data = null;
// 创建默认的httpClient实例
CloseableHttpClient httpClient = HttpClients.createDefault();
HttpPost httpPost = new HttpPost(url);
if (header != null){
header.forEach((key,value)->{
httpPost.addHeader(key,value.toString());
});
}
List formparams = new ArrayList<>();
if (parmasMap != null){
// 创建参数队列
for (Map.Entry<String, Object> entry : parmasMap.entrySet()){
formparams.add(new BasicNameValuePair(entry.getKey(), entry.getValue().toString()));
}
}
UrlEncodedFormEntity urlEncodedForm;
try{
urlEncodedForm = new UrlEncodedFormEntity(formparams, "utf-8");
httpPost.setEntity(urlEncodedForm);
System.out.println("executing request"+ httpPost.getURI());
CloseableHttpResponse response = httpClient.execute(httpPost);
try{
HttpEntity entity = response.getEntity();
if (entity != null){
data = EntityUtils.toString(entity);
System.out.println("################开始展示接收到的数据体####################");
System.out.println("Response Content:"+data);
System.out.println("###########################结束#######################");
return data;
}
return data;
}catch (Exception e){
e.printStackTrace();
}finally {
response.close();
}
}catch (Exception e){
e.printStackTrace();
}finally {
try{
httpClient.close();
}catch (Exception e){
e.printStackTrace();
}
}
return data;
}
/**
* 发送get请求
* @param url 请求地址
*/
public void get(String url){
CloseableHttpClient httpClient = HttpClients.createDefault();
try{
HttpGet httpGet = new HttpGet(url);
System.out.println("executing request "+httpGet.getURI());
CloseableHttpResponse response = httpClient.execute(httpGet);
try{
HttpEntity entity = response.getEntity();
System.out.println("#############################################");
System.out.println(response.getStatusLine());
if (entity != null){
System.out.println("Response content length :"+entity.getContentLength());
System.out.println("Response content :"+EntityUtils.toString(entity));
}
System.out.println("#############################################");
}finally {
response.close();
}
}catch (Exception e){
e.printStackTrace();
}
}
}
测试
@Test
void requestTest1(){
HttpClient httpClient = new HttpClient();
String url = "XXXXXXXXXXXXXXXXXXXXXXXX";
//配置参数
HashMap<String, Object> paramsMap = new HashMap<>();
paramsMap.put("XXX","");
paramsMap.put("XXX","");
paramsMap.put("XXX","XXXXXXXXXXXXXXXXXXXXXXXX");
paramsMap.put("XXX","");
paramsMap.put("XXX","");
paramsMap.put("XXX","");
paramsMap.put("XXX","");
paramsMap.put("XXX","");
//配置请求头
HashMap<String, Object> headerMap = new HashMap<>();
headerMap.put("XXX","XXX");
String response = httpClient.post(url, paramsMap, headerMap);
ResponseInfo ResponseInfo = JSONObject.parseObject(response, ResponseInfo.class);
System.out.println(ResponseInfo);
}