Servlet详解

sunyiwenlong

于 2024-08-29 23:14:14 发布

阅读量579

点赞数 8

文章标签： servlet

本文链接：https://blog.csdn.net/qq_41542723/article/details/141679229

版权

Servlet生命周期

默认的情况下，用户第一次请求时，会调用Servlet接口实现类的无参构造方法实例化对象（AServlet对象）。
AServlet对象创建后，http服务器会立刻调用AServlet对象的init方法。
用户第一次请求，init方法执行后，http服务器会立刻去调用AServlet对象的service方法。
用户第二次、第三次、第四次请求时，AServlet对象没有被重复创建，而是使用之前创建的AServlet对象，直接调用AServlet对象的service方法。
当服务器停止时，在服务器停止之前，http服务器会调用AServlet对象的destroy方法。

注意事项：

网站中所有的Servlet接口实现类的实例对象，只能由Http服务器负责创建。开发人员不能手动创建Servlet接口实现类的实例对象。
可以手动配置，要求Http服务器在启动时自动创建某个Servlet接口实现类的实例对象。（通过web.xml配置文件配置）
因为SpringBoot通常会使用@ServletComponentScan注解来扫描应用中的@WebServlet，@WebFilter和@WebListener注解；所以在Sprin Boot应用中，当Spring容器启动时，会自动注册和初始化各种Servlet、Filter和ServletListener等。

Servlet接口中的方法

init方法
service方法
destroy方法
public ServletConfig getServletConfig方法
public String getServletInfo方法

Servlet实现类中方法的调用次数

无参构造方法只执行1次。
init方法，只执行1次。
service方法，用户发送一次请求则执行一次，发送N次请求则执行N次。
destroy方法，只执行1次。

Servlet实现类中使用注解

@WebServlet注解，相关属性：

name属性：用来指定Servlet的名字。等同于：
urlPatterns属性：用来指定Servlet的映射路径。可以指定多个字符串。
loadOnStartUp属性：用来指定在服务器启动阶段是否加载该Servlet。等同于：，填写一个大于0的整数即可


// 注意：当注解的属性是一个数组，并且数组中只有一个元素，大括号可以省略。
@WebServlet(urlPatterns = "/welcome")
@WebServlet(urlPatterns = {"/welcome1", "/welcome2"})

// 这个value属性和urlPatterns属性一致，都是用来指定Servlet的映射路径的。
@WebServlet(value = {"/welcome1", "/welcome2"})

// 如果注解的属性名是value的话，属性名也是可以省略的。
@WebServlet(value = "/welcome1")
@WebServlet({"/wel", "/abc", "/def"})

@WebServlet("/wel")
public class WelcomeServlet extends HttpServlet {
}

ServletConfig接口中的方法

在Servlet类当中，都可以使用this去调用以下方法。因为GenericServlet实现了ServletConfig接口：

String getServletName()方法：获取Servlet的name
ServletContext getServletContext()方法：获取ServletContext对象。
String getInitParameter(String var1)方法：通过初始化参数的name获取value。
Enumeration getInitParameterNames()方法：获取所有的初始化参数的name

GenericServlet抽象类实现了Servlet、ServletConfig接口

AServlet直接实现Servlet接口，会将该接口中所有方法实现。
进行改进：我们让抽象类GenericServlet把不需要的方法实现即可，让service方法变成抽象方法。

public abstract class GenericServlet implements Servlet, ServletConfig, Serializable {
    private static final long serialVersionUID = 1L;
    private transient ServletConfig config;

    public GenericServlet() {
    }

    public void destroy() {
    }

    public String getInitParameter(String name) {
        return this.getServletConfig().getInitParameter(name);
    }

    public Enumeration<String> getInitParameterNames() {
        return this.getServletConfig().getInitParameterNames();
    }
	// GenericServlet类提供一个获取私有成员变量ServletConfig对象的方法。
	// 这个方法获取的就是Tomcat服务器创建的ServletConfig对象。
    public ServletConfig getServletConfig() {
        return this.config;
    }
	// GenericServlet类提供一个通过ServletConfig对象获取ServletContext对象的方法。
    public ServletContext getServletContext() {
        return this.getServletConfig().getServletContext();
    }

    public String getServletInfo() {
        return "";
    }
	// Tomcat服务器创建了ServletConfig对象，然后调用这个init方法，将ServletConfig对象传给了init方法
    public void init(ServletConfig config) throws ServletException {// 这个带参数的init方法由Tomcat服务器调用
    	// 把Tomcat服务器传的ServletConfig对象，赋值给GenericServlet类中的私有成员变量this.config。
    	// 把局部变量变成GenericServlet类中的私有成员变量。
        this.config = config;
        this.init();
    }
	// 另外提供一个init方法，目的是为了让子类重写。
	// 无参init方法能做的事情，无参构造方法也能做，之所以再提供一个init方法，是为了安全性。
	// 无参构造方法可以不用显示声明。显示的声明无参构造方法，不安全。人为操作，可能会导致创建对象失败。
    public void init() throws ServletException {
    }

    public void log(String message) {
        ServletContext var10000 = this.getServletContext();
        String var10001 = this.getServletName();
        var10000.log(var10001 + ": " + message);
    }

    public void log(String message, Throwable t) {
        this.getServletContext().log(this.getServletName() + ": " + message, t);
    }
	// 让service方法变成抽象方法，给子类实现
    public abstract void service(ServletRequest var1, ServletResponse var2) throws ServletException, IOException;

    public String getServletName() {
        return this.config.getServletName();
    }
}

public class AServlet  extends GenericServlet{
    @Override
    public void service(ServletRequest servletRequest, ServletResponse servletResponse) throws ServletException, IOException {

    }
}

思考第一个问题：AServlet还能使用GenericServlet类中的init方法吗?

可以。会执行GenericServlet类中的init方法。

思考第二个问题：init方法是谁调用的？

Tomcat服务器调用的。

思考第三个问题：init方法中的ServletConfig对象是谁创建的？是谁传过来的？

Tomcat服务器先创建了ServletConfig对象，然后调用init方法，将ServletConfig对象传给了init方法。

思考一下Tomcat服务器伪代码：

 public class Tomcat {
          public static void main(String[] args){
              // .....
              // Tomcat服务器伪代码
              // 创建LoginServlet对象（通过反射机制，调用无参数构造方法来实例化MyServlet对象）
              Class clazz = Class.forName("com.bjpowernode.javaweb.servlet.MyservletServlet");
              Object obj = clazz.newInstance();
              
              // 向下转型
              Servlet servlet = (Servlet)obj;
              
              // 创建ServletConfig对象
              // Tomcat服务器负责将ServletConfig对象实例化出来。
              // 多态（Tomcat服务器完全实现了Servlet规范）
              ServletConfig servletConfig = new org.apache.catalina.core.StandardWrapperFacade();
              
              // 调用Servlet的init方法
              //将这个实参传入到那个方法里。
              servlet.init(servletConfig);
              
              // 调用Servlet的service方法
              // ....
              
          }
      }

ServletContext应用域

一个ServletContext对象通常对应的是一个web.xml文件。
只要在同一个webapp当中，只要在同一个应用当中，所有的Servlet对象都是共享同一个ServletContext对象的。
ServletContext对象在服务器启动阶段创建，在服务器关闭的时候销毁。这就是ServletContext对象的生命周期。ServletContext对象是应用级对象。
ServletContext是一个接口，Tomcat服务器对ServletContext接口进行了实现。
ServletContext对象的创建也是Tomcat服务器来完成的。启动webapp的时候创建的。

ServletContext常用的方法

// 获取应用的根路径（非常重要），因为在java源代码当中有一些地方可能会需要应用的根路径，这个方法可以动态获取应用的根路径
// 在java源码当中，不要将应用的根路径写死，因为你永远都不知道这个应用在最终部署的时候，起一个什么名字。
public String getContextPath();
//String contextPath = application.getContextPath();

// 获取文件的绝对路径（真实路径）
public String getRealPath(String path);

// ServletContext对象还有另一个名字：应用域（后面还有其他域，例如：请求域、会话域）

// 如果所有的用户共享一份数据，并且这个数据很少的被修改，并且这个数据量很少，
// 可以将这些数据放到ServletContext这个应用域中

// 存（怎么向ServletContext应用域中存数据）
public void setAttribute(String name, Object value); // map.put(k, v)
// 取（怎么从ServletContext应用域中取数据）
public Object getAttribute(String name); // Object v = map.get(k)
// 删（怎么删除ServletContext应用域中的数据）
public void removeAttribute(String name); // map.remove(k)

// 通过ServletContext对象也是可以记录日志的
public void log(String message);
public void log(String message, Throwable t);
// 这些日志信息记录到哪里了？
// localhost.2021-11-05.log

// Tomcat服务器的logs目录下都有哪些日志文件？
//catalina.2021-11-05.log 服务器端的java程序运行的控制台信息。
//localhost.2021-11-05.log ServletContext对象的log方法记录的日志信息存储到这个文件中。
//localhost_access_log.2021-11-05.txt 访问日志

HttpServlet类

专门为HTTP协议准备的一个HttpServlet类。我们编写的Servlet类要继承HttpServlet。

HttpServlet在哪个包下？
○ jakarta.servlet.http.HttpServlet
http包下都有哪些类和接口呢？jakarta.servlet.http.*;
○ jakarta.servlet.http.HttpServlet （HTTP协议专用的Servlet类，抽象类）
○ jakarta.servlet.http.HttpServletRequest （HTTP协议专用的请求对象）
○ jakarta.servlet.http.HttpServletResponse （HTTP协议专用的响应对象）
HttpServletRequest对象中封装了什么信息？
○ HttpServletRequest，简称request对象。
○ HttpServletRequest中封装了请求协议的全部内容。
○ Tomcat服务器（WEB服务器）将“请求协议”中的数据全部解析出来，然后将这些数据全部封装到request对象当中了。
○ 也就是说，我们只要面向HttpServletRequest，就可以获取请求协议中的数据。
HttpServletResponse对象是专门用来响应HTTP协议到浏览器的。

public class HelloServlet extends HttpServlet {
	// 用户第一次请求，创建HelloServlet对象的时候，会执行这个无参数构造方法。
	public HelloServlet() {
    }
    
}

public abstract class GenericServlet implements Servlet, ServletConfig,
        java.io.Serializable {
           
	/* 用户第一次请求的时候，HelloServlet对象第一次被创建之后，因为HelloServlet
       没有init方法，HttpServlet也没有，所以执行GenericServlet的init有参构造.。  */
    public void init(ServletConfig config) throws ServletException {
        this.config = config;
        this.init();
    }
	// 用户第一次请求的时候，带有参数的init(ServletConfig config)执行之后，会执行这个没有参数的init()
	public void init() throws ServletException {
        // NOOP by default
    }
}

// HttpServlet模板类。
public abstract class HttpServlet extends GenericServlet {
    // 用户发送第一次请求的时候这个service会执行(HelloServlet没有service,执行Httpservlet的)
    // 用户发送第N次请求的时候，这个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);
        }
    }
    
    /*子类没有重写doGet就会走父类的，报405错误*/
    protected void doGet(HttpServletRequest req, HttpServletResponse resp)
        throws ServletException, IOException{
        // 报405错误
        String msg = lStrings.getString("http.method_get_not_supported");
        sendMethodNotAllowed(req, resp, msg);
    }
        /*子类没有重写doPost就会走父类的，报405错误*/
    protected void doPost(HttpServletRequest req, HttpServletResponse resp)
        throws ServletException, IOException {
        // 报405错误
        String msg = lStrings.getString("http.method_post_not_supported");
        sendMethodNotAllowed(req, resp, msg);
    }
    
}

/*
通过以上源代码分析：
	假设前端发送的请求是get请求，后端程序员重写的方法是doPost
	假设前端发送的请求是post请求，后端程序员重写的方法是doGet
	会发生什么呢？
		发生405这样的一个错误。
		405表示前端的错误，发送的请求方式不对。和服务器不一致。不是服务器需要的请求方式。
	
	通过以上源代码可以知道：只要HttpServlet类中的doGet方法或doPost方法执行了，必然405.

怎么避免405的错误呢？
	后端重写了doGet方法，前端一定要发get请求。
	后端重写了doPost方法，前端一定要发post请求。
	这样可以避免405错误。
	
	这种前端到底需要发什么样的请求，其实应该后端说了算。后端让发什么方式，前端就得发什么方式。
*/

我们编写的HelloServlet直接继承HttpServlet，直接重写HttpServlet类中的service()方法行吗？
○ 可以，只不过你享受不到405错误。享受不到HTTP协议专属的东西。
到今天我们终于得到了最终的一个Servlet类的开发步骤：
○ 第一步：编写一个Servlet类，直接继承HttpServlet
○ 第二步：重写doGet方法或者重写doPost方法，到底重写谁，javaweb程序员说了算。
○ 第三步：将Servlet类配置到web.xml文件当中。
○ 第四步：准备前端的页面（form表单），form表单中指定请求路径即可。

Servlet教程地址

sunyiwenlong

关注

8
点赞
踩
8

收藏

觉得还不错? 一键收藏
0
评论
Servlet详解

Tomcat服务器先创建了ServletConfig对象，然后调用init方法，将ServletConfig对象传给了init方法。在Servlet类当中，都可以使用this去调用以下方法。我们编写的Servlet类要继承HttpServlet。进行改进：我们让抽象类GenericServlet把不需要的方法实现即可，让service方法变成抽象方法。AServlet直接实现Servlet接口，会将该接口中所有方法实现。会执行GenericServlet类中的init方法。Tomcat服务器调用的。
复制链接

扫一扫