Servlet

(小程序服务/服务连接器)

一、生命周期(从创建直到毁灭的整个过程)

  • Servlet 通过调用 init () 方法进行初始化。
  • Servlet 调用 service() 方法来处理客户端的请求。
  • Servlet 通过调用 destroy() 方法终止(结束)。
  • 最后,Servlet 是由 JVM 的垃圾回收器进行垃圾回收的。
  1. init( )方法:

    • init 方法被设计成只调用一次。
    • 当用户调用一个 Servlet 时,就会创建一个 Servlet 实例,每一个用户请求都会产生一个新的线程,适当的时候移交给 doGet 或 doPost 方法。init() 方法简单地创建或加载一些数据,这些数据将被用于 Servlet 的整个生命周期。
    • 定义方法:

      public void init() throws ServletException {
        // 初始化代码...
      }
  2. service( )方法:

    • 执行实际任务的主要方法。
    • Servlet 容器(即 Web 服务器)调用 service() 方法来处理来自客户端(浏览器)的请求,并把格式化的响应写回给客户端。
    • 每次服务器接收到一个 Servlet 请求时,服务器会产生一个新的线程并调用服务。service() 方法检查 HTTP 请求类型(GET、POST、PUT、DELETE 等),并在适当的时候调用 doGet、doPost、doPut,doDelete 等方法。
    • 定义方法:

      public void service(ServletRequest request, 
                          ServletResponse response) 
            throws ServletException, IOException{
      }
    • doGet( )方法:

      GET 请求来自于一个 URL 的正常请求,或者来自于一个未指定 METHOD 的 HTML 表单,它由 doGet() 方法处理。

      public void doGet(HttpServletRequest request,
                        HttpServletResponse response)
          throws ServletException, IOException {
          // Servlet 代码
      }
    • doPost( )方法:

      POST 请求来自于一个特别指定了 METHOD 为 POST 的 HTML 表单,它由 doPost() 方法处理。

      public void doPost(HttpServletRequest request,
                         HttpServletResponse response)
          throws ServletException, IOException {
          // Servlet 代码
      }
  3. destroy( )方法:

    • destroy() 方法只会被调用一次,在 Servlet 生命周期结束时被调用。
    • destroy() 方法可以让您的 Servlet 关闭数据库连接、停止后台线程、把 Cookie 列表或点击计数器写入到磁盘,并执行其他类似的清理活动。
    • 在调用 destroy() 方法之后,servlet 对象被标记为垃圾回收。
    • 定义方法:

      public void destroy() {
          // 终止化代码...
        }

二、Servlet实例

  1. Hello World示例代码:

    // 导入必需的 java 库
    import java.io.*;
    import javax.servlet.*;
    import javax.servlet.http.*;
    
    // 扩展 HttpServlet 类
    public class HelloWorld extends HttpServlet {
     
      private String message;
    
      public void init() throws ServletException
      {
          // 执行必需的初始化
          message = "Hello World";
      }
    
      public void doGet(HttpServletRequest request,
                        HttpServletResponse response)
                throws ServletException, IOException
      {
          // 设置响应内容类型
          response.setContentType("text/html");
    
          // 实际的逻辑是在这里
          PrintWriter out = response.getWriter();
          out.println("<h1>" + message + "</h1>");
      }
      
      public void destroy()
      {
          // 什么也不做
      }
    }

三、Servlet表单数据

  • 用来传递信息,从浏览器到Web服务器,最终到后台程序;
  1. GET方法:

    • GET 方法向页面请求发送已编码的用户信息。页面和已编码的信息中间用 ? 字符分隔,如下所示:

      http://www.test.com/hello?key1=value1&key2=value2
    • GET 方法是默认的从浏览器向 Web 服务器传递信息的方法,它会产生一个很长的字符串,出现在浏览器的地址栏中。
    • 如果您要向服务器传递的是密码或其他的敏感信息,请不要使用 GET 方法。
    • GET 方法有大小限制:请求字符串中最多只能有 1024 个字符。
    • 这些信息使用 QUERY_STRING 头传递,并可以通过 QUERY_STRING 环境变量访问,Servlet 使用 doGet() 方法处理这种类型的请求。
  2. POST方法:

    • 向后台程序传递信息的比较可靠的方法;
    • POST 方法打包信息的方式与 GET 方法基本相同,但是 POST 方法不是把信息作为 URL 中 ? 字符后的文本字符串进行发送,而是把这些信息作为一个单独的消息。消息以标准输出的形式传到后台程序,您可以解析和使用这些标准输出。Servlet 使用 doPost() 方法处理这种类型的请求。
  3. 使用Servlet读取表单数据:

    • getParameter():您可以调用 request.getParameter() 方法来获取表单参数的值。
    • getParameterValues():如果参数出现一次以上,则调用该方法,并返回多个值,例如复选框。
    • getParameterNames():如果您想要得到当前请求中的所有参数的完整列表,则调用该方法。
  4. 使用URL的GET方法实例:

    package com.runoob.test;
    
    import java.io.IOException;
    import java.io.PrintWriter;
    
    import javax.servlet.ServletException;
    import javax.servlet.annotation.WebServlet;
    import javax.servlet.http.HttpServlet;
    import javax.servlet.http.HttpServletRequest;
    import javax.servlet.http.HttpServletResponse;
    
    /**
     * Servlet implementation class HelloForm
     */
    @WebServlet("/HelloForm")
    public class HelloForm extends HttpServlet {
        private static final long serialVersionUID = 1L;
           
        /**
         * @see HttpServlet#HttpServlet()
         */
        public HelloForm() {
            super();
            // TODO Auto-generated constructor stub
        }
    
        /**
         * @see HttpServlet#doGet(HttpServletRequest request, HttpServletResponse response)
         */
        protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
            // 设置响应内容类型
            response.setContentType("text/html;charset=UTF-8");
    
            PrintWriter out = response.getWriter();
            String title = "使用 GET 方法读取表单数据";
            // 处理中文
            String name =new String(request.getParameter("name").getBytes("ISO-8859-1"),"UTF-8");
            String docType = "<!DOCTYPE html> \n";
            out.println(docType +
                "<html>\n" +
                "<head><title>" + title + "</title></head>\n" +
                "<body bgcolor=\"#f0f0f0\">\n" +
                "<h1 align=\"center\">" + title + "</h1>\n" +
                "<ul>\n" +
                "  <li><b>站点名</b>:"
                + name + "\n" +
                "  <li><b>网址</b>:"
                + request.getParameter("url") + "\n" +
                "</ul>\n" +
                "</body></html>");
        }
        
        // 处理 POST 方法请求的方法
        public void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
            doGet(request, response);
        }
    }
  5. 使用表单的GET方法实例:

    使用 HTML 表单和提交按钮传递两个值。

    <!DOCTYPE html>
    <html>
    <head>
    <meta charset="utf-8">
    <title>菜鸟教程(runoob.com)</title>
    </head>
    <body>
    <form action="HelloForm" method="GET">
    网址名:<input type="text" name="name">
    <br />
    网址:<input type="text" name="url" />
    <input type="submit" value="提交" />
    </form>
    </body>
    </html>
  6. 使用表单的POST方法实例:

    • 注意:如果表单提交的数据中有中文数据则需要转码:

      String name =new String(request.getParameter("name").getBytes("ISO8859-1"),"UTF-8");
    • package com.runoob.test;
      
      import java.io.IOException;
      import java.io.PrintWriter;
      
      import javax.servlet.ServletException;
      import javax.servlet.annotation.WebServlet;
      import javax.servlet.http.HttpServlet;
      import javax.servlet.http.HttpServletRequest;
      import javax.servlet.http.HttpServletResponse;
      
      /**
       * Servlet implementation class HelloForm
       */
      @WebServlet("/HelloForm")
      public class HelloForm extends HttpServlet {
          private static final long serialVersionUID = 1L;
             
          /**
           * @see HttpServlet#HttpServlet()
           */
          public HelloForm() {
              super();
              // TODO Auto-generated constructor stub
          }
      
          /**
           * @see HttpServlet#doGet(HttpServletRequest request, HttpServletResponse response)
           */
          protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
              // 设置响应内容类型
              response.setContentType("text/html;charset=UTF-8");
      
              PrintWriter out = response.getWriter();
              String title = "使用 POST 方法读取表单数据";
              // 处理中文
              String name =new String(request.getParameter("name").getBytes("ISO8859-1"),"UTF-8");
              String docType = "<!DOCTYPE html> \n";
              out.println(docType +
                  "<html>\n" +
                  "<head><title>" + title + "</title></head>\n" +
                  "<body bgcolor=\"#f0f0f0\">\n" +
                  "<h1 align=\"center\">" + title + "</h1>\n" +
                  "<ul>\n" +
                  "  <li><b>站点名</b>:"
                  + name + "\n" +
                  "  <li><b>网址</b>:"
                  + request.getParameter("url") + "\n" +
                  "</ul>\n" +
                  "</body></html>");
          }
          
          // 处理 POST 方法请求的方法
          public void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
              doGet(request, response);
          }
  7. 将复选框数据传递到Servlet程序:

    • 当需要选择一个以上的选项时,则使用复选框。
    • HTML 代码实例 checkbox.html,一个带有两个复选框的表单:

      <!DOCTYPE html>
      <html>
      <head>
      <meta charset="utf-8">
      <title>菜鸟教程(runoob.com)</title>
      </head>
      <body>
      <form action="CheckBox" method="POST" target="_blank">
      <input type="checkbox" name="runoob" checked="checked" /> 菜鸟教程
      <input type="checkbox" name="google"  /> Google
      <input type="checkbox" name="taobao" checked="checked" /> 淘宝
      <input type="submit" value="选择站点" />
      </form>
      </body>
      </html>
    • CheckBox.java Servlet 程序,处理 Web 浏览器给出的复选框输入:

      package com.runoob.test;
      
      import java.io.IOException;
      import java.io.PrintWriter;
      
      import javax.servlet.ServletException;
      import javax.servlet.annotation.WebServlet;
      import javax.servlet.http.HttpServlet;
      import javax.servlet.http.HttpServletRequest;
      import javax.servlet.http.HttpServletResponse;
      
      /**
       * Servlet implementation class CheckBox
       */
      @WebServlet("/CheckBox")
      public class CheckBox extends HttpServlet {
          private static final long serialVersionUID = 1L;
          
          protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
              
              // 设置响应内容类型
              response.setContentType("text/html;charset=UTF-8");
      
              PrintWriter out = response.getWriter();
              String title = "读取复选框数据";
              String docType = "<!DOCTYPE html> \n";
                  out.println(docType +
                      "<html>\n" +
                      "<head><title>" + title + "</title></head>\n" +
                      "<body bgcolor=\"#f0f0f0\">\n" +
                      "<h1 align=\"center\">" + title + "</h1>\n" +
                      "<ul>\n" +
                      "  <li><b>菜鸟按教程标识:</b>: "
                      + request.getParameter("runoob") + "\n" +
                      "  <li><b>Google 标识:</b>: "
                      + request.getParameter("google") + "\n" +
                      "  <li><b>淘宝标识:</b>: "
                      + request.getParameter("taobao") + "\n" +
                      "</ul>\n" +
                      "</body></html>");
          }
          
          // 处理 POST 方法请求的方法
          public void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
              doGet(request, response);
          }
      }
  8. 读取所有的表单参数:

    • 以下是通用的实例,使用 HttpServletRequest 的 getParameterNames() 方法读取所有可用的表单参数。该方法返回一个枚举,其中包含未指定顺序的参数名。

      一旦我们有一个枚举,我们可以以标准方式循环枚举,使用 hasMoreElements() 方法来确定何时停止,使用 nextElement() 方法来获取每个参数的名称。

      import java.io.IOException;
      import java.io.PrintWriter;
      import java.util.Enumeration;
      
      import javax.servlet.ServletException;
      import javax.servlet.annotation.WebServlet;
      import javax.servlet.http.HttpServlet;
      import javax.servlet.http.HttpServletRequest;
      import javax.servlet.http.HttpServletResponse;
      
      /**
       * Servlet implementation class ReadParams
       */
      @WebServlet("/ReadParams")
      public class ReadParams extends HttpServlet {
          private static final long serialVersionUID = 1L;
             
          /**
           * @see HttpServlet#HttpServlet()
           */
          public ReadParams() {
              super();
              // TODO Auto-generated constructor stub
          }
      
          /**
           * @see HttpServlet#doGet(HttpServletRequest request, HttpServletResponse response)
           */
          protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
              // 设置响应内容类型
              response.setContentType("text/html;charset=UTF-8");
              PrintWriter out = response.getWriter();
              String title = "读取所有的表单数据";
              String docType =
                  "<!doctype html public \"-//w3c//dtd html 4.0 " +
                  "transitional//en\">\n";
                  out.println(docType +
                  "<html>\n" +
                  "<head><meta charset=\"utf-8\"><title>" + title + "</title></head>\n" +
                  "<body bgcolor=\"#f0f0f0\">\n" +
                  "<h1 align=\"center\">" + title + "</h1>\n" +
                  "<table width=\"100%\" border=\"1\" align=\"center\">\n" +
                  "<tr bgcolor=\"#949494\">\n" +
                  "<th>参数名称</th><th>参数值</th>\n"+
                  "</tr>\n");
      
              Enumeration paramNames = request.getParameterNames();
      
              while(paramNames.hasMoreElements()) {
                  String paramName = (String)paramNames.nextElement();
                  out.print("<tr><td>" + paramName + "</td>\n");
                  String[] paramValues =
                  request.getParameterValues(paramName);
                  // 读取单个值的数据
                  if (paramValues.length == 1) {
                      String paramValue = paramValues[0];
                      if (paramValue.length() == 0)
                          out.println("<td><i>没有值</i></td>");
                      else
                          out.println("<td>" + paramValue + "</td>");
                  } else {
                      // 读取多个值的数据
                      out.println("<td><ul>");
                      for(int i=0; i < paramValues.length; i++) {
                      out.println("<li>" + paramValues[i]);
                  }
                      out.println("</ul></td>");
                  }
                  out.print("</tr>");
              }
              out.println("\n</table>\n</body></html>");
          }
      
          /**
           * @see HttpServlet#doPost(HttpServletRequest request, HttpServletResponse response)
           */
          protected void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
              // TODO Auto-generated method stub
              doGet(request, response);
          }
      
      }
      <!DOCTYPE html>
      <html>
      <head>
      <meta charset="utf-8">
      <title>菜鸟教程(runoob.com)</title>
      </head>
      <body>
      
      <form action="ReadParams" method="POST" target="_blank">
      <input type="checkbox" name="maths" checked="checked" /> 数学
      <input type="checkbox" name="physics"  /> 物理
      <input type="checkbox" name="chemistry" checked="checked" /> 化学
      <input type="submit" value="选择学科" />
      </form>
      
      </body>
      </html>
    • 补充Java Enumeration接口

      • Enumeration接口中定义了一些方法,通过这些方法可以枚举(一次获得一个)对象集合中的元素。
      • boolean hasMoreElements( )
        测试此枚举是否包含更多的元素。
      • Object nextElement( )
        如果此枚举对象至少还有一个可提供的元素,则返回此枚举的下一个元素。
      • 实例如下:

        import java.util.Vector;
        import java.util.Enumeration;
         
        public class EnumerationTester {
         
           public static void main(String args[]) {
              Enumeration<String> days;
              Vector<String> dayNames = new Vector<String>();
              dayNames.add("Sunday");
              dayNames.add("Monday");
              dayNames.add("Tuesday");
              dayNames.add("Wednesday");
              dayNames.add("Thursday");
              dayNames.add("Friday");
              dayNames.add("Saturday");
              days = dayNames.elements();
              while (days.hasMoreElements()){
                 System.out.println(days.nextElement()); 
              }
           }
        }

        运行结果如下:

        Sunday
        Monday
        Tuesday
        Wednesday
        Thursday
        Friday
        Saturday

    四、HTTP Header请求实例

    ​ 下面的实例使用 HttpServletRequest 的 getHeaderNames() 方法读取 HTTP 头信息。该方法返回一个枚举,包含与当前的 HTTP 请求相关的头信息。

    ​ 一旦我们有一个枚举,我们可以以标准方式循环枚举,使用 hasMoreElements() 方法来确定何时停止,使用 nextElement() 方法来获取每个参数的名称。

    //导入必需的 java 库
    import java.io.IOException;
    import java.io.PrintWriter;
    import java.util.Enumeration;
    import javax.servlet.ServletException;
    import javax.servlet.annotation.WebServlet;
    import javax.servlet.http.HttpServlet;
    import javax.servlet.http.HttpServletRequest;
    import javax.servlet.http.HttpServletResponse;
    @WebServlet("/DisplayHeader")
    //扩展 HttpServlet 类
    public class DisplayHeader extends HttpServlet {
     // 处理 GET 方法请求的方法
     public void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException
     {
         // 设置响应内容类型
         response.setContentType("text/html;charset=UTF-8");
         PrintWriter out = response.getWriter();
         String title = "HTTP Header 请求实例 - 菜鸟教程实例";
         String docType =
             "<!DOCTYPE html> \n";
             out.println(docType +
             "<html>\n" +
             "<head><meta charset=\"utf-8\"><title>" + title + "</title></head>\n"+
             "<body bgcolor=\"#f0f0f0\">\n" +
             "<h1 align=\"center\">" + title + "</h1>\n" +
             "<table width=\"100%\" border=\"1\" align=\"center\">\n" +
             "<tr bgcolor=\"#949494\">\n" +
             "<th>Header 名称</th><th>Header 值</th>\n"+
             "</tr>\n");
         Enumeration headerNames = request.getHeaderNames();
         while(headerNames.hasMoreElements()) {
             String paramName = (String)headerNames.nextElement();
             out.print("<tr><td>" + paramName + "</td>\n");
             String paramValue = request.getHeader(paramName);
             out.println("<td> " + paramValue + "</td></tr>\n");
         }
         out.println("</table>\n</body></html>");
     }
     // 处理 POST 方法请求的方法
     public void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
         doGet(request, response);
     }
    }

    五、Servlet服务器HTTP响应

  9. 当一个 Web 服务器响应一个 HTTP 请求时,响应通常包括一个状态行、一些响应报头、一个空行和文档。一个典型的响应如下所示:

    HTTP/1.1 200 OK
    Content-Type: text/html
    Header2: ...
    ...
    HeaderN: ...
      (Blank Line)
    <!doctype ...>
    <html>
    <head>...</head>
    <body>
    ...
    </body>
    </html>
  10. 状态行包括 HTTP 版本(在本例中为 HTTP/1.1)、一个状态码(在本例中为 200)和一个对应于状态码的短消息(在本例中为 OK)。
  11. HTTP响应实例:

    //导入必需的 java 库
    import java.io.IOException;
    import java.io.PrintWriter;
    import java.text.SimpleDateFormat;
    import java.util.Calendar;
    import java.util.Date;
    
    import javax.servlet.ServletException;
    import javax.servlet.annotation.WebServlet;
    import javax.servlet.http.HttpServlet;
    import javax.servlet.http.HttpServletRequest;
    import javax.servlet.http.HttpServletResponse;
    
    @WebServlet("/Refresh")
    
    //扩展 HttpServlet 类
    public class Refresh extends HttpServlet {
    
        // 处理 GET 方法请求的方法
          public void doGet(HttpServletRequest request,
                            HttpServletResponse response)
                    throws ServletException, IOException
          {
              // 设置刷新自动加载时间为 5 秒
              response.setIntHeader("Refresh", 5);
              // 设置响应内容类型
              response.setContentType("text/html;charset=UTF-8");
             
              //使用默认时区和语言环境获得一个日历  
              Calendar cale = Calendar.getInstance();  
              //将Calendar类型转换成Date类型  
              Date tasktime=cale.getTime();  
              //设置日期输出的格式  
              SimpleDateFormat df=new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");  
              //格式化输出  
              String nowTime = df.format(tasktime);
              PrintWriter out = response.getWriter();
              String title = "自动刷新 Header 设置 - 菜鸟教程实例";
              String docType =
              "<!DOCTYPE html>\n";
              out.println(docType +
                "<html>\n" +
                "<head><title>" + title + "</title></head>\n"+
                "<body bgcolor=\"#f0f0f0\">\n" +
                "<h1 align=\"center\">" + title + "</h1>\n" +
                "<p>当前时间是:" + nowTime + "</p>\n");
          }
          // 处理 POST 方法请求的方法
          public void doPost(HttpServletRequest request,
                             HttpServletResponse response)
              throws ServletException, IOException {
             doGet(request, response);
          }
    }

    六、Servlet HTTP状态码

    1. HTTP 请求和 HTTP 响应消息的格式是类似的,结构如下:

      • 初始状态行 + 回车换行符(回车+换行)
      • 零个或多个标题行+回车换行符
      • 一个空白行,即回车换行符
      • 一个可选的消息主体,比如文件、查询数据或查询输出

      如:

      HTTP/1.1 200 OK
      Content-Type: text/html
      Header2: ...
      ...
      HeaderN: ...
        (Blank Line)
      <!doctype ...>
      <html>
      <head>...</head>
      <body>
      ...
      </body>
      </html>
    2. 状态行包括 HTTP 版本(在本例中为 HTTP/1.1)、一个状态码(在本例中为 200)和一个对应于状态码的短消息(在本例中为 OK)。
    3. 设置HTTP状态代码的方法:

      • public void setStatus(int statusCode)

        该方法设置一个任意的状态码。setStatus方法接受一个int(状态码)作为参数。如果您的响应包含了一个特殊的状态码和文档,请确保在使用PrintWriter实际返回任何内容之前调用setStatus。

      • public void sendRedirect(String url)

        该方法生成一个 302 响应,连同一个带有新文档 URL 的 Location 头。

      
      该方法发送一个状态码(通常为 404),连同一个在 HTML 文档内部自动格式化并发送到客户端的短消息。
    4. HTTP状态码实例

      下面的例子把 407 错误代码发送到客户端浏览器,浏览器会显示 "Need authentication!!!" 消息。

      // 导入必需的 java 库
      import java.io.*;
      import javax.servlet.*;
      import javax.servlet.http.*;
      import java.util.*;
      import javax.servlet.annotation.WebServlet;
      
      @WebServlet("/showError")
      // 扩展 HttpServlet 类
      public class showError extends HttpServlet {
       
        // 处理 GET 方法请求的方法
        public void doGet(HttpServletRequest request,
                          HttpServletResponse response)
                  throws ServletException, IOException
        {
            // 设置错误代码和原因
            response.sendError(407, "Need authentication!!!" );
        }
        // 处理 POST 方法请求的方法
        public void doPost(HttpServletRequest request,
                           HttpServletResponse response)
            throws ServletException, IOException {
           doGet(request, response);
        }
      }

      调用上面的 Servlet 将显示以下结果:

      HTTP Status 407 - Need authentication!!!
      type Status report
      
      message Need authentication!!!
      
      description The client must first authenticate itself with the proxy (Need authentication!!!).
      

七、Servlet编写过滤器

Servlet 过滤器可以动态地拦截请求和响应,以变换或使用包含在请求或响应中的信息。

可以将一个或多个 Servlet 过滤器附加到一个 Servlet 或一组 Servlet。Servlet 过滤器也可以附加到 JavaServer Pages (JSP) 文件和 HTML 页面。调用 Servlet 前调用所有附加的 Servlet 过滤器。

Servlet 过滤器是可用于 Servlet 编程的 Java 类,可以实现以下目的:

  • 在客户端的请求访问后端资源之前,拦截这些请求。
  • 在服务器的响应发送回客户端之前,处理这些响应。

根据规范建议的各种类型的过滤器:

  • 身份验证过滤器(Authentication Filters)。
  • 数据压缩过滤器(Data compression Filters)。
  • 加密过滤器(Encryption Filters)。
  • 触发资源访问事件过滤器。
  • 图像转换过滤器(Image Conversion Filters)。
  • 日志记录和审核过滤器(Logging and Auditing Filters)。
  • MIME-TYPE 链过滤器(MIME-TYPE Chain Filters)。
  • 标记化过滤器(Tokenizing Filters)。
  • XSL/T 过滤器(XSL/T Filters),转换 XML 内容。

过滤器通过 Web 部署描述符(web.xml)中的 XML 标签来声明,然后映射到您的应用程序的部署描述符中的 Servlet 名称或 URL 模式。

当 Web 容器启动 Web 应用程序时,它会为您在部署描述符中声明的每一个过滤器创建一个实例。

Filter的执行顺序与在web.xml配置文件中的配置顺序一致,一般把Filter配置在所有的Servlet之前。

  1. Servlet过滤器方法:

    • public void doFilter(ServletRequest, ServletResponse, FilterChain)

      该方法完成实际的过滤操作,当客户端请求方法与过滤器设置匹配的URL时,Servlet容器将先调用过滤器的doFilter方法。FilterChain用户访问后续过滤器。

    • public void init(FilterConfig filterConfig)

      web 应用程序启动时,web 服务器将创建Filter 的实例对象,并调用其init方法,读取web.xml配置,完成对象的初始化功能,从而为后续的用户请求作好拦截的准备工作(filter对象只会创建一次,init方法也只会执行一次)。开发人员通过init方法的参数,可获得代表当前filter配置信息的FilterConfig对象。

    
    Servlet容器在销毁过滤器实例前调用该方法,在该方法中释放Servlet过滤器占用的资源。
  2. FilterConfig 使用

    Filter 的 init 方法中提供了一个 FilterConfig 对象。

    如web.xml 文件配置如下:

    <filter>
        <filter-name>LogFilter</filter-name>
        <filter-class>com.runoob.test.LogFilter</filter-class>
        <init-param>
            <param-name>Site</param-name>
            <param-value>菜鸟教程</param-value>
        </init-param>
    </filter>

    在init方法使用FilterConfig对象获取参数:

    public void init(FilterConfig config) throws ServletException {
        // 获取初始化参数
        String site = config.getInitParamter("site");
        // 输出初始化参数
        System.out.println("网站名称:" + site)
    }
  3. Servlet 过滤器实例

    package com.runoob.test;
    
    //导入必需的 java 库
    import javax.servlet.*;
    import java.util.*;
    
    //实现 Filter 类
    public class LogFilter implements Filter  {
        public void  init(FilterConfig config) throws ServletException {
            // 获取初始化参数
            String site = config.getInitParameter("Site"); 
    
            // 输出初始化参数
            System.out.println("网站名称: " + site); 
        }
        public void  doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws java.io.IOException, ServletException {
    
            // 输出站点名称
            System.out.println("站点网址:http://www.runoob.com");
    
            // 把请求传回过滤链
            chain.doFilter(request,response);
        }
        public void destroy( ){
            /* 在 Filter 实例被 Web 容器从服务移除之前调用 */
        }
    }
    //导入必需的 java 库
    import java.io.IOException;
    import java.io.PrintWriter;
    import java.util.Enumeration;
    
    import javax.servlet.ServletException;
    import javax.servlet.annotation.WebServlet;
    import javax.servlet.http.HttpServlet;
    import javax.servlet.http.HttpServletRequest;
    import javax.servlet.http.HttpServletResponse;
    
    @WebServlet("/DisplayHeader")
    
    //扩展 HttpServlet 类
    public class DisplayHeader extends HttpServlet {
    
        // 处理 GET 方法请求的方法
        public void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException
        {
            // 设置响应内容类型
            response.setContentType("text/html;charset=UTF-8");
    
            PrintWriter out = response.getWriter();
            String title = "HTTP Header 请求实例 - 菜鸟教程实例";
            String docType =
                "<!DOCTYPE html> \n";
                out.println(docType +
                "<html>\n" +
                "<head><meta charset=\"utf-8\"><title>" + title + "</title></head>\n"+
                "<body bgcolor=\"#f0f0f0\">\n" +
                "<h1 align=\"center\">" + title + "</h1>\n" +
                "<table width=\"100%\" border=\"1\" align=\"center\">\n" +
                "<tr bgcolor=\"#949494\">\n" +
                "<th>Header 名称</th><th>Header 值</th>\n"+
                "</tr>\n");
    
            Enumeration headerNames = request.getHeaderNames();
    
            while(headerNames.hasMoreElements()) {
                String paramName = (String)headerNames.nextElement();
                out.print("<tr><td>" + paramName + "</td>\n");
                String paramValue = request.getHeader(paramName);
                out.println("<td> " + paramValue + "</td></tr>\n");
            }
            out.println("</table>\n</body></html>");
        }
        // 处理 POST 方法请求的方法
        public void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
            doGet(request, response);
        }
    }
  4. Web.xml 中的Servlet过滤器映射(Servlet Filter Mapping)

    定义过滤器,然后映射到一个 URL 或 Servlet,这与定义 Servlet,然后映射到一个 URL 模式方式大致相同。在部署描述符文件 web.xml 中为 filter 标签创建下面的条目:

    <?xml version="1.0" encoding="UTF-8"?>  
    <web-app>  
    <filter>
      <filter-name>LogFilter</filter-name>
      <filter-class>com.runoob.test.LogFilter</filter-class>
      <init-param>
        <param-name>Site</param-name>
        <param-value>菜鸟教程</param-value>
      </init-param>
    </filter>
    <filter-mapping>
      <filter-name>LogFilter</filter-name>
      <url-pattern>/*</url-pattern>
    </filter-mapping>
    <servlet>  
      <!-- 类名 -->  
      <servlet-name>DisplayHeader</servlet-name>  
      <!-- 所在的包 -->  
      <servlet-class>com.runoob.test.DisplayHeader</servlet-class>  
    </servlet>  
    <servlet-mapping>  
      <servlet-name>DisplayHeader</servlet-name>  
      <!-- 访问的网址 -->  
      <url-pattern>/TomcatTest/DisplayHeader</url-pattern>  
    </servlet-mapping>  
    </web-app>  

    上述过滤器适用于所有的 Servlet,因为我们在配置中指定 /*

  5. 使用多个过滤器

    Web 应用程序可以根据特定的目的定义若干个不同的过滤器。假设您定义了两个过滤器 AuthenFilterLogFilter。您需要创建一个如下所述的不同的映射,其余的处理与上述所讲解的大致相同:

    <filter>
       <filter-name>LogFilter</filter-name>
       <filter-class>com.runoob.test.LogFilter</filter-class>
       <init-param>
          <param-name>test-param</param-name>
          <param-value>Initialization Paramter</param-value>
       </init-param>
    </filter>
    
    <filter>
       <filter-name>AuthenFilter</filter-name>
       <filter-class>com.runoob.test.AuthenFilter</filter-class>
       <init-param>
          <param-name>test-param</param-name>
          <param-value>Initialization Paramter</param-value>
       </init-param>
    </filter>
    
    <filter-mapping>
       <filter-name>LogFilter</filter-name>
       <url-pattern>/*</url-pattern>
    </filter-mapping>
    
    <filter-mapping>
       <filter-name>AuthenFilter</filter-name>
       <url-pattern>/*</url-pattern>
    </filter-mapping>
  6. 过滤器的应用顺序

    web.xml 中的 filter-mapping 元素的顺序决定了 Web 容器应用过滤器到 Servlet 的顺序。若要反转过滤器的顺序,您只需要在 web.xml 文件中反转 filter-mapping 元素即可。

    例如,上面的实例将先应用 LogFilter,然后再应用 AuthenFilter,但是下面的实例将颠倒这个顺序:

    <filter-mapping>
       <filter-name>AuthenFilter</filter-name>
       <url-pattern>/*</url-pattern>
    </filter-mapping>
    
    <filter-mapping>
       <filter-name>LogFilter</filter-name>
       <url-pattern>/*</url-pattern>
    </filter-mapping>
  7. web.xml配置各节点说明

    • 指定一个过滤器。

      • 用于为过滤器指定一个名字,该元素的内容不能为空。
      • 元素用于指定过滤器的完整的限定类名。
      • 元素用于为过滤器指定初始化参数,它的子元素指定参数的名字,指定参数的值。
      • 在过滤器中,可以使用FilterConfig接口对象来访问初始化参数。
    • 元素用于设置一个 Filter 所负责拦截的资源。一个Filter拦截的资源可通过两种方式来指定:Servlet 名称和资源访问的请求路径

      • 子元素用于设置filter的注册名称。该值必须是在元素中声明过的过滤器的名字
      • 设置 filter 所拦截的请求路径(过滤器关联的URL样式)
    • 指定过滤器所拦截的Servlet名称。
    • 指定过滤器所拦截的资源被 Servlet 容器调用的方式,可以是REQUEST,INCLUDE,FORWARDERROR之一,默认REQUEST。用户可以设置多个子元素用来指定 Filter 对资源的多种调用方式进行拦截。
    • 子元素可以设置的值及其意义

      • REQUEST:当用户直接访问页面时,Web容器将会调用过滤器。如果目标资源是通过RequestDispatcher的include()或forward()方法访问时,那么该过滤器就不会被调用。
      • INCLUDE:如果目标资源是通过RequestDispatcher的include()方法访问时,那么该过滤器将被调用。除此之外,该过滤器不会被调用。
      • FORWARD:如果目标资源是通过RequestDispatcher的forward()方法访问时,那么该过滤器将被调用,除此之外,该过滤器不会被调用。
      • ERROR:如果目标资源是通过声明式异常处理机制调用时,那么该过滤器将被调用。除此之外,过滤器不会被调用。
  8. 过滤器中我们可以根据 doFilte() 方法中的 request 对象获取表单参数信息,例如我们可以获取到请求的用户名和密码进行逻辑处理,也可以通过 response 对用户做出回应。比如如果验证用户名不正确,禁止用户访问 web 资源,并且向浏览器输出提示,告诉用户用户名或者密码不正确等等;

    public void doFilter(ServletRequest req, ServletResponse resp,
    FilterChain chain) throws IOException, ServletException {
        //获取请求信息(测试时可以通过get方式在URL中添加name)
        //http://localhost:8080/servlet_demo/helloword?name=123
        String name = req.getParameter("name");
        // 过滤器核心代码逻辑
        System.out.println("过滤器获取请求参数:"+name);
        System.out.println("第二个过滤器执行--网站名称:www.runoob.com");
        if("123".equals(name)){
            // 把请求传回过滤链
            chain.doFilter(req, resp);
        }else{
            //设置返回内容类型
            resp.setContentType("text/html;charset=GBK");
            //在页面输出响应信息
            PrintWriter out = resp.getWriter();
            out.print("<b>name不正确,请求被拦截,不能访问web资源</b>");
            System.out.println("name不正确,请求被拦截,不能访问web资源");
        }