JavaWeb笔记之Listener和Filter

概述
本篇博文中主要探讨以下内容:

  1. Web监听器
  2. Web过滤器

一、Web监听器

监听器(Listener):当一个事件发生的时候,你希望获得这个事件发生的详细信息,而并不想干预这个事件本身的进程,这就要用到监听器。
Web应用程序中的事件主要发生在三个对象上:ServletContext、HttpSession和ServletRequest对象。
所以监听器可以分类为:

  • ServletContext事件监听器(监听Application应用程序域)
  • HttpServletSession事件监听器(监听Session会话域)
  • ServletRequest事件监听器(监听Requset请求域)

1. 监听ServletContext事件

监听对象事件监听器接口
ServletContextServletContextEventServletContextListener
ServletContextservletContextAttributeEventServletContextAttributeListener
  • 处理ServletContextEvent事件
    该事件是Web应用程序声明周期事件,初始化或销毁时发生的事件。
    两个方法

public void contextInitialized(ServletContextEvent sce):当ServletContext对象初始化时调用
public void contextDestroyed(ServletContextEvent sce):当ServletContext对象销毁时调用

  • 处理ServletContextAttributeEvent事件

public void attributeAdded(ServletContextAttributeEvent sre):当在ServletContext对象中添加属性时调用该方法。
public void attributeRemoved(ServletContextAttributeEvent sre):当在ServletContext对象中删除属性时调用该方法。
public void attributeReplaced(ServletContextAttributeEvent sre):当在ServletContext对象中替换属性时调用该方法。

例子:
页面访问量的统计程序

		ServletContext sc=getServletContext();
        Integer count=(Integer)sc.getAttribute("counter");
        if(count==null){
            count=new Integer(1);
        }else{
            count=new Integer(count.intValue()+1);
        }
        sc.setAttribute("counter", count);
        resp.getWriter().print("该页面被访问的次数是:"+count);
        resp.getWriter().close();

提示:上下文作用域中设置的属性在整个Web应用中被共享,只要服务器不被关闭,Web应用中任何一部分都能访问到该属性。所以线程是不安全的。

2. HttpSession 会话作用域

监听Httpsession域的创建与销毁的监听器。HttpSession对象的生命周期 :第一次调用request.getSession时创建;销毁有以下几种情况(服务器关闭、session过期、 手动销毁)
方法:

sessionCreated(HttpSessionEvent se)创建时调用

sessionDestroyed(HttpSessionEvent se)销毁时调用

session创建的时间:

request.getSession(),或者是访问一个JSP页面的时候。

销毁的时间:

默认为30分钟,非正常关闭服务器的时候。

attributeAdded()添加属性时调用的方法

attributeRemoved()删除属性时调用的方法

attributeReplaced()替换属性时调用的方

应用:可以用来实现统计当前的在线人数。

例子:在线多人登录
count

	PrintWriter pw=resp.getWriter();
        ServletContext sc=getServletContext();
        HttpSession sess=req.getSession();
        String name = req.getParameter("username");
        List<String> userList=(List) getServletContext().getAttribute("userList");
        if(userList==null){
            userList=new ArrayList<String>();
        }
        if(name!=null){
            name=new String(name.getBytes("iso-8859-1"),"utf-8");
            System.out.println("================="+name);
            userList.add(name);
            sess.setAttribute("username",name);
            getServletContext().setAttribute("userList", userList);
            req.getRequestDispatcher("/count1").forward(req, resp);

        }
        else{
            pw.print("<html>");
            pw.print("<head></head>");
            pw.print("<body><h1>在线书店登录</h1>");
            pw.print("<form action='/day13/count'>");
            pw.print("username:<input type='text' name='username'/><br/>");
            pw.print("<input type='submit' value='submit'/></form></body>");
            pw.print("</html>");
        }
        pw.flush();
        pw.close();

count1

		  PrintWriter pw=resp.getWriter();
          HttpSession sess=req.getSession();
          List<String> userList=(List) getServletContext().getAttribute("userList");
          String name=(String) sess.getAttribute("username");
          String action=req.getParameter("action");
          if(action==null){
               pw.print("用户"+name+"欢迎你!【<a href='count1?action=loginout'>注销</a>】<br/>");
               Iterator<String> i=userList.iterator();
               while(i.hasNext()){
                   String name1=i.next();
                   pw.print("<p>当前用户有:"+name1+"</p>");
               }

          }else if(action.equals("loginout")){
              sess.invalidate();
              userList.remove(name);
              getServletContext().setAttribute("userList", userList);

          }

提示:每一个会话只能访问当前会话作用域中设置的属性。但是当我们使用特殊的浏览器窗口打开方式使用相同的Session来访问该设置的属性。也就是说多个线程访问相同的会话属性。所以线程也是不安全的。

3. ServletRequest 请求作用域

方法:

requestInitialized(ServletRequestEvent sre)

requestDestroyed(ServletRequestEvent sre)
attributeAdded()添加属性时调用的方法

attributeRemoved()删除属性时调用的方法

attributeReplaced()替换属性时调用的方

二、Web过滤器

Filter也称之为过滤器,它是Servlet技术中最激动人心的技术,WEB开发人员通过Filter技术,对web服务器管理的所有web资源:例如Jsp, Servlet, 静态图片文件或静态 html 文件等进行拦截,从而实现一些特殊的功能。例如实现URL级别的权限访问控制、过滤敏感词汇、压缩响应信息等一些高级功能。
在这里插入图片描述

1. 过滤器是如何工作的

Filter接口中有一个doFilter方法,当我们编写好Filter,并配置对哪个web资源进行拦截后,WEB服务器每次在调用web资源的service方法之前,都会先调用一下filter的doFilter方法,因此,在该方法内编写代码可达到如下目的:

  1. 调用目标资源之前,让一段代码执行。
  2. 是否调用目标资源(即是否让用户访问web资源)。
  3. 调用目标资源之后,让一段代码执行。

web服务器在调用doFilter方法时,会传递一个filterChain对象进来,filterChain对象是filter接口中最重要的一个对 象,它也提供了一个doFilter方法,开发人员可以根据需求决定是否调用此方法,调用该方法,则web服务器就会调用web资源的service方 法,即web资源就会被访问,否则web资源不会被访问。

2. 过滤器的用途

验证过滤器、登录和审计过滤器、数据压缩过滤器、加密过滤器和XSLT过滤器等。

3.Filter的使用

3.1 Filter开发步骤

Filter开发分为二个步骤:

  1. 编写java类实现Filter接口,并实现其doFilter方法。
  2. 在 web.xml 文件中使用和元素对编写的filter类进行注册,并设置它所能拦截的资源。
    过滤器范例:
package me.gacl.web.filter;

import java.io.IOException;

import javax.servlet.Filter;
import javax.servlet.FilterChain;
import javax.servlet.FilterConfig;
import javax.servlet.ServletException;
import javax.servlet.ServletRequest;
import javax.servlet.ServletResponse;

/*
filter的三种典型应用:
1、可以在filter中根据条件决定是否调用chain.doFilter(request, response)方法,即是否让目标资源执行                  
2、在让目标资源执行之前,可以对request\response作预处理,再让目标资源执行
3、在目标资源执行之后,可以捕获目标资源的执行结果,从而实现一些特殊的功能
 
*/
public class FilterDemo01 implements Filter {

    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
        System.out.println("----过滤器初始化----");
    }

    @Override
    public void doFilter(ServletRequest request, ServletResponse response,
            FilterChain chain) throws IOException, ServletException {

        //对request和response进行一些预处理
        request.setCharacterEncoding("UTF-8");
        response.setCharacterEncoding("UTF-8");
        response.setContentType("text/html;charset=UTF-8");

        System.out.println("FilterDemo01执行前!!!");
        chain.doFilter(request, response);  //让目标资源执行,放行
        System.out.println("FilterDemo01执行后!!!");
    }

    @Override
    public void destroy() {
        System.out.println("----过滤器销毁----");
    }
}

在web. xml中配置过滤器:

<?xml version="1.0" encoding="UTF-8"?>
<web-app version="3.0"
    xmlns="http://java.sun.com/xml/ns/javaee"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://java.sun.com/xml/ns/javaee
    http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd">
  <display-name></display-name>
  <welcome-file-list>
    <welcome-file>index.jsp</welcome-file>
  </welcome-file-list>

  <!--配置过滤器-->
  <filter>
      <filter-name>FilterDemo01</filter-name>
      <filter-class>me.gacl.web.filter.FilterDemo01</filter-class>
  </filter>

  <!--映射过滤器-->
  <filter-mapping>
      <filter-name>FilterDemo01</filter-name>
      <!--“/*”表示拦截所有的请求 -->
      <url-pattern>/*</url-pattern>
  </filter-mapping>

</web-app>

3.2 Filter链

在一个web应用中,可以开发编写多个Filter,这些Filter组合起来称之为一个Filter链。
  web服务器根据Filter在web.xml文件中的注册顺序,决定先调用哪个Filter,当第一个Filter的doFilter方法被调用时,web服务器会创建一个代表Filter链的FilterChain对象传递给该方法。在doFilter方法中,开发人员如果调用了FilterChain对象的doFilter方法,则web服务器会检查FilterChain对象中是否还有filter,如果有,则调用第2个filter,如果没有,则调用目标资源。

4. Filter的生命周期

4.1 Filter的创建

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

4.2 Filter的销毁

Web容器调用destroy方法销毁Filter。destroy方法在Filter的生命周期中仅执行一次。在destroy方法中,可以释放过滤器使用的资源。

4.3 FilterConfig接口

用户在配置filter时,可以使用为filter配置一些初始化参数,当web容器实例化Filter对象,调用其init方法时,会把封装了filter初始化参数的filterConfig对象传递进来。因此开发人员在编写filter时,通过filterConfig对象的方法,就可获得:
  String getFilterName():得到filter的名称。
  String getInitParameter(String name): 返回在部署描述中指定名称的初始化参数的值。如果不存在返回null.
  Enumeration getInitParameterNames():返回过滤器的所有初始化参数的名字的枚举集合。
  public ServletContext getServletContext():返回Servlet上下文对象的引用。
  
范例:利用FilterConfig得到filter配置信息

package me.gacl.web.filter;

import java.io.IOException;
import java.util.Enumeration;
import javax.servlet.Filter;
import javax.servlet.FilterChain;
import javax.servlet.FilterConfig;
import javax.servlet.ServletException;
import javax.servlet.ServletRequest;
import javax.servlet.ServletResponse;

public class FilterDemo02 implements Filter {

    /* 过滤器初始化
     * @see javax.servlet.Filter#init(javax.servlet.FilterConfig)
     */
    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
        System.out.println("----过滤器初始化----");
        /**
         *  <filter>
                  <filter-name>FilterDemo02</filter-name>
                  <filter-class>me.gacl.web.filter.FilterDemo02</filter-class>
                  <!--配置FilterDemo02过滤器的初始化参数-->
                  <init-param>
                      <description>配置FilterDemo02过滤器的初始化参数</description>
                      <param-name>name</param-name>
                      <param-value>gacl</param-value>
                  </init-param>
                  <init-param>
                      <description>配置FilterDemo02过滤器的初始化参数</description>
                      <param-name>like</param-name>
                      <param-value>java</param-value>
                  </init-param>
            </filter>

             <filter-mapping>
                  <filter-name>FilterDemo02</filter-name>
                  <!--“/*”表示拦截所有的请求 -->
                  <url-pattern>/*</url-pattern>
             </filter-mapping>
         */
        //得到过滤器的名字
        String filterName = filterConfig.getFilterName();
        //得到在web.xml文件中配置的初始化参数
        String initParam1 = filterConfig.getInitParameter("name");
        String initParam2 = filterConfig.getInitParameter("like");
        //返回过滤器的所有初始化参数的名字的枚举集合。
        Enumeration<String> initParameterNames = filterConfig.getInitParameterNames();

        System.out.println(filterName);
        System.out.println(initParam1);
        System.out.println(initParam2);
        while (initParameterNames.hasMoreElements()) {
            String paramName = (String) initParameterNames.nextElement();
            System.out.println(paramName);
        }
    }

    @Override
    public void doFilter(ServletRequest request, ServletResponse response,
            FilterChain chain) throws IOException, ServletException {
        System.out.println("FilterDemo02执行前!!!");
        chain.doFilter(request, response);  //让目标资源执行,放行
        System.out.println("FilterDemo02执行后!!!");
    }

    @Override
    public void destroy() {
        System.out.println("----过滤器销毁----");
    }
}

5 Filter的部署

Filter的部署分为两个步骤:

1、注册Filter

2、映射Filter

5.1 注册Filter

开发好Filter之后,需要在web.xml文件中进行注册,这样才能够被web服务器调用

在web.xml文件中注册Filter范例:

<filter>
          <description>FilterDemo02过滤器</description>
          <filter-name>FilterDemo02</filter-name>
          <filter-class>me.gacl.web.filter.FilterDemo02</filter-class>
          <!--配置FilterDemo02过滤器的初始化参数-->
          <init-param>
              <description>配置FilterDemo02过滤器的初始化参数</description>
              <param-name>name</param-name>
              <param-value>gacl</param-value>
          </init-param>
          <init-param>
              <description>配置FilterDemo02过滤器的初始化参数</description>
              <param-name>like</param-name>
              <param-value>java</param-value>
          </init-param>
</filter>

用于添加描述信息,该元素的内容可为空,可以不配置。

用于为过滤器指定一个名字,该元素的内容不能为空。
  元素用于指定过滤器的完整的限定类名。
  元素用于为过滤器指定初始化参数,它的子元素指定参数的名字,指定参数的值。在过滤器中,可以使用FilterConfig接口对象来访问初始化参数。如果过滤器不需要指定初始化参数,那么元素可以不配置。

5.2 映射Filter

在web.xml文件中注册了Filter之后,还要在web.xml文件中映射Filter

<!--映射过滤器-->
  <filter-mapping>
      <filter-name>FilterDemo02</filter-name>
      <!--“/*”表示拦截所有的请求 -->
      <url-pattern>/*</url-pattern>
  </filter-mapping>

元素用于设置一个 Filter 所负责拦截的资源。一个Filter拦截的资源可通过两种方式来指定:Servlet 名称和资源访问的请求路径
  子元素用于设置filter的注册名称。该值必须是在元素中声明过的过滤器的名字
  设置 filter 所拦截的请求路径(过滤器关联的URL样式)
  指定过滤器所拦截的Servlet名称。
  指定过滤器所拦截的资源被 Servlet 容器调用的方式,可以是REQUEST,INCLUDE,FORWARD和ERROR之一,默认REQUEST。用户可以设置多个 子元素用来指定 Filter 对资源的多种调用方式进行拦截。如下:

<filter-mapping>
    <filter-name>testFilter</filter-name>
   <url-pattern>/index.jsp</url-pattern>
   <dispatcher>REQUEST</dispatcher>
   <dispatcher>FORWARD</dispatcher>
</filter-mapping>

子元素可以设置的值及其意义:

  1. REQUEST:当用户直接访问页面时,Web容器将会调用过滤器。如果目标资源是通过RequestDispatcher的include()或forward()方法访问时,那么该过滤器就不会被调用。
  2. INCLUDE:如果目标资源是通过RequestDispatcher的include()方法访问时,那么该过滤器将被调用。除此之外,该过滤器不会被调用。
  3. FORWARD:如果目标资源是通过RequestDispatcher的forward()方法访问时,那么该过滤器将被调用,除此之外,该过滤器不会被调用。
  4. ERROR:如果目标资源是通过声明式异常处理机制调用时,那么该过滤器将被调用。除此之外,过滤器不会被调用。

6. @WebFilter 注解

@WebFilter 用于将一个类声明为过滤器,该注解将会在部署时被容器处理,容器将根据具体的属性配置将相应的类部署为过滤器。该注解具有下表给出的一些常用属性 ( 以下所有属性均为可选属性,但是 value、urlPatterns、servletNames 三者必需至少包含一个,且 value 和 urlPatterns 不能共存,如果同时指定,通常忽略 value 的取值 )

属性名类型说明
filterNamestring指定过滤器的name属性,等价于
valuestring[]该属性等价于urlPatterns属性。但是两者不应该同时使用。
urlPatternsstring[]指定—组过滤器的URL匹配模式。等价于标签。
servletNamesstring[]指定过滤器将应用于哪些Servlet。取值是@WebServlet 中的name 属性的取值,或者是web.xml中的取值。
initParamsWeblnitParam[]指定—组过滤器初始化参数,等价于标签。
asyncSupportedboolean声明过滤器是否支持异步操作模式,等价于标签
descriptionstringi该过滤器的描述信息,等价于标签。
displayNamestring该过滤器的显示名,通常配合工具使用,等价于标签。
dispatcherTypesDispatcherType指定过滤器的转发模式。具体取值包括:ASYNC、ERROR、FORWARD、INCLUDE、REQUEST。
posted on 2021-11-30 17:59  JAVA开发区  阅读(12)  评论(0)    收藏  举报  来源