Tomcat+Spring应用系统中log4j配置文件的使用方法和存放位置

使用Spring Framework已经快两年了,是从Spring发行包携带的样例程序开始的,从来没有仔细研究过各部分的使用方法。最近才发现使用log4j的方法是不正确的。



log4j配置文件的存放位置

跟其他程序环境不同,在Spring Framework应用系统中,log4j配置文件的存放位置是自由的。在应用程序的web.xml中进行规定,[1]使用以下代码:

<context-param>
<param-name>log4jConfigLocation</param-name>
<param-value>/WEB-INF/classes/log4j.properties</param-value>
</context-param>

<context-param>
<param-name>log4jRefreshInterval</param-name>
<param-value>60000</param-value>
</context-param>

同时还要设置一个listener

<listener>
<listener-class>org.springframework.web.util.Log4jConfigListener</listener-class>
</listener>



告警的排除

设置好web.xml后,部署WAR文件,发现以下告警:

log4j:WARN No such property [maxFileSize] in org.apache.log4j.DailyRollingFileAppender.
log4j:WARN No such property [maxBackupIndex] in org.apache.log4j.DailyRollingFileAppender.

后来发现一个介绍更为详细的文章[3]学到以下知识:

  • Log4jConfigListener是spring提供的工具类,它开启一个log4j的监视线程,并每60(log4jRefreshInterval变量定义)秒检测日志配置变化,从而不需要每次重新启动web服务来应用新的配置。它使用log4jRefreshInterval,所以两者都不是必须的。
  • Log4j提供的appender有以下几种
    • org.apache.log4j.ConsoleAppender(控制台)
    • org.apache.log4j.FileAppender(文件)
    • org.apache.log4j.DailyRollingFileAppender(每天产生一个日志文件)
    • org.apache.log4j.RollingFileAppender(文件大小到达指定尺寸的时候产生一个新的文件)
    • org.apache.log4j.WriterAppender(将日志信息以流格式发送到任意指定的地方)
可见如果使用DailyRollingFileAppender,maxFileSize和maxBackupIndex是不必配置的。



部署第二个应用时的异常

如果第二个应用也要使用log4j,部署时会出现以下异常:

[ERROR] 23:43:18 [/第二个应用名] - 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' = [/usr/share/tomcat5/webapps/第一个应用名/] instead of [/usr/share/tomcat5/webapps/第二个应用名/] - Choose unique values for the 'webAppRootKey' context-param in your web.xml files!

根据[2][3]的解释,Tomcat跟其他容器(例如:Resin)不同,没有为各个应用分开存放属性,因此必须为"webAppRootKey"分配不同的值,根据[2]的建议,可以使用下面的设置:

<context-param>
<param-name>log4jExposeWebAppRoot</param-name>
<param-value>false</param-value>
</context-param>

根据[3]的建议,可以如下配置:

<context-param>
<param-name>webAppRootKey</param-name>
<param-value>应用的别名</param-value>
</context-param>

我采用了后者,因为别名更有用,在别的地方可以使用这个别名。



进一步思考

经过实验,觉得log4j.properties中的设置好像都作为系统属性加载到虚拟机中,这样,如果两个应用有相同的设置内容,第二个部署的设置不起作用。

而且这些配置只有重新启动虚拟机后才能消除,否则,修改了log4j.properties的设置(例如,日志级别)并不即时起作用。也许使用Log4jConfigListener会有用,但是没有实验。



遗留问题

使用Tomcat Manager部署应用时有时会出现以下异常:

2008-11-5 0:06:01 org.apache.catalina.loader.WebappClassLoader loadClass
信息: Illegal access: this web application instance has been stopped already. Could not load org.apache.log4j.PatternLayout. The eventual following stack trace is caused by an error thrown for debugging purposes as well as to attempt to terminate the thread which caused the illegal access, and has no functional impact.
java.lang.IllegalStateException
....

而且使用Tomcat Manager部署应用时有时产生不了log4j.properties中规定的日志文件。

而重新启动Tomcat后就正常了。