io.jafka.ptth

类 Request

java.lang.Object

io.jafka.ptth.Request

public class Request
extends Object

HTTP请求（用于包装参数）

从以下版本开始:

2017年7月12日

作者:

adyliu (imxylz@gmail.com)

构造器概要

构造器

构造器和说明
Request(String uri)
Request(String uri, String method)
Request(String uri, String method, Charset encoding) 构造一个http 请求

方法概要

限定符和类型	方法和说明
Request	addCookie(String name, String value, String domain, String path, Date expiryDate, int version) 请求增加Cookie
Request	addHeaders(org.apache.http.Header... headers) 添加HTTP的header
Request	addHeaders(String... headers) 添加HTTP的Header
Request	addParam(String name, Object value) 添加一个参数
Request	addParams(Collection<String> params)
Request	addParams(List<StringPair> params)
Request	addParams(Map<String,String> params)
Request	addParams(String... params)
Request	addParams(StringPair... params)
static String	buildUrl(String uri, Charset encoding, List<? extends org.apache.http.NameValuePair> params)
static String	buildUrl(String uri, Charset encoding, Map<String,String> params)
Response	execute()
Response	get()
org.apache.http.HttpEntity	getEntity()
org.apache.http.Header[]	getHeaders()
org.apache.http.client.protocol.HttpClientContext	getHttpContext() HTTP请求的上下文参数
String	getLocalsiteaddress() 获取本机的全部私有IP地址
List<StringPair>	getParams()
String	getUrl() 拼接完整的URL（如果是GET请求，则将全部参数拼接到URL上，POST请求并不会）
boolean	isGet()
boolean	isPost()
Response	post()
Request	removeHeader(String name)
Request	retry(int count) 出错尝试几次
Request	setConnectionTimeout(int timeout) set the connection timeout
Request	setCookieStore(org.apache.http.client.CookieStore cookieStore)
Request	setEncoding(Charset encoding) 设置请求的字符编码
Request	setEntity(org.apache.http.HttpEntity entity)
Request	setEntity(String content) 设置请求的内容体（注意，此方法和addParams(String...)等addParams* 方法有冲突，二选一）
Request	setForceOk(boolean forceOk)
Request	setMethod(String method) 设置HTTP请求的方法
Request	setReferer() 用uri来构造Referer
Request	setReferer(String referer)
Request	setSoTimeout(int timeout) set the so_timeout
Request	setUserAgent() 使用Chrome浏览器模拟
Request	setUserAgent(String userAgent) 设置HTTP的UserAgent对象
String	toDebugString() 生成调试信息（包括HEADER/BODY等）
String	toString()
Request	withCookieStore()
Request	withHttpProxy(org.apache.http.HttpHost host)
Request	withHttpProxy(String host, int port)

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

构造器详细资料

Request

public Request(String uri)

Request

public Request(String uri,
               String method)

Request

public Request(String uri,
               String method,
               Charset encoding)

构造一个http 请求

参数:

uri - 请求的地址

method - 请求方法字符串

encoding - 字符编码，请求内容的字符编码

方法详细资料

setReferer

public Request setReferer()

用uri来构造Referer

返回:

Request对象

另请参阅:

setReferer(String)

setReferer

public Request setReferer(String referer)

setUserAgent

public Request setUserAgent(String userAgent)

设置HTTP的UserAgent对象

参数:

userAgent - useragent格式

返回:

Request对象

另请参阅:

setUserAgent()

setUserAgent

public Request setUserAgent()

使用Chrome浏览器模拟

返回:

当前请求对象

setEncoding

public Request setEncoding(Charset encoding)

设置请求的字符编码

参数:

encoding - 字符编码

返回:

当前请求对象

setMethod

public Request setMethod(String method)

设置HTTP请求的方法

参数:

method - GET/POST/HTTP/PUT/DELET

返回:

当前请求对象

getHttpContext

public org.apache.http.client.protocol.HttpClientContext getHttpContext()

HTTP请求的上下文参数

返回:

上下文参数

addHeaders

public Request addHeaders(String... headers)

添加HTTP的Header

参数:

headers - header的name和value，需要成双入对

返回:

当前请求对象

addHeaders

public Request addHeaders(org.apache.http.Header... headers)

添加HTTP的header

参数:

headers - 请求的header

返回:

当前请求对象

removeHeader

public Request removeHeader(String name)

setForceOk

public Request setForceOk(boolean forceOk)

getUrl

public String getUrl()

拼接完整的URL（如果是GET请求，则将全部参数拼接到URL上，POST请求并不会）

返回:

完整的URL，含QueryString

getHeaders

public org.apache.http.Header[] getHeaders()

addParams

public Request addParams(Collection<String> params)

addParams

public Request addParams(String... params)

addParams

public Request addParams(List<StringPair> params)

addParams

public Request addParams(StringPair... params)

addParam

public Request addParam(String name,
                        Object value)

添加一个参数

参数:

name - 参数名

value - 参数值

返回:

如果参数值不为null,则将此参数添加到QueryString/RequestBody中

从以下版本开始:

2016年11月25日

addParams

public Request addParams(Map<String,String> params)

getParams

public List<StringPair> getParams()

isGet

public boolean isGet()

isPost

public boolean isPost()

getEntity

public org.apache.http.HttpEntity getEntity()

setEntity

public Request setEntity(String content)

设置请求的内容体（注意，此方法和addParams(String...)等addParams* 方法有冲突，二选一）

参数:

content - 请求内容（使用setEncoding(Charset)编码

返回:

Request请求

从以下版本开始:

2013/09/16

setEntity

public Request setEntity(org.apache.http.HttpEntity entity)

setConnectionTimeout

public Request setConnectionTimeout(int timeout)

set the connection timeout

参数:

timeout - the timeout value to be used in milliseconds.

返回:

the request object

setSoTimeout

public Request setSoTimeout(int timeout)

set the so_timeout

参数:

timeout - the timeout value to be used in milliseconds

返回:

the request object

withHttpProxy

public Request withHttpProxy(String host,
                             int port)

withHttpProxy

public Request withHttpProxy(org.apache.http.HttpHost host)

execute

public Response execute()
                 throws IOException

抛出:

IOException

get

public Response get()
             throws IOException

抛出:

IOException

post

public Response post()
              throws IOException

抛出:

IOException

retry

public Request retry(int count)

出错尝试几次

参数:

count - 尝试次数，默认为0，不尝试

返回:

Request 对象

withCookieStore

public Request withCookieStore()

setCookieStore

public Request setCookieStore(org.apache.http.client.CookieStore cookieStore)

addCookie

public Request addCookie(String name,
                         String value,
                         String domain,
                         String path,
                         Date expiryDate,
                         int version)

请求增加Cookie

参数:

name - cookie名称filem

value - cookie值

domain - 域名地址

path - cookie路径

expiryDate - 过期时间

version - 版本

返回:

请求对象

buildUrl

public static String buildUrl(String uri,
                              Charset encoding,
                              Map<String,String> params)

buildUrl

public static String buildUrl(String uri,
                              Charset encoding,
                              List<? extends org.apache.http.NameValuePair> params)

toString

public String toString()

覆盖:

toString 在类中 Object

toDebugString

public String toDebugString()
                     throws IOException

生成调试信息（包括HEADER/BODY等）

返回:

HTTP请求的调试信息

抛出:

IOException - 编码参数错误

getLocalsiteaddress

public String getLocalsiteaddress()

获取本机的全部私有IP地址

返回:

本机全部私有IP地址