Java HttpServletRequest 深入解析

简介

在 Java Web 开发中，HttpServletRequest 是一个极为重要的类，它是 Java Servlet API 的一部分，用于封装客户端（如浏览器）向服务器发送的 HTTP 请求信息。借助 HttpServletRequest，开发者能够获取请求的各种信息，像请求头、请求参数、请求方法等，从而依据这些信息进行相应的处理。本文将详细阐述 HttpServletRequest 的基础概念、使用方法、常见实践以及最佳实践。

1. 基础概念

1.1 什么是 HttpServletRequest

HttpServletRequest 是一个接口，它继承自 ServletRequest 接口，主要用于处理 HTTP 请求。当客户端向服务器发送 HTTP 请求时，服务器会创建一个 HttpServletRequest 对象，并将该对象传递给相应的 Servlet 进行处理。HttpServletRequest 对象封装了请求的所有信息，包括请求的方法（如 GET、POST）、请求的 URL、请求头、请求参数等。

1.2 主要作用

获取请求的基本信息，如请求的 URL、请求方法等。
获取请求头信息，如用户代理、Cookie 等。
获取请求参数，如表单数据、URL 参数等。
处理会话信息，如获取会话 ID、会话属性等。

2. 使用方法

2.1 获取请求的基本信息

以下是一个简单的示例，展示如何获取请求的基本信息：

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;

@WebServlet("/basicInfo")
public class BasicInfoServlet extends HttpServlet {
    @Override
    protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
        // 获取请求的 URL
        String requestURL = request.getRequestURL().toString();
        // 获取请求的方法
        String method = request.getMethod();

        response.setContentType("text/html;charset=UTF-8");
        response.getWriter().println("请求的 URL: " + requestURL);
        response.getWriter().println("请求的方法: " + method);
    }
}

2.2 获取请求头信息

以下示例展示了如何获取请求头信息：

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;

@WebServlet("/headerInfo")
public class HeaderInfoServlet extends HttpServlet {
    @Override
    protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
        // 获取用户代理
        String userAgent = request.getHeader("User-Agent");

        response.setContentType("text/html;charset=UTF-8");
        response.getWriter().println("用户代理: " + userAgent);
    }
}

2.3 获取请求参数

以下示例展示了如何获取请求参数：

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;

@WebServlet("/paramInfo")
public class ParamInfoServlet extends HttpServlet {
    @Override
    protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
        // 获取名为 "name" 的请求参数
        String name = request.getParameter("name");

        response.setContentType("text/html;charset=UTF-8");
        response.getWriter().println("姓名: " + name);
    }
}

3. 常见实践

3.1 处理表单数据

当用户提交表单时，通常使用 POST 方法，服务器可以通过 HttpServletRequest 获取表单数据。以下是一个处理表单数据的示例：

<!DOCTYPE html>
<html>
<head>
    <meta charset="UTF-8">
    <title>表单示例</title>
</head>
<body>
    <form action="processForm" method="post">
        <label for="username">用户名:</label>
        <input type="text" id="username" name="username"><br>
        <label for="password">密码:</label>
        <input type="password" id="password" name="password"><br>
        <input type="submit" value="提交">
    </form>
</body>
</html>

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;

@WebServlet("/processForm")
public class ProcessFormServlet extends HttpServlet {
    @Override
    protected void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
        // 设置请求的字符编码
        request.setCharacterEncoding("UTF-8");
        // 获取表单数据
        String username = request.getParameter("username");
        String password = request.getParameter("password");

        response.setContentType("text/html;charset=UTF-8");
        response.getWriter().println("用户名: " + username);
        response.getWriter().println("密码: " + password);
    }
}

3.2 处理文件上传

HttpServletRequest 可以用于处理文件上传。通常需要使用第三方库，如 Apache Commons FileUpload。以下是一个简单的文件上传示例：

import org.apache.commons.fileupload.FileItem;
import org.apache.commons.fileupload.disk.DiskFileItemFactory;
import org.apache.commons.fileupload.servlet.ServletFileUpload;

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.File;
import java.io.IOException;
import java.util.List;

@WebServlet("/uploadFile")
public class FileUploadServlet extends HttpServlet {
    protected void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
        boolean isMultipart = ServletFileUpload.isMultipartContent(request);
        if (isMultipart) {
            DiskFileItemFactory factory = new DiskFileItemFactory();
            ServletFileUpload upload = new ServletFileUpload(factory);
            try {
                List<FileItem> items = upload.parseRequest(request);
                for (FileItem item : items) {
                    if (!item.isFormField()) {
                        String fileName = item.getName();
                        if (fileName != null && !fileName.isEmpty()) {
                            File saveFile = new File("uploads/" + fileName);
                            item.write(saveFile);
                        }
                    }
                }
                response.getWriter().println("文件上传成功");
            } catch (Exception e) {
                e.printStackTrace();
                response.getWriter().println("文件上传失败");
            }
        }
    }
}

4. 最佳实践

4.1 设置字符编码

在处理请求参数和响应内容时，应该设置正确的字符编码，以避免中文乱码问题。在获取请求参数之前，使用 request.setCharacterEncoding("UTF-8") 设置请求的字符编码；在输出响应内容之前，使用 response.setContentType("text/html;charset=UTF-8") 设置响应的字符编码。

4.2 验证请求参数

在使用请求参数之前，应该对其进行验证，以确保参数的合法性。例如，检查参数是否为空、是否符合格式要求等。

4.3 防止 SQL 注入和 XSS 攻击

在处理用户输入时，应该对输入进行过滤和转义，以防止 SQL 注入和 XSS 攻击。可以使用 Java 的 PreparedStatement 来防止 SQL 注入，使用 Apache Commons Lang 库的 StringEscapeUtils 来防止 XSS 攻击。

5. 小结

HttpServletRequest 是 Java Web 开发中不可或缺的一部分，它提供了丰富的方法来获取客户端发送的 HTTP 请求信息。通过本文的介绍，我们了解了 HttpServletRequest 的基础概念、使用方法、常见实践以及最佳实践。在实际开发中，我们应该充分利用 HttpServletRequest 的功能，同时遵循最佳实践，以提高代码的安全性和健壮性。