HttpClient方式测试本地写好的接口(springboot方式)
1、首先确定好ip、端口号、是否在application-dev.yml中添加项目命名、以及确定接口路径
2、建立HttpClient工具类,代码如下,若是无参,可以传个空参过去即可
注:需要在pom.xml中引入以下jar包
<!-- 引入httpclient --> <dependency> <groupId>org.apache.httpcomponents</groupId> <artifactId>httpclient</artifactId> <version>4.5.12</version> </dependency> <!-- 使用StringUtils,作为判断 --> <dependency> <groupId>org.apache.commons</groupId> <artifactId>commons-lang3</artifactId> <version>3.9</version> </dependency>
<!-- fastjson --> <dependency> <groupId>com.alibaba</groupId> <artifactId>fastjson</artifactId> <version>1.2.70</version> </dependency>
package com.example.saledemo.utils; import java.io.IOException; import java.security.KeyManagementException; import java.security.KeyStoreException; import java.security.NoSuchAlgorithmException; import java.security.cert.CertificateException; import java.security.cert.X509Certificate; import java.util.ArrayList; import java.util.List; import java.util.Map; import javax.net.ssl.SSLContext; import org.apache.commons.lang3.StringUtils; import org.apache.http.HttpEntity; import org.apache.http.NameValuePair; import org.apache.http.ParseException; import org.apache.http.client.config.RequestConfig; 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.impl.client.CloseableHttpClient; import org.apache.http.impl.client.HttpClientBuilder; import org.apache.http.impl.client.HttpClients; import org.apache.http.message.BasicNameValuePair; import org.apache.http.ssl.SSLContextBuilder; import org.apache.http.ssl.TrustStrategy; import org.apache.http.util.EntityUtils; /** * 基于 httpclient 4.5版本的 http工具类 * * @author 刘磊 * */ public class HttpClientTool { private static final CloseableHttpClient httpClient; public static final String CHARSET = "UTF-8"; // 采用静态代码块,初始化超时时间配置,再根据配置生成默认httpClient对象 static { RequestConfig config = RequestConfig.custom().setConnectTimeout(60000).setSocketTimeout(15000).build(); httpClient = HttpClientBuilder.create().setDefaultRequestConfig(config).build(); } public static String doGet(String url, Map<String, String> params) { return doGet(url, params, CHARSET); } public static String doGetSSL(String url, Map<String, String> params) { return doGetSSL(url, params, CHARSET); } public static String doPost(String url, Map<String, String> params) throws IOException { return doPost(url, params, CHARSET); } /** * HTTP Get 获取内容 * @param url 请求的url地址 ?之前的地址 * @param params 请求的参数 * @param charset 编码格式 * @return 页面内容 */ public static String doGet(String url, Map<String, String> params, String charset) { if (StringUtils.isBlank(url)) { return null; } try { if (params != null && !params.isEmpty()) { List<NameValuePair> pairs = new ArrayList<NameValuePair>(params.size()); for (Map.Entry<String, String> entry : params.entrySet()) { String value = entry.getValue(); if (value != null) { pairs.add(new BasicNameValuePair(entry.getKey(), value)); } } // 将请求参数和url进行拼接 url += "?" + EntityUtils.toString(new UrlEncodedFormEntity(pairs, charset)); } HttpGet httpGet = new HttpGet(url); CloseableHttpResponse response = httpClient.execute(httpGet); int statusCode = response.getStatusLine().getStatusCode(); if (statusCode != 200) { httpGet.abort(); throw new RuntimeException("HttpClient,error status code :" + statusCode); } HttpEntity entity = response.getEntity(); String result = null; if (entity != null) { result = EntityUtils.toString(entity, "utf-8"); } EntityUtils.consume(entity); response.close(); return result; } catch (Exception e) { e.printStackTrace(); } return null; } /** * HTTP Post 获取内容 * @param url 请求的url地址 ?之前的地址 * @param params 请求的参数 * @param charset 编码格式 * @return 页面内容 * @throws IOException */ public static String doPost(String url, Map<String, String> params, String charset) throws IOException { if (StringUtils.isBlank(url)) { return null; } List<NameValuePair> pairs = null; if (params != null && !params.isEmpty()) { pairs = new ArrayList<NameValuePair>(params.size()); for (Map.Entry<String, String> entry : params.entrySet()) { String value = entry.getValue(); if (value != null) { pairs.add(new BasicNameValuePair(entry.getKey(), value)); } } } HttpPost httpPost = new HttpPost(url); if (pairs != null && pairs.size() > 0) { httpPost.setEntity(new UrlEncodedFormEntity(pairs, CHARSET)); } CloseableHttpResponse response = null; try { response = httpClient.execute(httpPost); int statusCode = response.getStatusLine().getStatusCode(); if (statusCode != 200) { httpPost.abort(); throw new RuntimeException("HttpClient,error status code :" + statusCode); } HttpEntity entity = response.getEntity(); String result = null; if (entity != null) { result = EntityUtils.toString(entity, "utf-8"); } EntityUtils.consume(entity); return result; } catch (ParseException e) { e.printStackTrace(); } finally { if (response != null) response.close(); } return null; } /** * HTTPS Get 获取内容 * @param url 请求的url地址 ?之前的地址 * @param params 请求的参数 * @param charset 编码格式 * @return 页面内容 */ public static String doGetSSL(String url, Map<String, String> params, String charset) { if (StringUtils.isBlank(url)) { return null; } try { if (params != null && !params.isEmpty()) { List<NameValuePair> pairs = new ArrayList<NameValuePair>(params.size()); for (Map.Entry<String, String> entry : params.entrySet()) { String value = entry.getValue(); if (value != null) { pairs.add(new BasicNameValuePair(entry.getKey(), value)); } } url += "?" + EntityUtils.toString(new UrlEncodedFormEntity(pairs, charset)); } HttpGet httpGet = new HttpGet(url); // https 注意这里获取https内容,使用了忽略证书的方式,当然还有其他的方式来获取https内容 CloseableHttpClient httpsClient = HttpClientTool.createSSLClientDefault(); CloseableHttpResponse response = httpsClient.execute(httpGet); int statusCode = response.getStatusLine().getStatusCode(); if (statusCode != 200) { httpGet.abort(); throw new RuntimeException("HttpClient,error status code :" + statusCode); } HttpEntity entity = response.getEntity(); String result = null; if (entity != null) { result = EntityUtils.toString(entity, "utf-8"); } EntityUtils.consume(entity); response.close(); return result; } catch (Exception e) { e.printStackTrace(); } return null; } /** * 这里创建了忽略整数验证的CloseableHttpClient对象 * @return */ public static CloseableHttpClient createSSLClientDefault() { try { SSLContext sslContext = new SSLContextBuilder().loadTrustMaterial(null, new TrustStrategy() { // 信任所有 public boolean isTrusted(X509Certificate[] chain, String authType) throws CertificateException { return true; } }).build(); SSLConnectionSocketFactory sslsf = new SSLConnectionSocketFactory(sslContext); return HttpClients.custom().setSSLSocketFactory(sslsf).build(); } catch (KeyManagementException e) { e.printStackTrace(); } catch (NoSuchAlgorithmException e) { e.printStackTrace(); } catch (KeyStoreException e) { e.printStackTrace(); } return HttpClients.createDefault(); } }
3、新建一个测试类
package com.example.saledemo.https; import com.alibaba.fastjson.JSONArray; import com.example.saledemo.utils.HttpClientTool; import java.util.HashMap; import java.util.Map; public class HttpMonthSale { // main方法测试接口 public static void main(String[] args) { // 需要传的参数 Map<String,String> params = new HashMap<>(); // 访问的url接口地址,ip:端口号/springboot中指定的项目名/接口路径 String url = "http://localhost:8085/monthticketsale/monthSaleAmount/querySalegoods"; // 获取返回的json字符串 String result = HttpClientTool.doGet(url,params); // System.out.println("result="+result); // 将json字符串转成json数组 JSONArray jsonArray = JSONArray.parseArray(result); // System.out.println(jsonArray); } }
4、写完后,启动idea,将接口项目启动起来,不然在启动main方法时,无法调用(这里一个是接口方项目,另一个是main方法,有先后顺序)
① 先启动接口项目
② 双击main方法,然后run启动main方法项目
5、观察控制台,接口方查询到的数据已经显示在控制台。
idea方式如图:
6、当然,我们往往都是将项目打包成war包的形式或者jar包的形式,通过tomcat(war方式),或者命令行方式(cmd->jar方式),发布到服务器中。和idea不同,idea是在自身编辑器的application-dev.yml这样的文件配置中进行配置的。也就是:
ip+端口号+项目设置的名字+接口--------来进行访问。
若配置中没设置项目命名,那么直接:ip+端口号+接口即可,不需要加项目名。(idea两种方式)
而打包前可以在pom.xml中的build中进行设置,起个名字。如图(tomcat两种方式)
注:<finalName>包名<finalName>,那么起好,clean-package之后,在项目的target文件夹下就会多出一个monthticketsale.war的包。将其复制到tomcat-webapps下,然后到bin目录下双击startup.bat,启动tomcat。完成后到网页输入:
ip+端口号+<finalName>对应的名字+接口即可访问。也就是:http://localhost:8080/monthticketsale/monthSaleAmount/querySalegoods
另一种方式:
在打包的时候不设置名字,那么就会默认artifactId+version的拼接:
ip+端口号+artifactId+version+接口即可访问。也就是:
http://localhost:8080/saledemo-0.0.1-SNAPSHOT/monthSaleAmount/querySalegoods