Servlet Response

ServletResponse 接口提供了一系列方法来设置和获取 HTTP 响应的信息。一个 ServletResponse 实例代表了一个 HTTP 响应,而这个响应可以包含一些 HTML 等内容和一些状态信息,如 HTTP 状态码和头信息。

响应体

使用 ServletResponse 接口,你可以很容易地向客户端发送响应体。响应体是 HTTP 响应的主要内容,可以是 HTML、CSS、JavaScript、文本或其他数据类型。下面是一些常用的方法:

  • void setContentType(String type):设置响应体的类型。例如,如果要返回 HTML 内容,则可以使用 text/html 作为 type 的值。
  • void setCharacterEncoding(String encoding):设置响应体的字符编码。例如,如果要返回 UTF-8 编码的 HTML 内容,则可以使用 UTF-8 作为 encoding 的值。
  • PrintWriter getWriter():获取一个 PrintWriter 实例,用于向客户端发送字符数据。
  • ServletOutputStream getOutputStream():获取一个 ServletOutputStream 实例,用于向客户端发送字节数据。

下面是一个示例代码,该代码会向客户端发送一个包含 HTML 内容的响应:

@WebServlet("/example")
public class ExampleServlet extends HttpServlet {
    protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
        response.setContentType("text/html");
        response.setCharacterEncoding("UTF-8");

        PrintWriter out = response.getWriter();
        out.println("<html>");
        out.println("<head>");
        out.println("<title>Example Servlet</title>");
        out.println("</head>");
        out.println("<body>");
        out.println("<h1>Hello, world!</h1>");
        out.println("</body>");
        out.println("</html>");
    }
}

在上面的代码中,我们首先使用 response.setContentType("text/html") 方法设置响应体的类型为 HTML。然后,我们使用 response.setCharacterEncoding("UTF-8") 方法设置响应体的字符编码为 UTF-8。接着,我们使用 response.getWriter() 方法获取一个 PrintWriter 实例,然后使用 out.println() 方法向客户端发送 HTML 内容。

响应头

除了响应体,HTTP 响应还可以包含一些元数据,如响应头信息。响应头信息提供了一些有关响应的附加信息,如响应体的类型、字符编码、过期时间等。使用 ServletResponse 接口,你也可以很容易地设置和获取响应头信息。下面是一些常用的方法:

  • void setHeader(String name, String value):设置响应头信息。例如,如果要设置 Content-Disposition 头信息,则可以使用 Content-Disposition 作为 name 的值,attachment; filename="example.txt" 作为 value 的值。
  • void addHeader(String name, String value):添加响应头信息。例如,如果要添加 Cache-Control 头信息,则可以使用 Cache-Control 作为 name 的值,no-cache 作为 value 的值。
  • void setIntHeader(String name, int value):设置响应头信息,值为一个整数。例如,如果要设置 Content-Length 头信息,则可以使用 Content-Length 作为 name 的值,文件大小作为 value 的值。
  • void addIntHeader(String name, int value):添加响应头信息,值为一个整数。例如,如果要添加 Expires 头信息,则可以使用 Expires 作为 name 的值,时间戳作为 value 的值。
  • String getHeader(String name):获取指定名称的响应头信息。例如,如果要获取 Content-Type 头信息,则可以使用 Content-Type 作为 name 的值。
  • Collection<String> getHeaders(String name):获取指定名称的所有响应头信息。例如,如果要获取 Set-Cookie 头信息,则可以使用 Set-Cookie 作为 name 的值。
  • int getIntHeader(String name):获取指定名称的整数型响应头信息。例如,如果要获取 Content-Length 头信息,则可以使用 Content-Length 作为 name 的值。

响应状态

响应状态是指 HTTP 响应的状态码,表示服务器对请求的处理结果。使用 ServletResponse 接口,你也可以设置响应状态码。下面是一些常用的状态码:

  • 200:表示请求已成功,且服务器已返回所请求的数据。
  • 302:表示请求的资源已被移动到新的位置,并且新的位置已经在响应头信息中返回。
  • 404:表示请求的资源不存在。
  • 500:表示服务器在处理请求时发生了错误。

设置响应状态码的方法如下:

  • void setStatus(int sc):设置响应状态码。例如,如果要设置状态码为 200,则可以使用 setStatus(200)

示例代码

下面是一个示例代码,该代码会向客户端发送一个包含 HTML 内容的响应,并设置响应头信息和状态码:

@WebServlet("/example")
public class ExampleServlet extends HttpServlet {
    protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
        response.setContentType("text/html");
        response.setCharacterEncoding("UTF-8");
        response.setStatus(HttpServletResponse.SC_OK);
        response.setHeader("Cache-Control", "no-cache");

        PrintWriter out = response.getWriter();
        out.println("<html>");
        out.println("<head>");
        out.println("<title>Example Servlet</title>");
        out.println("</head>");
        out.println("<body>");
        out.println("<h1>Hello, world!</h1>");
        out.println("</body>");
        out.println("</html>");
    }
}

在上面的代码中,我们使用 HttpServletResponse.SC_OK 设置响应状态码为 200。然后,我们使用 response.setHeader("Cache-Control", "no-cache") 方法设置 Cache-Control 头信息为 no-cache。最后,我们使用 out.println() 方法向客户端发送 HTML 内容。

总结

通过本文,可以了解 ServletResponse 接口的基本用法,包括如何向客户端发送响应体、如何设置响应头信息以及如何设置响应状态码。使用 ServletResponse 接口,你可以很容易地生成并发送 HTTP 响应,从而让客户端得到所需的数据和状态信息。当你需要向客户端返回一个 HTTP 响应时,ServletResponse 接口必须要了解的一个接口。