HttpClient详细介绍及传参的方式：
HTTP 协议可能是现在 Internet 上使用得最多、最重要的协议了，越来越多的 Java 应用程序需要直接通过 HTTP 协议来访问网络资源。虽然在 JDK 的 java net包中已经提供了访问 HTTP 协议的基本功能，但是对于大部分应用程序来说，JDK 库本身提供的功能还不够丰富和灵活。HttpClient 是 Apache Jakarta Common 下的子项目，用来提供高效的、最新的、功能丰富的支持 HTTP 协议的客户端编程工具包，并且它支持 HTTP 协议最新的版本和建议。
HTTP和浏览器有点像，但却不是浏览器。很多人觉得既然HttpClient是一个HTTP客户端编程工具，很多人把他当做浏览器来理解，但是其实HttpClient不是浏览器，它是一个HTTP通信库，因此它只提供一个通用浏览器应用程序所期望的功能子集，最根本的区别是HttpClient中没有用户界面，浏览器需要一个渲染引擎来显示页面，并解释用户输入，例如鼠标点击显示页面上的某处，有一个布局引擎，计算如何显示HTML页面，包括级联样式表和图像。javascript解释器运行嵌入HTML页面或从HTML页面引用的javascript代码。来自用户界面的事件被传递到javascript解释器进行处理。除此之外，还有用于插件的接口，可以处理Applet，嵌入式媒体对象（如pdf文件，Quicktime电影和Flash动画）或ActiveX控件（可以执行任何操作）。HttpClient只能以编程的方式通过其API用于传输和接受HTTP消息。
HttpClient的主要功能：
实现了所有 HTTP 的方法（GET、POST、PUT、HEAD、DELETE、HEAD、OPTIONS 等）
支持 HTTPS 协议
支持代理服务器（Nginx等）等
支持自动（跳转）转向
……
maven依赖
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>fastjson</artifactId>
<version>1.2.43</version>
</dependency>
<dependency>
<groupId>org.apache.httpcomponents</groupId>
<artifactId>httpclient</artifactId>
<version>4.5.3</version>
</dependency>
HttpClientUtil:
/** * @Author dw * @ClassName HttpClientUtil * @Description * @Date 2020/8/28 11:32 * @Version 1.0 */ public class HttpClientUtil { /** * 获得Http客户端(可以理解为:你得先有一个浏览器;注意:实际上HttpClient与浏览器是不一样的) */ private final CloseableHttpClient httpClient = HttpClientBuilder.create().build(); /** * 编码格式。发送编码格式统一用UTF-8 */ private static final String ENCODING = "UTF-8"; /** * 设置连接超时时间，单位毫秒。 */ private static final int CONNECT_TIMEOUT = 6000; /** * 请求获取数据的超时时间(即响应时间)，单位毫秒。 */ private static final int SOCKET_TIMEOUT = 6000; /** * GET有参(方式一：直接拼接URL) * * @param url 请求的url * @param params 拼接好的请求参数 * 如下： * StringBuffer params = new StringBuffer(); * // 字符数据最好encoding以下;这样一来，某些特殊字符才能传过去(如:某人的名字就是“&”,不encoding的话,传不过去) * params.append("name=" + URLEncoder.encode("&", "utf-8")); * params.append("&"); * params.append("age=24"); */ public String doGet(String url, StringBuffer params) { // 创建Get请求 HttpGet httpGet = new HttpGet(url + "?" + params); // 响应模型 CloseableHttpResponse response = null; try { // 将上面的配置信息 运用到这个Get请求里 httpGet.setConfig(getRequestConfig()); // 由客户端执行(发送)Get请求 response = httpClient.execute(httpGet); // 从响应模型中获取响应实体 HttpEntity responseEntity = response.getEntity(); System.out.println("响应状态为:" + response.getStatusLine()); if (responseEntity != null) { String result = EntityUtils.toString(responseEntity, StandardCharsets.UTF_8); System.out.println("响应内容长度为:" + responseEntity.getContentLength()); System.out.println("响应内容为:" + result); return result; } } catch (ClientProtocolException e) { e.printStackTrace(); } catch (ParseException e) { e.printStackTrace(); } catch (IOException e) { e.printStackTrace(); } finally { try { // 释放资源 if (httpClient != null) { httpClient.close(); } if (response != null) { response.close(); } } catch (IOException e) { e.printStackTrace(); } } return null; } /** * GET有参(方式一：直接拼接URL) * * @param url 请求的url * @param mapParams 请求参数Map */ public String doGet(String url, HashMap<String, String> mapParams) { StringBuffer params = new StringBuffer(); // 字符数据最好encoding以下(URLEncoder.encode("&", "utf-8"));这样一来，某些特殊字符才能传过去(如:某人的名字就是“&”,不encoding的话,传不过去) mapParams.forEach((k, v) -> { params.append(k).append("=").append(v).append("&"); }); // 移除该字符串的最后一个 "&" params.substring(0, params.length() - 1); // 创建Get请求 HttpGet httpGet = new HttpGet(url + "?" + params); // 响应模型 CloseableHttpResponse response = null; try { // 将上面的配置信息 运用到这个Get请求里 httpGet.setConfig(getRequestConfig()); // 由客户端执行(发送)Get请求 response = httpClient.execute(httpGet); // 从响应模型中获取响应实体 HttpEntity responseEntity = response.getEntity(); System.out.println("响应状态为:" + response.getStatusLine()); if (responseEntity != null) { String result = EntityUtils.toString(responseEntity, StandardCharsets.UTF_8); System.out.println("响应内容长度为:" + responseEntity.getContentLength()); System.out.println("响应内容为:" + result); return result; } } catch (ClientProtocolException e) { e.printStackTrace(); } catch (ParseException e) { e.printStackTrace(); } catch (IOException e) { e.printStackTrace(); } finally { try { // 释放资源 if (httpClient != null) { httpClient.close(); } if (response != null) { response.close(); } } catch (IOException e) { e.printStackTrace(); } } return null; } /** * GET---有参 (方式二:将参数放入键值对类中,再放入URI中,从而通过URI得到HttpGet实例) * * @param scheme 请求的方式: HTTP、Https * @param host 请求的主机 * @param port 请求的端口 * @param requestPath 请求的路径 eg: "/doGetControllerTwo" * @param paramsMap 请求的参数 */ public String doGet(String scheme, String host, Integer port, String requestPath, HashMap<String, String> paramsMap) { // 参数 URI uri = null; try { List<NameValuePair> params = new ArrayList<>(); paramsMap.forEach((k, v) -> { params.add(new BasicNameValuePair(k, v)); }); // 设置uri信息,并将参数集合放入uri; // 注:这里也支持一个键值对一个键值对地往里面放setParameter(String key, String value) uri = new URIBuilder().setScheme(scheme).setHost(host) .setPort(port).setPath(requestPath) .setParameters(params).build(); } catch (URISyntaxException e1) { e1.printStackTrace(); } // 创建Get请求 HttpGet httpGet = new HttpGet(uri); // 响应模型 CloseableHttpResponse response = null; try { // 将上面的配置信息 运用到这个Get请求里 httpGet.setConfig(getRequestConfig()); // 由客户端执行(发送)Get请求 response = httpClient.execute(httpGet); // 从响应模型中获取响应实体 HttpEntity responseEntity = response.getEntity(); System.out.println("响应状态为:" + response.getStatusLine()); if (responseEntity != null) { String result = EntityUtils.toString(responseEntity, StandardCharsets.UTF_8); System.out.println("响应内容长度为:" + responseEntity.getContentLength()); System.out.println("响应内容为:" + result); return result; } } catch (ClientProtocolException e) { e.printStackTrace(); } catch (ParseException e) { e.printStackTrace(); } catch (IOException e) { e.printStackTrace(); } finally { try { // 释放资源 if (httpClient != null) { httpClient.close(); } if (response != null) { response.close(); } } catch (IOException e) { e.printStackTrace(); } } return null; } /** * POST---无参 * * @param url 请求地址 */ public String doPost(String url) { // 创建Post请求 HttpPost httpPost = new HttpPost(url); // 响应模型 CloseableHttpResponse response = null; try { // 由客户端执行(发送)Post请求 response = httpClient.execute(httpPost); // 从响应模型中获取响应实体 HttpEntity responseEntity = response.getEntity(); System.out.println("响应状态为:" + response.getStatusLine()); if (responseEntity != null) { String result = EntityUtils.toString(responseEntity, StandardCharsets.UTF_8); System.out.println("响应内容长度为:" + responseEntity.getContentLength()); System.out.println("响应内容为:" + result); return result; } } catch (ClientProtocolException e) { e.printStackTrace(); } catch (ParseException e) { e.printStackTrace(); } catch (IOException e) { e.printStackTrace(); } finally { try { // 释放资源 if (httpClient != null) { httpClient.close(); } if (response != null) { response.close(); } } catch (IOException e) { e.printStackTrace(); } } return null; } /** * POST---有参测试(普通参数) * * @param url 请求地址 * @param paramsMap 请求参数map */ public String doPost(String url, HashMap<String, String> paramsMap) { // 参数 StringBuffer params = new StringBuffer(); paramsMap.forEach((k, v) -> { params.append(k).append("=").append(v).append("&"); }); // 创建Post请求 HttpPost httpPost = new HttpPost(url + "?" + params); // 设置ContentType(注:如果只是传普通参数的话,ContentType不一定非要用application/json) httpPost.setHeader("Content-Type", "application/json;charset=utf8"); // 响应模型 CloseableHttpResponse response = null; try { // 由客户端执行(发送)Post请求 response = httpClient.execute(httpPost); // 从响应模型中获取响应实体 HttpEntity responseEntity = response.getEntity(); System.out.println("响应状态为:" + response.getStatusLine()); if (responseEntity != null) { String result = EntityUtils.toString(responseEntity, StandardCharsets.UTF_8); System.out.println("响应内容长度为:" + responseEntity.getContentLength()); System.out.println("响应内容为:" + result); return result; } } catch (ClientProtocolException e) { e.printStackTrace(); } catch (ParseException e) { e.printStackTrace(); } catch (IOException e) { e.printStackTrace(); } finally { try { // 释放资源 if (httpClient != null) { httpClient.close(); } if (response != null) { response.close(); } } catch (IOException e) { e.printStackTrace(); } } return null; } /** * POST---有参测试(对象参数) * @param url 请求地址 * @param object 对象参数 */ public String doPost(String url,Object object) { // 创建Post请求 HttpPost httpPost = new HttpPost(url); // 我这里利用阿里的fastJson，将Object转换为json字符串; String jsonString = JSON.toJSONString(object); StringEntity entity = new StringEntity(jsonString, ENCODING); // post请求是将参数放在请求体里面传过去的;这里将entity放入post请求体中 httpPost.setEntity(entity); httpPost.setHeader("Content-Type", "application/json;charset=utf8"); // 响应模型 CloseableHttpResponse response = null; try { // 由客户端执行(发送)Post请求 response = httpClient.execute(httpPost); // 从响应模型中获取响应实体 HttpEntity responseEntity = response.getEntity(); System.out.println("响应状态为:" + response.getStatusLine()); if (responseEntity != null) { String result = EntityUtils.toString(responseEntity, StandardCharsets.UTF_8); System.out.println("响应内容长度为:" + responseEntity.getContentLength()); System.out.println("响应内容为:" + result); return result; } } catch (ClientProtocolException e) { e.printStackTrace(); } catch (ParseException e) { e.printStackTrace(); } catch (IOException e) { e.printStackTrace(); } finally { try { // 释放资源 if (httpClient != null) { httpClient.close(); } if (response != null) { response.close(); } } catch (IOException e) { e.printStackTrace(); } } return null; } /** * requestConfig * 请求超时配置 */ public RequestConfig getRequestConfig() { // 配置信息 RequestConfig requestConfig = RequestConfig.custom() // 设置连接超时时间(单位毫秒) .setConnectTimeout(CONNECT_TIMEOUT) // 设置请求超时时间(单位毫秒) .setConnectionRequestTimeout(SOCKET_TIMEOUT) // socket读写超时时间(单位毫秒) .setSocketTimeout(SOCKET_TIMEOUT) // 设置是否允许重定向(默认为true) .setRedirectsEnabled(true).build(); return requestConfig; } }
二：RestTemplate
使用Apache的HttpClient这种方法使用起来太过繁琐。spring提供了一种简单便捷的模板类来进行操作，这就是RestTemplate，RestTemplate 是从 Spring3.0 开始支持的一个 HTTP 请求工具，它提供了常见的REST请求方案的模版，例如 GET 请求、POST 请求、PUT 请求、DELETE 请求以及一些通用的请求执行方法 exchange 以及 execute。
RestTemplate包含以下几个部分：
- HttpMessageConverter 对象转换器
- ClientHttpRequestFactory 默认是JDK的HttpURLConnection
- ResponseErrorHandler 异常处理
- ClientHttpRequestInterceptor 请求拦截器
二、一个简单的例子
定义一个简单的restful接口
@RestController
public class TestController
{
@RequestMapping(value = "testPost", method = RequestMethod.POST)
public ResponseBean testPost(@RequestBody RequestBean requestBean)
{
ResponseBean responseBean = new ResponseBean();
responseBean.setRetCode("0000");
responseBean.setRetMsg("succ");
return responseBean;
}
}
使用RestTemplate访问该服务
//请求地址
String url = "http://localhost:8080/testPost";
//入参
RequestBean requestBean = new RequestBean();
requestBean.setTest1("1");
requestBean.setTest2("2");
requestBean.setTest3("3");
RestTemplate restTemplate = new RestTemplate();
ResponseBean responseBean = restTemplate.postForObject(url, requestBean, ResponseBean.class);
从这个例子可以看出，使用restTemplate访问restful接口非常的简单粗暴无脑。(url, requestMap, ResponseBean.class)这三个参数分别代表 请求地址、请求参数、HTTP响应转换被转换成的对象类型。
RestTemplate方法的名称遵循命名约定，第一部分指出正在调用什么HTTP方法，第二部分指示返回的内容。本例中调用了restTemplate.postForObject方法，post指调用了HTTP的post方法，Object指将HTTP响应转换为您选择的对象类型。还有其他很多类似的方法，有兴趣的同学可以 参考官方api。
三、手动指定转换器(HttpMessageConverter)
我们知道，调用reseful接口传递的数据内容是json格式的字符串，返回的响应也是json格式的字符串。然而restTemplate.postForObject方法的请求参数RequestBean和返回参数ResponseBean却都是java类。是RestTemplate通过HttpMessageConverter自动帮我们做了转换的操作。
默认情况下RestTemplate自动帮我们注册了一组HttpMessageConverter用来处理一些不同的contentType的请求。
如StringHttpMessageConverter来处理text/plain;MappingJackson2HttpMessageConverter来处理application/json;MappingJackson2XmlHttpMessageConverter来处理application/xml。
你可以在org.springframework.http.converter包下找到所有spring帮我们实现好的转换器。
如果现有的转换器不能满足你的需求，你还可以实现org.springframework.http.converter.HttpMessageConverter接口自己写一个。详情参考官方api。
选好了HttpMessageConverter后怎么把它注册到我们的RestTemplate中呢
RestTemplate restTemplate = new RestTemplate();
//获取RestTemplate默认配置好的所有转换器
List<HttpMessageConverter<?>> messageConverters = restTemplate.getMessageConverters();
//默认的MappingJackson2HttpMessageConverter在第7个 先把它移除掉
messageConverters.remove(6);
//添加上GSON的转换器
messageConverters.add(6, new GsonHttpMessageConverter());
这个简单的例子展示了如何使用 GsonHttpMessageConverter替换掉默认用来处理application/json的MappingJackson2HttpMessageConverter。
四.设置底层连接方式
要创建一个RestTemplate的实例，您可以像上述例子中简单地调用默认的无参数构造函数。这将使用java.net包中的标准Java类作为底层实现来创建HTTP请求。
但很多时候我们需要像传统的HttpClient那样设置HTTP请求的一些属性。RestTemplate使用了一种很偷懒的方式实现了这个需求，那就是直接使用一个HttpClient作为底层实现......
//生成一个设置了连接超时时间、请求超时时间、异常最大重试次数的httpClient
RequestConfig config = RequestConfig.custom().setConnectionRequestTimeout(10000).setConnectTimeout(10000).setSocketTimeout(30000).build();
HttpClientBuilder builder = HttpClientBuilder.create().setDefaultRequestConfig(config).setRetryHandler(new DefaultHttpRequestRetryHandler(5, false));
HttpClient httpClient = builder.build();
//使用httpClient创建一个ClientHttpRequestFactory的实现
ClientHttpRequestFactory requestFactory = new HttpComponentsClientHttpRequestFactory(httpClient);
//ClientHttpRequestFactory作为参数构造一个使用作为底层的RestTemplate
RestTemplate restTemplate = new RestTemplate(requestFactory);
五、设置拦截器(ClientHttpRequestInterceptor)
有时候我们需要对请求做一些通用的拦截设置，这就可以使用拦截器进行处理。拦截器需要我们实现org.springframework.http.client.ClientHttpRequestInterceptor接口自己写。
举个简单的例子，写一个在header中根据请求内容和地址添加令牌的拦截器。
public class TokenInterceptor implements ClientHttpRequestInterceptor
{
@Override
public ClientHttpResponse intercept(HttpRequest request, byte[] body, ClientHttpRequestExecution execution) throws IOException
{
//请求地址
String checkTokenUrl = request.getURI().getPath();
//token有效时间
int ttTime = (int) (System.currentTimeMillis() / 1000 + 1800);
//请求方法名 POST、GET等
String methodName = request.getMethod().name();
//请求内容
String requestBody = new String(body);
//生成令牌 此处调用一个自己写的方法，有兴趣的朋友可以自行google如何使用ak/sk生成token，此方法跟本教程无关，就不贴出来了
String token = TokenHelper.generateToken(checkTokenUrl, ttTime, methodName, requestBody);
//将令牌放入请求header中
request.getHeaders().add("X-Auth-Token",token);
return execution.execute(request, body);
}
}
创建RestTemplate实例的时候可以这样向其中添加拦截器
RestTemplate restTemplate = new RestTemplate();
//向restTemplate中添加自定义的拦截器
restTemplate.getInterceptors().add(new TokenInterceptor());