Servlet 简介

Java Servlet 是运行在 Web 服务器或应用服务器上的程序，它是作为来自 Web 浏览器或其他 HTTP 客户端的请求和 HTTP 服务器上的数据库或应用程序之间的中间层。

Servlet 基本使用

1. 创建Maven Web项目后，导入Servlet依赖坐标和Tomcat插件：

    1<dependencies>
    2    <!-- Servlet依赖 -->
    3    <dependency>
    4        <groupId>javax.servlet</groupId>
    5        <artifactId>javax.servlet-api</artifactId>
    6        <version>3.1.0</version>
    7        <scope>provided</scope>
    8    </dependency>
    9</dependencies>
   10<build>
   11   <plugins>
   12   	<!-- Tomcat插件 -->
   13       <plugin>
   14           <groupId>org.apache.tomcat.maven</groupId>
   15           <artifactId>tomcat7-maven-plugin</artifactId>
   16           <version>2.2</version>
   17       </plugin>
   18   </plugins>
   19</build>
   

   使用<scope>provided</scope>的原因： provided指的是在编译和测试过程中有效，最后生成的war包时不会加入。 因为Tomcat的lib目录中已经有servlet-api这个jar包，如果在生成war包的时候生效就会和Tomcat中的jar包冲突，导致报错。

2. 创建Servlet类，实现Servlet接口，并重写接口中所有方法：

    1package com.linner.web;
    2
    3import javax.servlet.*;
    4import javax.servlet.annotation.WebServlet;
    5import java.io.IOException;
    6
    7@WebServlet("/demo")
    8public class ServletDemo implements Servlet {
    9
   10    @Override
   11    public void service(ServletRequest servletRequest, ServletResponse servletResponse) throws ServletException, IOException {
   12        System.out.println("Hello Servlet!");
   13    }
   14
   15    @Override
   16    public String getServletInfo() {
   17        return null;
   18    }
   19
   20    @Override
   21    public void destroy() {
   22
   23    }
   24
   25    @Override
   26    public void init(ServletConfig servletConfig) throws ServletException {
   27
   28    }
   29
   30    @Override
   31    public ServletConfig getServletConfig() {
   32        return null;
   33    }
   34}
   

   • 使用@WebServlet注解配置该Servlet的访问路径：@WebServlet("/demo")

3. 启动Tomcat，根据自己项目和Tomcat的配置访问，如：http://localhost:8080/web-demo/demo

   访问成功后可以看到在控制台输出service()方法中的内容。

Servlet 执行流程

运行Tomcat时并没有显式创建Servlet对象，也没有显式调用其中的方法。可控制台依然输出了ServletDemo.service()中的内容。

访问该Tomcat项目时，浏览器发出http://localhost:8080/web-demo/demo请求，从请求中可以解析出三部分内容：

• 根据localhost:8080可以找到要访问的Tomcat Web服务器
• 根据web-demo可以找到部署在Tomcat服务器上的web-demo项目
• 根据demo可以找到要访问的是项目中的哪个Servlet类，根据@WebServlet后面的值进行匹配

找到ServletDemo这个类后，Tomcat Web服务器就会为ServletDemo这个类创建一个对象，然后调用对象中的service()方法。

而Tomcat则是根据@WebServlet注解或web.xml配置文件等信息来创建对应的Servlet对象。

Servlet 生命周期

生命周期是指对象的生命周期指一个对象从被创建到被销毁的整个过程。

Servlet运行在Servlet容器（web服务器）中，其生命周期由容器来管理，分为4个阶段：

1. 加载和实例化：默认情况下，Servlet会在第一次访问时被容器创建

2. 初始化：在Servlet实例化之后，容器将调用Servlet的init()方法初始化这个对象，完成一些如加载配置文件、创建连接等初始化的工作

   init()方法仅会被调用一次

3. 请求处理：每次请求Servlet时，Servlet容器都会调用Servlet的service()方法对请求进行处理

4. 服务终止：当需要释放内存或者容器关闭时，容器就会调用Servlet实例的destroy()方法完成资源的释放

   在destroy()方法调用之后，容器会释放这个Servlet实例，该实例随后会被Java的垃圾收集器所回收

可以把Servlet的创建放到服务器启动的时候来创建（修改@WebServlet注解）：

1@WebServlet(urlPatterns = "/demo1", loadOnStartup = 1)

loadOnstartup的取值有两类情况：

1. 负整数：第一次访问时创建Servlet对象
2. 非负整数：服务器启动时创建Servlet对象，数字越小优先级越高（0的优先级最高）

Example：

 1package com.linner.web;
 2  
 3import javax.servlet.*;
 4import javax.servlet.annotation.WebServlet;
 5import java.io.IOException;
 6
 7@WebServlet(urlPatterns = "/demo", loadOnStartup = 1)
 8public class ServletDemo implements Servlet {
 9    /**
10     * 初始化方法
11     * - 在Servlet被第一次访问或者服务器启动时被调用一次
12     */
13    public void init(ServletConfig config) throws ServletException {
14        System.out.println("init...");
15    }
16
17    /**
18     * 提供服务
19     * - 每一次Servlet被访问时被调用
20     * - 可被调用多次
21     */
22    public void service(ServletRequest req, ServletResponse res) throws ServletException, IOException {
23        System.out.println("Hello Servlet!");
24    }
25
26    /**
27     * 销毁方法
28     * - 调用时机：内存释放或者服务器关闭的时候被调用一次
29     */
30    public void destroy() {
31        System.out.println("destroy...");
32    }
33
34    public ServletConfig getServletConfig() {
35        return null;
36    }
37
38    public String getServletInfo() {
39        return null;
40    }
41}

注意：若要在关闭Tomcat时调用destroy()，需要在正常关闭Tomcat的情况下，destroy()才能被执行。

Servlet 方法

剩下两个Servlet方法的作用是：

• 获取Servlet信息：

  1public String getServletInfo() {
  2    return "";
  3}
  

• 获取ServletConfig对象：

  1public String getServletInfo() {
  2    return "";
  3}
  

  ServletConfig对象，Tomcat Web服务器在创建Servlet对象的时候会通过init()方法将其作为参数传入：

  1void init(ServletConfig config) throws ServletException
  

  在getServletInfo()中仅需将服务器传过来的ServletConfig进行返回即可：

   1private ServletConfig servletConfig;
   2
   3public void init(ServletConfig config) throws ServletException {
   4    // 获取服务器传入的ServletConfig
   5    this.servletConfig = config;
   6    System.out.println("init...");
   7}
   8public ServletConfig getServletConfig() {
   9    // 将服务器传入的ServletConfig返回
  10    return servletConfig;
  11}
  

urlPattern 配置

urlPatterns 多路径访问

一个Servlet，可以配置多个访问路径（urlPattern）：

1@WebServlet(urlPatterns = {"/path1", "/path2", ....})

精确匹配

• 配置路径：

  1@WebServlet("/path/servlet")
  

• 访问路径：http://localhost:8080/web-demo/path/servlet

目录匹配

• 配置路径：

  1@WebServlet("/path/*")
  

• 访问路径：

  • http://localhost:8080/web-demo/path/abc
  • http://localhost:8080/web-demo/path/def
  • http://localhost:8080/web-demo/path/
  • http://localhost:8080/web-demo/path/anypath
  • …

精确匹配优先级要高于目录匹配

扩展名匹配

• 配置路径：

  1@WebServlet("*.html")
  

• 访问路径：

  • http://localhost:8080/web-demo/index.html
  • http://localhost:8080/web-demo/login.html
  • http://localhost:8080/web-demo/any_name.html
  • …

注意：

1. 如果路径配置的不是扩展名，那么在路径的前面就必须要加/否则会报错
2. 如果路径配置的是*.html，那么在*.html的前面不能加/，否则会报错

任意匹配

• 配置路径：

  1@WebServlet("/")
  

  或

  1@WebServlet("/*")
  

• 访问路径：

  任何以 http://localhost:8080/web-demo/ 开头的路径

/和/*的区别：

1. 当项目中的Servlet配置了@WebServlet("/")，会覆盖掉Tomcat中的DefaultServlet，当其他的urlPattern都匹配不上时都会走这个Servlet。
2. 当项目中配置了@WebServlet("/")，意味着匹配任意访问路径。
3. DefaultServlet是用来处理静态资源，如果使用@WebServlet("/")将其覆盖掉。当请求静态资源的时候则是使用了自定义的Servlet类，最终会导致静态资源不能被访问。

XML配置Servlet（不推荐）

Servlet从3.0版本后才开始支持注解配置，而3.0版本前只支持XML配置文件的配置方法。

• 编写Servlet类：

  1package com.linner.web;
  2
  3import javax.servlet.*;
  4import javax.servlet.annotation.WebServlet;
  5import java.io.IOException;
  6
  7public class ServletDemo implements Servlet {
  8    // ...
  9}
  

• 在web.xml中配置该Servlet：

   1<?xml version="1.0" encoding="UTF-8"?>
   2<web-app xmlns="http://xmlns.jcp.org/xml/ns/javaee"
   3        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
   4        xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/web-app_4_0.xsd"
   5        version="4.0">
   6
   7    <!-- Servlet 全类名 -->
   8    <servlet>
   9        <!-- Servlet的名称，名字任意 -->
  10        <servlet-name>demo</servlet-name>
  11        <!-- Servlet的类全名 -->
  12        <servlet-class>com.linner.web.ServletDemo</servlet-class>
  13    </servlet>
  14
  15    <!-- Servlet 访问路径 -->
  16    <servlet-mapping>
  17        <!-- Servlet的名称，要和上面的名称一致 -->
  18        <servlet-name>demo</servlet-name>
  19        <!-- Servlet的访问路径 -->
  20        <url-pattern>/demo</url-pattern>
  21    </servlet-mapping>
  22</web-app>
  

ServletRequest 和 ServletResponse

在 Servlet.service() 中有这样两个参数，它们的类型是 ServletRequest 和 ServletResponse。这两个参数就是Servlet的 Request 和 Response 对象。

Request是请求对象，作用是将客户端的请求数据从客户端发送到服务端；Response是响应对象，作用是将服务端的响应数据从服务端发送到客户端。