HttpClient的基本使用

Posted 2020-12-03 jpfss

HttpClient的基本使用

前言

HttpClient是Apache提供的一个用于在Java中处理HTTP请求、响应操作的工具，由于JDK自带的API对HTTP协议的支持不是很友好，使用起来也不是很方便，加上这几天刚好有个小项目需要使用到，所以学习了HttpClient的基本使用，并且将学习过程的笔记整理出来

Http请求

正如我们所知道的，一个Http请求包含了一下几个部分的内容，首先是请求行(包括了请求方法、请求的URI、HTTP协议的版本)，请求头(若干的键值对)，以及可选的请求体(POST中经常存放，GET中则没有该项内容)

HttpClient对其中各个部分都进行了封装，接下来我们来详细看下具体的操作

Http请求行

一个Http请求行对应的内容在上面已经提过了，这里就不做过多的叙述，在HttpClient中，一个Http请求行对应的类为RequestLine，具体的操作如下代码所示：

    // 创建一个GET对象
    HttpGet get = new HttpGet("http://www.baidu.com");
    // 获得请求行对象
    RequestLine statusLine = get.getRequestLine();
    // 获得请求方法
    System.out.println(statusLine.getMethod());
    // 获得请求URI
    System.out.println(statusLine.getUri());
    // 获得HTTP版本协议
    System.out.println(statusLine.getProtocolVersion());

对应的输出结果如下所示：

GET
http://www.baidu.com
HTTP/1.1

可以看到，HttpClient通过RequestLine对象将一个Http请求对应的请求行封装起来了。

请求头

在Http中，Http的头信息包含了很多的内容，比如Content-type、Set-Cookie等，这里我们演示一个简单的小案例，注意这里的头信息包括了请求以及响应，它们只是对应的键值对以及含义不同而已吗，形式上是一致的，如下代码所示：

    /*
        通过Header对象设置头信息
     */
    Header header = new BasicHeader("Content-type", "text/plain");
    Header header1 = new BasicHeader("Set-Cookie", "c1=a; path=/; domain=localhost");
    response.addHeader(header);
    response.addHeader(header1);

    /*
        获取特定的头信息
    */
    Header respHeader = response.getFirstHeader("Content-type");
    System.out.println(respHeader.getName() + " : " + respHeader.getValue());
    respHeader = response.getFirstHeader("Set-Cookie");
    System.out.println(respHeader.getName() + " : " + respHeader.getValue());

     /*
        通过迭代器访问所有的头信息
     */
    HeaderIterator iterator = response.headerIterator();
    while (iterator.hasNext()){
        Header tmp = iterator.nextHeader();
        System.out.println(tmp.getName() + " : " + tmp.getValue());
    }

    /*
        获取某一头信息中的所有元素以及其值
    */

    HeaderElementIterator iterator1 = new BasicHeaderElementIterator(response.headerIterator("Set-Cookie"));
    while (iterator1.hasNext()){
        HeaderElement element = iterator1.nextElement();
        System.out.println(element.getName() + " : " + element.getValue());

        NameValuePair[] params = element.getParameters();
        for (NameValuePair n : params) {
            System.out.println(n.getName() + " : " + n.getValue());
        }
    }

对应的输出结果如下所示：

Content-type : text/plain
Set-Cookie : c1=a; path=/; domain=localhost
Content-type : text/plain
Set-Cookie : c1=a; path=/; domain=localhost
c1 : a
path : /
domain : localhost

Http实体

在一个Http中，通常还会涉及到实体，Entity，也就是请求/响应的真正内容，在请求中，通常是PUT以及POST中会含有该实体，而在响应中，一般都会包含一个实体，用于作为服务端返回信息的载体。

在HttpClient中，实体有三种形式，内容以及具体的含义如下所示：

1. streamed：来自于字节流，尤其是来自response的内容，通常是不可重复的
2. self-contained：来自内存或者跟连接没有关系，通常是可重复的，通常用于封装Http请求
3. wrapping：来自于其他entity

这里需要注意的是，实体的形式并不意味着实体的具体类型，也就是说，上面的实体形式只是一个概念上的理解，具体的类型可以有：StringEntity、ByteArrayEntity、InputStreamEntity、FileEntity等，基本上这些类型都见名之意，故这里不做过多的解释，具体可以参考官方手册

下面简单演示使用StringEntity传递以及接收数据

    /*
        设置String类型的实体
    */
    StringEntity entity = new StringEntity("hello");
    response.setEntity(entity);

    /*
       接收String类型的实体
    */

    HttpEntity entity1 = response.getEntity();
    if (entity1 != null){
        // 通过EntityUtils工具来获取
        //System.out.println(EntityUtils.toString(entity1));

        // 通过流来获取数据
        InputStream inputStream = entity1.getContent();
        byte[] data = new byte[inputStream.available()];
        inputStream.read(data);

        System.out.println(new String(data, 0, data.length));
        inputStream.close(); // 这里切记要记得关闭资源

    }

Http响应

Http响应行

正如我们所知道的Http响应包含了一个响应行(Http版本，状态码，状态码的解释)响应头(参见上面请求头部分)以及对应的实体(参见上面的实体部分)

接下来我们来具体看下响应行以及HttpResponse对象的使用

    // 创建一个HttpResponse
    HttpResponse response = new BasicHttpResponse(HttpVersion.HTTP_1_1, HttpStatus.SC_OK, "ok");
    // 获得相应的状态行
    StatusLine statusLine1 = response.getStatusLine();
    // Http协议版本
    System.out.println(statusLine1.getProtocolVersion());
    // 响应结果
    System.out.println(statusLine1.getStatusCode());
    // 响应结果的解释
    System.out.println(statusLine1.getReasonPhrase());

对应的结果如下所示

HTTP/1.1
200
ok

发送/接收Http请求

上面主要是关于Http请求以及响应的内容，接下来来看下HttpClient是如何发送Http请求以及接收请求

    // 创建一个HttpClient对象
    CloseableHttpClient client = HttpClients.createDefault();
    // 发送请求并且获得返回的结果
    CloseableHttpResponse response = client.execute(request);

总结

本节主要介绍了HttpClient的使用，包括了对Http请求对象的使用、Http响应对象的使用以及如何发送Http请求以及获得返回的结果