Servlet 应用程序事件、监听器

时间:2023-03-09 09:25:06
Servlet 应用程序事件、监听器

  Web容器管理Servlet/JSP相关的生命周期,若对HttpServletRequest对象、HttpSession对象、ServletContxt对象在生成、销毁或相关属性设置发生的时机点有兴趣,可以实现对应的监听器(Listener)。

一、ServletContext事件、监听器

与ServletContext相关的监听器有两个,ServletContextListener、ServletContextAttributeListener

1、ServletContextListener

它是生命周期监听器,如果想要知道何时web应用程序已经初始化或者即将结束销毁,可以实现该监听器。

例如,可以实现ServletContextListener,在此应用程序初始过程中,准备好数据库连接线对象、读取应用程序设置等动作,如放置使用头像的目录信息,就不适合将目录名称写死,这时候可以这么做:

 package cc.openhome;
import javax.servlet.*;
@WebListener //使用@weblistener标注
public class ContextParameterReader implements ServletContextListener{
public void contextInitialized(ServletContextEvent e){
ServletContext context = sce.getServletContext();//取得ServletContext
String avatars = context.getInitParameter("AVATAR");//取得初始参数
context.setAttribute("avatars",avatars);//设置ServletContext属性
}
public void contextDestroyed(ServletContextEvent sce){}
}

  整个web应用程序生命周期,Servlet共享的资料可以设置为ServletContext属性。这些属性数据会一直存在于web应用程序中。可以通过setAttribute()方法设置对象为ServletContext属性,之后可通过ServletContext的getAttribute()方法取出该属性。如果移除属性,用removeAttribute()。

 package ServletAPI;

 import java.io.IOException;
import java.io.PrintWriter; import javax.servlet.ServletException;
import javax.servlet.annotation.WebInitParam;
import javax.servlet.annotation.WebServlet;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse; /**
* Servlet implementation class Avatar
*/
@WebServlet(
urlPatterns = { "/avatar.view" },
initParams = {
@WebInitParam(name = "AVATAR_DIR", value = "/image")//根目录WebContent内部
})
public class Avatar extends HttpServlet {
private static final long serialVersionUID = 1L;
private String AVATAR_DIR;
/**
* @see HttpServlet#HttpServlet()
*/
public Avatar() {
super();
// TODO Auto-generated constructor stub
}
public void init() throws ServletException{
//AVATAR_DIR=getInitParameter("AVATAR_DIR");
AVATAR_DIR=(String) getServletContext().getAttribute("avatars");
} /**
* @see HttpServlet#doGet(HttpServletRequest request, HttpServletResponse response)
*/
protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
// TODO Auto-generated method stub
response.setContentType("text/html;charset=UTF-8");
PrintWriter out=response.getWriter();
out.println("<!DOCTYPE html>");
out.println("<html>");
out.println("<head>");
out.println("<meta content='text/html; charset=UTF-8' http-equiv='content-type'>");
out.println("<title>头像显示</title>");
out.println("</head>");
out.println("<body>");
for(String avatar:getServletContext().getResourcePaths(AVATAR_DIR)){//取得头像路径
avatar=avatar.replaceFirst("/", "");
out.println("<img src='"+avatar+"'>");
}
out.println("</body>");
out.println("</html>");
out.close();
} /**
* @see HttpServlet#doPost(HttpServletRequest request, HttpServletResponse response)
*/
protected void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
// TODO Auto-generated method stub
} }

avatar.java

2、ServletContextAttributeListener

它是监听属性改变的监听器,如果想要对象被设置、移除或替换ServletContext属性,也可以收到通知以进行一些操作,可以实现该监听器。

当在ServletContext中添加属性、移除或者替换属性时,对应的attributeAdded()、attributeRemoved()、attributeReplaced()方法就会被调用。

二、HttpSession事件、监听器

与HttpSession相关的有四个监听器:HttpSessionListener、HttpSessionAttributeListener、HttpSessionBindingListener与HttpSessionActivationListener.

1、HttpSessionListener

它是生命周期监听器,如果想要在HttpSession对象创建或者结束时,做些相对应动作,可以实现该监听。

在HttpSession对象初始化或结束之前,会分别调用sessionCreated()、sessionDestroyed()方法,

可以通过传入的HttpSessionEvent,使用getSession()取得HttpSession,以针对会话对象做出相应操作。例如:除非用户注销,否则登录后的用户在另个浏览器上登录会显示登录失败。

如果用户不小心再注销前关闭了浏览器,那么数据库中代表登录与否的字段就不会被重置。为此,可是实现HttpSessionListener,由于HttpSession有存活期限,当容器销毁某个HttpSession时,就会调用sessionDestroyed(),就可以再当中判断要重置哪个用户的数据库中代表登录与否的字段。

例1:显示目前已经在线人数的统计。

 package ServletAPI;

 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;
import javax.servlet.http.HttpSession; /**
* Servlet implementation class Welcome
*/
@WebServlet("/welcome.view")
public class Welcome extends HttpServlet {
private static final long serialVersionUID = 1L; /**
* @see HttpServlet#doGet(HttpServletRequest request, HttpServletResponse response)
*/
protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
// TODO Auto-generated method stub
response.setContentType("text/html;charset=UTF-8");
PrintWriter out=response.getWriter();
HttpSession session=request.getSession(true);
out.println("<html>");
out.println("<head>");
out.println("<title>欢迎</title>");
out.println("</head>");
out.println("<body>");
out.println("<h1>目前在线人数"+OnlineUserCounter.getCounter()+"人</h1>");//获取在线人数
if(session!=null){
String user=(String) session.getAttribute("user");
out.println("<h1>欢迎:"+user+"</h1>");
out.println("<a href='logout.do'>注销</a>");
}
out.println("</body>");
out.println("</html>");
} }

Welcome.java

 package ServletAPI;

 import javax.servlet.annotation.WebListener;

 import javax.servlet.http.HttpSessionEvent;
import javax.servlet.http.HttpSessionListener; /**
* Application Lifecycle Listener implementation class OnlineUserCounter
*
*/
@WebListener()
public class OnlineUserCounter implements HttpSessionListener {
private static int counter; public static int getCounter(){
return counter;
} /**
* @see HttpSessionListener#sessionCreated(HttpSessionEvent)
*/
public void sessionCreated(HttpSessionEvent se) {
// TODO Auto-generated method stub
OnlineUserCounter.counter++;
} /**
* @see HttpSessionListener#sessionDestroyed(HttpSessionEvent)
*/
public void sessionDestroyed(HttpSessionEvent se) {
// TODO Auto-generated method stub
OnlineUserCounter.counter--;
} }

OnlineUserCounter.java

 package ServletAPI;

 import java.io.IOException;
import java.util.HashMap;
import java.util.Map; import javax.print.attribute.standard.PagesPerMinute;
import javax.servlet.ServletException;
import javax.servlet.annotation.WebServlet;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse; import org.apache.catalina.User; /**
* Servlet implementation class loginlistener
*/
@WebServlet("/listener.view")
public class loginlistener extends HttpServlet {
private static final long serialVersionUID = 1L;
private Map<String, String> users;
/**
* @see HttpServlet#HttpServlet()
*/
public loginlistener() {
//super();
users=new HashMap<String, String>();
users.put("nihao", "nihaonihao");
users.put("momor", "123456789");
users.put("hamimi", "123456789");
// TODO Auto-generated constructor stub
} /**
* @see HttpServlet#doPost(HttpServletRequest request, HttpServletResponse response)
*/
protected void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
// TODO Auto-generated method stub
String name=request.getParameter("user");
String passwd=request.getParameter("passwd");
String page="listenerlogin.html";
if(users.containsKey(name) && users.get(name).equals(passwd)){
User user=(User) new ServletAPI.User(name);
request.getSession().setAttribute("user", user);
page="welcome.view";
}
response.sendRedirect(page);
} }

login.java

  运行结果

Servlet 应用程序事件、监听器

2、HttpSessionAttributeListener

    它是属性改变监听器,用法同ServletContextAttributeListener一样。

3、HttpSessionBindingListener

它是对象绑定监听器,如果有个即将加HttpSessionBindingListener入HttpSession的属性对象,希望在设置给HttpSession成为属性或从HttpSession中删除时,可以收到HttpSession的通知,可以让该对象实现该监听器。

当实现此接口的属性对象被加入HttpSession或冲中移除,就会调用valueBound()与valueUnbound()方法,并传入HttpSessionBindingEvent对象,可以通过该对象的getSession()取得HttpSession对象。

4、HttpSessionActivationListener

对象迁移监听器,几乎不会用到。

三、HttpServletRequest事件、监听器

有三个相关的监听器:ServletRequestListener、ServletRequestAttributeListener、AsyncListener(这个在异步处理时会介绍到)。