HttpUtils(调用第三方接口时使用)

文档日志

• 创建文档 2019/12/10 16:31 第一次独立对接第三方，虽然有现成的工具包，但想想还是自己捋一捋吧，手k一遍也加深点映像

代码依赖包

ApacheHttpClient包 密码: f1fj

代码详情

import org.apache.http.NameValuePair;
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.client.utils.URIBuilder;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.message.BasicNameValuePair;
import org.apache.http.util.EntityUtils;

import java.io.IOException;
import java.net.URI;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;

/**
 * Http工具类
 */
public class HttpUtils {
    /**
     *	一、Get请求，携带参数
     *	@Param url		请求地址
     *	@Param param	请求参数
     *	@Param charset	返回值编码集类型
     *  @Return
     */
    public static String doGet(String url, Map<String, String> param, String charset) {
        //	1.1 创建CloseableHttpClient对象
        CloseableHttpClient httpClient = HttpClients.createDefault();
        // 1.2 接口返回值
        String resultStr = "";
        // 1.3 请求执行后返回体
        CloseableHttpResponse response = null;

        try{
            // 2.1 将url地址转为URIBuilder类型，方便对请求的内容进行修改操作
            URIBuilder builder = new URIBuilder(url);

            // 2.2 判断参数是否为空
            if(param != null) {
                // 2.2.1 遍历参数集合param中的key值
                for (String key : param.keySet()) {
                    // 2.2.2 向url中拼接key和对应的值
                    builder.addParameter(key, param.get(key));
                }
            }

            // 2.3 获取拼接参数后的新url
            URI uri = builder.build();

            // 2.4 创建httpGet请求
            HttpGet httpGet = new HttpGet(uri);
            // 2.4.1 设置请求的配置 setSocketTimeout是设置请求返回的超时时间 setConnectTimeout是设置连接超时时间
            RequestConfig requestConfig = RequestConfig.custom().setSocketTimeout(1800000).setConnectTimeout(10000).build();
            // 2.4.2 向请求中装载配置
            httpGet.setConfig(requestConfig);

            // 2.5 执行请求，获取返回体
            response = httpClient.execute(httpGet);
            // 2.5.1 获取请求返回的状态码，并判断是否是200
            if (response.getStatusLine().getStatusCode() == 200) {
                // 2.5.2 获取返回信息并转码
                resultStr = EntityUtils.toString(response.getEntity(), charset);
            }
        } catch (Exception e) {
            e.printStackTrace();
        } finally {
            // 3. 关闭httpClient和response对象
            try {
                if (response != null) {
                    response.close();
                }
                httpClient.close();
            } catch (Exception e) {
                e.printStackTrace();
            }
        }
        return resultStr;
    }

    /**
     * 二、Get请求不携带参数,编码集默认是UTF-8
     * @param url
     * @return
     */
    public static String doGet(String url) {
        return doGet(url, null, "UTF-8");
    }

    /**
     * 三、Get请求携带编码集参数
     * @param url
     * @param charset
     * @return
     */
    public static String doGet(String url, String charset) {
        return doGet(url, null, charset);
    }

    /**
     * 四、Post请求，携带参数
     * 
     * @param url
     * @param param
     * @param charset
     * @return
     */
    public static String doPost(String url, Map<String, String> param, String charset) {
        //	1.1 创建CloseableHttpClient对象
        CloseableHttpClient httpClient = HttpClients.createDefault();
        // 1.2 接口返回值
        String resultStr = "";
        // 1.3 请求执行后返回体
        CloseableHttpResponse response = null;

        try {
            // 2. 创建HttpPost请求
            HttpPost httpPost = new HttpPost(url);

            // 2.1 判断传参是否为null
            if (param != null) {
                // 2.2 拼接paramList
                List<NameValuePair> paramList = new ArrayList<>();
                // 2.2.1 遍历参数集合param
                for (Map.Entry key : param.entrySet()) {
                    // 2.2.2 将每一个键值对拼接到paramList中
                    paramList.add(new BasicNameValuePair(key.getKey().toString(), key.getValue().toString()));
                }
                // 2.3 模拟表单，设置传参编码集
                UrlEncodedFormEntity entity = new UrlEncodedFormEntity(paramList,charset);
                // 2.4 将参数实体追加到请求中
                httpPost.setEntity(entity);
            }

            // 2.5 执行httpPost请求，得到返回体
            response = httpClient.execute(httpPost);
            if(charset == null){
                charset = "UTF-8";
            }

            // 2.5.1 获取请求返回的状态码，并判断是否是200
            if (response.getStatusLine().getStatusCode() == 200) {
                // 2.5.2 获取返回信息并转码
                resultStr = EntityUtils.toString(response.getEntity(), charset);
            }
        } catch (Exception e) {
            e.printStackTrace();
        } finally {
            // 3. 关闭httpClient和response对象
            try {
                response.close();
            } catch (IOException e) {
                e.printStackTrace();
            }
        }
        return resultStr;
    }

    /**
     * 五、不带参POST请求，默认字符集为UTF-8
     * @param url
     * @return
     */
    public static String doPostZ(String url){
        return doPost(url,null,"UTF-8");
    }

    /**
     * 六、不带参，指定字符集POST请求
     * @param url
     * @param charset
     * @return
     */
    public static String doPostZ(String url, String charset){
        return doPost(url,null,charset);
    }

    /**
     * 七、任何字符串格式参数（常用为json格式的字符串当参数）POST请求
     * @param url
     * @param json
     * @param charset
     * @return
     */
    public static String doPostJson(String url, String json, String charset){
        // 1. 创建CloseableHttpClient对象,用于执行请求
        CloseableHttpClient httpClient = HttpClients.createDefault();
        // 2. 接口返回值
        CloseableHttpResponse response = null;
        // 3. 请求执行后返回的信息
        String resultString = ""; 
        try {
            // 4. 创建Http Post请求
            HttpPost httpPost = new HttpPost(url);
            // 4.2 创建请求内容（添加参数）
            StringEntity entity = new StringEntity(json,charset);
            // 4.3 向请求添加请求内容
            httpPost.setEntity(entity);
            // 4.4 执行http请求
            response = httpClient.execute(httpPost);
            // 4.5 接收返回值
            resultString = EntityUtils.toString(response.getEntity(), charset); 
        } catch (Exception e) {
            e.printStackTrace();
        } finally {
            try {
                response.close();
            } catch (IOException e) {
                e.printStackTrace();
            }
        }
        return resultString;
    }
}

小结

• 有了这个工具类之后，具体怎么使用就不多介绍了，有需要改动的就自己去调整，然后直接调用就好。实际上这个工具类中的一些类并不是我经常用到的，也还没有点进去理解过，暂时就先这样，后续再补充，永远进行时