Code Correctness: Multiple Stream Commits

Servlet 的輸出串流交付之後，將串流緩衝區重設或執行重新交付給串流的任何其他動作等，都是錯誤的。同樣地，在呼叫 getOutputStream 之後呼叫 getWriter() 或 (反之亦然) 也是錯誤的。

發送 HttpServletRequest、重新導向 HttpServletResponse 或排清 Servlet 的輸出串流緩衝區等，都會造成相關的串流交付。任何後續的緩衝區重設或串流交付時 (例如其他排清或重新導向)，將造成 IllegalStateException。

此外，Java Servlet 會允許使用 ServletOutputStream 或 PrintWriter (但不是兩者同時)，將資料重新寫入回應串流。呼叫 getOutputStream() 之後呼叫 getWriter() (反之亦然) 也會造成 IllegalStateException。



在執行階段，IllegalStateException 可防止回應處理常式執行完成，以有效撤銷回應。這樣可能會造成伺服器不穩定，而這是錯誤執行的 Servlet 徵兆。

範例 1：以下程式碼在 Servlet 回應輸出串流緩衝區排清後，將 Servlet 回應重新導向。

public class RedirectServlet extends HttpServlet {
    public void doGet(HttpServletRequest req, HttpServletResponse res) throws ServletException, IOException {
        ...
        OutputStream out = res.getOutputStream();
        ...
        // flushes, and thereby commits, the output stream
        out.flush();
        out.close();        // redirecting the response causes an IllegalStateException
        res.sendRedirect("http://www.acme.com");
    }
}

範例 2：相反地，以下程式碼嘗試在發送要求之後寫入和排清 PrintWriter 的緩衝區。

public class FlushServlet extends HttpServlet {
    public void doGet(HttpServletRequest req, HttpServletResponse res) throws ServletException, IOException {
        ...
        // forwards the request, implicitly committing the stream
        getServletConfig().getServletContext().getRequestDispatcher("/jsp/boom.jsp").forward(req, res);
        ...

        // IllegalStateException; cannot redirect after forwarding
        res.sendRedirect("http://www.acme.com/jsp/boomboom.jsp");

        PrintWriter out = res.getWriter();

        // writing to an already-committed stream will not cause an exception,
        // but will not apply these changes to the final output, either
        out.print("Writing here does nothing");

        // IllegalStateException; cannot flush a response's buffer after forwarding the request
        out.flush();
        out.close();
    }
}