原文链接:点击打开链接
listener
在Web项目中,我们可以使用Listener接口来监听Container的中一些对象状态的变化,并且根据这些对象的状态的变化做出相应的响应。
在Servlet 2.4和JSP 2.0 规范中一共有八个listener接口和六个event事件类。
当一个事件发生的时候我们可以使用listener中的某个方法去对事件做出相应的响应,这些方法的参数都是java.util.EventObject的子类。
这些Listener与其方法对应的Event参数类型如下图:
上图详细描述了八个listener接口和与其对应的event类
我们大致可以把八个listener分成三类,分别为与ServletContext、HttpSession、ServletRuquest相关的listener,在上图中已经使用不同的底色进行标注。
由于listener在实际的应用中好像不如预计的广泛,所以底下只简单介绍接口、方法、参数和注意点(统计在线人数和在线人员名单也许是用的最多的使用listener的实现了)。
好了,让我们从与ServletContext相关的两个接口开始吧
首先ServletContext是整个Web应用的上下文,所以这个对象里存放的应该是和整个Web应用相关的东西(在线人数明显很符合这个特点)
ServletContextListener
void contextInitialized(ServletContextEvent sce)
这个方法在Container初始化整个Web应用时调用,运行在该Web应用中servlet和filter初始化之前
void contextDestroyed(ServletContextEvent sce)
这个方法在Container卸载整个Web应用时调用,运行在该Web应用中servlet和filter的destroy()方法之后
ServletContextAttributeListener
void attributeAdded(ServletContextAttributeEvent scab)
这个方法在通过ServletContext的void setAttribute(String name, Object object)向ServletContext新添加一个name为名,object为值得对象之后被调用
void attributeReplaced(ServletContextAttributeEvent scab)
这个方法在通过ServletContext的void setAttribute(String name, Object object)替换ServletContext中name对应的值之后被调用
void attributeRemoved(ServletContextAttributeEvent scab)
这个方法在通过ServletContext的void removeAttribute(String name)删除ServletContext中以name为名的键值对之后或者ServletContext被销毁之前被调用。
ServletContextAttributeEvent提供两个方法:
String getName()返回键值对的名也就是name。
Object getValue()这个方法,在attributeAdded中返回新添的键值对的值;在attributeReplaced和中attributeRemoved返回原键值对的值。
HttpSessionListener
void sessionCreated(HttpSessionEvent se)
当一个session被创建之后,容器调用此方法。
void sessionDestroyed(HttpSessionEvent se)
当一个session将要被销毁时,容器调用此方法。
HttpSessionEvent只有一个方法HttpSession getSession(),该方法返回对应的session。
HttpSessionActivationListener
这个接口一般和Servlet容器的集群有关系,它监听的是同一个session转移至不同的JVM的事件。
void sessionDidActivate(HttpSessionEvent se)
当一个session对象已经变成有效的状态的时候,容器调用此方法
void sessionWillPassivate(HttpSessionEvent se)
当一个session对象将要变成无效状态的时候,容器调用此方法
HttpSessionAttributeListener
这个接口和ServletContextAttributeListener方法一样,唯一的差别即是:
ServletContextAttributeListener针对的是ServletContext,而HttpSessionAttributeListener针对的Session。
void attributeAdded(HttpSessionBindingEvent se)
这个方法在通过HttpSession的void setAttribute(String name, Object object)向HttpSession新添加一个name为名,object为值得对象之后被调用
void attributeReplaced(HttpSessionBindingEvent se)
这个方法在通过HttpSession的void setAttribute(String name, Object object)替换HttpSession中name对应的值之后被调用
void attributeRemoved(HttpSessionBindingEvent se)
这个方法在通过HttpSession的void removeAttribute(String name)删除HttpSession中以name为名的键值对或者HttpSession失效时被调用之后被调用。
HttpSessionBindingEvent提供三个方法:
String getName()返回键值对的名也就是name。
Object getValue()这个方法,在attributeAdded中返回新添的键值对的值;在attributeReplaced和中attributeRemoved返回原键值对的值。
HttpSession getSession() 返回发生此事件的HttpSession对象。
HttpSessionBindingListener
注意:这个listener是一个比较特殊的listener,它不需要在web.xml中进行配置。
此listener需要存放于session中的对象实现此接口,才能被响应。
void valueBound(HttpSessionBindingEvent event)
此方法通过HttpSession的void setAttribute(String name, Object object)被调用。其中object需要实现HttpSessionBindingListener接口。
void valueUnbound(HttpSessionBindingEvent event)
此方法通过HttpSession的void removeAttribute(String name)或者HttpSession失效时被调用。其中nam对应的object需要实现HttpSessionBindingListener接口。
这个接口和HttpSessionAttributeListener差别为,此接口不需要在web.xml中配置并且可以监听单个类的对象被放入session或者从session中去掉的动作。而HttpSessionAttributeListener需要在web.xml中配置,并且是监听所有类的对象。
ServletRequestListener
void requestInitialized(ServletRequestEvent sre)
request初始化之后,容器调用此方法。
void requestDestroyed(ServletRequestEvent sre)
request消亡之前,容器调用此方法。
ServletRequestEvent提供二个方法:
ServletContext getServletContext()
返回此事件request对象对应的ServletContext
ServletRequest getServletRequest()
返回此事件的request对象
ServletRequestAttributeListener
这个listener作用和ServletContextAttributeListener和HttpSessionAttributeListener类似,不过它监听的是ServletRequest对象。
void attributeAdded(ServletRequestAttributeEvent srae)
这个方法在通过ServletRequest的void setAttribute(String name, Object object)向ServletRequest新添加一个name为名,object为值得对象之后被调用
void attributeReplaced(ServletRequestAttributeEvent srae)
这个方法在通过ServletRequest的void setAttribute(String name, Object object)替换ServletRequest中name对应的值之后被调用
void attributeRemoved(ServletRequestAttributeEvent srae)
这个方法在通过ServletRequest的void removeAttribute(String name)删除ServletRequest中以name为名的键值对或者ServletRequest失效时被调用之后被调用。
ServletRequestAttributeEvent除了继承了ServletRequestEvent的ServletContext getServletContext()和ServletRequest getServletRequest()还提供了:
String getName()返回键值对的名也就是name
Object getValue()这个方法,在attributeAdded中返回新添的键值对的值;在attributeReplaced和中attributeRemoved返回原键值对的值。
除了HttpSessionBindingListener以外,其他的listener都必须在web.xml中进行配置。
配置的方法很简单就是在web.xml中最后一个</filter-mapping>后,添加一个
其中squall.servlet.listener.Listener为某一个listener的实现类。
基本步骤:
定义一个类继承ServletContextListener
然后把它在web.xml配置为listener