HttpClient入门(1) 发送请求,处理响应及响应重复读取

HttpClient是Apache旗下的项目,是一个负责创建和维护HTTP和相关协议的工具集。

以下分析使用版本为:
httpclient-4.5.3.jar
httpcore-4.4.6.jar
jdk1.8.0_131
所有示例代码均经过运行测试

发送请求

httpclient最重要的功能就是发送http请求,下面介绍如何执行一个get请求:

CloseableHttpClient httpclient = HttpClients.createDefault();
HttpGet get = new HttpGet("http://www.jianshu.com/u/8a3115bb299c");
try(CloseableHttpResponse response = httpclient.execute(get)) {         
    HttpEntity entity = response.getEntity();
    System.out.println(EntityUtils.toString(entity, "UTF-8"));
} catch (Exception e) {
    e.printStackTrace();
}

httpclient支持Http/1.1规范中定义的所有方法:GET,HEAD,POST,PUT,DELETE,TRACE,OPTIONS,对应的类是:HttpGet,HttpHead,HttpPost,HttpPut,HttpDelete,HttpTrace,HttpOptions。

请求URI

URI(统一资源标识符),用于标识应用请求的资源,通常由协议版本,主机名,端口(可选),资源路径,参数名(可选),参数值(可选)组成。
请求时,可以通过拼接字符串的形式访问:

HttpGet get = new HttpGet("http://www.jianshu.com/p/7021031d6e49?utm_medium=index-banner&utm_source=desktop");

httpclient也提供了URIBuilder这个类简化请求URI的创建和修改。

URI uri = new URIBuilder()
                .setScheme("http")
                .setHost("www.jianshu.com")
                .setPath("/p/7021031d6e49")
                .setParameter("utm_medium", "index-banner")
                .setParameter("utm_source", "desktop")
                .build();
HttpGet httpget = new HttpGet(uri);
System.out.println(httpget.getURI());

输出

http://www.jianshu.com/p/7021031d6e49?utm_medium=index-banner&utm_source=desktop

http请求是客户端发给服务端的一个消息,消息的第一行包括了请求方法,URI以及使用的协议版本。

HttpGet get = new HttpGet("http://www.jianshu.com/u/8a3115bb299c");
RequestLine requestLine = get.getRequestLine();
System.out.println(requestLine.getMethod());
System.out.println(requestLine.getUri());
System.out.println(requestLine.getProtocolVersion());
System.out.println(requestLine);

输出

GET
http://www.jianshu.com/u/8a3115bb299c
HTTP/1.1
GET http://www.jianshu.com/u/8a3115bb299c HTTP/1.1

处理响应

服务端接收并处理请求后,会返回消息给到客户端,该消息的第一行包括协议版本,状态码以及描述文字。

CloseableHttpClient httpclient = HttpClients.createDefault();
HttpGet get = new HttpGet("http://www.jianshu.com/u/8a3115bb299c");
try(CloseableHttpResponse response = httpclient.execute(get)) {   
    System.out.println(response.getStatusLine());
    System.out.println(response.getProtocolVersion());
    System.out.println(response.getStatusLine().getStatusCode());
    System.out.println(response.getStatusLine().getReasonPhrase());
    System.out.println(response.getStatusLine().toString());
} catch (Exception e) {
    e.printStackTrace();
}

输出

HTTP/1.1 200 OK
HTTP/1.1
200
OK
HTTP/1.1 200 OK

服务端返回的响应被封装在HttpEntity,通过HttpEntity可以获取请求响应的一些元信息,比如Content-Type,Content-Length以及Content-Encoding,元信息需由服务端提供,否则将是空值。

CloseableHttpClient httpclient = HttpClients.createDefault();
HttpGet get = new HttpGet("http://www.jianshu.com/u/8a3115bb299c");
try(CloseableHttpResponse response = httpclient.execute(get)) {            
    HttpEntity entity = response.getEntity();
    System.out.println(entity.getContentType());
    System.out.println(entity.getContentLength());
    System.out.println(entity.getContentEncoding());
} catch (Exception e) {
    e.printStackTrace();
}

输出

Content-Type: text/html; charset=utf-8
-1
null

HttpEntity提供了多种方法来读取正文,官方文档推荐使用以下方法进行读取:HttpEntity.getContent()HttpEntity.writeTo(outputStream)

HttpEntity.getContent()方式
CloseableHttpClient httpclient = null;
CloseableHttpResponse response = null;
BufferedReader reader = null;
try {
    httpclient = HttpClients.createDefault();
    HttpGet get = new HttpGet("http://www.jianshu.com/u/8a3115bb299c");
    response = httpclient.execute(get);
    HttpEntity entity = response.getEntity();
    reader = new BufferedReader(new InputStreamReader(entity.getContent(), "UTF-8"));
    String str = "";
    StringBuilder sb = new StringBuilder();  
    while ((str = reader.readLine()) != null) {  
        sb.append(str).append("\n");  
    }
    System.out.println(sb);
} catch (Exception e) {
    e.printStackTrace();
} finally {
    CommonUtils.closeReader(reader);
    CommonUtils.closeResponse(response);
    CommonUtils.closeHttpClient(httpclient);
}
CommonUtils
public void closeReader(BufferedReader reader) {
    try {
        if (reader != null) {
            reader.close();
        }
    } catch (Exception e) {
        e.printStackTrace();
    }
}
    
public void closeResponse(CloseableHttpResponse response) {
    try {
        if (response != null) {
            response.close();
        }
    } catch (Exception e) {
        e.printStackTrace();
    }
}

public void closeHttpClient(CloseableHttpClient httpclient) {
    try {
        if (httpclient != null) {
            httpclient.close();
        }
    } catch (Exception e) {
        e.printStackTrace();
    }
}
HttpEntity.writeTo方式
CloseableHttpClient httpclient = null;
CloseableHttpResponse response = null;
ByteArrayOutputStream outstream = new ByteArrayOutputStream();
try {
    httpclient = HttpClients.createDefault();
    HttpGet get = new HttpGet("http://www.jianshu.com/u/8a3115bb299c");
    response = httpclient.execute(get);
    HttpEntity entity = response.getEntity();
    entity.writeTo(outstream);
    System.out.println(outstream.toString("UTF-8"));
} catch (Exception e) {
    e.printStackTrace();
} finally {
    CommonUtils.closeOutputStream(outstream);
    CommonUtils.closeResponse(response);
    CommonUtils.closeHttpClient(httpclient);
}
CommonUtils
public void closeOutputStream(ByteArrayOutputStream outstream) {
    try {
        if (outstream != null) {
        outstream.close();
    }
    } catch (Exception e) {
        e.printStackTrace();
    }
}

为了确保资源的正确释放,采用上述两种方式读取正文时,都需对流进行关闭。除此之外,HttpClient还提供了EntityUtils工具类,方便对正文的读取操作,不过官方文档中建议,只有当响应实体来自受信任的HTTP服务器,并且已知其长度有限,才可以采用这种方法。

EntityUtils.toString方式
CloseableHttpClient httpclient = HttpClients.createDefault();
HttpGet get = new HttpGet("http://www.jianshu.com/u/8a3115bb299c");
try(CloseableHttpResponse response = httpclient.execute(get)) {         
    HttpEntity entity = response.getEntity();
    System.out.println(EntityUtils.toString(entity, "UTF-8"));
} catch (Exception e) {
    e.printStackTrace();
} finally {
    CommonUtils.closeHttpClient(httpclient);
}

EntityUtils.toString内部会对HttpEntity中的输入流进行关闭。
以上三种读取方式,当CloseableHttpClient的实例不再使用时,都需调用close方法进行关闭。

通过BufferedHttpEntity实现响应多次读取

对于流类型的HttpEntity而言,是不可重复读取的,若想多次读取,则需要在某个地方将HttpEntity缓存起来,最简单的方式,可以使用HttpClient提供的BufferedHttpEntity类来实现。

HttpEntity.getContent()+BufferedHttpEntity实现多次读取
CloseableHttpClient httpclient = HttpClients.createDefault();
HttpGet get = new HttpGet("http://www.jianshu.com/u/8a3115bb299c");
try(CloseableHttpResponse response = httpclient.execute(get)) {
    HttpEntity entity = response.getEntity();
    BufferedHttpEntity bufferedEntity = new BufferedHttpEntity(entity);
    System.out.println(getEntityContent(bufferedEntity));
    System.out.println(getEntityContent(bufferedEntity));
} catch (Exception e) {
    e.printStackTrace();
} finally {
    CommonUtils.closeHttpClient(httpclient);
}
public String getEntityContent(HttpEntity entity) {
    try(BufferedReader reader = new BufferedReader(new InputStreamReader(entity.getContent(), "UTF-8"))) {
        String str = "";
        StringBuilder sb = new StringBuilder();  
        while ((str = reader.readLine()) != null) {  
            sb.append(str).append("\n");  
        }
        return sb.toString();
    } catch (Exception e) {
        e.printStackTrace();
        return "";
    }
}
HttpEntity.writeTo+BufferedHttpEntity实现多次读取
CloseableHttpClient httpclient = HttpClients.createDefault();
HttpGet get = new HttpGet("http://www.jianshu.com/u/8a3115bb299c");
try(CloseableHttpResponse response = httpclient.execute(get)) {
    HttpEntity entity = response.getEntity();
    BufferedHttpEntity bufferedEntity = new BufferedHttpEntity(entity);
    System.out.println(getContentByWriteTo(bufferedEntity));
    System.out.println(getContentByWriteTo(bufferedEntity));
} catch (Exception e) {
    e.printStackTrace();
} finally {
    CommonUtils.closeHttpClient(httpclient);
}
public String getContentByWriteTo(HttpEntity entity) {
    try(ByteArrayOutputStream outstream = new ByteArrayOutputStream()) {
        entity.writeTo(outstream);
        return outstream.toString("UTF-8");
    } catch (Exception e) {
        e.printStackTrace();
        return "";
    }
}
EntityUtils.toString+BufferedHttpEntity实现多次读取
CloseableHttpClient httpclient = HttpClients.createDefault();
HttpGet get = new HttpGet("http://www.jianshu.com/u/8a3115bb299c");
try(CloseableHttpResponse response = httpclient.execute(get)) {            
    HttpEntity entity = response.getEntity();
    BufferedHttpEntity bufferedEntity = new BufferedHttpEntity(entity);
    System.out.println(EntityUtils.toString(bufferedEntity, "UTF-8"));
    System.out.println(EntityUtils.toString(bufferedEntity, "UTF-8"));
} catch (Exception e) {
    e.printStackTrace();
} finally {
    CommonUtils.closeHttpClient(httpclient);
}

至此,通过HttpClient,简单实现了http get请求的发送和响应处理。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 194,491评论 5 459
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 81,856评论 2 371
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 141,745评论 0 319
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 52,196评论 1 263
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 61,073评论 4 355
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 46,112评论 1 272
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 36,531评论 3 381
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 35,215评论 0 253
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 39,485评论 1 290
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 34,578评论 2 309
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 36,356评论 1 326
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,215评论 3 312
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 37,583评论 3 299
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 28,898评论 0 17
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,174评论 1 250
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 41,497评论 2 341
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 40,697评论 2 335

推荐阅读更多精彩内容