1. 程式人生 > >輕鬆把玩HttpClient之封裝HttpClient工具類(三),外掛式配置Header

輕鬆把玩HttpClient之封裝HttpClient工具類(三),外掛式配置Header

       上篇文章介紹了外掛式配置HttpClient,本文將介紹外掛式配置Header。

       為什麼要配置header在前面已經提到了,還裡再簡單說一下,要使用HttpClient模擬請求,去訪問各種介面或者網站資源,都有可能有各種限制,比如說java客戶端模擬訪問csdn部落格,就必須設定User-Agent,否則就報錯了。還有各種其他情況,必須的設定一些特定的Header,才能請求成功,或者才能不出問題。

       好了就說這麼多,本次還是採用構造者模式的級聯呼叫方式,來完成該工具類。在該工具類中,為所有常用的Http Request Header都提供了設定方法。具體引數參考的連結是

HTTP Header 詳解

       不再多廢話了,看具體程式碼吧:

package com.tgb.ccl.http.common;

import java.util.HashMap;
import java.util.Map;

import org.apache.http.Consts;
import org.apache.http.Header;
import org.apache.http.message.BasicHeader;

/**
 * 建立HttpReqHead
 * 
 * @author arron
 * @date 2015年11月9日 上午10:37:23
 * @version 1.0
 */
public class HttpHeader {

	private HttpHeader() {};

	public static HttpHeader custom() {
		return new HttpHeader();
	}

	//記錄head頭資訊
	private Map<String, Header> headerMaps = new HashMap<String, Header>();
	
	/**
	 * 指定客戶端能夠接收的內容型別
	 * 例如:Accept: text/plain, text/html
	 * 
	 * @param accept
	 */
	public HttpHeader accept(String accept) {
		headerMaps.put(HttpReqHead.ACCEPT,
				new BasicHeader(HttpReqHead.ACCEPT, accept));
		return this;
	}

	/**
	 * 瀏覽器可以接受的字元編碼集
	 * 例如:Accept-Charset: iso-8859-5
	 * 
	 * @param acceptCharset
	 */
	public HttpHeader acceptCharset(String acceptCharset) {
		headerMaps.put(HttpReqHead.ACCEPT_CHARSET,
				new BasicHeader(HttpReqHead.ACCEPT_CHARSET, acceptCharset));
		return this;
	}

	/**
	 * 指定瀏覽器可以支援的web伺服器返回內容壓縮編碼型別
	 * 例如:Accept-Encoding: compress, gzip
	 * 
	 * @param acceptEncoding
	 */
	public HttpHeader acceptEncoding(String acceptEncoding) {
		headerMaps.put(HttpReqHead.ACCEPT_ENCODING,
				new BasicHeader(HttpReqHead.ACCEPT_ENCODING, acceptEncoding));
		return this;
	}

	/**
	 * 瀏覽器可接受的語言
	 * 例如:Accept-Language: en,zh
	 * 
	 * @param acceptLanguage
	 */
	public HttpHeader acceptLanguage(String acceptLanguage) {
		headerMaps.put(HttpReqHead.ACCEPT_LANGUAGE,
				new BasicHeader(HttpReqHead.ACCEPT_LANGUAGE, acceptLanguage));
		return this;
	}

	/**
	 * 可以請求網頁實體的一個或者多個子範圍欄位
	 * 例如:Accept-Ranges: bytes
	 * 
	 * @param acceptRanges
	 */
	public HttpHeader acceptRanges(String acceptRanges) {
		headerMaps.put(HttpReqHead.ACCEPT_RANGES,
				new BasicHeader(HttpReqHead.ACCEPT_RANGES, acceptRanges));
		return this;
	}

	/**
	 * HTTP授權的授權證書
	 * 例如:Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
	 * 
	 * @param authorization
	 */
	public HttpHeader authorization(String authorization) {
		headerMaps.put(HttpReqHead.AUTHORIZATION,
				new BasicHeader(HttpReqHead.AUTHORIZATION, authorization));
		return this;
	}

	/**
	 * 指定請求和響應遵循的快取機制
	 * 例如:Cache-Control: no-cache
	 * 
	 * @param cacheControl
	 */
	public HttpHeader cacheControl(String cacheControl) {
		headerMaps.put(HttpReqHead.CACHE_CONTROL,
				new BasicHeader(HttpReqHead.CACHE_CONTROL, cacheControl));
		return this;
	}

	/**
	 * 表示是否需要持久連線(HTTP 1.1預設進行持久連線)
	 * 例如:Connection: close 短連結; Connection: keep-alive 長連線
	 * 
	 * @param connection
	 * @return
	 */
	public HttpHeader connection(String connection) {
		headerMaps.put(HttpReqHead.CONNECTION,
				new BasicHeader(HttpReqHead.CONNECTION, connection));
		return this;
	}
	
	/**
	 * HTTP請求傳送時,會把儲存在該請求域名下的所有cookie值一起傳送給web伺服器
	 * 例如:Cookie: $Version=1; Skin=new;
	 * 
	 * @param cookie
	 */
	public HttpHeader cookie(String cookie) {
		headerMaps.put(HttpReqHead.COOKIE,
				new BasicHeader(HttpReqHead.COOKIE, cookie));
		return this;
	}

	/**
	 * 請求內容長度
	 * 例如:Content-Length: 348
	 * 
	 * @param contentLength
	 */
	public HttpHeader contentLength(String contentLength) {
		headerMaps.put(HttpReqHead.CONTENT_LENGTH,
				new BasicHeader(HttpReqHead.CONTENT_LENGTH, contentLength));
		return this;
	}

	/**
	 * 請求的與實體對應的MIME資訊
	 * 例如:Content-Type: application/x-www-form-urlencoded
	 * 
	 * @param contentType
	 */
	public HttpHeader contentType(String contentType) {
		headerMaps.put(HttpReqHead.CONTENT_TYPE,
				new BasicHeader(HttpReqHead.CONTENT_TYPE, contentType));
		return this;
	}

	/**
	 * 請求傳送的日期和時間
	 * 例如:Date: Tue, 15 Nov 2010 08:12:31 GMT
	 * 
	 * @param date
	 * @return
	 */
	public HttpHeader date(String date) {
		headerMaps.put(HttpReqHead.DATE,
				new BasicHeader(HttpReqHead.DATE, date));
		return this;
	}
	
	/**
	 * 請求的特定的伺服器行為
	 * 例如:Expect: 100-continue
	 * 
	 * @param expect
	 */
	public HttpHeader expect(String expect) {
		headerMaps.put(HttpReqHead.EXPECT,
				new BasicHeader(HttpReqHead.EXPECT, expect));
		return this;
	}
	
	/**
	 * 發出請求的使用者的Email
	 * 例如:From: 
[email protected]
* * @param from */ public HttpHeader from(String from) { headerMaps.put(HttpReqHead.FROM, new BasicHeader(HttpReqHead.FROM, from)); return this; } /** * 指定請求的伺服器的域名和埠號 * 例如:Host: blog.csdn.net * * @param host * @return */ public HttpHeader host(String host) { headerMaps.put(HttpReqHead.HOST, new BasicHeader(HttpReqHead.HOST, host)); return this; } /** * 只有請求內容與實體相匹配才有效 * 例如:If-Match: “737060cd8c284d8af7ad3082f209582d” * * @param ifMatch * @return */ public HttpHeader ifMatch(String ifMatch) { headerMaps.put(HttpReqHead.IF_MATCH, new BasicHeader(HttpReqHead.IF_MATCH, ifMatch)); return this; } /** * 如果請求的部分在指定時間之後被修改則請求成功,未被修改則返回304程式碼 * 例如:If-Modified-Since: Sat, 29 Oct 2010 19:43:31 GMT * * @param ifModifiedSince * @return */ public HttpHeader ifModifiedSince(String ifModifiedSince) { headerMaps.put(HttpReqHead.IF_MODIFIED_SINCE, new BasicHeader(HttpReqHead.IF_MODIFIED_SINCE, ifModifiedSince)); return this; } /** * 如果內容未改變返回304程式碼,引數為伺服器先前傳送的Etag,與伺服器迴應的Etag比較判斷是否改變 * 例如:If-None-Match: “737060cd8c284d8af7ad3082f209582d” * * @param ifNoneMatch * @return */ public HttpHeader ifNoneMatch(String ifNoneMatch) { headerMaps.put(HttpReqHead.IF_NONE_MATCH, new BasicHeader(HttpReqHead.IF_NONE_MATCH, ifNoneMatch)); return this; } /** * 如果實體未改變,伺服器傳送客戶端丟失的部分,否則傳送整個實體。引數也為Etag * 例如:If-Range: “737060cd8c284d8af7ad3082f209582d” * * @param ifRange * @return */ public HttpHeader ifRange(String ifRange) { headerMaps.put(HttpReqHead.IF_RANGE, new BasicHeader(HttpReqHead.IF_RANGE, ifRange)); return this; } /** * 只在實體在指定時間之後未被修改才請求成功 * 例如:If-Unmodified-Since: Sat, 29 Oct 2010 19:43:31 GMT * * @param ifUnmodifiedSince * @return */ public HttpHeader ifUnmodifiedSince(String ifUnmodifiedSince) { headerMaps.put(HttpReqHead.IF_UNMODIFIED_SINCE, new BasicHeader(HttpReqHead.IF_UNMODIFIED_SINCE, ifUnmodifiedSince)); return this; } /** * 限制資訊通過代理和閘道器傳送的時間 * 例如:Max-Forwards: 10 * * @param maxForwards * @return */ public HttpHeader maxForwards(String maxForwards) { headerMaps.put(HttpReqHead.MAX_FORWARDS, new BasicHeader(HttpReqHead.MAX_FORWARDS, maxForwards)); return this; } /** * 用來包含實現特定的指令 * 例如:Pragma: no-cache * * @param pragma * @return */ public HttpHeader pragma(String pragma) { headerMaps.put(HttpReqHead.PRAGMA, new BasicHeader(HttpReqHead.PRAGMA, pragma)); return this; } /** * 連線到代理的授權證書 * 例如:Proxy-Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ== * * @param proxyAuthorization */ public HttpHeader proxyAuthorization(String proxyAuthorization) { headerMaps.put(HttpReqHead.PROXY_AUTHORIZATION, new BasicHeader(HttpReqHead.PROXY_AUTHORIZATION, proxyAuthorization)); return this; } /** * 只請求實體的一部分,指定範圍 * 例如:Range: bytes=500-999 * * @param range */ public HttpHeader range(String range) { headerMaps.put(HttpReqHead.RANGE, new BasicHeader(HttpReqHead.RANGE, range)); return this; } /** * 先前網頁的地址,當前請求網頁緊隨其後,即來路 * 例如:Referer: http://www.zcmhi.com/archives/71.html * * @param referer */ public HttpHeader referer(String referer) { headerMaps.put(HttpReqHead.REFERER, new BasicHeader(HttpReqHead.REFERER, referer)); return this; } /** * 客戶端願意接受的傳輸編碼,並通知伺服器接受接受尾加頭資訊 * 例如:TE: trailers,deflate;q=0.5 * * @param te */ public HttpHeader te(String te) { headerMaps.put(HttpReqHead.TE, new BasicHeader(HttpReqHead.TE, te)); return this; } /** * 向伺服器指定某種傳輸協議以便伺服器進行轉換(如果支援) * 例如:Upgrade: HTTP/2.0, SHTTP/1.3, IRC/6.9, RTA/x11 * * @param upgrade */ public HttpHeader upgrade(String upgrade) { headerMaps.put(HttpReqHead.UPGRADE, new BasicHeader(HttpReqHead.UPGRADE, upgrade)); return this; } /** * User-Agent的內容包含發出請求的使用者資訊 * * @param userAgent * @return */ public HttpHeader userAgent(String userAgent) { headerMaps.put(HttpReqHead.USER_AGENT, new BasicHeader(HttpReqHead.USER_AGENT, userAgent)); return this; } /** * 關於訊息實體的警告資訊 * 例如:Warn: 199 Miscellaneous warning * * @param warning * @return */ public HttpHeader warning(String warning) { headerMaps.put(HttpReqHead.WARNING, new BasicHeader(HttpReqHead.WARNING, warning)); return this; } /** * 通知中間閘道器或代理伺服器地址,通訊協議 * 例如:Via: 1.0 fred, 1.1 nowhere.com (Apache/1.1) * * @param via * @return */ public HttpHeader via(String via) { headerMaps.put(HttpReqHead.VIA, new BasicHeader(HttpReqHead.VIA, via)); return this; } /** * 設定此HTTP連線的持續時間(超時時間) * 例如:Keep-Alive: 300 * * @param keepAlive * @return */ public HttpHeader keepAlive(String keepAlive) { headerMaps.put(HttpReqHead.KEEP_ALIVE, new BasicHeader(HttpReqHead.KEEP_ALIVE, keepAlive)); return this; } public String accept() { return get(HttpReqHead.ACCEPT); } public String acceptCharset() { return get(HttpReqHead.ACCEPT_CHARSET); } public String acceptEncoding() { return get(HttpReqHead.ACCEPT_ENCODING); } public String acceptLanguage() { return get(HttpReqHead.ACCEPT_LANGUAGE); } public String acceptRanges() { return get(HttpReqHead.ACCEPT_RANGES); } public String authorization() { return get(HttpReqHead.AUTHORIZATION); } public String cacheControl() { return get(HttpReqHead.CACHE_CONTROL); } public String connection() { return get(HttpReqHead.CONNECTION); } public String cookie() { return get(HttpReqHead.COOKIE); } public String contentLength() { return get(HttpReqHead.CONTENT_LENGTH); } public String contentType() { return get(HttpReqHead.CONTENT_TYPE); } public String date() { return get(HttpReqHead.DATE); } public String expect() { return get(HttpReqHead.EXPECT); } public String from() { return get(HttpReqHead.FROM); } public String host() { return get(HttpReqHead.HOST); } public String ifMatch() { return get(HttpReqHead.IF_MATCH); } public String ifModifiedSince() { return get(HttpReqHead.IF_MODIFIED_SINCE); } public String ifNoneMatch() { return get(HttpReqHead.IF_NONE_MATCH); } public String ifRange() { return get(HttpReqHead.IF_RANGE); } public String ifUnmodifiedSince() { return get(HttpReqHead.IF_UNMODIFIED_SINCE); } public String maxForwards() { return get(HttpReqHead.MAX_FORWARDS); } public String pragma() { return get(HttpReqHead.PRAGMA); } public String proxyAuthorization() { return get(HttpReqHead.PROXY_AUTHORIZATION); } public String referer() { return get(HttpReqHead.REFERER); } public String te() { return get(HttpReqHead.TE); } public String upgrade() { return get(HttpReqHead.UPGRADE); } public String userAgent() { return get(HttpReqHead.USER_AGENT); } public String via() { return get(HttpReqHead.VIA); } public String warning() { return get(HttpReqHead.WARNING); } public String keepAlive() { return get(HttpReqHead.KEEP_ALIVE); } /** * 獲取head資訊 * * @return */ private String get(String headName) { if (headerMaps.containsKey(headName)) { return headerMaps.get(headName).getValue(); } return null; } /** * 返回header頭資訊 * * @return */ public Header[] build() { Header[] headers = new Header[headerMaps.size()]; int i = 0; for (Header header : headerMaps.values()) { headers[i] = header; i++; } headerMaps.clear(); headerMaps = null; return headers; } /** * Http頭資訊 * * @author arron * @date 2015年11月9日 上午11:29:04 * @version 1.0 */ private static class HttpReqHead { public static final String ACCEPT = "Accept"; public static final String ACCEPT_CHARSET = "Accept-Charset"; public static final String ACCEPT_ENCODING = "Accept-Encoding"; public static final String ACCEPT_LANGUAGE = "Accept-Language"; public static final String ACCEPT_RANGES = "Accept-Ranges"; public static final String AUTHORIZATION = "Authorization"; public static final String CACHE_CONTROL = "Cache-Control"; public static final String CONNECTION = "Connection"; public static final String COOKIE = "Cookie"; public static final String CONTENT_LENGTH = "Content-Length"; public static final String CONTENT_TYPE = "Content-Type"; public static final String DATE= "Date"; public static final String EXPECT = "Expect"; public static final String FROM = "From"; public static final String HOST = "Host"; public static final String IF_MATCH = "If-Match "; public static final String IF_MODIFIED_SINCE = "If-Modified-Since"; public static final String IF_NONE_MATCH = "If-None-Match"; public static final String IF_RANGE = "If-Range"; public static final String IF_UNMODIFIED_SINCE = "If-Unmodified-Since"; public static final String KEEP_ALIVE = "Keep-Alive"; public static final String MAX_FORWARDS = "Max-Forwards"; public static final String PRAGMA = "Pragma"; public static final String PROXY_AUTHORIZATION = "Proxy-Authorization"; public static final String RANGE = "Range"; public static final String REFERER = "Referer"; public static final String TE = "TE"; public static final String UPGRADE = "Upgrade"; public static final String USER_AGENT = "User-Agent"; public static final String VIA = "Via"; public static final String WARNING = "Warning"; } /** * 常用頭資訊配置 * * @author arron * @date 2015年11月18日 下午5:30:00 * @version 1.0 */ public static class Headers{ public static final String APP_FORM_URLENCODED="application/x-www-form-urlencoded"; public static final String TEXT_PLAIN="text/plain"; public static final String TEXT_HTML="text/html"; public static final String TEXT_XML="text/xml"; public static final String TEXT_JSON="text/json"; public static final String CONTENT_CHARSET_ISO_8859_1 = Consts.ISO_8859_1.name(); public static final String CONTENT_CHARSET_UTF8 = Consts.UTF_8.name(); public static final String DEF_PROTOCOL_CHARSET = Consts.ASCII.name(); public static final String CONN_CLOSE = "close"; public static final String KEEP_ALIVE = "keep-alive"; public static final String EXPECT_CONTINUE = "100-continue"; } }
       呼叫方式:
	//設定header資訊
	Header[] headers=HttpHeader.custom().keepAlive("false").connection("close").contentType(Headers.APP_FORM_URLENCODED).build();
       就是這麼簡單。到此該工具類就完成了。下一篇將分享該工具類以及單次呼叫測試和多執行緒呼叫測試。

       httpclientUtil (QQ交流群:548452686 httpclientUtil交流