ServerResponse (hutool 6.0.0-M20 API)

All Known Implementing Classes:

JavaxServletResponse, ServletResponse, SmartHttpResponse, SunServerResponse, TomcatResponse, UndertowResponse
```
public interface ServerResponse
```
服务端响应接口，用于写出数据

Author:

Looly

Field Summary

Fields
Modifier and Type Field and Description

static Charset DEFAULT_CHARSET
默认编码，用于获取请求头和响应头编码，默认为UTF-8

Fields
Modifier and Type	Field and Description
`static Charset`	`DEFAULT_CHARSET` 默认编码，用于获取请求头和响应头编码，默认为UTF-8

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`ServerResponse`	`addHeader(String header, String value)` 添加响应头，如果已经存在，则追加
`Charset`	`getCharset()` 获取编码，默认为UTF-8
`OutputStream`	`getOutputStream()` 获取输出流，用于写出数据
`default PrintWriter`	`getWriter()` 获取响应数据流
`ServerResponse`	`setCharset(Charset charset)` 设置编码，默认为UTF-8
`default ServerResponse`	`setContentLength(long contentLength)` 设置Content-Length头，-1表示移除头
`default ServerResponse`	`setContentType(String contentType)` 设置Content-Type头，类似于:text/html;charset=utf-8 如果用户传入的信息无charset信息，自动根据charset补充，charset设置见`setCharset(Charset)`
`default ServerResponse`	`setHeader(HeaderName headerName, String value)` 设置响应头，如果已经存在，则覆盖
`default ServerResponse`	`setHeader(String header, List<String> value)` 设置响应头，如果已经存在，则覆盖
`ServerResponse`	`setHeader(String header, String value)` 设置响应头，如果已经存在，则覆盖
`ServerResponse`	`setStatus(int statusCode)` 设置状态码
`default ServerResponse`	`write(byte[] data)` 写出数据到客户端
`default ServerResponse`	`write(byte[] data, String contentType)` 写出数据到客户端
`default ServerResponse`	`write(File file)` 返回文件给客户端（文件下载）
`default ServerResponse`	`write(File file, String fileName)` 返回文件给客户端（文件下载）
`default ServerResponse`	`write(InputStream in)` 写出数据到客户端
`default ServerResponse`	`write(InputStream in, int length)` 写出数据到客户端
`default ServerResponse`	`write(InputStream in, int length, String contentType)` 返回数据给客户端
`default ServerResponse`	`write(InputStream in, int length, String contentType, String fileName)` 返回文件数据给客户端（文件下载）
`default ServerResponse`	`write(InputStream in, String contentType)` 返回数据给客户端
`default ServerResponse`	`write(InputStream in, String contentType, String fileName)` 返回文件数据给客户端（文件下载）
`default ServerResponse`	`write(String data)` 写出数据到客户端
`default ServerResponse`	`write(String data, String contentType)` 写出数据到客户端

- Field Detail
  - DEFAULT_CHARSET
```
static final Charset DEFAULT_CHARSET
```
    默认编码，用于获取请求头和响应头编码，默认为UTF-8
- Method Detail
  - setStatus
```
ServerResponse setStatus(int statusCode)
```
    设置状态码
    
    Parameters:
    
    statusCode - 状态码
    
    Returns:
    
    this
  - setCharset
```
ServerResponse setCharset(Charset charset)
```
    设置编码，默认为UTF-8
    
    Parameters:
    
    charset - 编码
    
    Returns:
    
    this
  - getCharset
```
Charset getCharset()
```
    获取编码，默认为UTF-8
    
    Returns:
    
    编码
  - addHeader
```
ServerResponse addHeader(String header,
                         String value)
```
    添加响应头，如果已经存在，则追加
    
    Parameters:
    
    header - 头key
    
    value - 值
    
    Returns:
    
    this
  - setHeader
```
ServerResponse setHeader(String header,
                         String value)
```
    设置响应头，如果已经存在，则覆盖
    
    Parameters:
    
    header - 头key
    
    value - 值
    
    Returns:
    
    this
  - setHeader
```
default ServerResponse setHeader(HeaderName headerName,
                                 String value)
```
    设置响应头，如果已经存在，则覆盖
    
    Parameters:
    
    headerName - 头key
    
    value - 值
    
    Returns:
    
    this
  - setHeader
```
default ServerResponse setHeader(String header,
                                 List<String> value)
```
    设置响应头，如果已经存在，则覆盖
    
    Parameters:
    
    header - 头key
    
    value - 值列表，如果为空，删除该header
    
    Returns:
    
    this
  - setContentType
```
default ServerResponse setContentType(String contentType)
```
    设置Content-Type头，类似于:text/html;charset=utf-8
    如果用户传入的信息无charset信息，自动根据charset补充，charset设置见setCharset(Charset)
    
    Parameters:
    
    contentType - Content-Type头内容
    
    Returns:
    
    this
  - setContentLength
```
default ServerResponse setContentLength(long contentLength)
```
    设置Content-Length头，-1表示移除头
    
    Parameters:
    
    contentLength - Content-Length头内容
    
    Returns:
    
    this
  - getOutputStream
```
OutputStream getOutputStream()
```
    获取输出流，用于写出数据
    
    Returns:
    
    输出流
  - getWriter
```
default PrintWriter getWriter()
```
    获取响应数据流
    
    Returns:
    
    响应数据流
  - write
```
default ServerResponse write(String data,
                             String contentType)
```
    写出数据到客户端
    
    Parameters:
    
    data - 数据
    
    contentType - Content-Type类型
    
    Returns:
    
    this
  - write
```
default ServerResponse write(String data)
```
    写出数据到客户端
    
    Parameters:
    
    data - 数据
    
    Returns:
    
    this
  - write
```
default ServerResponse write(byte[] data,
                             String contentType)
```
    写出数据到客户端
    
    Parameters:
    
    data - 数据
    
    contentType - 返回的类型
    
    Returns:
    
    this
  - write
```
default ServerResponse write(byte[] data)
```
    写出数据到客户端
    
    Parameters:
    
    data - 数据
    
    Returns:
    
    this
  - write
```
default ServerResponse write(InputStream in,
                             String contentType)
```
    返回数据给客户端
    
    Parameters:
    
    in - 需要返回客户端的内容
    
    contentType - 返回的类型
    
    Returns:
    
    this
    
    Since:
    
    5.2.6
  - write
```
default ServerResponse write(InputStream in,
                             int length,
                             String contentType)
```
    返回数据给客户端
    
    Parameters:
    
    in - 需要返回客户端的内容
    
    length - 内容长度，默认0表示不定长度，会输出Transfer-encoding: chunked
    
    contentType - 返回的类型
    
    Returns:
    
    this
    
    Since:
    
    5.2.7
  - write
```
default ServerResponse write(InputStream in)
```
    写出数据到客户端
    
    Parameters:
    
    in - 数据流
    
    Returns:
    
    this
  - write
```
default ServerResponse write(InputStream in,
                             int length)
```
    写出数据到客户端
    
    Parameters:
    
    in - 数据流
    
    length - 指定响应内容长度，默认0表示不定长度，会输出Transfer-encoding: chunked
    
    Returns:
    
    this
  - write
```
default ServerResponse write(File file)
```
    返回文件给客户端（文件下载）
    
    Parameters:
    
    file - 写出的文件对象
    
    Returns:
    
    this
    
    Since:
    
    5.2.6
  - write
```
default ServerResponse write(File file,
                             String fileName)
```
    返回文件给客户端（文件下载）
    
    Parameters:
    
    file - 写出的文件对象
    
    fileName - 文件名
    
    Returns:
    
    this
  - write
```
default ServerResponse write(InputStream in,
                             String contentType,
                             String fileName)
```
    返回文件数据给客户端（文件下载）
    
    Parameters:
    
    in - 需要返回客户端的内容
    
    contentType - 返回的类型
    
    fileName - 文件名
    
    Returns:
    
    this
  - write
```
default ServerResponse write(InputStream in,
                             int length,
                             String contentType,
                             String fileName)
```
    返回文件数据给客户端（文件下载）
    
    Parameters:
    
    in - 需要返回客户端的内容
    
    length - 长度
    
    contentType - 返回的类型
    
    fileName - 文件名
    
    Returns:
    
    this

Interface ServerResponse

Field Summary

Method Summary

Field Detail

DEFAULT_CHARSET

Method Detail

setStatus

setCharset

getCharset

addHeader

setHeader

setHeader

setHeader

setContentType

setContentLength

getOutputStream

getWriter

write

write

write

write

write

write

write

write

write

write

write

write