HttpClient的基本使用

mac2026-06-14  18

——————HttpClient4.510 API参考 点我进入

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等)等支持自动(跳转)转向……

HttpClient接口有两个比较常用的实现类,DefaultHttpClient和CloseableHttpClient,不过在较新版本中DefaultHttpClient已经被弃用,现在用得较多的是CloseableHttpClient。

使用HttpClient发送请求的一般步骤 

1、创建HttpClient对象,本文中使用CloseableHttpClient对象。

2、创建请求方法的实例,并指定请求URL。如果需要发送GET请求,创建HttpGet对象;如果需要发送POST请求,创建HttpPost对象。 

3、如果需要发送请求参数,可调用HttpGet同的setParams(HetpParams params)方法来添加请求参数;对于HttpPost对象而言,可调用setEntity(HttpEntity entity)方法来设置请求参数。

4、调用HttpClient对象的execute(HttpUriRequest request)发送请求,该方法返回一个HttpResponse,本文使用它的实现类CloseableHttpResponse。 

5、调用HttpResponse的getAllHeaders()、getHeaders(String name)等方法可获取服务器的响应头;调用HttpResponse的getEntity()方法可获取HttpEntity对象,该对象包装了服务器的响应内容。程序可通过该对象获取服务器的响应内容。

6、释放连接。无论执行方法是否成功,都必须释放连接

需要引入的依赖

GET无参请求:

HttpClient发送示例:

  /**      * GET---无参测试      *      * @date 2018年7月13日 下午4:18:50      */     @Test     public void doGetTestOne() {         // 获得Http客户端(可以理解为:你得先有一个浏览器;注意:实际上HttpClient与浏览器是不一样的)         CloseableHttpClient httpClient = HttpClientBuilder.create().build();         // 创建Get请求         HttpGet httpGet = new HttpGet("http://localhost:12345/doGetControllerOne");           // 响应模型         CloseableHttpResponse response = null;         try {             // 由客户端执行(发送)Get请求             response = httpClient.execute(httpGet);             // 从响应模型中获取响应实体             HttpEntity responseEntity = response.getEntity();             System.out.println("响应状态为:" + response.getStatusLine());             if (responseEntity != null) {                 System.out.println("响应内容长度为:" + responseEntity.getContentLength());                 System.out.println("响应内容为:" + EntityUtils.toString(responseEntity));             }         } 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();             }         }     }

GET有参

(方式一:直接拼接URL):

HttpClient发送示例:

  /**      * GET---有参测试 (方式一:手动在url后面加上参数)      *      * @date 2018年7月13日 下午4:19:23      */     @Test     public void doGetTestWayOne() {         // 获得Http客户端(可以理解为:你得先有一个浏览器;注意:实际上HttpClient与浏览器是不一样的)         CloseableHttpClient httpClient = HttpClientBuilder.create().build();           // 参数         StringBuffer params = new StringBuffer();         try {             // 字符数据最好encoding一下;这样一来,某些特殊字符才能传过去(如:某人的名字就是“&”,不encoding的话,传不过去)             params.append("name=" + URLEncoder.encode("&", "utf-8"));             params.append("&");             params.append("age=24");         } catch (UnsupportedEncodingException e1) {             e1.printStackTrace();         }           // 创建Get请求         HttpGet httpGet = new HttpGet("http://localhost:12345/doGetControllerTwo" + "?" + params);         // 响应模型         CloseableHttpResponse response = null;         try {             // 配置信息             RequestConfig requestConfig = RequestConfig.custom()                     // 设置连接超时时间(单位毫秒)                     .setConnectTimeout(5000)                     // 设置请求超时时间(单位毫秒)                     .setConnectionRequestTimeout(5000)                     // socket读写超时时间(单位毫秒)                     .setSocketTimeout(5000)                     // 设置是否允许重定向(默认为true)                     .setRedirectsEnabled(true).build();               // 将上面的配置信息 运用到这个Get请求里             httpGet.setConfig(requestConfig);               // 由客户端执行(发送)Get请求             response = httpClient.execute(httpGet);               // 从响应模型中获取响应实体             HttpEntity responseEntity = response.getEntity();             System.out.println("响应状态为:" + response.getStatusLine());             if (responseEntity != null) {                 System.out.println("响应内容长度为:" + responseEntity.getContentLength());                 System.out.println("响应内容为:" + EntityUtils.toString(responseEntity));             }         } 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();             }         }     }

(方式二:使用URI获得HttpGet)

/** * GET---有参测试 (方式二:将参数放入键值对类中,再放入URI中,从而通过URI得到HttpGet实例) * * @date 2018年7月13日 下午4:19:23 */ @Test public void doGetTestWayTwo() { // 获得Http客户端(可以理解为:你得先有一个浏览器;注意:实际上HttpClient与浏览器是不一样的) CloseableHttpClient httpClient = HttpClientBuilder.create().build(); // 参数 URI uri = null; try { // 将参数放入键值对类NameValuePair中,再放入集合中,类似于List<Map> List<NameValuePair> params = new ArrayList<>(); params.add(new BasicNameValuePair("name", "&")); params.add(new BasicNameValuePair("age", "18")); // 设置uri信息,并将参数集合放入uri; // 注:这里也支持一个键值对一个键值对地往里面放setParameter(String key, String value) uri = new URIBuilder().setScheme("http").setHost("localhost") .setPort(12345).setPath("/doGetControllerTwo") .setParameters(params).build(); } catch (URISyntaxException e1) { e1.printStackTrace(); } // 创建Get请求 HttpGet httpGet = new HttpGet(uri); // 响应模型 CloseableHttpResponse response = null; try { // 配置信息 RequestConfig requestConfig = RequestConfig.custom() // 设置连接超时时间(单位毫秒) .setConnectTimeout(5000) // 设置请求超时时间(单位毫秒) .setConnectionRequestTimeout(5000) // socket读写超时时间(单位毫秒) .setSocketTimeout(5000) // 设置是否允许重定向(默认为true) .setRedirectsEnabled(true).build(); // 将上面的配置信息 运用到这个Get请求里 httpGet.setConfig(requestConfig); // 由客户端执行(发送)Get请求 response = httpClient.execute(httpGet); // 从响应模型中获取响应实体 HttpEntity responseEntity = response.getEntity(); System.out.println("响应状态为:" + response.getStatusLine()); if (responseEntity != null) { System.out.println("响应内容长度为:" + responseEntity.getContentLength()); System.out.println("响应内容为:" + EntityUtils.toString(responseEntity)); } } 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(); } } }

POST无参:

HttpClient发送示例:

    /**      * POST---无参测试      *      * @date 2018年7月13日 下午4:18:50      */     @Test     public void doPostTestOne() {           // 获得Http客户端(可以理解为:你得先有一个浏览器;注意:实际上HttpClient与浏览器是不一样的)         CloseableHttpClient httpClient = HttpClientBuilder.create().build();           // 创建Post请求         HttpPost httpPost = new HttpPost("http://localhost:12345/doPostControllerOne");         // 响应模型         CloseableHttpResponse response = null;         try {             // 由客户端执行(发送)Post请求             response = httpClient.execute(httpPost);             // 从响应模型中获取响应实体             HttpEntity responseEntity = response.getEntity();               System.out.println("响应状态为:" + response.getStatusLine());             if (responseEntity != null) {                 System.out.println("响应内容长度为:" + responseEntity.getContentLength());                 System.out.println("响应内容为:" + EntityUtils.toString(responseEntity));             }         } 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();             }         }     }

Post有参

Post也可以和Get请求一样将参数放在URL中,方式和Get请求的代码类似。另外也可以将参数放在请求体中

/** * POST---有参测试(对象参数) * * @date 2018年7月13日 下午4:18:50 */ @Test public void doPostTestTwo() { // 获得Http客户端(可以理解为:你得先有一个浏览器;注意:实际上HttpClient与浏览器是不一样的) CloseableHttpClient httpClient = HttpClientBuilder.create().build(); // 创建Post请求 HttpPost httpPost = new HttpPost("http://localhost:12345/doPostControllerTwo"); User user = new User(); user.setName("潘晓婷"); user.setAge(18); user.setGender("女"); user.setMotto("姿势要优雅~"); // 我这里利用阿里的fastjson,将Object转换为json字符串; // (需要导入com.alibaba.fastjson.JSON包) String jsonString = JSON.toJSONString(user); StringEntity entity = new StringEntity(jsonString, "UTF-8"); // 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) { System.out.println("响应内容长度为:" + responseEntity.getContentLength()); System.out.println("响应内容为:" + EntityUtils.toString(responseEntity)); } } 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(); } } }

补充

解决响应乱码问题(示例):

application/x-www-form-urlencoded表单请求(示例):

使用 UrlEncodedFormEntity 来设置 body,消息体内容类似于“KEY1=VALUE1&KEY2=VALUE2&...”这种形式,服务端接收以后也要依据这种协议形式做处理。

有时候我们不想使用上述格式来传值,而是想使用json格式来设置body,就可以使用StringEntity。

JSONObject jsonObject = new JSONObject(); jsonObject.put("KEY1", "VALUE1"); jsonObject.put("KEY2", "VALUE2"); httpPost.setEntity(new StringEntity(jsonObject.toString()));

其实采用StringEntity的话形式就比较自由了,除了json你也可以使用其它任意的字符串,只要服务端能做相应处理即可。

最新回复(0)