所在位置：首页 → 编程语言 → Java → httpclient教程三：get、post、put、delete请求实现

httpclient教程三：get、post、put、delete请求实现

发布： 更新时间：2022-10-22 21:26:11

一、get请求实现

1.无请求头

public static final Charset CHARSET_DEFAULT = StandardCharsets.UTF_8;
/**
 * 无请求头信息的get()请求
 *
 * @param url API请求地址
 * @return 请求响应完整信息
 */
public static CloseableHttpResponse get(String url) {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet httpGet = new HttpGet(url);
    CloseableHttpResponse response = null;
    try {
        response = httpClient.execute(httpGet);
    } catch (IOException e) {
        LOGGER.error("get请求执行异常：\n");
        e.printStackTrace();
    }
    return response;
}

2.带请求头

/**
 * 带请求头的get()请求
 *
 * @param url     API请求地址
 * @param headers 请求头，使用Map键值对方式传入
 * @return 请求响应完整信息
 */
public static CloseableHttpResponse get(String url, HashMap<String, String> headers) {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet httpGet = new HttpGet(url);
    for (HashMap.Entry<String, String> entry : headers.entrySet()) {
        httpGet.setHeader(entry.getKey(), entry.getValue());
    }
    CloseableHttpResponse response = null;
    try {
        response = httpClient.execute(httpGet);
    } catch (IOException e) {
        LOGGER.error("get请求执行异常：\n");
        e.printStackTrace();
    }
    return response;
}

3.带请求头和参数

/**
 * 带请求头和额外参数的get()请求
 *
 * @param url        API请求地址
 * @param headers    请求头，使用Map键值对方式传入
 * @param parameters 请求参数使用NameValuePair键值对方式传入,使用方式如下
 *                   List<NameValuePair> parameters=new ArrayList<>();
 *                   parameters.add(new BasicNameValuePair("page","2")) ;
 *                   parameters.add(new BasicNameValuePair("token","tokenvalue")) ;
 *                   此方法需要所有的参数都在此传入不能一半直接写在url，一半在这里传参
 * @return 请求响应完整信息
 */
public static CloseableHttpResponse get(String url, HashMap<String, String> headers, List<NameValuePair> parameters) {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    URLEncodedUtils.format(parameters, CHARSET_DEFAULT);
    url = String.format("%s%s", url, new URIBuilder().addParameters(parameters));
    HttpGet httpGet = new HttpGet(url);
    for (HashMap.Entry<String, String> entry : headers.entrySet()) {
        httpGet.setHeader(entry.getKey(), entry.getValue());
    }

    CloseableHttpResponse response = null;
    try {
        response = httpClient.execute(httpGet);
    } catch (IOException e) {
        LOGGER.error("get请求执行异常：\n");
        e.printStackTrace();
    }
    return response;
}

4.无请求头有参数

/**
 * 无请求头，有额外参数的get()请求
 *
 * @param url        API请求地址
 * @param parameters 请求参数使用NameValuePair键值对方式传入,使用方式如下
 *                   List<NameValuePair> parameters=new ArrayList<>();
 *                   parameters.add(new BasicNameValuePair("page","2")) ;
 *                   parameters.add(new BasicNameValuePair("token","tokenvalue")) ;
 *                   此方法需要所有的参数都在此传入不能一半直接写在url，一半在这里传参
 * @return 请求响应完整信息
 */
public static CloseableHttpResponse get(String url, List<NameValuePair> parameters) {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    URLEncodedUtils.format(parameters, CHARSET_DEFAULT);
    url = String.format("%s%s", url, new URIBuilder().addParameters(parameters));
    HttpGet httpGet = new HttpGet(url);

    CloseableHttpResponse response = null;
    try {
        response = httpClient.execute(httpGet);
    } catch (IOException e) {
        LOGGER.error("get请求执行异常：\n");
        e.printStackTrace();
    }
    return response;
}

二、post请求实现

1.无请求头，无参数

   /**
     * 无请求头,无参数信息的post()请求
     *
     * @param url API请求地址
     * @return 请求响应完整信息
     */
    public static CloseableHttpResponse post(String url) {
        CloseableHttpClient httpClient = HttpClients.createDefault();
        HttpPost httpPost = new HttpPost(url);
        CloseableHttpResponse response = null;
        try {
            response = httpClient.execute(httpPost);
        } catch (IOException e) {
            LOGGER.error("post请求执行异常：" + url+ "\n");
            e.printStackTrace();
        }
        return response;
    }

2.带请求头，无参数

/**
 * 带请求头、无参数的post()请求
 *
 * @param url     API请求地址
 * @param headers 请求头，使用Map键值对方式传入
 * @return 请求响应完整信息
 */
public static CloseableHttpResponse post(String url, HashMap<String, String> headers) {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpPost httpPost = new HttpPost(url);
    for (HashMap.Entry<String, String> entry : headers.entrySet()) {
        httpPost.setHeader(entry.getKey(), entry.getValue());
    }
    CloseableHttpResponse response = null;
    try {
        response = httpClient.execute(httpPost);
    } catch (IOException e) {
        LOGGER.error("post请求执行异常：" + url+ "\n");
        e.printStackTrace();
    }
    return response;
}

3.带请求头和参数

通过表单传参：

/**
 * 带请求头和参数的post()请求,通过表单（键值对）传参
 *
 * @param url        API请求地址
 * @param headers    请求头，使用Map键值对方式传入
 * @param parameters 请求参数使用NameValuePair键值对方式传入,使用方式如下
 *                   List<NameValuePair> parameters=new ArrayList<>();
 *                   parameters.add(new BasicNameValuePair("page","2")) ;
 *                   parameters.add(new BasicNameValuePair("token","tokenvalue")) ;
 * @return 请求响应完整信息
 */
public static CloseableHttpResponse post(String url, HashMap<String, String> headers, List<NameValuePair> parameters) {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    UrlEncodedFormEntity entity = new UrlEncodedFormEntity(parameters, CHARSET_DEFAULT);
    HttpPost httpPost = new HttpPost(url);
    httpPost.setEntity(entity);
    for (HashMap.Entry<String, String> entry : headers.entrySet()) {
        httpPost.setHeader(entry.getKey(), entry.getValue());
    }

    CloseableHttpResponse response = null;
    try {
        response = httpClient.execute(httpPost);
    } catch (IOException e) {
        LOGGER.error("post请求执行异常：" + url+ "\n");
        e.printStackTrace();
    }
    return response;
}

通过body传参：

/**
 * 有请求头，有额外参数的post()请求，通过body传参
 *
 * @param url        API请求地址
 * @param headers    请求头，使用Map键值对方式传入
 * @param bodyEntity body请求实体
 * @return 请求响应完整信息
 */
public static CloseableHttpResponse post(String url, HashMap<String, String> headers, String bodyEntity) {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    StringEntity entity = new StringEntity(bodyEntity, CHARSET_DEFAULT);
    HttpPost httpPost = new HttpPost(url);
    httpPost.setEntity(entity);
    for (HashMap.Entry<String, String> entry : headers.entrySet()) {
        httpPost.setHeader(entry.getKey(), entry.getValue());
    }
    CloseableHttpResponse response = null;
    try {
        response = httpClient.execute(httpPost);
    } catch (IOException e) {
        LOGGER.error("post请求执行异常：" + url+ "\n");
        e.printStackTrace();
    }
    return response;
}

4.无请求头，有参数

通过表单传参：

/**
 * 无请求头，有额外参数的post()请求，通过表单（键值对）传参
 *
 * @param url        API请求地址
 * @param parameters 请求参数使用NameValuePair键值对方式传入,使用方式如下
 *                   List<NameValuePair> parameters=new ArrayList<>();
 *                   parameters.add(new BasicNameValuePair("page","2")) ;
 *                   parameters.add(new BasicNameValuePair("token","tokenvalue")) ;
 * @return 请求响应完整信息
 */
public static CloseableHttpResponse post(String url, List<NameValuePair> parameters) {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    UrlEncodedFormEntity entity = new UrlEncodedFormEntity(parameters, CHARSET_DEFAULT);
    HttpPost httpPost = new HttpPost(url);
    httpPost.setEntity(entity);
    CloseableHttpResponse response = null;
    try {
        response = httpClient.execute(httpPost);
    } catch (IOException e) {
        LOGGER.error("post请求执行异常：" + url+ "\n");
        e.printStackTrace();
    }
    return response;
}

通过body传参：

/**
 * 无请求头，有额外参数的post()请求，通过body传参
 *
 * @param url        API请求地址
 * @param bodyEntity body请求实体
 * @return 请求响应完整信息
 */
public static CloseableHttpResponse post(String url, String bodyEntity) {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    StringEntity entity = new StringEntity(bodyEntity, CHARSET_DEFAULT);
    HttpPost httpPost = new HttpPost(url);
    httpPost.setEntity(entity);
    CloseableHttpResponse response = null;
    try {
        response = httpClient.execute(httpPost);
    } catch (IOException e) {
        LOGGER.error("post请求执行异常：" + url+ "\n");
        e.printStackTrace();
    }
    return response;
}

三、带文件上传的post请求实现

/**
 * 带有文件上传的post请求，只有请求头与文件信息，没有额外参数
 *
 * @param url      API请求地址
 * @param headers  请求头，使用Map键值对方式传入
 * @param file     要上传的文件
 * @param pairName 上传文件对应的参数名称
 * @param fileType 上传文件对应的MIME类型,如 MIMEType.MIME_DOC
 * @return 请求响应完整信息
 */
public static CloseableHttpResponse postUpload(String url, HashMap<String, String> headers, File file, String pairName, String fileType) {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpPost httpPost = new HttpPost(url);

    //设置请求实体为浏览器兼容模式，防止上传中文文件名乱码
    HttpMultipartMode mode = HttpMultipartMode.BROWSER_COMPATIBLE;
    MultipartEntityBuilder multipartEntityBuilder = MultipartEntityBuilder.create().setMode(mode);

    //实体中插入文件信息，设置编码方式
    ContentType fileContentType = ContentType.create(fileType, CHARSET_DEFAULT);
    multipartEntityBuilder.addBinaryBody(pairName, file, fileContentType, file.getName());
    multipartEntityBuilder.setCharset(CHARSET_DEFAULT);

    HttpEntity entity = multipartEntityBuilder.build();
    httpPost.setEntity(entity);

    for (HashMap.Entry<String, String> entry : headers.entrySet()) {
        httpPost.setHeader(entry.getKey(), entry.getValue());
    }

    CloseableHttpResponse response = null;
    try {
        response = httpClient.execute(httpPost);
    } catch (IOException e) {
        LOGGER.error("postUpload请求执行异常：" + url+ "\n");
        e.printStackTrace();
    }
    return response;
}

/**
 * 带有文件上传的post请求，除请求头与文件信息外，还包含有额外参数
 *
 * @param url        API请求地址
 * @param headers    请求头，使用Map键值对方式传入
 * @param parameters 请求参数使用NameValuePair键值对方式传入,使用方式如下
 *                   List<NameValuePair> parameters=new ArrayList<>();
 *                   parameters.add(new BasicNameValuePair("page","2")) ;
 *                   parameters.add(new BasicNameValuePair("token","tokenvalue")) ;
 * @param file       要上传的文件
 * @param pairName   上传文件对应的参数名称
 * @param fileType   上传文件对应的MIME类型,如 MIMEType.MIME_DOC
 * @return 请求响应完整信息
 */
public static CloseableHttpResponse postUpload(String url, HashMap<String, String> headers, List<NameValuePair> parameters, File file, String pairName, String fileType) {

    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpPost httpPost = new HttpPost(url);

    //设置请求实体为浏览器兼容模式，防止上传中文文件名乱码
    HttpMultipartMode mode = HttpMultipartMode.BROWSER_COMPATIBLE;
    MultipartEntityBuilder multipartEntityBuilder = MultipartEntityBuilder.create().setMode(mode);

    //实体中插入文件信息，设置编码方式
    ContentType fileContentType = ContentType.create(fileType, CHARSET_DEFAULT);
    multipartEntityBuilder.addBinaryBody(pairName, file, fileContentType, file.getName());
    multipartEntityBuilder.setCharset(CHARSET_DEFAULT);

    //实体中插入其他表单参数信息
    for (NameValuePair pair : parameters) {
        ContentType contentType = ContentType.create("text/plain", CHARSET_DEFAULT);
        StringBody value = new StringBody(pair.getValue(), contentType);
        multipartEntityBuilder.addPart(pair.getName(), value);
 //     multipartEntityBuilder.addTextBody(pair.getName(),pair.getValue()) ;  //使用这个会导致参数中文乱码
    }

    HttpEntity entity = multipartEntityBuilder.build();
    httpPost.setEntity(entity);
    //插入请求头信息
    for (HashMap.Entry<String, String> entry : headers.entrySet()) {
        httpPost.setHeader(entry.getKey(), entry.getValue());
    }
    CloseableHttpResponse response = null;
    try {
        //执行请求
        response = httpClient.execute(httpPost);
    } catch (IOException e) {
        LOGGER.error("postUpload请求执行异常：" + url+ "\n");
        e.printStackTrace();
    }
    return response;
}

/**
 * 带有文件上传的post请求，只文件信息和额外参数，没有请求头
 *
 * @param url        API请求地址
 * @param parameters 请求参数使用NameValuePair键值对方式传入,使用方式如下
 *                   List<NameValuePair> parameters=new ArrayList<>();
 *                   parameters.add(new BasicNameValuePair("page","2")) ;
 *                   parameters.add(new BasicNameValuePair("token","tokenvalue")) ;
 * @param file       要上传的文件
 * @param pairName   上传文件对应的参数名称
 * @param fileType   上传文件对应的MIME类型,如 MIMEType.MIME_DOC
 * @return 请求响应完整信息
 */
public static CloseableHttpResponse postUpload(String url, List<NameValuePair> parameters, File file, String pairName, String fileType) {

    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpPost httpPost = new HttpPost(url);

    //设置请求实体为浏览器兼容模式，防止上传中文文件名乱码
    HttpMultipartMode mode = HttpMultipartMode.BROWSER_COMPATIBLE;
    MultipartEntityBuilder multipartEntityBuilder = MultipartEntityBuilder.create().setMode(mode);

    //实体中插入文件信息，设置编码方式
    ContentType fileContentType = ContentType.create(fileType, CHARSET_DEFAULT);
    multipartEntityBuilder.addBinaryBody(pairName, file, fileContentType, file.getName());
    multipartEntityBuilder.setCharset(CHARSET_DEFAULT);

    //实体中插入其他表单参数信息
    for (NameValuePair pair : parameters) {
        ContentType contentType = ContentType.create("text/plain", CHARSET_DEFAULT);
        StringBody value = new StringBody(pair.getValue(), contentType);
        multipartEntityBuilder.addPart(pair.getName(), value);
	//  multipartEntityBuilder.addTextBody(pair.getName(),pair.getValue()) ;  //使用这个会导致参数中文乱码
    }

    HttpEntity entity = multipartEntityBuilder.build();
    httpPost.setEntity(entity);

    CloseableHttpResponse response = null;
    try {
        //执行请求
        response = httpClient.execute(httpPost);
    } catch (IOException e) {
        LOGGER.error("postUpload请求执行异常：" + url+ "\n");
        e.printStackTrace();
    }
    return response;
}

四、put与delete 请求

put请求与post请求实现基本一致，把对应请求方式由post更换成put即可
delete请求与get请求实现基本一致，把对应的请求方式由get更换为delete即可

标签：, ,
上一篇：Jmeter实现RPC接口测试简洁化需求下一篇：httpclient教程二：详细执行原理详解
文章排行

©2021-2022 三酷猫软件站 版权所有
本站所有资源均来自互联网收集整理，如侵犯了您的利益，请通过邮件与我们联系：zhixiazyw@163.com (商务合作联系方式同上)

备案号：鄂ICP备19031406号-29