婚庆公司网站建设总结,建设银行官方网站打不开,wordpress的第三方登录插件下载,途牛旅游线路网站建设分析1、简介
HttpClient 是 Apache Jakarta Common 下的子项目#xff0c;用来提供高效的、最新的、功能丰富的支持 HTTP 协议的客户端编程工具包#xff0c;并且它支持 HTTP 协议最新的版本和建议。HttpClient 已经应用在很多的项目中#xff0c;比如 Apache Jakarta 上很著名…1、简介
HttpClient 是 Apache Jakarta Common 下的子项目用来提供高效的、最新的、功能丰富的支持 HTTP 协议的客户端编程工具包并且它支持 HTTP 协议最新的版本和建议。HttpClient 已经应用在很多的项目中比如 Apache Jakarta 上很著名的另外两个开源项目 Cactus 和 HTMLUnit 都使用了 HttpClient。
HttpClient 相比传统 JDK 自带的 URLConnection增加了易用性和灵活性它不仅是客户端发送 HTTP 请求变得容易而且也方便了开发人员测试接口基于 HTTP 协议的即提高了开发的效率也方便提高代码的健壮性。因此熟练掌握 HttpClient 是很重要的必修内容掌握 HttpClient 后相信对于 HTTP 协议的了解会更加深入。
2、引入依赖
HttpClient 是三方工具首先需要引入依赖。如下
!-- 此处使用的是 5.x 版本可以根据自身情况引入版本 --
dependencygroupIdorg.apache.httpcomponents.client5/groupIdartifactIdhttpclient5/artifactIdversion5.1.1/version
/dependency
3、获取客户端
在使用时首先需要 获取 HttpClient 对象有如下几种获取方式 默认创建方式
// 获取默认配置的 HttpClient
CloseableHttpClient httpClient HttpClients.createDefault();
2.根据系统配置创建
// 此种方式是通过 根据 系统配置创建 HttpClient
CloseableHttpClient httpClient HttpClients.createSystem();
在项目启动时可以通过设置如下JVM启动参数
http.agent 配置 userAgenthttp.keepAlive 配置 keepAlive 数据
3.自定义创建
// 此种方式可以在创建时 设置一些默认值
CloseableHttpClient httpClient HttpClients.custom().setDefaultHeaders(Collections.emptyList()) // 设置默认请求头.setDefaultRequestConfig(RequestConfig.DEFAULT) // 设置默认配置.build();
4、配置参数
HttpClient 可以通过在创建 HttpClient 对象时就设置全局配置也可以为单个请求设置请求配置。 创建配置对象 // 创建请求配置信息
RequestConfig requestConfig RequestConfig.custom()// 设置连接超时时间.setConnectTimeout(Timeout.of(3000, TimeUnit.MILLISECONDS))// 设置响应超时时间.setResponseTimeout(3000, TimeUnit.MILLISECONDS) // 设置从连接池获取链接的超时时间.setConnectionRequestTimeout(3000, TimeUnit.MILLISECONDS).build();2.设置全局配置
// 此种方式可以在创建时 设置一些默认值
CloseableHttpClient httpClient HttpClients.custom().setDefaultHeaders(Collections.emptyList()) // 设置默认请求头.setDefaultRequestConfig(requestConfig) // 设置默认配置.build();
3.单个请求设置配置
// 创建 GET 请求对象
HttpGet httpGet new HttpGet(uri);// 设置请求参数
httpGet.setConfig(requestConfig);
5、设置请求头信息
在请求时经常会遇到设置自定义请求头或者更改 Conent-Type 的值可以通过如下两种方式设置 设置公共请求头
ListHeader headers new ArrayList();
headers.add(new BasicHeader(HttpHeaders.CONTENT_TYPE, ContentType.APPLICATION_JSON));
headers.add(new BasicHeader(HttpHeaders.ACCEPT_ENCODING, gzip, x-gzip, deflate));
headers.add(new BasicHeader(HttpHeaders.CONNECTION, keep-alive));// 创建 一个默认的 httpClient
CloseableHttpClient httpClient HttpClients.custom().setDefaultHeaders(headers) // 设置默认请求头.build()
2.单个请求设置请求头
// 创建 POST 请求
HttpPost httpPost new HttpPost(uri);
// 添加 Content-Type 请求头
httpPost.addHeader(HttpHeaders.CONTENT_TYPE, ContentType.APPLICATION_FORM_URLENCODED);
// 添加 accept 请求头
httpPost.addHeader(new BasicHeader(HttpHeaders.ACCEPT, */*));
6、发送请求
GET 请求
GET请求的所有参数是直接拼接在 URL 后面的在 HttpClient 中 有两种方式可以实现如下所示 请求参数直接拼接在请求路径后面
String name URLEncoder.encode(张三, utf-8);
// 请求路径及参数
String url http://localhost:10010/user/params?age20name name;// 创建 GET 请求对象
HttpGet httpGet new HttpGet(url);
// 调用 HttpClient 的 execute 方法执行请求
CloseableHttpResponse response httpClient.execute(httpGet);
// 获取请求状态
int code response.getCode();
// 如果请求成功
if(code HttpStatus.SC_OK){LOGGER.info(响应结果为{}, EntityUtils.toString(response.getEntity()));
}
2.通过 URIBuilder 构建请求路径
// 构建请求路径及参数
URL url new URL(http://localhost:10010/user/params);
URI uri new URIBuilder().setScheme(url.getProtocol()).setHost(url.getHost()).setPort(url.getPort()).setPath(url.getPath())// 构建参数.setParameters(new BasicNameValuePair(name, 张三),new BasicNameValuePair(age, 20)).build();// 创建 GET 请求对象
HttpGet httpGet new HttpGet(uri);
// 调用 HttpClient 的 execute 方法执行请求
CloseableHttpResponse response httpClient.execute(httpGet);
// 获取请求状态
int code response.getCode();
// 如果请求成功
if(code HttpStatus.SC_OK){LOGGER.info(响应结果为{}, EntityUtils.toString(response.getEntity()));
}
POST 请求
众所周知HTTP 中的 POST 请求的数据是包含在请求体中的。在 HttpClient 中 POST 请求发送数据是通过调用 HttpPost 类的 setEntity(HttpEntity entity) 方法设置消息内容的。 发送 JSON 数据 HttpClient 中发送 JSON 数据可以使用 StringHttpEntity 类实现如下所示
// 请求参数
String url http://localhost:10010/user/body;
// 创建 GET 请求对象
HttpPost httpPost new HttpPost(url);
// 构建对象
User user new User();
user.setName(张三).setAge(20).setAddress(new Address().setCounty(中国).setCity(北京)).setAihao(Arrays.asList(跑步, 爬山, 看书));// 创建 字符串实体对象
HttpEntity httpEntity new StringEntity(JSON.toJSONString(user));
httpPost.setEntity(httpEntity);// 发送 POST 请求
httpClient.execute(httpPost);
2.模拟form表单数据
在实际使用时可以存在 需要模拟 form 表单的情况进行请求数据在 HttpClent 中也可以很方便的实现 form 的提交功能。操作步骤如下 修改 contentType
// 创建 ContentType 对象为 form 表单模式
ContentType contentType ContentType.create(application/x-www-form-urlencoded, StandardCharsets.UTF_8);
// 添加到 HttpPost 头中
httpPost.setHeader(HttpHeaders.CONTENT_TYPE, contentType);
创建请求数据 HttpEntity
// 方式一、自己拼接请求数据并且创建 StringEntity 对象
String query name URLEncoder.encode(张三, utf-8) age20;
HttpEntity httpEntity new StringEntity(query);// 方式二、通过UrlEncodedFormEntity 创建 HttpEntity
HttpEntity httpEntity new UrlEncodedFormEntity(Arrays.asList(new BasicNameValuePair(name, 张三),new BasicNameValuePair(age, 20)),StandardCharsets.UTF_8
);// 把 HttpEntity 设置到 HttpPost 中
httpPost.setEntity(httpEntity);
完整代码如下所示
// 创建 POST 请求对象
HttpPost httpPost new HttpPost(http://localhost:10010/user/map);
/*String query name URLEncoder.encode(张三, utf-8) age20;HttpEntity httpEntity new StringEntity(query);*/HttpEntity httpEntity new UrlEncodedFormEntity(Arrays.asList(new BasicNameValuePair(name, 张三),new BasicNameValuePair(age, 20)),StandardCharsets.UTF_8
);// 设置请求数据
httpPost.setEntity(httpEntity);
// 设置请求头
ContentType contentType ContentType.APPLICATION_FORM_URLENCODED.withCharset(StandardCharsets.UTF_8);
httpPost.setHeader(HttpHeaders.CONTENT_TYPE, contentType);
// 调用 HttpClient 的 execute 方法执行请求
CloseableHttpResponse response httpClient.execute(httpPost);
// 获取请求状态
int code response.getCode();
// 如果请求成功
if(code HttpStatus.SC_OK){LOGGER.info(响应结果为{}, EntityUtils.toString(response.getEntity()));
}
7、上传下载
上传
在 HttpClient 中实现上传功能是非常方便的可以通过 MultipartEntityBuilder直接构建 HttpEntity 即可。
//要上传的文件
File file new File(F:/20150703212056_Yxi4L.jpeg);// 创建对象
MultipartEntityBuilder builder MultipartEntityBuilder.create();// 添加二进制消息体
builder.addBinaryBody(file, file);// 也可以添加文本消息
ContentType contentType ContentType.TEXT_PLAIN.withCharset(StandardCharsets.UTF_8);
builder.addTextBody(name, 张三, contentType);// 通过 MultipartEntityBuilder 构建消息体
HttpEntity httpEntity builder.build();
HttpPost httpPost new HttpPost(http://localhost:10010/user/upload);
httpPost.setEntity(httpEntity);
CloseableHttpResponse response httpClient.execute(httpPost);
// 获取请求状态
int code response.getCode();
// 如果请求成功
if(code HttpStatus.SC_OK){LOGGER.info(响应结果为{}, EntityUtils.toString(response.getEntity()));
}
下载
HttpClient 中的下载也相当简单只需要发送请求判断请求成功后读取输入流然后保存到响应的路径下即可如下
// 请求下载路径
HttpGet httpGet new HttpGet(http://localhost:10010/user/downLoad);
CloseableHttpResponse response httpClient.execute(httpGet);// 如果请求成功
if (response.getCode() HttpStatus.SC_OK){// 获取下载文件的文件名此处的 File-Name 头信息需要在服务端进行自定义Header header response.getFirstHeader(File-Name);String value header.getValue();// 读取数据byte[] bytes EntityUtils.toByteArray(response.getEntity());try (OutputStream outputStream new FileOutputStream(F:/ value);){outputStream.write(bytes);outputStream.flush();}
}
8、响应处理
在 HttpClient 中把响应封装成了 CloseableHttpResponse 对象在此对象中可以获取如下数据
getCode() 获取响应状态getEntity() 获取响应数据// 如果请求成功
if(code HttpStatus.SC_OK){LOGGER.info(响应结果为{}, EntityUtils.toString(response.getEntity()));
}
HttpClient 提供了 EntityUtils工具类可以很好的把 响应的 HttpEntity 转换为 字节数组或者字符串
// 转换为字符串
EntityUtils.toString(response.getEntity());// 转换为字节数组
EntityUtils.toByteArray(response.getEntity());
除了上述外还可以在 调用 HttpClient 的 execute()方法时 传入响应处理器返回自定义的数据类型。如下所示是返回一个 自定义的 Response 对象
// 自定义响应对象
Data
Accessors(chain true)
class Response {// 响应状态private int code;// 响应描述private String msg;// 响应体private String body;
}// 调用 execute 时自定义 响应处理类Response execute httpClient.execute(httpGet, response - {return new Response().setCode(response.getCode()).setMsg(response.getReasonPhrase()).setBody(EntityUtils.toString(response.getEntity(), StandardCharsets.UTF_8));});
9、会话保持
在实际项目中经常会遇到需要先登录然后才能进行访问其他接口那么 在 HttpClient 中提供了 HttpClientContext 类可以很好的实现会话保持功能。
创建HttpClientContext在 execute() 方法中传入 第一步创建的对象
如下所示
// 创建 HttpClientContext对象
HttpContext httpContext new BasicHttpContext();
httpContext.setAttribute(name, zhangsan);
HttpClientContext httpClientContext HttpClientContext.adapt(httpContext);// 登录
httpClient.execute(new HttpPost(), httpClientContext);// 获取数据
httpClient.execute(new HttpGet(), httpClientContext);
10、总结
这里只是 HttpClient 的使用做了简单的介绍起到抛砖引玉的作用其实HttpClient 提供的功能非常强大的在接下来会对 HttpClient 层层剖析慢慢揭开 其神秘面纱。
