Servlet4.0 Response

Servlet4.0 Response对象

Response对象封装Server返回Client的所有信息。在HTTP协议中，Server传达给Client信息转换到HTTP Header或者HTTP BODY中。

5.1 Buffering缓冲区

Serverlet Container可以但不强制缓冲发送给客户端的内容。默认得，Servlet Container会开放接口设置缓冲区。如ServletResponse对象的方法可以设置缓冲区：

• getBufferSize
• setBufferSize
• isCommitted
• reset
• resetBuffer
• flushBuffer

当Servlet Container使用ServletOutputStream或者Write时，可以使用这些方法配置缓冲区。

getBufferSize返回缓冲区大小，若没有缓冲区，则返回0。

setBufferSize servlet可以使用该方法设置缓冲区大小。

申请的大小可以不是servlet请求的大小，但是至少要是请求的大小。这样，容器才能重使用该缓冲区，也能够提供足够的缓冲区。该方法需要在Servlet Container使用ServletOutputStream或者是Writer输出响应之前调用。

isCommitted方法表示内容是否已经响应给客户端。

flushBuffer方法强制将缓冲区数据输出至客户端。

reset方法强制清空缓冲区的数据若内容未提交至客户端。

resetBuffer方法强制清空缓冲区的数据但不包括请求头和响应码若内容未提交至客户端。

若内容已经输出至客户端，调用reset方法或resetBuffer方法都会抛出异常。但是不会改变缓冲区内容。

若缓冲区已经满需要立即输出响应内容给客户端。

5.2 HTTP响应头

Servlet可以通过ServletResponse接口的方法设置HTTP响应头。方法如下：

• setHeader
• addHeader

setHeader使用指定的名称替换已经存在的值，若header的值是集合，则集合的值被清空，使用新值替换。

addHeader添加指定名称的值到集合，该名称未存在，则会创建新集合。

若header的值是int类型或Date类型，则ServletResponse接口提供下述方法：

• setIntHeader
• setDateHeader
• addIntHeader
• setIntHeader

HTTP响应头需要比响应体输出至客户端，若响应体已经输出再输出响应头，Servlet Container会忽略响应头。

对于Servlet生成的内容Servlet 编程者有义务设置Content-Type。HTTP/1.1不要求必须设置Content-Type请求头。

推荐Servlet Container 使用X-Powerd-By请求头发布自身的实现。

这个请求头的值起码是一个以上。如"Servlet/4.0"。

5.3 HTTP Trailer 预告

HTTP Trailer是发送在响应体之后的响应头集合。适用于chunked编码发送的场景或者是其他额外的协议。

如果HTTP Trailer 请求头已经就绪则调用isTrailerFieldsReady()方法会返回true。

servlet可以通过HttpServletRequest接口的getTrailerFields()方法读取 Trailer 请求头。

servlet可以输出HTTP Trailer头通过提供Supplier给HttpServletResponse接口提供的setTrailerFields()方法。也可以通过提供的Supplier使用HttpServletResponse接口的getTrailerFields()方法获取HTTP Trailer请求头。

5.4 非阻塞IO

非阻塞IO只能在异步处理请求中使用。否则ServletInputStream.setReadListener和ServletOutputStream.setWriteListener调用时，需要抛出IllegalStateException异常。

为了支持在Web 容器支持非阻塞写，引入如下改变：

WriteListener提供下述回调方法：

• void onWritePossible() 当WriteListener注册到ServletOutputStream

后，当ServletOutputStream能写时会第一次调用WriteListener.onWritePossible()方法。

只有当ServletOutputStream.isReady()方法返回true才会调用WriteListener.onWritePossible()方法。

• onError(Throwable t)处理响应失败时会调用该方法。

伴随着WriteListener还有ServletOutputStream的其他方法帮助WebApplication判断是否准备好写内容至客户端。

• boolean isReady()如果写ServletOutputStream成功则会返回true。如果这个方法返回true,则ServletOutputStream写操作可以继续完成。若没有后续内容需要写，则该方法返回false。
• void setWriteListener(WriteListener listener) 关联WriteListener和ServletOutputStream。当可以写入数据时容器会调用WriteListener的方法。

注册的WriteListener会开始非阻塞IO，此时禁止转为阻塞IO。Servlet Container需要保证WriteListener的线程安全

5.5 Response对象的生命周期

每个Response对象都只能在service或者doFilter方法中生效，异步处理请求除外。

异步处理请求情况下，Response对象一直有效直到Servlet Container 调用AsyncContext.complete方法后。Servlet Container会回收Response对象为了提供性能，

研发需要明白，在这些作用域外引用Response对象都会引发未知错误。