【JavaWeb】Servlet系列——模板方法设计模式、HttpServlet源码分析、Web站点的欢迎页面、关于WEB-INF目录

携手创作，共同成长！这是我参与「掘金日新计划 · 8 月更文挑战」的第五天，点击查看活动详情 >>

19 模板方法设计模式

19.1 什么是设计模式？

• 某个问题的固定的解决方案。(可以被重复使用。)

19.2 你知道哪些设计模式？

GoF设计模式：

• 通常我们所说的23种设计模式。（Gang of Four：4人组提出的设计模式）
• 单例模式
• 工厂模式
• 代理模式
• 门面模式
• 责任链设计模式
• 观察者模式
• 模板方法设计模式
• .....

JavaEE设计模式：

• DAO
• DTO
• VO
• PO
• pojo
• ....

19.3 什么是模板方法设计模式？

• 在模板类的模板方法当中定义核心算法骨架，具体的实现步骤可以延迟到子类当中完成。

• 模板类通常是一个抽象类，模板类当中的模板方法定义核心算法，这个方法通常是final的（但也可以不是final的）

• 模板类当中的抽象方法就是不确定实现的方法，这个不确定怎么实现的事儿交给子类去做。

20 HttpServlet源码分析

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

20.1 HttpServlet在哪个包下？

• jakarta.servlet.http.HttpServlet

20.2 到目前为止我们接触了servlet规范中哪些接口？

• jakarta.servlet.Servlet 核心接口（接口）
• jakarta.servlet.ServletConfig Servlet配置信息接口（接口）
• jakarta.servlet.ServletContext Servlet上下文接口（接口）
• jakarta.servlet.ServletRequest Servlet请求接口（接口）
• jakarta.servlet.ServletResponse Servlet响应接口（接口）
• jakarta.servlet.ServletException Servlet异常（类）
• jakarta.servlet.GenericServlet 标准通用的Servlet类（抽象类）

20.3 http包下都有哪些类和接口呢？

​ jakarta.servlet.http.*;

• jakarta.servlet.http.HttpServlet （HTTP协议专用的Servlet类，抽象类）
• jakarta.servlet.http.HttpServletRequest （HTTP协议专用的请求对象）
• jakarta.servlet.http.HttpServletResponse （HTTP协议专用的响应对象）

20.4 HttpServletRequest对象中封装了什么信息？

• HttpServletRequest，简称request对象。
• HttpServletRequest中封装了请求协议的全部内容。
• Tomcat服务器（WEB服务器）将“请求协议”中的数据全部解析出来，然后将这些数据全部封装到request对象当中了。
• 也就是说，我们只要面向HttpServletRequest，就可以获取请求协议中的数据。

HttpServletResponse对象是专门用来响应HTTP协议到浏览器的。

20.5 Servlet生命周期

• 用户第一次请求
  • Tomcat服务器通过反射机制，调用无参数构造方法。创建Servlet对象。(web.xml文件中配置的Servlet类对应的对象。)
  • Tomcat服务器调用Servlet对象的init方法完成初始化。
  • Tomcat服务器调用Servlet对象的service方法处理请求。
• 用户第二次请求
  • Tomcat服务器调用Servlet对象的service方法处理请求。
• 用户第三次请求
  • Tomcat服务器调用Servlet对象的service方法处理请求。
• ....
  • Tomcat服务器调用Servlet对象的service方法处理请求。
• 服务器关闭
  • Tomcat服务器调用Servlet对象的destroy方法，做销毁之前的准备工作。
  • Tomcat服务器销毁Servlet对象。

20.6 HttpServlet源码分析：

public class HelloServlet extends HttpServlet {
	// 用户第一次请求，创建HelloServlet对象的时候，会执行这个无参数构造方法。
	public HelloServlet() {
    }
    
    //override 重写 doGet方法
    //override 重写 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()
	public void init() throws ServletException {
        // NOOP by default
    }
}

// HttpServlet模板类。
public abstract class HttpServlet extends GenericServlet {
    // 用户发送第一次请求的时候这个service会执行
    // 用户发送第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);
        }
    }
    
    
    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);
    }
    
}

通过以上源代码分析： 假设前端发送的请求是get请求，后端程序员重写的方法是doPost，假设前端发送的请求是post请求，后端程序员重写的方法是doGet，会发生什么呢？ 发生405这样的一个错误。 405表示前端的错误，发送的请求方式不对。和服务器不一致。不是服务器需要的请求方式。

通过以上源代码可以知道：只要HttpServlet类中的doGet方法或doPost方法执行了，必然405.

怎么避免405的错误呢？ 后端重写了doGet方法，前端一定要发get请求。后端重写了doPost方法，前端一定要发post请求。这样可以避免405错误。

​ 这种前端到底需要发什么样的请求，其实应该后端说了算。后端让发什么方式，前端就得发什么方式。 ​ ​ 有的人，你会看到为了避免405错误，在Servlet类当中，将doGet和doPost方法都进行了重写。这样确实可以避免405的发生，但是不建议，405错误还是有用的。该报错的时候就应该让他报错。如果你要是同时重写了doGet和doPost，那还不如你直接重写service方法好了。这样代码还能少写一点。

20.7 我们编写的HelloServlet直接继承HttpServlet，直接重写HttpServlet类中的service()方法行吗？

• 可以，只不过你享受不到405错误。享受不到HTTP协议专属的东西。

20.8 最终的一个Servlet类的开发步骤：

• 第一步：编写一个Servlet类，直接继承HttpServlet
• 第二步：重写doGet方法或者重写doPost方法，到底重写谁，javaweb程序员说了算。
• 第三步：将Servlet类配置到web.xml文件当中。
• 第四步：准备前端的页面（form表单），html页面当中的action值为“/项目名/路径”，form表单中指定请求路径即可。

21 关于一个web站点的欢迎页面

21.1 什么是一个web站点的欢迎页面？

对于一个webapp来说，我们是可以设置它的欢迎页面的。设置了欢迎页面之后，当你访问这个webapp的时候，或者访问这个web站点的时候，没有指定任何“资源路径”，这个时候会默认访问你的欢迎页面。

我们一般的访问方式是：

• http://localhost:8080/servlet06/login.html 这种方式是指定了要访问的就是login.html资源。

如果我们访问的方式是：

• http://localhost:8080/servlet06 如果我们访问的就是这个站点，没有指定具体的资源路径。它默认会访问你设置的欢迎页面。

21.2 怎么设置欢迎页面呢？

第一步：我在IDEA工具的web目录下新建了一个文件login.html

第二步：在web.xml文件中进行了以下的配置

• <welcome-file-list>
          <welcome-file>login.html</welcome-file>
  </welcome-file-list>
  

• 注意：设置欢迎页面的时候，这个路径不需要以“/”开始。并且这个路径默认是从webapp的根下开始查找。

第三步：启动服务器，浏览器地址栏输入地址

• http://localhost:8080/servlet07

21.3 如果在webapp的根下新建一个目录，目录中再给一个文件，那么这个欢迎页该如何设置呢？

• 在webapp根下新建page1

• 在page1下新建page2目录

• 在page2目录下新建page.html页面

• 在web.xml文件中应该这样配置

  • <welcome-file-list>
        <welcome-file>page1/page2/page.html</welcome-file>
    </welcome-file-list>
    

  • 注意：路径不需要以“/”开始，并且路径默认从webapp的根下开始找。

21.4 一个webapp是可以设置多个欢迎页面的

• <welcome-file-list>
      <welcome-file>page1/page2/page.html</welcome-file>
      <welcome-file>login.html</welcome-file>
  </welcome-file-list>
  

• 注意：越靠上的优先级越高。找不到的继续向下找。

21.5 当文件名设置为index.html不需要在web.xml文件中进行配置欢迎页面。

这是因为小猫咪Tomcat服务器已经提前配置好了。

实际上配置欢迎页面有两个地方可以配置：

• 一个是在webapp内部的web.xml文件中。（在这个地方配置的属于局部配置）

• 一个是在CATALINA_HOME/conf/web.xml文件中进行配置。（在这个地方配置的属于全局配置）

  • <welcome-file-list>
        <welcome-file>index.html</welcome-file>
        <welcome-file>index.htm</welcome-file>
        <welcome-file>index.jsp</welcome-file>
    </welcome-file-list>
    

  • Tomcat服务器的全局欢迎页面是：index.html index.htm index.jsp。如果你一个web站点没有设置局部的欢迎页面，Tomcat服务器就会以index.html index.htm index.jsp作为一个web站点的欢迎页面。

• 注意原则：局部优先原则。（就近原则）

21.6 欢迎页可以是一个Servlet吗？

• 当然可以。

• 你不要多想，欢迎页就是一个资源，既然是一个资源，那么可以是静态资源，也可以是动态资源。

• 静态资源：index.html welcome.html .....

• 动态资源：Servlet类。

• 步骤：

  • 第一步：写一个Servlet

    • public class WelcomeServlet extends HttpServlet {
          @Override
          protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
              response.setContentType("text/html");
              PrintWriter out = response.getWriter();
              out.print("<h1>welcome to bjpowernode!</h1>");
          }
      }
      

  • 第二步：在web.xml文件中配置servlet

    • <servlet>
          <servlet-name>welcomeServlet</servlet-name>
          <servlet-class>com.bjpowernode.javaweb.servlet.WelcomeServlet</servlet-class>
      </servlet>
      <servlet-mapping>
          <servlet-name>welcomeServlet</servlet-name>
          <url-pattern>/fdsa/fds/a/fds/af/ds/af/dsafdsafdsa</url-pattern>
      </servlet-mapping>
      

  • 第三步：在web.xml文件中配置欢迎页

    • <welcome-file-list>
          <welcome-file>fdsa/fds/a/fds/af/ds/af/dsafdsafdsa</welcome-file>
      </welcome-file-list>
      

22 关于WEB-INF目录

• 在WEB-INF目录下新建了一个文件：welcome.html
• 打开浏览器访问：http://localhost:8080/servlet07/WEB-INF/welcome.html 出现了404错误。
• 注意：放在WEB-INF目录下的资源是受保护的。在浏览器上不能够通过路径直接访问。所以像HTML、CSS、JS、image等静态资源一定要放到WEB-INF目录之外。