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

转载自 http://www.zxbc.cn/html/20080402/33022_4.html  

 

解决的办法自然是用相对路径代替绝对路径，有如下三种方法：

方法一、 让 log4j 从 System 中读取对应的 property 属性值
其实 log4j 的 FileAppender 本身就有这样的机制，如：log4j.appender.logfile.File=${WORKDIR}/logs/app.log
其中 "${WORKDIR}" 表示引用了一个变量 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)  在项目启动时,装入初始化类:

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

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

(2)  web.xml 中的配置

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 日志文件的相对于当前应用的路径。详细代码如下：

Code
package wbb.bysxxglxt.util; 

import org.apache.struts.action. * ; 
import org.apache.commons.logging.LogFactory; 
import org.apache.commons.logging.Log; 
import javax.servlet.ServletException; 
import java.util.Properties; 
import java.io.InputStream; 
import org.apache.log4j.PropertyConfigurator; 
import java.io.FileInputStream; 
import java.io.IOException; 

public   class  ExtendedActionServlet extends ActionServlet {

          private  Log log  =  LogFactory.getLog( this .getClass().getName());

          public  ExtendedActionServlet() {} 

          public   void  init() throws ServletException {
             log.info( " Initializing, My MyActionServlet init this System’s Const Variable " ); 
             String prefix  =   this .getServletConfig().getServletContext().getRealPath( " / " );
             String file  =   this .getServletConfig().getInitParameter( " log4j " ); 
             String filePath  =  prefix  +  file; 
             Properties props  =   new  Properties(); 
             System. out .println(prefix); 
             System. out .println(file); 
             System. out .println(filePath); 

              try  { 
                 FileInputStream log4jStream  =   new  FileInputStream(filePath); 
                 props.load(log4jStream);
                 log4jStream.close(); 
                 String logFile  =  prefix  +  
                                 props.getProperty( " log4j.appender.A1.File " );  // 设置路径]
                 System. out .println(logFile); 
                 props.setProperty( " log4j.appender.A1.File " , logFile);
                 PropertyConfigurator.configure(props);  // 装入log4j配置信息 
             }  catch  (IOException e) { 
                 e.printStackTrace(); 
            } 
             log.info( " Initializing, end My Init " );
             super.init();  // 应用了struts,此方法不能省，ActionServlet覆盖了的此方法中有很多重要操作 
         } 
}

web.xml 相关配置：

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 >  [Page]
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 为什么会这么早自动启动。尽管后面加载的 ExtendedActionServlet 中正确设置了 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 文件的内容：

Code
### 设置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 [Page]
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