優(yōu)秀是一種習(xí)慣

log4j中配置日志文件相對(duì)路徑方法

提醒：本文并不是本人的原創(chuàng)，轉(zhuǎn)載自 http://www.zxbc.cn/html/20080402/33022_4.html ，將原文中的代碼和讀取來(lái)別扭的語(yǔ)句略作修改以使讀者更容易理解作者的意思，在此感謝本文的原作者。

解決的辦法自然是用相對(duì)路徑代替絕對(duì)路徑，有如下三種方法：

方法一、 讓 log4j 從 System 中讀取對(duì)應(yīng)的 property 屬性值
其實(shí) log4j 的 FileAppender 本身就有這樣的機(jī)制，如：log4j.appender.logfile.File=${WORKDIR}/logs/app.log
其中 "${WORKDIR}" 表示引用了一個(gè)變量 WORKDIR，這個(gè)表達(dá)式會(huì)被 System Property 中的 "WORKDIR" 的值代替。這樣，我們就可以在 log4j 加載配置文件之前，先用 System.setProperty ("WORKDIR", WORKDIR);設(shè)置好根路徑，此操作可通過(guò)一初始的servlet進(jìn)行。

方法二、可以使用服務(wù)器環(huán)境變量
log4j 的配置文件支持服務(wù)器的 vm 的環(huán)境變量，格式類(lèi)似${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 系統(tǒng)的環(huán)境變量，這個(gè)環(huán)境變量就不需要在 Windows 系統(tǒng)的環(huán)境變量中設(shè)置。之所以這樣，你可以看看tomcat\\bin\\catalina.bat(startup, shutdown都是調(diào)用這個(gè))里面自帶有 -Dcatalina.home="%CATALINA_HOME%"。繼承這個(gè)思想，所以你也可以自己設(shè)定一個(gè)參數(shù) -Dmylog.home="D:/abc/log" 到對(duì)應(yīng)的服務(wù)器 java 啟動(dòng)的 vm 參數(shù)中

方法三、通過(guò) servlet 初始化 init() 方法中加載 file 屬性實(shí)現(xiàn)相對(duì)路徑
具體實(shí)現(xiàn)：編寫(xiě)一個(gè) servlet, 在系統(tǒng)加載的時(shí)候, 就把 properties 的文件讀到一個(gè) properties 文件中。那個(gè) file 的屬性值(我使用的是相對(duì)目錄)改掉(前面加上系統(tǒng)的根目錄)，然后把這個(gè) properties 對(duì)象設(shè)置到 propertyConfig 中去，這樣就初始化了 log 的設(shè)置。在后面的使用中就用不著再配置了。
一般在我們開(kāi)發(fā)項(xiàng)目過(guò)程中，log4j 日志輸出路徑固定到某個(gè)文件夾，這樣如果我換一個(gè)環(huán)境，日志路徑又需要重新修改，比較不方便，目前我采用了動(dòng)態(tài)改變?nèi)罩韭窂降姆椒▉?lái)實(shí)現(xiàn)相對(duì)路徑保存日志文件
(1)  在項(xiàng)目啟動(dòng)時(shí),裝入初始化類(lèi):

Log4jInit 類(lèi)源代碼
 1public 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");//設(shè)置路徑
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}

實(shí)際上 log4j 的配置文件如果為默認(rèn)名稱(chēng): log4j.properties，則可放置在 JVM 能讀到的 classpath 里的任意地方，一般是放在 WEB-INF/classes 目錄下。當(dāng)log4j 的配置文件不再是默認(rèn)名稱(chēng)，則需要另外加載并給出參數(shù)，如上 "PropertyConfigurator.configure(props);//裝入log4j配置信息"。

(2)  web.xml 中的配置

web.xml 中相關(guān)配置
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 設(shè)為 0 ，以便在 Web 容器啟動(dòng)時(shí)即裝入該 Servlet 。log4j.properties 文件放在根的properties子目錄中，也可以把它放在其它目錄中。應(yīng)該把 .properties 文件集中存放，這樣方便管理。

(3)  log4j.properties 中即可配置 log4j.appender.file.File 為當(dāng)前應(yīng)用的相對(duì)路徑

以上是網(wǎng)上 log4j 日志文件相對(duì)路徑配置的三種方法（我能找到的就三種），分析：

方法一主要是擴(kuò)展了 log4j 的 RollingFileAppender 類(lèi)，其他的 FileAppender 同樣道理。擴(kuò)展的方法，就是用一個(gè)子類(lèi)去覆蓋 setFile 方法，這個(gè)方法在 log4j讀取配置文件生成 appender 的時(shí)候調(diào)用，傳入的就是配置文件中的路徑，這樣我就可以按照自己的想法在路徑前面加上根路徑了。這種方法可以 log4j.properties中用相對(duì)路徑自由配置 log4j.appender.A1.File 屬性來(lái)決定生成的日志文件相對(duì) web 應(yīng)用根目錄的位置。

方法二是利用服務(wù)器 vm 中已經(jīng)存在的環(huán)境變量如 ${catalina.home} 來(lái)設(shè)置相對(duì)于 ${catalina.home} 的日志路徑，日志只能放到服務(wù)器子目錄里，而且如果用的是其它服務(wù)器，則要改對(duì)應(yīng)的環(huán)境變量。此方法平臺(tái)移植不方便。

方法三是擴(kuò)展 ActionServlet 類(lèi)，覆蓋其 init() 方法，新方法中載入 log4j.properties 位置的參數(shù)，可以自由配置 log4j 的配置文件的名字和存放位置。也可自由配置 log4j 日志文件的相對(duì)于當(dāng)前應(yīng)用的路徑。詳細(xì)代碼如下：

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"); //設(shè)置路徑]
                 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(); //應(yīng)用了struts,此方法不能省，ActionServlet覆蓋了的此方法中有很多重要操作 
         } 
}

web.xml 相關(guān)配置：

web.xml 中相關(guān)配置
 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 參數(shù)中相對(duì)路徑的斜杠線的寫(xiě)法，而且 log4j 的配置文件如果放置在 WEB-INF/classes 目錄或 WEB-INF 等目錄中最好改名，因?yàn)樵诩虞d此 Servlet之前，服務(wù)器如tomcat 啟動(dòng)時(shí)會(huì)自動(dòng)搜索 WEB-INF 目錄和 WEB-INF/classes 目錄中的 log4j.properties 文件，如有則自動(dòng)加載。log4j 屬性文件(即配置文件)加載后，由于該屬性文件中 log4j.appender.A1.File 的值用的是相對(duì)路徑，自動(dòng)加載配置便會(huì)出錯(cuò)：
log4j:ERROR setFile(null,true) call failed.
java.io.FileNotFoundException: WEB-INF\\logs\\bysxxglxt.log (系統(tǒng)找不到指定的路徑。)
不知道 log4j 為什么會(huì)這么早自動(dòng)啟動(dòng)。盡管后面加載的 ExtendedActionServlet 中正確設(shè)置了 log4j 屬性文件并正常加載了，但報(bào)的這個(gè)錯(cuò)還是怪不爽的，于是只有更改 log4j 屬性文件名字或者更改其存放位置，讓其不能自動(dòng)加載了，不過(guò)還是有兩個(gè)警告：
log4j:WARN No appenders could be found for logger (org.apache.commons.digester.Digester.sax). 
log4j:WARN Please initialize the log4j system properly.
這樣做就算是掩耳盜鈴了，如果你有更好的解決辦法，希望能在此貼出來(lái)，大家一起研究。

log4j.properties 文件的內(nèi)容：

Code
### 設(shè)置logger級(jí)別 ###
log4j.rootLogger=DEBUG,stdout,A1 

### appender.stdout輸出到控制臺(tái) ###
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 
##注意上面日志文件相對(duì)應(yīng)用根目錄路徑的寫(xiě)法 
log4j.appender.A1.DatePattern=’.’yyyy-MM-dd’.log’ 
log4j.appender.A1.Append=true 
## 輸出DEBUG級(jí)別以上的日志 
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

posted on 2009-08-10 11:57 黃土高坡 閱讀(1945) 評(píng)論(2)  編輯  收藏