关于tomcat多个spring应用部署时webAppRootKey属性设置问题

Spring中有个监听器

 

public class WebAppRootListener implements ServletContextListener {

	public void contextInitialized(ServletContextEvent event) {
		WebUtils.setWebAppRootSystemProperty(event.getServletContext());
	}

	public void contextDestroyed(ServletContextEvent event) {
		WebUtils.removeWebAppRootSystemProperty(event.getServletContext());
	}

}

 初始化方法内容如下（将日志代码去掉）：

 

 

public static void setWebAppRootSystemProperty(ServletContext servletContext) throws IllegalStateException {
		Assert.notNull(servletContext, "ServletContext must not be null");
		String root = servletContext.getRealPath("/");
		if (root == null) {
			throw new IllegalStateException();
		}
		String param = servletContext.getInitParameter(WEB_APP_ROOT_KEY_PARAM);//webAppRootKey
		String key = (param != null ? param : DEFAULT_WEB_APP_ROOT_KEY);//webapp.root
		String oldValue = System.getProperty(key);
		if (oldValue != null && !StringUtils.pathEquals(oldValue, root)) {
			throw new IllegalStateException（）
                 }
		System.setProperty(key, root);
	}

 可以看到这个监听器的作用就是将项目根路径作为value放到系统参数中去，而这个key值默认是“webapp.root”，如果想要修改可以在ServletContext中通过设置“webAppRootKey”这个参数来修改这个key值（比如在web.xml文件中修改）。

这个参数可以用于一些工具包在项目运行时动态以${webapp.root}这样的方式动态获取项目路径，比如log4j.properties配置文件中 log4j.appender.file.File=${webapp.root}/WEB-INF/logs/sample.log就可以在运行时动态的找出项目的路径。

包括Tomcat的一些容器，没有为各个应用维护自己的系统参数，所以必须用“webAppRootKey”为每个web应用设置单独的根目录系统参数key，否则会引起冲突，报错。看上面代码就是如果两个同一个key值被设置过一次且值与当前不同则报错。

当然想要用这个系统参数要在web.xml中配置WebAppRootListener这个监听器，但是如果配置了Log4jConfigListener或者LogbackConfigListener则不需要再陪上面的监听器了，因为这两个监听器的初始化方法第一步就是运行上面的setWebAppRootSystemProperty，但是运不运行又要看另一个参数 "xxxExposeWebAppRoot"。那又是另一回事了