HttpUtil (Netty API Reference (4.1.22.Final))

java.lang.Object
- io.netty.handler.codec.http.HttpUtil

public final class HttpUtil
extends java.lang.Object

在HTTP上下文中有用的实用方法。

方法摘要

所有方法静态方法具体的方法弃用的方法
Modifier and Type	Method and Description
`static java.nio.charset.Charset`	`getCharset(java.lang.CharSequence contentTypeValue)` 从Content-Type标头值中获取字符集。
`static java.nio.charset.Charset`	`getCharset(java.lang.CharSequence contentTypeValue, java.nio.charset.Charset defaultCharset)` 从Content-Type标头值中获取字符集。
`static java.nio.charset.Charset`	`getCharset(HttpMessage message)` 从消息的Content-Type头获取字符集。
`static java.nio.charset.Charset`	`getCharset(HttpMessage message, java.nio.charset.Charset defaultCharset)` 从消息的Content-Type头获取字符集。
`static java.lang.CharSequence`	`getCharsetAsSequence(java.lang.CharSequence contentTypeValue)` 从Content-Type头值中获取字符集作为字符序列。
`static java.lang.CharSequence`	`getCharsetAsSequence(HttpMessage message)` 从消息的Content-Type头部获取字符集作为字符序列。
`static java.lang.CharSequence`	`getCharsetAsString(HttpMessage message)` 已过时。使用`getCharsetAsSequence(HttpMessage)`
`static long`	`getContentLength(HttpMessage message)` 返回内容的长度。
`static int`	`getContentLength(HttpMessage message, int defaultValue)` 获取 `int`表示形式。
`static long`	`getContentLength(HttpMessage message, long defaultValue)` 如果消息没有 `"Content-Length" header` ，则返回内容的长度或指定的默认值。
`static java.lang.CharSequence`	`getMimeType(java.lang.CharSequence contentTypeValue)` 从Content-Type头值中取出MIME类型部分作为字符序列。
`static java.lang.CharSequence`	`getMimeType(HttpMessage message)` 从消息的Content-Type头中作为char序列获取MIME类型部分。
`static boolean`	`is100ContinueExpected(HttpMessage message)` 返回 `true`当且仅当指定的消息包含预期标题并且唯一期望值是100-继续期望值时。
`static boolean`	`isAsteriskForm(java.net.URI uri)` 根据 rfc7230, 5.3确定uri是否以星号形式。
`static boolean`	`isContentLengthSet(HttpMessage m)`
`static boolean`	`isKeepAlive(HttpMessage message)` 当且仅当连接可以保持打开并因此“保持活动”时才返回 `true` 。
`static boolean`	`isOriginForm(java.net.URI uri)` 根据 rfc7230, 5.3确定uri是否是原始形式。
`static boolean`	`isTransferEncodingChunked(HttpMessage message)` 检查指定的`HttpMessage`中的传输编码是否已分块
`static void`	`set100ContinueExpected(HttpMessage message, boolean expected)` 将 `"Expect: 100-continue"`标头设置为或从指定的消息中删除。
`static void`	`setContentLength(HttpMessage message, long length)` 设置 `"Content-Length"`标题。
`static void`	`setKeepAlive(HttpHeaders h, HttpVersion httpVersion, boolean keepAlive)` 根据指定消息的协议版本设置 `"Connection"`头的值。
`static void`	`setKeepAlive(HttpMessage message, boolean keepAlive)` 根据指定消息的协议版本设置 `"Connection"`标头的值。
`static void`	`setTransferEncodingChunked(HttpMessage m, boolean chunked)` 设置 `HttpHeaderNames.TRANSFER_ENCODING`要么包括 `HttpHeaderValues.CHUNKED`如果 `chunked`是 `true` ，或删除 `HttpHeaderValues.CHUNKED`如果 `chunked`是 `false` 。

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 方法详细信息
  - isOriginForm
```
public static boolean isOriginForm(java.net.URI uri)
```
    根据 rfc7230, 5.3确定uri是否为原始形式。
  - isAsteriskForm
```
public static boolean isAsteriskForm(java.net.URI uri)
```
    根据 rfc7230, 5.3确定uri是否以星号形式。
  - isKeepAlive
```
public static boolean isKeepAlive(HttpMessage message)
```
    当且仅当连接可以保持打开并因此“保持活动”时才返回true 。这种方法尊重的价值。 "Connection"头，然后返回值HttpVersion.isKeepAliveDefault() 。
  - setKeepAlive
```
public static void setKeepAlive(HttpMessage message,
                                boolean keepAlive)
```
    根据指定消息的协议版本设置"Connection"标头的值。此getMethod根据HttpVersion.isKeepAliveDefault()指定的消息协议版本的默认保持活动模式设置或删除"Connection"标头。
    - 如果连接默认保持活动状态：
      
      设置为"close"如果keepAlive是false 。
      
      否则删除。
    - 如果连接默认关闭：
      
      设置为"keep-alive"如果keepAlive是true 。
      
      否则删除。
    另请参见：
    
    setKeepAlive(HttpHeaders, HttpVersion, boolean)
  - setKeepAlive
```
public static void setKeepAlive(HttpHeaders h,
                                HttpVersion httpVersion,
                                boolean keepAlive)
```
    根据指定消息的协议版本设置"Connection"标头的值。此getMethod设置或删除"Connection"标头，具体取决于HttpVersion.isKeepAliveDefault()中指定的消息协议版本的默认保持活动模式。
    - 如果连接默认保持活动状态：
      
      设置为"close"如果keepAlive是false 。
      
      否则删除。
    - 如果连接默认关闭：
      
      设置为"keep-alive"如果keepAlive是true 。
      
      否则删除。
  - getContentLength
```
public static long getContentLength(HttpMessage message)
```
    返回内容的长度。请注意，此值不是从ByteBufHolder.content()中检索的，而是从"Content-Length"标题中检索的，因此它们彼此独立。
    
    结果
    
    内容的长度
    
    异常
    
    java.lang.NumberFormatException - 如果消息没有 "Content-Length"标题或其值不是数字
  - getContentLength
```
public static long getContentLength(HttpMessage message,
                                    long defaultValue)
```
    如果消息没有"Content-Length" header ，则返回内容的长度或指定的默认值。请注意，此值不是从ByteBufHolder.content()中检索的，而是从"Content-Length"标题中检索的，因此它们彼此独立。
    
    参数
    
    message - 消息
    
    defaultValue - 默认值
    
    结果
    
    内容长度或指定的默认值
    
    异常
    
    java.lang.NumberFormatException - 如果 "Content-Length"头不解析为长
  - getContentLength
```
public static int getContentLength(HttpMessage message,
                                   int defaultValue)
```
    获取 int代表性 getContentLength(HttpMessage, long) 。
    
    结果
    
    内容长度或defaultValue如果此消息没有"Content-Length"标头或其值不是数字）。不要超过整数的边界。
  - setContentLength
```
public static void setContentLength(HttpMessage message,
                                    long length)
```
    设置 "Content-Length"标题。
  - isContentLengthSet
```
public static boolean isContentLengthSet(HttpMessage m)
```
  - is100ContinueExpected
```
public static boolean is100ContinueExpected(HttpMessage message)
```
    返回true当且仅当指定的消息包含期望头并且唯一期望值是100-继续期望值时。请注意，如果期望头对消息无效（例如，消息是响应，或消息上的版本是HTTP / 1.0），则此方法返回false 。
    
    参数
    
    message - 消息
    
    结果
    
    true当且仅当期望100-继续存在并且它是唯一期望存在
  - set100ContinueExpected
```
public static void set100ContinueExpected(HttpMessage message,
                                          boolean expected)
```
    将"Expect: 100-continue"标头设置为或从指定的消息中删除。如果expected是true ，该"Expect: 100-continue"头设置和其他所有以前"Expect"头被删除。否则，所有"Expect"标头将被完全删除。
  - isTransferEncodingChunked
```
public static boolean isTransferEncodingChunked(HttpMessage message)
```
    检查以查看指定的HttpMessage中的传输编码是否已分块
    
    参数
    
    message - 要检查的消息
    
    结果
    
    如果传输编码是分块的，则为真，否则为false
  - setTransferEncodingChunked
```
public static void setTransferEncodingChunked(HttpMessage m,
                                              boolean chunked)
```
    设置 HttpHeaderNames.TRANSFER_ENCODING要么包括 HttpHeaderValues.CHUNKED如果 chunked是 true ，或删除 HttpHeaderValues.CHUNKED如果 chunked是 false 。
    
    参数
    
    m - 包含要修改标题的消息。
    
    chunked - 如果true然后在头中包含HttpHeaderValues.CHUNKED 。否则从标题中删除HttpHeaderValues.CHUNKED 。
  - getCharset
```
public static java.nio.charset.Charset getCharset(HttpMessage message)
```
    从消息的Content-Type头获取字符集。
    
    参数
    
    message - 从中获取Content-Type标头的实体
    
    结果
    
    来自消息的Content-Type头部的字符集或 CharsetUtil.ISO_8859_1，如果charset不存在或不可解析
  - getCharset
```
public static java.nio.charset.Charset getCharset(java.lang.CharSequence contentTypeValue)
```
    从Content-Type标头值中获取字符集。
    
    参数
    
    contentTypeValue - 要解析的Content-Type标头值
    
    结果
    
    来自消息内容类型标头的字符集或 CharsetUtil.ISO_8859_1如果字符集未呈现或不可解析
  - getCharset
```
public static java.nio.charset.Charset getCharset(HttpMessage message,
                                                  java.nio.charset.Charset defaultCharset)
```
    从消息的Content-Type头获取字符集。
    
    参数
    
    message - 从中获取Content-Type标头的实体
    
    defaultCharset - 在空白，不正确或不包含必需的部分标题值的情况下使用的结果
    
    结果
    
    来自消息的Content-Type头部的字符集或 defaultCharset如果字符集未呈现或不可 defaultCharset
  - getCharset
```
public static java.nio.charset.Charset getCharset(java.lang.CharSequence contentTypeValue,
                                                  java.nio.charset.Charset defaultCharset)
```
    从Content-Type标头值中获取字符集。
    
    参数
    
    contentTypeValue - 要解析的Content-Type标头值
    
    defaultCharset - 在空白，不正确或不包含必需的部分标题值的情况下使用的结果
    
    结果
    
    来自消息的Content-Type头部的字符集或 defaultCharset如果字符集未呈现或不可 defaultCharset
  - getCharsetAsString
```
@Deprecated
public static java.lang.CharSequence getCharsetAsString(HttpMessage message)
```
    已过时。使用getCharsetAsSequence(HttpMessage)
    
    从消息的Content-Type头部获取字符集作为字符序列。很多网站/可能的客户端都有charset =“CHARSET”，例如charset =“utf-8”。或“utf8”而不是“utf-8”这不符合标准，但此方法提供了在代码中手动捕获所需错误的功能
    
    参数
    
    message - 从中获取Content-Type标头的实体
    
    结果
    
    CharSequence带有来自消息内容类型头部的字符集或 null如果未提供字符集
  - getCharsetAsSequence
```
public static java.lang.CharSequence getCharsetAsSequence(HttpMessage message)
```
    从消息的Content-Type头部获取字符集作为字符序列。很多网站/可能的客户端都有charset =“CHARSET”，例如charset =“utf-8”。或“utf8”而不是“utf-8”这不符合标准，但此方法提供了在代码中手动捕获所需错误的功能
    
    结果
    
    CharSequence带有来自消息Content-Type头部的字符集或 null如果未提供字符集
  - getCharsetAsSequence
```
public static java.lang.CharSequence getCharsetAsSequence(java.lang.CharSequence contentTypeValue)
```
    从Content-Type头值中获取字符集作为字符序列。很多网站/可能的客户端都有charset =“CHARSET”，例如charset =“utf-8”。或“utf8”而不是“utf-8”这不符合标准，但此方法提供了在代码中手动捕获所需错误的功能
    
    参数
    
    contentTypeValue - 要解析的Content-Type标头值
    
    结果
    
    CharSequence带有来自消息内容类型标头的字符集或 null如果未提供字符集
    
    异常
    
    java.lang.NullPointerException - 如果是 contentTypeValue == null
  - getMimeType
```
public static java.lang.CharSequence getMimeType(HttpMessage message)
```
    从消息的Content-Type头中作为char序列获取MIME类型部分。
    
    参数
    
    message - 从中获取Content-Type标头的实体
    
    结果
    
    MIME类型为CharSequence从消息的Content-Type首部或null如果此标头的Content-Type头或MIME类型部分不呈现
    将返回“content-type：text / html; charset = utf-8” - “text / html”
    将返回“content-type：text / html” - “text / html”
    “content-type：”或否标题 - null我们将被退回
  - getMimeType
```
public static java.lang.CharSequence getMimeType(java.lang.CharSequence contentTypeValue)
```
    从Content-Type头值中取出MIME类型部分作为字符序列。
    
    参数
    
    contentTypeValue - 要解析的Content-Type标头值
    
    结果
    
    MIME类型为CharSequence从消息的Content-Type首部或null如果此标头的Content-Type头或MIME类型部分不呈现
    将返回“content-type：text / html; charset = utf-8” - “text / html”
    将返回“content-type：text / html” - “text / html”
    “content-type： null - null我们会被退回
    
    异常
    
    java.lang.NullPointerException - 如果是 contentTypeValue == null

Class HttpUtil

方法摘要

Methods inherited from class java.lang.Object

方法详细信息

isOriginForm

isAsteriskForm

isKeepAlive

setKeepAlive

setKeepAlive

getContentLength

getContentLength

getContentLength

setContentLength

isContentLengthSet

is100ContinueExpected

set100ContinueExpected

isTransferEncodingChunked

setTransferEncodingChunked

getCharset

getCharset

getCharset

getCharset

getCharsetAsString

getCharsetAsSequence

getCharsetAsSequence

getMimeType

getMimeType