SpringBoot通过HttpClient方式调用Restful接口

浅浅的花香味﹌ 2022-02-25 05:08 1202阅读 0赞

# 前言 #

HttpClient相比于传统jdk自带的URLConnection，增加了易用性和灵活性，它不仅是客户端发送http请求变得容易，而且也方便了开发人员测试接口，提高了开发的效率。HttpClient是Apache Jakarta Common下的子项目，用来提供高效的、最新的、功能丰富的支持HTTP协议的客户端编程工具包，并且它支持HTTP协议最新的版本和建议。  
由于公司业务发展，需要通过springboot服务调用ssm服务，原本打算的是通过dubbo实现这种服务间调用，但是考虑到只要调用一个接口这种方式太浪费了。于是想到了通过httpclient方式实现服务调用

# 实现思路 #

使用HttpClient发送请求、接收响应很简单，一般需要如下几步：

1.  创建HttpClient对象
2.  创建请求方法的实例，并指定请求URL。如果需要发送GET请求，创建HttpGet对象；如果需要发送POST请求，创建HttpPost对象
3.  如果需要发送参数，可调用HttpGet、HttpPost共同的setParams(HetpParams params)方法来添加请求参数；对于HttpPost对象而言，也可调用setEntity(HttpEntity entity)方法来设置请求参数
4.  调用HttpClient对象的execute(HttpUriRequest request)发送请求，该方法返回一个HttpResponse
5.  调用HttpResponse的getAllHeaders()、getHeaders(String name)等方法可获取服务器的响应头；调用HttpResponse的getEntity()方法可获取HttpEntity对象，该对象包装了服务器的响应内容。程序可通过该对象获取服务器的响应内容。
6.  释放连接。无论执行方法是否成功，都必须释放连接

# 实现步骤 #

## pom添加依赖 ##

<dependency>
        <groupId>org.apache.httpcomponents</groupId>
        <artifactId>httpclient</artifactId>
        <version>4.5.4</version>
    </dependency>

## 代码实现 ##

/** * http客户端 * * * @author：刘子腾 * @date：2019年3月20日21:44:06 */
    public class HttpClientTest { 
    
        /** * post请求传输map数据 * * @param url url地址 * @param map map数据 * @param encoding 编码方式 * @return * @throws ClientProtocolException * @throws IOException */
        public static String sendPostDataByMap(String url, Map<String, String> map, String encoding) throws ClientProtocolException, IOException { 
            String result = "";
            // 创建httpclient对象
            CloseableHttpClient httpClient = HttpClients.createDefault();
            // 创建post方式请求对象
            HttpPost httpPost = new HttpPost(url);
            // 装填参数
            List<NameValuePair> nameValuePairs = new ArrayList<NameValuePair>();
            if (map != null) { 
                for (Entry<String, String> entry : map.entrySet()) { 
                    nameValuePairs.add(new BasicNameValuePair(entry.getKey(), entry.getValue()));
                }
            }
    
            // 设置参数到请求对象中
            httpPost.setEntity(new UrlEncodedFormEntity(nameValuePairs, encoding));
    
            // 设置header信息
            // 指定报文头【Content-type】、【User-Agent】
            httpPost.setHeader("Content-type", "application/x-www-form-urlencoded");
            httpPost.setHeader("User-Agent", "Mozilla/4.0 (compatible; MSIE 5.0; Windows NT; DigExt)");
    
            // 执行请求操作，并拿到结果（同步阻塞）
            CloseableHttpResponse response = httpClient.execute(httpPost);
            // 获取结果实体
            // 判断网络连接状态码是否正常(0--200都数正常)
            if (response.getStatusLine().getStatusCode() == HttpStatus.SC_OK) { 
                result = EntityUtils.toString(response.getEntity(), "utf-8");
            }
            // 释放链接
            response.close();
    
            return result;
        }
    
        /** * post请求传输json数据 * * @param url url地址 * @param json json数据 * @param encoding 编码方式 * @return * @throws ClientProtocolException * @throws IOException */
        public static String sendPostDataByJson(String url, String json, String encoding) throws ClientProtocolException, IOException { 
            String result = "";
    
            // 创建httpclient对象
            CloseableHttpClient httpClient = HttpClients.createDefault();
            // 创建post方式请求对象
            HttpPost httpPost = new HttpPost(url);
            // 设置参数到请求对象中
            StringEntity stringEntity = new StringEntity(json, ContentType.APPLICATION_JSON);
            stringEntity.setContentEncoding("utf-8");
            httpPost.setEntity(stringEntity);
    
            // 执行请求操作，并拿到结果（同步阻塞）
            CloseableHttpResponse response = httpClient.execute(httpPost);
    
            // 获取结果实体
            // 判断网络连接状态码是否正常(0--200都数正常)
            if (response.getStatusLine().getStatusCode() == HttpStatus.SC_OK) { 
                result = EntityUtils.toString(response.getEntity(), "utf-8");
            }
            // 释放链接
            response.close();
    
            return result;
        }
    
        /** * get请求传输数据 * * @param url * @param encoding * @return * @throws ClientProtocolException * @throws IOException */
        public String sendGetData(String url, String encoding) throws ClientProtocolException, IOException { 
            String result = "";
    
            // 创建httpclient对象
            CloseableHttpClient httpClient = HttpClients.createDefault();
    
            // 创建get方式请求对象
            HttpGet httpGet = new HttpGet(url);
            httpGet.addHeader("Content-type", "application/json");
            // 通过请求对象获取响应对象
            CloseableHttpResponse response = httpClient.execute(httpGet);
    
            // 获取结果实体
            // 判断网络连接状态码是否正常(0--200都数正常)
            if (response.getStatusLine().getStatusCode() == HttpStatus.SC_OK) { 
                result = EntityUtils.toString(response.getEntity(), "utf-8");
            }
            // 释放链接
            response.close();
    
            return result;
        }
    
        @Test
        public void testSendPostDataByMap() throws ClientProtocolException, IOException { 
            String url = "http://localhost:8080/httpService/sendPostDataByMap";
            Map<String, String> map = new HashMap<String, String>();
            map.put("name", "wyj");
            map.put("city", "南京");
            String body = sendPostDataByMap(url, map, "utf-8");
            System.out.println("响应结果：" + body);
        }
    
        @Test
        public void testSendPostDataByJson() throws ClientProtocolException, IOException { 
            String url = "http://localhost:8080/httpService/sendPostDataByJson";
            Map<String, String> map = new HashMap<String, String>();
            map.put("name", "wyj");
            map.put("city", "南京");
            String body = sendPostDataByJson(url, JSON.toJSONString(map), "utf-8");
            System.out.println("响应结果：" + body);
        }
    
        @Test
        public void testSendGetData() throws ClientProtocolException, IOException { 
            String url = "http://localhost:8080/httpService/sendGetData?name=wyj&city=南京";
            String body = sendGetData(url, "utf-8");
            System.out.println("响应结果：" + body);
        }
    
    }