HttpServerResponse (hutool 5.8.33 API)

java.lang.Object
- cn.hutool.http.server.HttpServerBase
- - cn.hutool.http.server.HttpServerResponse

All Implemented Interfaces:

Closeable, AutoCloseable
```
public class HttpServerResponse
extends HttpServerBase
```
Http响应对象，用于写出数据到客户端

Constructor Summary

Constructors
Constructor and Description

HttpServerResponse(com.sun.net.httpserver.HttpExchange httpExchange)
构造

Constructors
Constructor and Description
`HttpServerResponse(com.sun.net.httpserver.HttpExchange httpExchange)` 构造

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`HttpServerResponse`	`addHeader(String header, String value)` 添加响应头，如果已经存在，则追加
`com.sun.net.httpserver.Headers`	`getHeaders()` 获得所有响应头，获取后可以添加新的响应头
`OutputStream`	`getOut()` 获取响应数据流
`PrintWriter`	`getWriter()` 获取响应数据流
`HttpServerResponse`	`send(int httpStatusCode)` 发送HTTP状态码，Content-Length为0不定长度，会输出Transfer-encoding: chunked
`HttpServerResponse`	`send(int httpStatusCode, long bodyLength)` 发送HTTP状态码
`HttpServerResponse`	`send404(String content)` 发送404错误页
`HttpServerResponse`	`sendError(int errorCode, String content)` 发送错误页
`HttpServerResponse`	`sendOk()` 发送成功状态码
`HttpServerResponse`	`sendOk(int bodyLength)` 发送成功状态码
`HttpServerResponse`	`setAttr(String name, Object value)` 设置属性
`HttpServerResponse`	`setCharset(Charset charset)` 设置响应的编码
`HttpServerResponse`	`setContentLength(long contentLength)` 设置Content-Length头
`HttpServerResponse`	`setContentType(String contentType)` 设置Content-Type头，类似于:text/html;charset=utf-8 如果用户传入的信息无charset信息，自动根据charset补充，charset设置见`setCharset(Charset)`
`HttpServerResponse`	`setHeader(Header header, String value)` 设置响应头，如果已经存在，则覆盖
`HttpServerResponse`	`setHeader(String header, List<String> value)` 设置响应头，如果已经存在，则覆盖
`HttpServerResponse`	`setHeader(String header, String value)` 设置响应头，如果已经存在，则覆盖
`HttpServerResponse`	`setHeaders(Map<String,List<String>> headers)` 设置所有响应头，如果已经存在，则覆盖
`HttpServerResponse`	`write(byte[] data)` 写出数据到客户端
`HttpServerResponse`	`write(byte[] data, String contentType)` 写出数据到客户端
`HttpServerResponse`	`write(File file)` 返回文件给客户端（文件下载）
`HttpServerResponse`	`write(File file, String fileName)` 返回文件给客户端（文件下载）
`HttpServerResponse`	`write(InputStream in)` 写出数据到客户端
`HttpServerResponse`	`write(InputStream in, int length)` 写出数据到客户端
`HttpServerResponse`	`write(InputStream in, int length, String contentType)` 返回数据给客户端
`HttpServerResponse`	`write(InputStream in, int length, String contentType, String fileName)` 返回文件数据给客户端（文件下载）
`HttpServerResponse`	`write(InputStream in, String contentType)` 返回数据给客户端
`void`	`write(InputStream in, String contentType, String fileName)` 返回文件数据给客户端（文件下载）
`HttpServerResponse`	`write(String data)` 写出数据到客户端
`HttpServerResponse`	`write(String data, String contentType)` 写出数据到客户端

Methods inherited from class cn.hutool.http.server.HttpServerBase
close, getHttpContext, getHttpExchange

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

- Constructor Detail
  - HttpServerResponse
```
public HttpServerResponse(com.sun.net.httpserver.HttpExchange httpExchange)
```
    构造
    
    Parameters:
    
    httpExchange - HttpExchange
- Method Detail
  - send
```
public HttpServerResponse send(int httpStatusCode)
```
    发送HTTP状态码，Content-Length为0不定长度，会输出Transfer-encoding: chunked
    
    Parameters:
    
    httpStatusCode - HTTP状态码，见HttpStatus
    
    Returns:
    
    this
  - sendOk
```
public HttpServerResponse sendOk()
```
    发送成功状态码
    
    Returns:
    
    this
  - sendOk
```
public HttpServerResponse sendOk(int bodyLength)
```
    发送成功状态码
    
    Parameters:
    
    bodyLength - 响应体长度，默认0表示不定长度，会输出Transfer-encoding: chunked
    
    Returns:
    
    this
    
    Since:
    
    5.5.7
  - send404
```
public HttpServerResponse send404(String content)
```
    发送404错误页
    
    Parameters:
    
    content - 错误页页面内容，默认text/html类型
    
    Returns:
    
    this
  - sendError
```
public HttpServerResponse sendError(int errorCode,
                                    String content)
```
    发送错误页
    
    Parameters:
    
    errorCode - HTTP错误状态码，见HttpStatus
    
    content - 错误页页面内容，默认text/html类型
    
    Returns:
    
    this
  - send
```
public HttpServerResponse send(int httpStatusCode,
                               long bodyLength)
```
    发送HTTP状态码
    
    Parameters:
    
    httpStatusCode - HTTP状态码，见HttpStatus
    
    bodyLength - 响应体长度，默认0表示不定长度，会输出Transfer-encoding: chunked
    
    Returns:
    
    this
  - getHeaders
```
public com.sun.net.httpserver.Headers getHeaders()
```
    获得所有响应头，获取后可以添加新的响应头
    
    Returns:
    
    响应头
  - addHeader
```
public HttpServerResponse addHeader(String header,
                                    String value)
```
    添加响应头，如果已经存在，则追加
    
    Parameters:
    
    header - 头key
    
    value - 值
    
    Returns:
    
    this
  - setHeader
```
public HttpServerResponse setHeader(Header header,
                                    String value)
```
    设置响应头，如果已经存在，则覆盖
    
    Parameters:
    
    header - 头key
    
    value - 值
    
    Returns:
    
    this
  - setHeader
```
public HttpServerResponse setHeader(String header,
                                    String value)
```
    设置响应头，如果已经存在，则覆盖
    
    Parameters:
    
    header - 头key
    
    value - 值
    
    Returns:
    
    this
  - setHeader
```
public HttpServerResponse setHeader(String header,
                                    List<String> value)
```
    设置响应头，如果已经存在，则覆盖
    
    Parameters:
    
    header - 头key
    
    value - 值列表
    
    Returns:
    
    this
  - setHeaders
```
public HttpServerResponse setHeaders(Map<String,List<String>> headers)
```
    设置所有响应头，如果已经存在，则覆盖
    
    Parameters:
    
    headers - 响应头map
    
    Returns:
    
    this
  - setContentType
```
public HttpServerResponse setContentType(String contentType)
```
    设置Content-Type头，类似于:text/html;charset=utf-8
    如果用户传入的信息无charset信息，自动根据charset补充，charset设置见setCharset(Charset)
    
    Parameters:
    
    contentType - Content-Type头内容
    
    Returns:
    
    this
  - setContentLength
```
public HttpServerResponse setContentLength(long contentLength)
```
    设置Content-Length头
    
    Parameters:
    
    contentLength - Content-Length头内容
    
    Returns:
    
    this
  - setCharset
```
public HttpServerResponse setCharset(Charset charset)
```
    设置响应的编码
    
    Parameters:
    
    charset - 编码
    
    Returns:
    
    this
  - setAttr
```
public HttpServerResponse setAttr(String name,
                                  Object value)
```
    设置属性
    
    Parameters:
    
    name - 属性名
    
    value - 属性值
    
    Returns:
    
    this
  - getOut
```
public OutputStream getOut()
```
    获取响应数据流
    
    Returns:
    
    响应数据流
  - getWriter
```
public PrintWriter getWriter()
```
    获取响应数据流
    
    Returns:
    
    响应数据流
  - write
```
public HttpServerResponse write(String data,
                                String contentType)
```
    写出数据到客户端
    
    Parameters:
    
    data - 数据
    
    contentType - Content-Type类型
    
    Returns:
    
    this
  - write
```
public HttpServerResponse write(String data)
```
    写出数据到客户端
    
    Parameters:
    
    data - 数据
    
    Returns:
    
    this
  - write
```
public HttpServerResponse write(byte[] data,
                                String contentType)
```
    写出数据到客户端
    
    Parameters:
    
    data - 数据
    
    contentType - 返回的类型
    
    Returns:
    
    this
  - write
```
public HttpServerResponse write(byte[] data)
```
    写出数据到客户端
    
    Parameters:
    
    data - 数据
    
    Returns:
    
    this
  - write
```
public HttpServerResponse write(InputStream in,
                                String contentType)
```
    返回数据给客户端
    
    Parameters:
    
    in - 需要返回客户端的内容
    
    contentType - 返回的类型
    
    Returns:
    
    this
    
    Since:
    
    5.2.6
  - write
```
public HttpServerResponse write(InputStream in,
                                int length,
                                String contentType)
```
    返回数据给客户端
    
    Parameters:
    
    in - 需要返回客户端的内容
    
    length - 内容长度，默认0表示不定长度，会输出Transfer-encoding: chunked
    
    contentType - 返回的类型
    
    Returns:
    
    this
    
    Since:
    
    5.2.7
  - write
```
public HttpServerResponse write(InputStream in)
```
    写出数据到客户端
    
    Parameters:
    
    in - 数据流
    
    Returns:
    
    this
  - write
```
public HttpServerResponse write(InputStream in,
                                int length)
```
    写出数据到客户端
    
    Parameters:
    
    in - 数据流
    
    length - 指定响应内容长度，默认0表示不定长度，会输出Transfer-encoding: chunked
    
    Returns:
    
    this
  - write
```
public HttpServerResponse write(File file)
```
    返回文件给客户端（文件下载）
    
    Parameters:
    
    file - 写出的文件对象
    
    Returns:
    
    this
    
    Since:
    
    5.2.6
  - write
```
public HttpServerResponse write(File file,
                                String fileName)
```
    返回文件给客户端（文件下载）
    
    Parameters:
    
    file - 写出的文件对象
    
    fileName - 文件名
    
    Returns:
    
    this
    
    Since:
    
    5.5.8
  - write
```
public void write(InputStream in,
                  String contentType,
                  String fileName)
```
    返回文件数据给客户端（文件下载）
    
    Parameters:
    
    in - 需要返回客户端的内容
    
    contentType - 返回的类型
    
    fileName - 文件名
    
    Since:
    
    5.2.6
  - write
```
public HttpServerResponse write(InputStream in,
                                int length,
                                String contentType,
                                String fileName)
```
    返回文件数据给客户端（文件下载）
    
    Parameters:
    
    in - 需要返回客户端的内容
    
    length - 长度
    
    contentType - 返回的类型
    
    fileName - 文件名
    
    Returns:
    
    this
    
    Since:
    
    5.2.7

Class HttpServerResponse

Constructor Summary

Method Summary

Methods inherited from class cn.hutool.http.server.HttpServerBase

Methods inherited from class java.lang.Object

Constructor Detail

HttpServerResponse

Method Detail

send

sendOk

sendOk

send404

sendError

send

getHeaders

addHeader

setHeader

setHeader

setHeader

setHeaders

setContentType

setContentLength

setCharset

setAttr

getOut

getWriter

write

write

write

write

write

write

write

write

write

write

write

write