Tomcat部署多工程时Log4j的问题

Story：松哥最近在调试测试环境的时候，希望在一个Tomcat中部署多个Java Web工程时，遇到一个极不明显的问题（日志内容太多，troubleshouting的时候找了半天才看到），后来才知道是Log4j的问题。

问题表现为：

1. 在一个tomcat中配置了3个工程，当重启tomcat后，只有第一个project1能正常访问，其它project2、project3都访问不了；（初步断定是Java工程的问题，也可能是tomcat的server.xml配置有问题）
2. troubleshouting的时候，在server.xml中修改配置文件，注释掉其它两个service，只留一个project2，重启tomcat后project2可以正常访问；相同的方式试了project3也是；（断定服务器上的tomcat配置是没问题的）
3. 问题应该是在Java工程里，因此反复查看tomcat的log，发现是Log4j的问题；

1.tomcat日志中的报错内容

#tail -f /usr/local/tomcat/log/catalina.out

Sep 22, 2017 5:46:05 PM org.apache.catalina.core.StandardContext listenerStart
SEVERE: Exception sending context initialized event to listener instance of class org.springframework.web.util.Log4jConfigListener
java.lang.IllegalStateException: Web app root system property already set to different value: 'webapp.root' = [/data/wwwroot/testmerchant/shop-merchant/] instead of [/data/wwwroot/teststore/shop-store/] - Choose unique values for the 'webAppRootKey' context-param in your web.xml files!
at org.springframework.web.util.WebUtils.setWebAppRootSystemProperty(WebUtils.java:156)
at org.springframework.web.util.Log4jWebConfigurer.initLogging(Log4jWebConfigurer.java:117)
at org.springframework.web.util.Log4jConfigListener.contextInitialized(Log4jConfigListener.java:46)
at org.apache.catalina.core.StandardContext.listenerStart(StandardContext.java:5118)
at org.apache.catalina.core.StandardContext.startInternal(StandardContext.java:5634)
at org.apache.catalina.util.LifecycleBase.start(LifecycleBase.java:145)
at org.apache.catalina.core.ContainerBase$StartChild.call(ContainerBase.java:1571)
at org.apache.catalina.core.ContainerBase$StartChild.call(ContainerBase.java:1561)
at java.util.concurrent.FutureTask.run(FutureTask.java:262)
at java.util.concurrent.ThreadPoolExecutor.runWorker(ThreadPoolExecutor.java:1145)
at java.util.concurrent.ThreadPoolExecutor$Worker.run(ThreadPoolExecutor.java:615)
at java.lang.Thread.run(Thread.java:745)

2.错误的原因

日志中有句话如下：
java.lang.IllegalStateException: Web app root system property already set to different value: 'webapp.root' = [/data/wwwroot/project1] instead of [/data/wwwroot/project2] - Choose unique values for the 'webAppRootKey' context-param in your web.xml files!

每个工程系统默认webAppRootKey的值都是webapp.root，webapp.root对应的是项目的根路径，所以当有两个使用该值的工程同时在一个Tomcat下面时会报错，因为一个key只能保存一个value，后初始化的会替换先初始化的，所以遇到这个问题的解决办法，就是去每个工程中的web.xml里面给webAppRootKey重新赋个值，且每个值不能重复，重启tomcat就OK了。

3.解决问题的代码

3.1 修改project1的web.xml

#vim /data/wwwroot/project1/WEB-INF/web.xml
 29         
 30                 org.springframework.web.util.Log4jConfigListener
 31         
 32 
 33         
 34         
 35                 webAppRootKey
 36                 app1.root
 37         

3.2 修改project2的web.xml

#vim /data/wwwroot/project2/WEB-INF/web.xml
 29         
 30                 org.springframework.web.util.Log4jConfigListener
 31         
 32 
 33         
 34         
 35                 webAppRootKey
 36                 app2.root
 37         

其中，的格式建议：[工程名].root

---

关于Log4j

1.什么是Log4j？

• log4j是一个用Java编写的可靠，快速和灵活的日志框架（API），它在Apache软件许可下发布。
• Log4j已经被移植到了C，C++，C＃，Perl，Python和Ruby等语言中。
• Log4j是高度可配置的，并可通过在运行时的外部文件配置。它根据记录的优先级别，并提供机制，以指示记录信息到许多的目的地，诸如：数据库，文件，控制台，UNIX系统日志等。

2.Log4j中有三个主要组成部分：

• loggers: 负责捕获记录信息。
• appenders : 负责发布日志信息，以不同的首选目的地。
• layouts: 负责格式化不同风格的日志信息。

3.Log4j的特性

• log4j的是线程安全的
• log4j是经过优化速度的
• log4j是基于一个名为记录器的层次结构
• log4j的支持每个记录器多输出追加器（appender）
• log4j支持国际化。
• log4j并不限于一组预定义的设备
• 日志行为可以使用配置文件在运行时设置
• log4j设计从一开始就是处理Java异常
• log4j使用多个层次，即ALL，TRACE，DEBUG，INFO，WARN，ERROR和FATAL
• 日志输出的格式可以通过扩展Layout类容易地改变
• 日志输出的目标，以及在写入策略可通过实现Appender程序接口改变
• log4j 会故障停止。然而，尽管它肯定努力确保传递，log4j不保证每个日志语句将被传递到目的地。

参考及引用
http://www.yiibai.com/log4j/