HttpServlet源码分析及HttpServletRequest接口

2023.10.20

HttpServlet

HttpServlet类是专门为HTTP协议准备的。比GenericServlet更加适合HTTP协议下的开发。

http包下都有哪些类和接口呢？（jakarta.servlet.http.*）

• jakarta.servlet.http.HttpServlet （HTTP协议专用的Servlet类，抽象类）

• jakarta.servlet.http.HttpServletRequest （HTTP协议专用的请求对象）：封装了请求协议的全部内容。Tomcat服务器（WEB服务器）将"请求协议"中的数据全部解析出来，然后将这些数据全部封装到request对象当中了。

• jakarta.servlet.http.HttpServletResponse （HTTP协议专用的响应对象）

httpServlet部分源码分析：

public class HelloServlet extends HttpServlet {
	// 用户第一次请求，创建HelloServlet对象的时候，会执行这个无参数构造方法。
	public HelloServlet() {
    }
    
    //override 需要前端发送get请求，就重写 doGet方法
    //override 需要前端发送post请求，就重写 doPost方法
}

public abstract class GenericServlet implements Servlet, ServletConfig,
        java.io.Serializable {
           
	// 用户第一次请求的时候，HelloServlet对象第一次被创建之后，这个init方法会执行。
    public void init(ServletConfig config) throws ServletException {
        this.config = config;
        this.init();
    }
	// 用户第一次请求的时候，带有参数的init(ServletConfig config)执行之后，会执行这个没有参数的init()，这个init是供程序员重写的。
	public void init() throws ServletException {
        // NOOP by default
    }
}

// HttpServlet模板类。
public abstract class HttpServlet extends GenericServlet {
    // 用户发送第一次请求的时候这个service会执行
    // 用户只要发送一次请求，这个service方法就会执行一次。
    @Override
    public void service(ServletRequest req, ServletResponse res)
        throws ServletException, IOException {

        HttpServletRequest  request;
        HttpServletResponse response;

        try {
            // 将ServletRequest和ServletResponse向下转型为带有Http的HttpServletRequest和HttpServletResponse
            request = (HttpServletRequest) req;
            response = (HttpServletResponse) res;
        } catch (ClassCastException e) {
            throw new ServletException(lStrings.getString("http.non_http"));
        }
        // 调用重载的service方法。
        service(request, response);
    }
    
    // 这个service方法的两个参数都是带有Http的。
    // 这个service是一个模板方法。
    // 在该方法中定义核心算法骨架，具体的实现步骤延迟到子类中去完成。
    protected void service(HttpServletRequest req, HttpServletResponse resp)
        throws ServletException, IOException {
        // 获取请求方式
        // 这个请求方式最终可能是：""
        // 注意：request.getMethod()方法获取的是请求方式，可能是七种之一：
        // GET POST PUT DELETE HEAD OPTIONS TRACE
        String method = req.getMethod();

        // 如果请求方式是GET请求，则执行doGet方法。
        if (method.equals(METHOD_GET)) {
            long lastModified = getLastModified(req);
            if (lastModified == -1) {
                // servlet doesn't support if-modified-since, no reason
                // to go through further expensive logic
                doGet(req, resp);
            } else {
                long ifModifiedSince;
                try {
                    ifModifiedSince = req.getDateHeader(HEADER_IFMODSINCE);
                } catch (IllegalArgumentException iae) {
                    // Invalid date header - proceed as if none was set
                    ifModifiedSince = -1;
                }
                if (ifModifiedSince < (lastModified / 1000 * 1000)) {
                    // If the servlet mod time is later, call doGet()
                    // Round down to the nearest second for a proper compare
                    // A ifModifiedSince of -1 will always be less
                    maybeSetLastModified(resp, lastModified);
                    doGet(req, resp);
                } else {
                    resp.setStatus(HttpServletResponse.SC_NOT_MODIFIED);
                }
            }

        } else if (method.equals(METHOD_HEAD)) {
            long lastModified = getLastModified(req);
            maybeSetLastModified(resp, lastModified);
            doHead(req, resp);

        } else if (method.equals(METHOD_POST)) {
            // 如果请求方式是POST请求，则执行doPost方法。
            doPost(req, resp);

        } else if (method.equals(METHOD_PUT)) {
            doPut(req, resp);

        } else if (method.equals(METHOD_DELETE)) {
            doDelete(req, resp);

        } else if (method.equals(METHOD_OPTIONS)) {
            doOptions(req,resp);

        } else if (method.equals(METHOD_TRACE)) {
            doTrace(req,resp);

        } else {
            //
            // Note that this means NO servlet supports whatever
            // method was requested, anywhere on this server.
            //

            String errMsg = lStrings.getString("http.method_not_implemented");
            Object[] errArgs = new Object[1];
            errArgs[0] = method;
            errMsg = MessageFormat.format(errMsg, errArgs);

            resp.sendError(HttpServletResponse.SC_NOT_IMPLEMENTED, errMsg);
        }
    }
    
    
    protected void doGet(HttpServletRequest req, HttpServletResponse resp)
        throws ServletException, IOException{
        // 报405错误
        String msg = lStrings.getString("http.method_get_not_supported");
        sendMethodNotAllowed(req, resp, msg);
    }
    
    protected void doPost(HttpServletRequest req, HttpServletResponse resp)
        throws ServletException, IOException {
        // 报405错误
        String msg = lStrings.getString("http.method_post_not_supported");
        sendMethodNotAllowed(req, resp, msg);
    }
    
}

通过以上源代码分析：

通过以上源代码可以知道：只要HttpServlet类中的doGet方法或doPost方法执行了，必然发生405错误。 所以说 假设前端发送的请求是get请求，而后端程序员重写的方法是doPost ， 或者， 假设前端发送的请求是post请求，后端程序员重写的方法是doGet， 那么就会发生405错误。

为了避免发生405错误，后端程序员希望前端传来什么类型的请求，就应该重写什么类型的方法，如：希望传来get类型的请求，就要重写doGet方法，防止报405错误。

一个Servlet类的开发步骤：

1. 编写一个Servlet类，直接继承HttpServlet
2. 重写doGet方法或者重写doPost方法，到底重写谁，看你需要前端传过来什么类型的请求。
3. 将Servlet类配置到web.xml文件当中。
4. 准备前端的页面（form表单），form表单中指定请求路径即可。

HttpServletRequest接口

HttpServletRequest是一个接口，全限定名称：jakarta.servlet.http.HttpServletRequest

HttpServletRequest接口是Servlet规范中的一员，其父接口是：ServletRequest。

HttpServletRequest对象中都有什么信息？都包装了什么信息？

HttpServletRequest对象是Tomcat服务器负责创建的，里面封装了HTTP的请求协议。

用户发送请求的时候，遵循了HTTP协议，发送的是HTTP的请求协议，Tomcat服务器将HTTP协议中的信息以及数据全部解析出来，然后Tomcat服务器把这些信息封装到HttpServletRequest对象当中，传给了我们javaweb程序员。

javaweb程序员面向HttpServletRequest接口编程，调用方法就可以获取到请求的信息了。

HttpServletRequest接口中有哪些常用的方法？

ap<String,String[]> getParameterMap() 这个是获取Map
Enumeration<String> getParameterNames() 这个是获取Map集合中所有的key
String[] getParameterValues(String name) 根据key获取Map集合的value
String getParameter(String name)  获取value这个一维数组当中的第一个元素。这个方法最常用。
// 以上的4个方法，和获取用户提交的数据有关系。

请求域

• request对象实际上又称为"请求域"对象。

先说说应用域对象是什么？

ServletContext （Servlet上下文对象。）

什么情况下会考虑向ServletContext这个应用域当中绑定数据？

• 第一：所有用户共享的数据。

• 第二：这个共享的数据量很小。

• 第三：这个共享的数据很少的修改操作。

• 在以上三个条件都满足的情况下，使用这个应用域对象，可以大大提高我们程序执行效率。

• 实际上向应用域当中绑定数据，就相当于把数据放到了缓存（Cache）当中，然后用户访问的时候直接从缓存中取，减少IO的操作，大大提升系统的性能，所以缓存技术是提高系统性能的重要手段。

常见的缓存技术：

• 字符串常量池

• 整数型常量池 [-128~127]，但凡是在这个范围当中的Integer对象不再创建新对象，直接从这个整数型常量池中获取。大大提升系统性能。

• 数据库连接池（提前创建好N个连接对象，将连接对象放到集合当中，使用连接对象的时候，直接从缓存中拿。省去了连接对象的创建过程。效率提升。）

• 线程池（Tomcat服务器就是支持多线程的。所谓的线程池就是提前先创建好N个线程对象，将线程对象存储到集合中，然后用户请求过来之后，直接从线程池中获取线程对象，直接拿来用。提升系统性能）

• redis、mongoDB.....

ServletContext当中有三个操作域的方法：

void setAttribute(String name, Object obj); // 向域当中绑定数据。
Object getAttribute(String name); // 从域当中根据name获取数据。
void removeAttribute(String name); // 将域当中绑定的数据移除

// 以上的操作类似于Map集合的操作。
Map<String, Object> map;
map.put("name", obj); // 向map集合中放key和value
Object obj = map.get("name"); // 通过map集合的key获取value
map.remove("name"); // 通过Map集合的key删除key和value这个键值对。

"请求域"对象

• "请求域"对象要比"应用域"对象范围小很多。生命周期短很多。请求域只在一次请求内有效。

• 一个请求对象request对应一个请求域对象。一次请求结束之后，这个请求域就销毁了。

• 请求域对象也有这三个方法：

void setAttribute(String name, Object obj); // 向域当中绑定数据。
Object getAttribute(String name); // 从域当中根据name获取数据。
void removeAttribute(String name); // 将域当中绑定的数据移除

• 请求域和应用域的选用原则？

  • 尽量使用小的域对象，因为小的域对象占用的资源较少。

由于一个request对应一个请求域，那两个Servlet怎么共享数据？

将数据放到ServletContext应用域当中，当然是可以的，但是应用域范围太大，占用资源太多。不建议使用。

可以将数据放到request域当中，然后AServlet转发到BServlet，保证AServlet和BServlet在同一次请求当中，这样就可以做到两个Servlet，或者多个Servlet共享同一份数据。

跳转的代码如下：

// 第一步：获取请求转发器对象
RequestDispatcher dispatcher = request.getRequestDispatcher("/b");
// 第二步：调用转发器的forward方法完成跳转/转发
dispatcher.forward(request,response);

// 第一步和第二步代码可以联合在一起。
request.getRequestDispatcher("/b").forward(request,response);

关于request对象中两个非常容易混淆的方法：

// uri?username=zhangsan&userpwd=123&sex=1
String username = request.getParameter("username");

// 之前一定是执行过：request.setAttribute("name", new Object())
Object obj = request.getAttribute("name");

以上两个方法的区别是什么？

• 第一个方法：获取的是用户在浏览器上提交的数据。
• 第二个方法：获取的是请求域当中绑定的数据。

HttpServletRequest接口的其他常用方法：

// 1、获取客户端的IP地址
String remoteAddr = request.getRemoteAddr();

// get请求在请求行上提交数据。
// post请求在请求体中提交数据。
// 2、设置请求体的字符集。（显然这个方法是处理POST请求的乱码问题。这种方式并不能解决get请求的乱码问题。）
// Tomcat10之后，request请求体当中的字符集默认就是UTF-8，不需要设置字符集，不会出现乱码问题。
// Tomcat9前（包括9在内），如果前端请求体提交的是中文，后端获取之后出现乱码，怎么解决这个乱码？执行以下代码。
request.setCharacterEncoding("UTF-8");

// 在Tomcat9之前（包括9），响应中文也是有乱码的，怎么解决这个响应的乱码？
response.setContentType("text/html;charset=UTF-8");
// 在Tomcat10之后，包括10在内，响应中文的时候就不在出现乱码问题了。以上代码就不需要设置UTF-8了。

// 注意一个细节
// 在Tomcat10包括10在内之后的版本，中文将不再出现乱码。（这也体现了中文地位的提升。）

// get请求乱码问题怎么解决？
// get请求发送的时候，数据是在请求行上提交的，不是在请求体当中提交的。
// 方案：修改CATALINA_HOME/conf/server.xml配置文件
<Connector URIEncoding="UTF-8" />
// 注意：从Tomcat8之后，URIEncoding的默认值就是UTF-8，所以GET请求也没有乱码问题了。
    
// 3、获取应用的根路径
String contextPath = request.getContextPath();

// 4、获取请求方式
String method = request.getMethod();

// 5、获取请求的URI
String uri = request.getRequestURI();  // /aaa/testRequest

// 6、获取servlet path
String servletPath = request.getServletPath(); //   /testRequest