如何在Servlet容器中使用HttpServletResponse？

news2025/2/14 5:30:21

HttpServletResponse 是 Java Servlet API 中的一个接口，它代表了服务器对客户端的响应。通过 HttpServletResponse 对象，可以设置响应的状态码、发送数据到客户端（如 HTML 页面、文件等）、添加响应头信息等。下面是如何在 Servlet 容器中使用 HttpServletResponse 的一些基本操作示例。

基本用法

当编写一个 Servlet 时，通常会覆盖 doGet() 或 doPost() 方法，在这些方法中，可以访问 HttpServletRequest 和 HttpServletResponse 对象来处理请求和生成响应。

发送简单文本响应

这是一个简单的例子，展示了如何向客户端发送纯文本消息：

import javax.servlet.ServletException;
import javax.servlet.annotation.WebServlet;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
import java.io.PrintWriter;

@WebServlet("/hello")
public class HelloServlet extends HttpServlet {
    protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
        // 设置响应内容类型
        response.setContentType("text/plain;charset=UTF-8");

        // 获取PrintWriter对象用于输出文本
        PrintWriter out = response.getWriter();
        
        // 输出文本
        out.println("Hello, World!");
    }
}

设置响应状态码

可以通过 HttpServletResponse 来设置 HTTP 状态码，例如返回一个 404 错误页面：

protected void doGet(HttpServletRequest request, HttpServletResponse response) throws IOException {
    response.sendError(HttpServletResponse.SC_NOT_FOUND, "Resource not available");
}

发送重定向

要将用户重定向到另一个 URL，可以使用 sendRedirect() 方法：

protected void doGet(HttpServletRequest request, HttpServletResponse response) throws IOException {
    response.sendRedirect("http://example.com");
}

设置响应头

有时候需要为响应添加自定义的 HTTP 头信息，比如缓存控制或身份验证信息：

protected void doGet(HttpServletRequest request, HttpServletResponse response) throws IOException {
    // 设置响应头
    response.setHeader("Cache-Control", "no-cache, no-store, must-revalidate");
    response.setHeader("Pragma", "no-cache");
    response.setDateHeader("Expires", 0);

    // 输出内容
    PrintWriter out = response.getWriter();
    out.println("This page will not be cached.");
}

发送文件下载

如果想让用户的浏览器下载一个文件而不是直接显示它，可以通过设置适当的响应头实现：

protected void doGet(HttpServletRequest request, HttpServletResponse response) throws IOException {
    String filePath = "/path/to/file.txt"; // 文件路径
    File downloadFile = new File(filePath);
    FileInputStream inStream = new FileInputStream(downloadFile);

    // 获取 MIME 类型
    String mimeType = getServletContext().getMimeType(filePath);
    if (mimeType == null) {
        mimeType = "application/octet-stream";
    }

    // 设置响应头
    response.setContentType(mimeType);
    response.setContentLength((int) downloadFile.length());
    String headerKey = "Content-Disposition";
    String headerValue = String.format("attachment; filename=\"%s\"", downloadFile.getName());
    response.setHeader(headerKey, headerValue);

    // 写入输入流到响应输出流
    OutputStream outStream = response.getOutputStream();
    byte[] buffer = new byte[4096];
    int bytesRead = -1;

    while ((bytesRead = inStream.read(buffer)) != -1) {
        outStream.write(buffer, 0, bytesRead);
    }

    inStream.close();
    outStream.close();
}