web.xml中的ServletContextListener

Posted 2020-09-19 slgkaifa

要想了解ServletContextListener，先看看web.xml中的<listener>配置。

一）web.xml中的内容载入顺序：

        首先能够肯定的是，载入顺序与它们在 web.xml 文件里的先后顺序无关。

即不会由于 filter 写在 listener 的前面而会先载入 filter。终于得出的结论是：listener -> filter -> servlet
        同一时候还存在着这样一种配置节：context-param，它用于向 ServletContext 提供键值对，即应用程序上下文信息。我们的 listener, filter 等在初始化时会用到这些上下文中的信息，那么 context-param 配置节是不是应该写在 listener 配置节前呢？实际上 context-param 配置节可写在任何位置，因此真正的载入顺序为：context-param -> listener -> filter -> servlet
        对于某类配置节而言，与它们出现的顺序是有关的。

以 filter 为例。web.xml 中当然能够定义多个 filter，与 filter 相关的一个配置节是 filter-mapping，这里一定要注意，对于拥有同样 filter-name 的 filter 和 filter-mapping 配置节而言。filter-mapping 必须出如今 filter 之后。否则当解析到 filter-mapping 时。它所相应的 filter-name 还没有定义。web 容器启动时初始化每一个 filter 时，是依照 filter 配置节出现的顺序来初始化的，当请求资源匹配多个 filter-mapping 时，filter 拦截资源是依照 filter-mapping 配置节出现的顺序来依次调用 doFilter() 方法的。
    servlet 同 filter 类似 ，此处不再赘述。
       由此，能够看出，web.xml 的载入顺序是：context-param -> listener -> filter -> servlet ，而同个类型之间的实际程序调用的时候的顺序是依据相应的 mapping 的顺序进行调用的。

二）ServletContextListener 是什么：从上面载入顺序分享一下，ServletContextListener 就是一个监听器。
        ServletContext 被 Servlet 程序用来与 Web 容器通信。

比如写日志，转发请求。每个 Web 应用程序含有一个Context，被Web应用内的各个程序共享。

由于Context能够用来保存资源而且共享，所以我所知道的 ServletContext 的最大应用是Web缓存----把不常常更改的内容读入内存。所以server响应请求的时候就不须要进行慢速的磁盘I/O了。
       ServletContextListener 是 ServletContext 的监听者，假设 ServletContext 发生变化，如server启动时 ServletContext 被创建，server关闭时 ServletContext 将要被销毁。
       在JSP文件里。application 是 ServletContext 的实例，由JSP容器默认创建。Servlet 中调用 getServletContext()方法得到 ServletContext 的实例。

三）ServletContextListener 可以做些什么：一切你想做的，就是一个监听器可以做的事。

1.设计缓存：

思路：

缓存的思路大概是：
    1）server启动时，ServletContextListener 的 contextInitialized()方法被调用，所以在里面创建好缓存。能够从文件里或者从数据库中读取取缓存内容生成类，用 ervletContext.setAttribute()方法将缓存类保存在 ServletContext 的实例中。
   2）程序使用 ServletContext.getAttribute()读取缓存。

假设是 JSP。使用a pplication.getAttribute()。假设是 Servlet。使用 getServletContext().getAttribute()。

假设缓存发生变化(如訪问计数)，你能够同一时候更改缓存和文件/数据库。

或者你等 变化积累到一定程序再保存。也能够在下一步保存。
    3）server将要关闭时，ServletContextListener 的 contextDestroyed()方法被调用，所以在里面保存缓存的更改。将更改后的缓存保存回文件或者数据库，更新原来的内容。

import User; //my own class
import DatabaseManager; // my own class
import javax.servlet.ServletContext;
import javax.servlet.ServletContextListener;

public class MyContextListener

	implements ServletContextListener {
	private ServletContext context = null;

	public void contextInitialized(ServletContextEvent event) {
		context = event.getServletContext();
		User user = DatabaseManager.getUserById(1);
		context.setAttribute("user1", user);
	}

	public void contextDestroyed(ServletContextEvent event) {
		User user = (User)context.getAttribute("user1");
		DatabaseManager.updateUserData(user);
		this.context = null;
	}
} 

2）推断一个配置文件的编码格式：

public class InitProperties implements ServletContextListener {
	
	private static final Logger logger = Logger
			.getLogger(InitProperties.class);

	@Override
	public void contextDestroyed(ServletContextEvent arg0) {
		// TODO Auto-generated method stub

	}
/**
 * 该监听器仅仅用于初始化时监听配置文件是否是utf-8编码  且仅仅在初始化时运行一次  对兴许的各种请求无影响
 * **/
	@Override
	public void contextInitialized(ServletContextEvent arg0) {
		
		//载入文件的编码格式  查看是否是utf-8类型的
		try {
			String fileUrl = PropertiesHander.class.getResource("/evoucher.conf").toString();
			fileUrl = fileUrl.replace("file:","");
					
			File file = new File(fileUrl);
			InputStream	ios = new java.io.FileInputStream(file);
				byte[] b = new byte[3];
	
				try {
					ios.read(b);
					ios.close();
					} catch (IOException e) {
							
							logger.error("检測编码载入时关闭流出现载入异常");
					}
		      
				//默认编码是 23  23   23 的  相同能够载入这样的默认的编码
				if (b[0] == 35 && b[1] == 35 && b[2] == 35)

				 {
					logger.info(file.getName() + "：编码为默认编码");	
				 }
				  //utf-8编码的首字母是  ef  bb  bf 
				else if (b[0] == -17 && b[1] == -69 && b[2] == -65)

				 {
					logger.info(file.getName() + "：编码为UTF-8");	
				 }

				else
				 {
					 try{
				     // logger.error(file.getName() + "文件编码格式不是UTF-8编码。请又一次确定编码格式！");
				      throw new EVoucherException(file.getName() + "文件编码格式不是UTF-8编码，请又一次确定编码格式！");
					 }
					 catch(EVoucherException e){
					 // logger.error(e);
					  EVoucherException.getEVException(null, e, logger);
					  System.exit(0);
						
					 }

				  }
						
			} catch (FileNotFoundException e) {
					
				logger.error("检測编码时载入文件出现异常");
					
			}

	}

}

四）布署 ServletContextListener

<listener>
	<listener-class>MyServletContextListener</listener-class>
</listener>

<!-- 自己主动监听配置文件是否是utf-8编码 -->
	<listener>
      <listener-class>assp.evoucher.common.util.InitProperties</listener-class>
    </listener>