httpClient笔记_java

参考博客http://t.csdn.cn/Ylcy6

httpClient 1.简介

百度百科
HttpClient 是Apache Jakarta Common 下的子项目，可以用来提供高效的、最新的、功能丰富的支持 HTTP 协议的客户端编程工具包，并且它支持 HTTP 协议最新的版本和建议。

HTTP 协议是 Internet 上使用得最多、最重要的协议之一，越来越多的 Java 应用程序需要直接通过 HTTP 协议来访问网络资源。虽然在 JDK 的 java net包中已经提供了访问 HTTP 协议的基本功能，但是对于大部分应用程序来说，JDK 库本身提供的功能还不够丰富和灵活。HttpClient 是 Apache Jakarta Common 下的子项目，用来提供高效的、最新的、功能丰富的支持 HTTP 协议的客户端编程工具包，并且它支持 HTTP 协议最新的版本和建议。HttpClient 已经应用在很多的项目中，比如 Apache Jakarta 上很著名的另外两个开源项目 Cactus 和 HTMLUnit 都使用了 HttpClient。Commons HttpClient项目现已终止，不再开发。它已被Apache HttpComponents项目里的HttpClient和HttpCore模块取代，它们提供了更好的性能和更大的灵活性。

个人理解

我在学习微服务的时候，发现了这个没有学习的知识点，于是就需要进行补救。在微服务中，我们需要在一个模块中调用另一个模块的内容，那么我们就需要使用浏览器地址进行调用另一个项目，所以我们需要使用这个技术

2.搭建环境

创建一个springboot的web环境，使用jdk1.8

导入两个依赖


<dependency>
    <groupId>org.apache.httpcomponentsgroupId>
    <artifactId>httpclientartifactId>
dependency>


<dependency>
    <groupId>com.alibabagroupId>
    <artifactId>fastjsonartifactId>
    <version>1.2.79version>
dependency>

3.GET无参

在调用另一个项目的地址时，调用无参的get请求时的写法如下：

直接在test中进行测试

@Test
void doGetTestOne() {
    //1.获得Http客户端(可以理解为:你得先有一个浏览器;注意:实际上HttpClient与浏览器是不一样的)
    CloseableHttpClient httpClient = HttpClientBuilder.create().build();

    //2.创建get请求
    HttpGet httpGet = new HttpGet("http://localhost:8080/doGetControllerOne");

    //3.响应模型  定义在外面的原因是后面的finally需要进行释放资源
    CloseableHttpResponse response = null;

    try {

        // 3.由客户端执行(发送)Get请求
        response = httpClient.execute(httpGet);
        // 4.从响应模型中获取响应实体
        HttpEntity responseEntity = response.getEntity();
        
        //输出
        System.out.println("响应状态为:" + response.getStatusLine());
        if (responseEntity != null) {
            System.out.println("响应内容长度为:" + responseEntity.getContentLength());
            System.out.println("响应内容为:" + EntityUtils.toString(responseEntity));
        }
    } catch (IOException e) {
        e.printStackTrace();
    }finally {

        try {
            // 释放资源
            if (httpClient != null) {
                httpClient.close();
            }
            if (response != null) {
                response.close();
            }
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
}

编写controller

@RestController
public class doGetController {
    @RequestMapping("/doGetControllerOne")
    public String doGetControllerOne(){
        return "123";
    }
}

测试方式：

先启动boot然后再运行测试样例最后得到结果

4.GET有参 4.1使用字符串拼接URL

Controller

@RequestMapping("/doGetControllerTwo")
public String doGetControllerTwo(String name,Integer age){
    return name+"的年龄为"+age;
}

test

//get方式有参  直接拼接URL
@Test
void doGetTestTwo(){
    CloseableHttpClient httpClient = HttpClientBuilder.create().build();

    StringBuffer params = new StringBuffer();

    try {
        //人的名字就叫 &
        params.append("name="+ URLEncoder.encode("&","UTF-8"));
        params.append("&");
        params.append("age=24");
    } catch (UnsupportedEncodingException e) {
        e.printStackTrace();
    }

    HttpGet httpGet = new HttpGet("http://localhost:8080/doGetControllerTwo?" + params);

    CloseableHttpResponse response = null;

    // 配置信息
    RequestConfig requestConfig = RequestConfig.custom()
        // 设置连接超时时间(单位毫秒)
        .setConnectTimeout(5000)
        // 设置请求超时时间(单位毫秒)
        .setConnectionRequestTimeout(5000)
        // socket读写超时时间(单位毫秒)
        .setSocketTimeout(5000)
        // 设置是否允许重定向(默认为true)
        .setRedirectsEnabled(true).build();

    // 将上面的配置信息 运用到这个Get请求里
    httpGet.setConfig(requestConfig);

    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 (IOException e) {
        e.printStackTrace();
    }finally {

        // 释放资源
        if (httpClient != null) {
            try {
                httpClient.close();
            } catch (IOException e) {
                e.printStackTrace();
            }
        }
        if (response != null) {
            try {
                response.close();
            } catch (IOException e) {
                e.printStackTrace();
            }
        }
    }
}

结果

4.2使用URI获得HttpGet

将参数放入键值对类中,再放入URI中,从而通过URI得到HttpGet实例

Controller

@RequestMapping("/doGetControllerThree")
public String doGetControllerThree(String name,Integer age){
    return name+"的年龄为"+age;
}

test

//get方式有参  使用URI获得HttpGet
@Test
void doGetTestThree(){
    // 获得Http客户端(可以理解为:你得先有一个浏览器;注意:实际上HttpClient与浏览器是不一样的)
    CloseableHttpClient httpClient = HttpClientBuilder.create().build();

    // 参数
    URI uri = null;
    try {
        // 将参数放入键值对类NameValuePair中,再放入集合中
        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(8080).setPath("/doGetControllerThree")
            .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 (IOException e) {
        e.printStackTrace();
    } finally {
        try {
            // 释放资源
            if (httpClient != null) {
                httpClient.close();
            }
            if (response != null) {
                response.close();
            }
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
}

结果

5.POST无参

之前是使用HttpGet对象传递请求，现在是HttpPost对象

Controller

@RequestMapping("/doPostControllerOne")
public String doPostControllerOne(){
    return "123";
}

test

//post无参
@Test
void doPostTestOne(){
    // 获得Http客户端(可以理解为:你得先有一个浏览器;注意:实际上HttpClient与浏览器是不一样的)
    CloseableHttpClient httpClient = HttpClientBuilder.create().build();

    // 创建Post请求  使用的是HttpPost
    HttpPost httpPost = new HttpPost("http://localhost:8080/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 (IOException e) {
        e.printStackTrace();
    } finally {
        try {
            // 释放资源
            if (httpClient != null) {
                httpClient.close();
            }
            if (response != null) {
                response.close();
            }
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
}

结果

6.POST有参 6.1普通参数

注：POST传递普通参数时，方式与GET一样即可，这里以直接在url后缀上参数的方式示例。

Controller

@RequestMapping("/doPostControllerTwo")
public String doPostControllerTwo(String name,Integer age){
    return name+"的年龄为"+age;
}

test

//post有参 普通参数
@Test
void doPostTestTwo(){
    // 获得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();
    }

    // 创建Post请求
    HttpPost httpPost = new HttpPost("http://localhost:8080/doPostControllerTwo" + "?" + params);

    // 设置ContentType(注:如果只是传普通参数的话,ContentType不一定非要用application/json)
    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 (IOException e) {
        e.printStackTrace();
    } finally {
        try {
            // 释放资源
            if (httpClient != null) {
                httpClient.close();
            }
            if (response != null) {
                response.close();
            }
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
}

结果

6.2参数是一个对象

实体类注：需要导入lombok

@Data
@AllArgsConstructor
@NoArgsConstructor
@ToString
public class User {
    private String name;
    private Integer age;
    private String gender;
    private String motto;//座右铭
}

Controller

@RequestMapping(value="/doPostControllerThree",method= RequestMethod.POST)
public String doPostControllerThree(@RequestBody User user){
    return user.toString();
}

test

//post有参 参数是一个对象
@Test
void doPostTestThree(){
    // 获得Http客户端(可以理解为:你得先有一个浏览器;注意:实际上HttpClient与浏览器是不一样的)
    CloseableHttpClient httpClient = HttpClientBuilder.create().build();

    // 创建Post请求
    HttpPost httpPost = new HttpPost("http://localhost:8080/doPostControllerThree");
    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 (IOException e) {
        e.printStackTrace();
    } finally {
        try {
            // 释放资源
            if (httpClient != null) {
                httpClient.close();
            }
            if (response != null) {
                response.close();
            }
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
}

结果

6.3参数是对象+普通参数

注：POST传递普通参数时，方式与GET一样即可，这里以通过URI获得HttpPost的方式为例。

实体类和上面的相同

Controller

@RequestMapping(value = "/doPostControllerFour",method = RequestMethod.POST)
public String doPostControllerFour(@RequestBody User user,Integer flag,String meaning){
    return user.toString()+"\n"+flag+">>>"+meaning;

}

test

//post有参 参数是一个对象+普通参数
@Test
void doPostTestFour(){
    // 获得Http客户端(可以理解为:你得先有一个浏览器;注意:实际上HttpClient与浏览器是不一样的)
    CloseableHttpClient httpClient = HttpClientBuilder.create().build();

    // 创建Post请求
    // 参数
    URI uri = null;
    try {
        // 将参数放入键值对类NameValuePair中,再放入集合中
        List<NameValuePair> params = new ArrayList<>();
        params.add(new BasicNameValuePair("flag", "4"));
        params.add(new BasicNameValuePair("meaning", "这是什么鬼？"));
        // 设置uri信息,并将参数集合放入uri;
        // 注:这里也支持一个键值对一个键值对地往里面放setParameter(String key, String value)
        uri = new URIBuilder().setScheme("http").setHost("localhost").setPort(8080)
            .setPath("/doPostControllerFour").setParameters(params).build();
    } catch (URISyntaxException e1) {
        e1.printStackTrace();
    }

    HttpPost httpPost = new HttpPost(uri);
    // HttpPost httpPost = new
    // HttpPost("http://localhost:12345/doPostControllerThree1");

    // 创建user参数
    User user = new User();
    user.setName("潘晓婷");
    user.setAge(18);
    user.setGender("女");
    user.setMotto("姿势要优雅~");

    // 将user对象转换为json字符串，并放入entity中
    StringEntity entity = new StringEntity(JSON.toJSONString(user), "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 (IOException e) {
        e.printStackTrace();
    } finally {
        try {
            // 释放资源
            if (httpClient != null) {
                httpClient.close();
            }
            if (response != null) {
                response.close();
            }
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
}

结果

欢迎分享，转载请注明来源：内存溢出

原文地址: http://outofmemory.cn/langs/795269.html

httpClient笔记

发表评论

评论列表（0条）