HttpHeader (Ziyi Boot 1.0.0 API)

java.lang.Object
- cn.ziyicloud.framework.boot.util.httpclient.config.HttpHeader

```
public class HttpHeader
extends Object
```
创建HttpReqHead

作者:

Li Ruitong

嵌套类概要

嵌套类
限定符和类型类和说明

static class HttpHeader.Headers
常用头信息配置

嵌套类
限定符和类型	类和说明
`static class`	`HttpHeader.Headers` 常用头信息配置

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`String`	`accept()`
`HttpHeader`	`accept(String accept)` 指定客户端能够接收的内容类型例如：Accept: text/plain, text/html
`String`	`acceptCharset()`
`HttpHeader`	`acceptCharset(String acceptCharset)` 浏览器可以接受的字符编码集例如：Accept-Charset: iso-8859-5
`String`	`acceptEncoding()`
`HttpHeader`	`acceptEncoding(String acceptEncoding)` 指定浏览器可以支持的web服务器返回内容压缩编码类型例如：Accept-Encoding: compress, gzip
`String`	`acceptLanguage()`
`HttpHeader`	`acceptLanguage(String acceptLanguage)` 浏览器可接受的语言例如：Accept-Language: en,zh
`String`	`acceptRanges()`
`HttpHeader`	`acceptRanges(String acceptRanges)` 可以请求网页实体的一个或者多个子范围字段例如：Accept-Ranges: bytes
`String`	`authorization()`
`HttpHeader`	`authorization(String authorization)` HTTP授权的授权证书例如：Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
`org.apache.http.Header[]`	`build()` 返回header头信息
`org.apache.http.Header[]`	`buildJson()` 返回header头信息--json格式
`String`	`cacheControl()`
`HttpHeader`	`cacheControl(String cacheControl)` 指定请求和响应遵循的缓存机制例如：Cache-Control: no-cache
`String`	`connection()`
`HttpHeader`	`connection(String connection)` 表示是否需要持久连接（HTTP 1.1默认进行持久连接）例如：Connection: close 短链接； Connection: keep-alive 长连接
`String`	`contentLength()`
`HttpHeader`	`contentLength(String contentLength)` 请求内容长度例如：Content-Length: 348
`String`	`contentType()`
`HttpHeader`	`contentType(String contentType)` 请求的与实体对应的MIME信息例如：Content-Type: application/x-www-form-urlencoded
`String`	`cookie()`
`HttpHeader`	`cookie(String cookie)` HTTP请求发送时，会把保存在该请求域名下的所有cookie值一起发送给web服务器例如：Cookie: $Version=1; Skin=new;
`static HttpHeader`	`custom()` 获取实例
`String`	`date()`
`HttpHeader`	`date(String date)` 请求发送的日期和时间例如：Date: Tue, 15 Nov 2010 08:12:31 GMT
`String`	`expect()`
`HttpHeader`	`expect(String expect)` 请求的特定的服务器行为例如：Expect: 100-continue
`String`	`from()`
`HttpHeader`	`from(String from)` 发出请求的用户的Email 例如：From: user@email.com
`String`	`host()`
`HttpHeader`	`host(String host)` 指定请求的服务器的域名和端口号例如：Host: blog.csdn.net
`String`	`ifMatch()`
`HttpHeader`	`ifMatch(String ifMatch)` 只有请求内容与实体相匹配才有效例如：If-Match: “737060cd8c284d8af7ad3082f209582d”
`String`	`ifModifiedSince()`
`HttpHeader`	`ifModifiedSince(String ifModifiedSince)` 如果请求的部分在指定时间之后被修改则请求成功，未被修改则返回304代码例如：If-Modified-Since: Sat, 29 Oct 2010 19:43:31 GMT
`String`	`ifNoneMatch()`
`HttpHeader`	`ifNoneMatch(String ifNoneMatch)` 如果内容未改变返回304代码，参数为服务器先前发送的Etag，与服务器回应的Etag比较判断是否改变例如：If-None-Match: “737060cd8c284d8af7ad3082f209582d”
`String`	`ifRange()`
`HttpHeader`	`ifRange(String ifRange)` 如果实体未改变，服务器发送客户端丢失的部分，否则发送整个实体。
`String`	`ifUnmodifiedSince()`
`HttpHeader`	`ifUnmodifiedSince(String ifUnmodifiedSince)` 只在实体在指定时间之后未被修改才请求成功例如：If-Unmodified-Since: Sat, 29 Oct 2010 19:43:31 GMT
`String`	`keepAlive()`
`HttpHeader`	`keepAlive(String keepAlive)` 设置此HTTP连接的持续时间（超时时间）例如：Keep-Alive: 300
`String`	`maxForwards()`
`HttpHeader`	`maxForwards(String maxForwards)` 限制信息通过代理和网关传送的时间例如：Max-Forwards: 10
`HttpHeader`	`other(String key, String value)` 自定义header头信息
`String`	`pragma()`
`HttpHeader`	`pragma(String pragma)` 用来包含实现特定的指令例如：Pragma: no-cache
`String`	`proxyAuthorization()`
`HttpHeader`	`proxyAuthorization(String proxyAuthorization)` 连接到代理的授权证书例如：Proxy-Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
`HttpHeader`	`range(String range)` 只请求实体的一部分，指定范围例如：Range: bytes=500-999
`String`	`referer()`
`HttpHeader`	`referer(String referer)` 先前网页的地址，当前请求网页紧随其后,即来路例如：Referer: http://www.zcmhi.com/archives/71.html
`String`	`te()`
`HttpHeader`	`te(String te)` 客户端愿意接受的传输编码，并通知服务器接受接受尾加头信息例如：TE: trailers,deflate;q=0.5
`String`	`upgrade()`
`HttpHeader`	`upgrade(String upgrade)` 向服务器指定某种传输协议以便服务器进行转换（如果支持）例如：Upgrade: HTTP/2.0, SHTTP/1.3, IRC/6.9, RTA/x11
`String`	`userAgent()`
`HttpHeader`	`userAgent(String userAgent)` User-Agent的内容包含发出请求的用户信息
`String`	`via()`
`HttpHeader`	`via(String via)` 通知中间网关或代理服务器地址，通信协议例如：Via: 1.0 fred, 1.1 nowhere.com (Apache/1.1)
`String`	`warning()`
`HttpHeader`	`warning(String warning)` 关于消息实体的警告信息例如：Warn: 199 Miscellaneous warning

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 方法详细资料
  - custom
```
public static HttpHeader custom()
```
    获取实例
    
    返回:
    
    返回当前对象
  - build
```
public org.apache.http.Header[] build()
```
    返回header头信息
    
    返回:
    
    返回构建的header头信息数组
  - buildJson
```
public org.apache.http.Header[] buildJson()
```
    返回header头信息--json格式
    
    返回:
    
    返回构建的header头信息数组
  - other
```
public HttpHeader other(String key,
                        String value)
```
    自定义header头信息
    
    参数:
    
    key - header-key
    
    value - header-value
    
    返回:
    
    返回当前对象
  - accept
```
public HttpHeader accept(String accept)
```
    指定客户端能够接收的内容类型例如：Accept: text/plain, text/html
    
    参数:
    
    accept - accept
    
    返回:
    
    返回当前对象
  - acceptCharset
```
public HttpHeader acceptCharset(String acceptCharset)
```
    浏览器可以接受的字符编码集例如：Accept-Charset: iso-8859-5
    
    参数:
    
    acceptCharset - accept-charset
    
    返回:
    
    返回当前对象
  - acceptEncoding
```
public HttpHeader acceptEncoding(String acceptEncoding)
```
    指定浏览器可以支持的web服务器返回内容压缩编码类型例如：Accept-Encoding: compress, gzip
    
    参数:
    
    acceptEncoding - accept-encoding
    
    返回:
    
    返回当前对象
  - acceptLanguage
```
public HttpHeader acceptLanguage(String acceptLanguage)
```
    浏览器可接受的语言例如：Accept-Language: en,zh
    
    参数:
    
    acceptLanguage - accept-language
    
    返回:
    
    返回当前对象
  - acceptRanges
```
public HttpHeader acceptRanges(String acceptRanges)
```
    可以请求网页实体的一个或者多个子范围字段例如：Accept-Ranges: bytes
    
    参数:
    
    acceptRanges - accept-ranges
    
    返回:
    
    返回当前对象
  - authorization
```
public HttpHeader authorization(String authorization)
```
    HTTP授权的授权证书例如：Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
    
    参数:
    
    authorization - authorization
    
    返回:
    
    返回当前对象
  - cacheControl
```
public HttpHeader cacheControl(String cacheControl)
```
    指定请求和响应遵循的缓存机制例如：Cache-Control: no-cache
    
    参数:
    
    cacheControl - cache-control
    
    返回:
    
    返回当前对象
  - connection
```
public HttpHeader connection(String connection)
```
    表示是否需要持久连接（HTTP 1.1默认进行持久连接）例如：Connection: close 短链接； Connection: keep-alive 长连接
    
    参数:
    
    connection - connection
    
    返回:
    
    返回当前对象
  - cookie
```
public HttpHeader cookie(String cookie)
```
    HTTP请求发送时，会把保存在该请求域名下的所有cookie值一起发送给web服务器例如：Cookie: $Version=1; Skin=new;
    
    参数:
    
    cookie - cookie
    
    返回:
    
    返回当前对象
  - contentLength
```
public HttpHeader contentLength(String contentLength)
```
    请求内容长度例如：Content-Length: 348
    
    参数:
    
    contentLength - content-length
    
    返回:
    
    返回当前对象
  - contentType
```
public HttpHeader contentType(String contentType)
```
    请求的与实体对应的MIME信息例如：Content-Type: application/x-www-form-urlencoded
    
    参数:
    
    contentType - content-type
    
    返回:
    
    返回当前对象
  - date
```
public HttpHeader date(String date)
```
    请求发送的日期和时间例如：Date: Tue, 15 Nov 2010 08:12:31 GMT
    
    参数:
    
    date - date
    
    返回:
    
    返回当前对象
  - expect
```
public HttpHeader expect(String expect)
```
    请求的特定的服务器行为例如：Expect: 100-continue
    
    参数:
    
    expect - expect
    
    返回:
    
    返回当前对象
  - from
```
public HttpHeader from(String from)
```
    发出请求的用户的Email 例如：From: user@email.com
    
    参数:
    
    from - from
    
    返回:
    
    返回当前对象
  - host
```
public HttpHeader host(String host)
```
    指定请求的服务器的域名和端口号例如：Host: blog.csdn.net
    
    参数:
    
    host - host
    
    返回:
    
    返回当前对象
  - ifMatch
```
public HttpHeader ifMatch(String ifMatch)
```
    只有请求内容与实体相匹配才有效例如：If-Match: “737060cd8c284d8af7ad3082f209582d”
    
    参数:
    
    ifMatch - if-match
    
    返回:
    
    返回当前对象
  - ifModifiedSince
```
public HttpHeader ifModifiedSince(String ifModifiedSince)
```
    如果请求的部分在指定时间之后被修改则请求成功，未被修改则返回304代码例如：If-Modified-Since: Sat, 29 Oct 2010 19:43:31 GMT
    
    参数:
    
    ifModifiedSince - if-modified-Since
    
    返回:
    
    返回当前对象
  - ifNoneMatch
```
public HttpHeader ifNoneMatch(String ifNoneMatch)
```
    如果内容未改变返回304代码，参数为服务器先前发送的Etag，与服务器回应的Etag比较判断是否改变例如：If-None-Match: “737060cd8c284d8af7ad3082f209582d”
    
    参数:
    
    ifNoneMatch - if-none-match
    
    返回:
    
    返回当前对象
  - ifRange
```
public HttpHeader ifRange(String ifRange)
```
    如果实体未改变，服务器发送客户端丢失的部分，否则发送整个实体。参数也为Etag 例如：If-Range: “737060cd8c284d8af7ad3082f209582d”
    
    参数:
    
    ifRange - if-range
    
    返回:
    
    返回当前对象
  - ifUnmodifiedSince
```
public HttpHeader ifUnmodifiedSince(String ifUnmodifiedSince)
```
    只在实体在指定时间之后未被修改才请求成功例如：If-Unmodified-Since: Sat, 29 Oct 2010 19:43:31 GMT
    
    参数:
    
    ifUnmodifiedSince - if-unmodified-since
    
    返回:
    
    返回当前对象
  - maxForwards
```
public HttpHeader maxForwards(String maxForwards)
```
    限制信息通过代理和网关传送的时间例如：Max-Forwards: 10
    
    参数:
    
    maxForwards - max-forwards
    
    返回:
    
    返回当前对象
  - pragma
```
public HttpHeader pragma(String pragma)
```
    用来包含实现特定的指令例如：Pragma: no-cache
    
    参数:
    
    pragma - pragma
    
    返回:
    
    返回当前对象
  - proxyAuthorization
```
public HttpHeader proxyAuthorization(String proxyAuthorization)
```
    连接到代理的授权证书例如：Proxy-Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
    
    参数:
    
    proxyAuthorization - proxy-authorization
    
    返回:
    
    返回当前对象
  - range
```
public HttpHeader range(String range)
```
    只请求实体的一部分，指定范围例如：Range: bytes=500-999
    
    参数:
    
    range - range
    
    返回:
    
    返回当前对象
  - referer
```
public HttpHeader referer(String referer)
```
    先前网页的地址，当前请求网页紧随其后,即来路例如：Referer: http://www.zcmhi.com/archives/71.html
    
    参数:
    
    referer - referer
    
    返回:
    
    返回当前对象
  - te
```
public HttpHeader te(String te)
```
    客户端愿意接受的传输编码，并通知服务器接受接受尾加头信息例如：TE: trailers,deflate;q=0.5
    
    参数:
    
    te - te
    
    返回:
    
    返回当前对象
  - upgrade
```
public HttpHeader upgrade(String upgrade)
```
    向服务器指定某种传输协议以便服务器进行转换（如果支持）例如：Upgrade: HTTP/2.0, SHTTP/1.3, IRC/6.9, RTA/x11
    
    参数:
    
    upgrade - upgrade
    
    返回:
    
    返回当前对象
  - userAgent
```
public HttpHeader userAgent(String userAgent)
```
    User-Agent的内容包含发出请求的用户信息
    
    参数:
    
    userAgent - user-agent
    
    返回:
    
    返回当前对象
  - warning
```
public HttpHeader warning(String warning)
```
    关于消息实体的警告信息例如：Warn: 199 Miscellaneous warning
    
    参数:
    
    warning - warning
    
    返回:
    
    返回当前对象
  - via
```
public HttpHeader via(String via)
```
    通知中间网关或代理服务器地址，通信协议例如：Via: 1.0 fred, 1.1 nowhere.com (Apache/1.1)
    
    参数:
    
    via - via
    
    返回:
    
    返回当前对象
  - keepAlive
```
public HttpHeader keepAlive(String keepAlive)
```
    设置此HTTP连接的持续时间（超时时间）例如：Keep-Alive: 300
    
    参数:
    
    keepAlive - keep-alive
    
    返回:
    
    返回当前对象
  - accept
```
public String accept()
```
  - acceptCharset
```
public String acceptCharset()
```
  - acceptEncoding
```
public String acceptEncoding()
```
  - acceptLanguage
```
public String acceptLanguage()
```
  - acceptRanges
```
public String acceptRanges()
```
  - authorization
```
public String authorization()
```
  - cacheControl
```
public String cacheControl()
```
  - connection
```
public String connection()
```
  - cookie
```
public String cookie()
```
  - contentLength
```
public String contentLength()
```
  - contentType
```
public String contentType()
```
  - date
```
public String date()
```
  - expect
```
public String expect()
```
  - from
```
public String from()
```
  - host
```
public String host()
```
  - ifMatch
```
public String ifMatch()
```
  - ifModifiedSince
```
public String ifModifiedSince()
```
  - ifNoneMatch
```
public String ifNoneMatch()
```
  - ifRange
```
public String ifRange()
```
  - ifUnmodifiedSince
```
public String ifUnmodifiedSince()
```
  - maxForwards
```
public String maxForwards()
```
  - pragma
```
public String pragma()
```
  - proxyAuthorization
```
public String proxyAuthorization()
```
  - referer
```
public String referer()
```
  - te
```
public String te()
```
  - upgrade
```
public String upgrade()
```
  - userAgent
```
public String userAgent()
```
  - via
```
public String via()
```
  - warning
```
public String warning()
```
  - keepAlive
```
public String keepAlive()
```

类 HttpHeader

嵌套类概要

方法概要

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

方法详细资料

custom

build

buildJson

other

accept

acceptCharset

acceptEncoding

acceptLanguage

acceptRanges

authorization

cacheControl

connection

cookie

contentLength

contentType

date

expect

from

host

ifMatch

ifModifiedSince

ifNoneMatch

ifRange

ifUnmodifiedSince

maxForwards

pragma

proxyAuthorization

range

referer

te

upgrade

userAgent

warning

via

keepAlive

accept

acceptCharset

acceptEncoding

acceptLanguage

acceptRanges

authorization

cacheControl

connection

cookie

contentLength

contentType

date

expect

from

host

ifMatch

ifModifiedSince

ifNoneMatch

ifRange

ifUnmodifiedSince

maxForwards

pragma

proxyAuthorization

referer

te

upgrade

userAgent

via

warning

keepAlive