log4j中配置日志文件相对路径方法分析

核心提示：方法一、 解决的办法自然是用相对路径代替绝对路径，其实log4j的FileAppender本身就有这样的机制， 如：log4j.appender.logfile.File=${WORKDIR}/logs/app.log 其中${WORKDIR}/是个变量，会被System Property中的WORKDIR的值代替。这样，我们就可以在log4j加

方法一、

        解决的办法自然是用相对路径代替绝对路径，其实log4j的FileAppender本身就有这样的机制，如：log4j.appender.logfile.File=${WORKDIR}/logs/app.log
其 中“${WORKDIR}/”是个变量，会被System Property中的“WORKDIR”的值代替。这样，我们就可以在log4j加载配置文件之前，先用System.setProperty ("WORKDIR", WORKDIR);设置好根路径，此操作可通过一初始的servlet进行。

方法二、可以使用服务器环境变量
        log4j的配置文件支持服务器的vm的环境变量，格式类似${catalina.home}
        log4j.appender.R=org.apache.log4j.RollingFileAppender
        log4j.appender.R.File=${catalina.home}/logs/logs_tomcat.log
        log4j.appender.R.MaxFileSize=10KB
        其中的${catalina.home}并非windows系统的环境变量，这个环境变量就不需要在Windows系统的环境变量中设置。之所以这样，你 可以看看tomcat/bin/catalina.bat(startup,shutdown都是调用这个)里面自带有-Dcatalina.home= "%CATALINA_HOME%" 。继承这个思想，所以你也可以自己设定一个参数-Dmylog.home="D:/abc/log"到对应的服务器java启动的vm参数中

方法三、通过servlet初始化init()方法中加载file属性实现相对路径
        具体实现:做一个servlet,在系统加载的时候,就把properties的文件读到一个properties文件中.那个file的属性值(我使用 的是相对目录)改掉(前面加上系统的根目录),让后把这个properties对象设置到propertyConfig中去,这样就初始化了log的设 置.在后面的使用中就用不着再配置了
一般在我们开发项目过程中,log4j日志输出路径固定到某个文件夹,这样如果我换一个环境,日志路径又需要重新修改,比较不方便,目前我采用了动态改变日志路径方法来实现相对路径保存日志文件

  (1).在项目启动时,装入初始化类:

1. 1 . public   class  Log4jInit  extends  HttpServlet {      
2. 2 .          static  Logger logger = Logger.getLogger(Log4jInit. class );      
3. 3 .          public  Log4jInit() {      
4. 4 .         }      
5. 5 .     
6. 6 .          public   void  init(ServletConfig config)  throws  ServletException {      
7. 7 .             String prefix = config.getServletContext().getRealPath( "/" );      
8. 8 .             String file = config.getInitParameter( "log4j" );      
9. 9 .             String filePath = prefix + file;      
10. 10 .             Properties props =  new  Properties();      
11. 11 .              try  {      
12. 12 .                 FileInputStream istream =  new  FileInputStream(filePath);      
13. 13 .                 props.load(istream);      
14. 14 .                 istream.close();      
15. 15 .                  //toPrint(props.getProperty("log4j.appender.file.File"));      
16. 16 .                 String logFile = prefix + props.getProperty( "log4j.appender.file.File" ); //设置路径      
17. 17 .                 props.setProperty( "log4j.appender.file.File" ,logFile);      
18. 18 .                 PropertyConfigurator.configure(props); //装入log4j配置信息      
19. 19 .             }  catch  (IOException e) {      
20. 20 .                 toPrint( "Could not read configuration file ["  + filePath +  "]." );      
21. 21 .                 toPrint( "Ignoring configuration file ["  + filePath +  "]." );      
22. 22 .                  return ;      
23. 23 .             }      
24. 24 .         }      
25. 25 .     
26. 26 .          public   static   void  toPrint(String content) {      
27. 27 .             System.out.println(content);      
28. 28 .         }      
29. 29 .}    

实 际上log4j的配置文件log4j.properties如为默认名，可放置在JVM能读到的classpath里的任意地方，一般是放在WEB- INF/classes目录下。当log4j的配置文件不再是默认名，则需要另外加载并给出参数，如上 “ropertyConfigurator.configure(props);//装入log4j配置信息”

  (2).Web.xml中的配置

1. < servlet >   
2.           < servlet-name > log4j-init </ servlet-name >   
3.           < servlet-class > Log4jInit </ servlet-class >   
4.           < init-param >   
5.             < param-name > log4j </ param-name >   
6.             < param-value > WEB-INF/classes/log4j.properties </ param-value >   
7.           </ init-param >   
8.           < load-on-startup > 1 </ load-on-startup >   
9.   </ servlet >   

注意：上面的load-on-startup设为0，以便在Web容器启动时即装入该Servlet。log4j.properties文件放在根的properties子目录中，也可以把它放在其它目录中。应该把.properties文件集中存放，这样方便管理。
  (3).log4j.properties中即可配置log4j.appender.file.File为当前应用的相对路径.

以上是网上log4j日志文件的相对路径配置的三种方法（我能找到的就三种），分析：

        方法一主要是扩展了log4j的RollingFileAppender类，其他的FileAppender同样道理。扩展的方法，就是用一个子类去覆盖setFile方法，这个方法在log4j读取配置文件生成appender的时候调用，传入的就是配
置文件中的路径，这样我就可以按照自己的想法在路径前面加上根路径了。这种方法可以在log4j.properties中用相对路径自由配置log4j.appender.A1.File属性来决定生成的日志相对web应用根
目录的位置。

        方法二是利用服务器vm中已经存在的环境变量如${catalina.home}来设置相对于${catalina.home}的日志路径，日志只能放到服务器子目录里，而且如果是用的其它服务器，则要改对应的环境变量。此方法平台移植不方便。

        方法三是扩展ActionServlet类，覆盖其init()方法，新方法中载入log4j.properties位置的参数，可以自由配置log4j的配置文件的名字和存放位置。也可自由配置log4j日志文件的相对于当前应用的路径。详
细代码如下：

 程序代码：

1. package  wbb.bysxxglxt.util;   
2.   
3. import  org.apache.struts.action.*;   
4. import  org.apache.commons.logging.LogFactory;   
5. import  org.apache.commons.logging.Log;   
6. import  javax.servlet.ServletException;   
7. import  java.util.Properties;   
8. import  java.io.InputStream;   
9. import  org.apache.log4j.PropertyConfigurator;   
10. import  java.io.FileInputStream;   
11. import  java.io.IOException;   
12.   
13. public   class  ExtendedActionServlet  extends  ActionServlet {   
14.           private  Log log = LogFactory.getLog( this .getClass().getName());   
15.   
16.           public  ExtendedActionServlet() {}   
17.   
18.           public   void  init()  throws  ServletException {   
19.              log.info(   
20.                       "Initializing, My MyActionServlet init this System's Const Variable" );   
21.              String prefix =  this .getServletConfig().getServletContext().getRealPath(   
22.                       "/" );   
23.              String file =  this .getServletConfig().getInitParameter( "log4j" );   
24.              String filePath = prefix + file;   
25.              Properties props =  new  Properties();   
26.              System.out.println(prefix);   
27.              System.out.println(file);   
28.              System.out.println(filePath);   
29.   
30.               try  {   
31.                  FileInputStream log4jStream =  new  FileInputStream(filePath);   
32.                  props.load(log4jStream);   
33.                  log4jStream.close();   
34.                  String logFile = prefix +   
35.                                  props.getProperty( "log4j.appender.A1.File" );  //设置路径   
36.   
37.                  System.out.println(logFile);   
38.                  props.setProperty( "log4j.appender.A1.File" , logFile);   
39.                  PropertyConfigurator.configure(props);  //装入log4j配置信息   
40.              }  catch  (IOException e) {   
41.                  e.printStackTrace();   
42.              }   
43.              log.info( "Initializing, end My Init" );   
44.               super .init(); //应用了struts,此方法不能省，ActionServlet覆盖了的此方法中有很多重要操作   
45.          }   
46. }  

**********************应用web.xml 关键部分***************************  

 程序代码：

 

1. < servlet >   
2.           < servlet-name > action </ servlet-name >   
3.           < servlet-class > wbb.bysxxglxt.util.ExtendedActionServlet </ servlet-class >   
4.           < init-param >   
5.             < param-name > config </ param-name >   
6.             < param-value > /WEB-INF/struts-config.xml </ param-value >   
7.           </ init-param >   
8.           < init-param >   
9.               < param-name > log4j </ param-name >   
10.               < param-value > properties/log4j.properties </ param-value >                        
11.             </ init-param >   
12.           < init-param >   
13.             < param-name > debug </ param-name >   
14.             < param-value > 0 </ param-value >   
15.           </ init-param >   
16.           < init-param >   
17.             < param-name > application </ param-name >   
18.             < param-value > ApplicationResources </ param-value >   
19.           </ init-param >   
20.           < load-on-startup > 0 </ load-on-startup >   
21.   </ servlet >   
22.   < servlet-mapping >   
23.           < servlet-name > action </ servlet-name >   
24.           < url-pattern > *.do </ url-pattern >   
25. </ servlet-mapping >   

注 意log4j参数中相对路径的斜杠线的写法，而且log4j属性文件如放置在web-inf/classes目录或web-inf等目录中最好改名，因为 在加载此Servlet之前，服务器如tomcat启动时会自动搜索web-inf目录和web-inf/classes目录中 log4j.properties文件，如有则自动加载。log4j属性文件加载后,由于该属性文件中log4j.appender.A1.File的值 用的是相对路径，自动加载配置便会出错：
log4j:ERROR setFile(null,true) call failed.
java.io.FileNotFoundException: WEB-INF/logs/bysxxglxt.log (系统找不到指定的路径。)
不知道log4j为什么会这么早自动启动。尽管后面加载扩展的ActionServlet中正确设置了log4j属性文件并正常加载了，但报的这个错还是怪不爽的，于是只有更改log4j属性文件名字或者更改其存放位置，让其不能自动加载了，不过还是有两个警告：
log4j:WARN No appenders could be found for logger (org.apache.commons.digester.Digester.sax).
log4j:WARN Please initialize the log4j system properly.
这样做就算是掩耳盗铃了，如果你有更好的解决办法，希望能在此贴出来，大家一起研究。

********************log4j.properties*****************************
### 设置logger级别 ###

 程序代码

log4j.rootLogger=DEBUG,stdout,A1

### appender.stdout输出到控制台 ###
log4j.appender.stdout=org.apache.log4j.ConsoleAppender
log4j.appender.stdout.Target=System.out
log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
log4j.appender.stdout.layout.ConversionPattern= [%5p] [BYSXXGLXT] %d{yyyy-MM-dd HH:mm:ss}: %-4r [%-5p] [%t] ( %F,%L ) - %m%n

### appender.A1输出到日志文件 ###
log4j.appender.A1=org.apache.log4j.DailyRollingFileAppender
log4j.appender.A1.File=WEB-INF//logs//bysxxglxt.log
##注意上面日志文件相对应用根目录路径的写法
log4j.appender.A1.DatePattern='.'yyyy-MM-dd'.log'
log4j.appender.A1.Append=true
## 输出DEBUG级别以上的日志
log4j.appender.A1.Threshold=DEBUG
log4j.appender.A1.layout=org.apache.log4j.PatternLayout
log4j.appender.A1.layout.ConversionPattern= [%5p] [BYSXXGLXT] %d{yyyy-MM-dd HH:mm:ss}: %-4r     [%t] ( %F,%L ) - %m%n