log4j的完全使用详解

一. Log4J的功能详细使用

 

参考:http://blog.youkuaiyun.com/seraph5186/archive/2009/02/05/3863726.aspx

 

 

二. Log4j的配置文件和Log4j的Jar文离

 

默认, Log4j jar会读当前目录下的log4j.properties文件, 但如果想把log4j.properties文件脱离jar的当前目录, 这个时候Jar 文件无法在默认情况下读取log4j.properties. 通过测试发现, ANT会先查找LIBPATH和CLASSPATH环境变量所指定的路径下的JAR文件. 所以把Log4j.properties所在的目录指定到任一个LIBPATH和CLASSPATH中, Log4j就会读取log4j.properties文件. PS: UNIX和windows下测试成功

 

另一种可选方案是设置两个-lib在ANT的命令行上, 一个指向log4j Jar文件, 一个指向log4j.properties.

 

分析: ANT, Log4j会通过环境变量LIBPATH和CLASSPATH或者-lib参数的指定把JAR文件和配置文件集中在一起.

 

三. Log4j日志文件的相对路径使用

 

 

默认情况下, Log4J中的配置文件是无法直接识别变量的. 必须通过另外的辅助方案来设置.

方法一、 通过Servlet的System.setProperty方法来设置

log4j的FileAppender本身就有这样的机制,就是用相对路径代替绝对路径,比如：log4j.appender.logfile.File=${WORKDIR}/logs/app.log
其中“${WORKDIR}/”是个变量，会被System Property中的“WORKDIR”的值代替。这样，我们就可以在log4j加载配置文件之前，先用System.setProperty ("WORKDIR", WORKDIR);设置好根路径.

方法二、通过Tomcat使用服务器环境变量
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).在项目启动时,装入初始化类:
public class Log4jInit extends HttpServlet {
         static Logger logger = Logger.getLogger(Log4jInit.class);
         public Log4jInit() {
         }

         public void init(ServletConfig config) throws ServletException {
             String prefix = config.getServletContext().getRealPath("/");
             String file = config.getInitParameter("log4j");
             String filePath = prefix + file;
             Properties props = new Properties();
             try {
                 FileInputStream istream = new FileInputStream(filePath);
                 props.load(istream);
                 istream.close();
                 //toPrint(props.getProperty("log4j.appender.file.File"));
                 String logFile = prefix + props.getProperty("log4j.appender.file.File");//设置路径
                 props.setProperty("log4j.appender.file.File",logFile);
                 PropertyConfigurator.configure(props);//装入log4j配置信息
             } catch (IOException e) {
                 toPrint("Could not read configuration file [" + filePath + "].");
                 toPrint("Ignoring configuration file [" + filePath + "].");
                 return;
             }
         }

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

(2).Web.xml中的配置
<servlet>
         <servlet-name>log4j-init</servlet-name>
         <servlet-class>Log4jInit</servlet-class>
         <init-param>
           <param-name>log4j</param-name>
           <param-value>WEB-INF/classes/log4j.properties</param-value>
         </init-param>
         <load-on-startup>1</load-on-startup>
       </servlet>

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

分析：

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

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

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

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 关键部分***************************

      

<servlet>
         <servlet-name>action</servlet-name>
         <servlet-class>wbb.bysxxglxt.util.ExtendedActionServlet</servlet-class>
         <init-param>
           <param-name>config</param-name>
           <param-value>/WEB-INF/struts-config.xml</param-value>
         </init-param>
         <init-param>
             <param-name>log4j</param-name>
             <param-value>properties/log4j.properties</param-value>                    
           </init-param>
         <init-param>
           <param-name>debug</param-name>
           <param-value>0</param-value>
         </init-param>
         <init-param>
           <param-name>application</param-name>
           <param-value>ApplicationResources</param-value>
         </init-param>
         <load-on-startup>0</load-on-startup>
       </servlet>
       <servlet-mapping>
         <servlet-name>action</servlet-name>
         <url-pattern>*.do</url-pattern>
       </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

 

 

 

以上方案都是建立在项目集成环境中完成的. 当脱里这些环境时, 这些方案都不可取. 比如没有任何JAVA,IDE或者服务器存在,但是基于ANT和脚本的纯脚本环境. 以上方案都不可取. 此时可以试着用下面两种方案:

 

 

方法四、修改Log4j JAR文件

 

 

log4j 是一个非常好用的 log 库。在实际的应用过程中，我会用到 FileAppender 把 log 信息写到文件中。通过 log4j.properties 可以配置 log 文件的路径。为了避免在布署时修改 log4j.properties ，我希望可以把 log 文件的路径写到 环境变量中。遗憾的是 log4j 不支持从环境变量中读取变量值。因此我修改了 log4j 的部分源码，实现了这个功能。

 

我是在 1.2.11 版的 log4j 上进行修改的，在 http://logging.apache.org/site/binindex.cgi 

下载 logging-log4j-1.2.11

 

对源码进行浏览后,估计需要修改的文件应该是

src/java/org/apache/log4j/helpers/OptionConverter.java

在这个文件可以看到, log4j 对 ${} 这种形式的变量会进行以下转换（下面是代码片段）

 

// first try in System properties      String replacement = getSystemProperty(key, null);      // then try props parameter      if(replacement == null && props != null) {      replacement = props.getProperty(key);      }

 

就是说,会先从系统变量中读取属性值,如果系统变量不存在这个属性,就从log4j配置文件中属性中读取.

问题就在这里了!

并没有从环境变量中读取,因此,我增加了一个函数:

 

public static String getEnvProperty(String key, String def) {     try {         String value = System.getenv(key);         if (value == null)         {             value = def;         }       return value;     } catch(Throwable e) { // MS-Java throws com.ms.security.SecurityExceptionEx       LogLog.debug("Was not allowed to read system property /""+key+"/".");       return def;     }   }

 

是的,通过调用 System.getenv() ,就可以从环境变量中读取属性值了.

再修改上面的第一个代码片段，改为

 

// first try in System properties      String replacement = getSystemProperty(key, null);      // then try in environment properties      if (replacement == null)      {          replacement = getEnvProperty(key, null);      }      // then try props parameter      if(replacement == null && props != null) {      replacement = props.getProperty(key);      }

 

ok, 代码修改工作完毕, 现在需要编译了.

在 logging-log4j-1.2.11 目录下输入
ant

会提示要加参数,所以改为输入
ant build

编译通过,但发现有其它问题,不过不要紧了,已经有这个文件就可以了
logging-log4j-1.2.11/dist/classes/org/apache/log4j/helpers/OptionConverter.class

要正常生成 jar 文件,可能需要其它库文件支持,但不是我研究的方向了.
我只要把这个 OptionConverter.class 放到 log4j-1.2.11.jar 文件里, 替换掉旧的 OptionConverter.class 就可以了.

howto? easy job. 用 winrar 打开 log4j-1.2.11.jar, 用新的 OptionConverter.class 覆盖掉旧的, done!

最后一步, 把这个新的log4j-1.2.11.jar 拷贝到你的系统中,就可以了.

或者改一个名字? log4j-1.2.11-pro.jar ? 增强版~ 咔咔, well done!

最后，看一下 log4j.properties 中怎么用环境变量

 

log4j.appender.demo=org.apache.log4j.DailyRollingFileAppender log4j.appender.demo.File=${MY_PROJECT_HOME}/logs/demo.log log4j.appender.demo.DatePattern='.'yyyyMMdd log4j.appender.demo.layout=org.apache.log4j.PatternLayout log4j.appender.demo.layout.ConversionPattern=%-d{yyyy-MM-dd HH:mm:ss} [%c] : %L - %n%m%n%n

 

蓝色粗体字部分就是环境变量了，因此只需要定义一个名为 MY_PROJECT_HOME 的环境变量，就可以把 log 文件输出到指定的目录下，而不需要修改 log4j.properties 了。

 

 

方法五、利用ANT选项功能和VM读取系统环境变量

 

到目前为止, 个人觉得此方案是最佳方案, 它不需要借助任何辅助和修改任何文件.

ANT可以识别ANT_OPTS环境变量, 从而带参数进ANT中. 通过设置

set ANT_OPTS=-DANT_Log_File_Home=C:/ANT_LOG

然后在log4j.properties中设置

 

log4j.appender.demo=org.apache.log4j.DailyRollingFileAppender log4j.appender.demo.File=${ANT_Log_File_Home}/logs/demo.log log4j.appender.demo.DatePattern='.'yyyyMMdd log4j.appender.demo.layout=org.apache.log4j.PatternLayout log4j.appender.demo.layout.ConversionPattern=%-d{yyyy-MM-dd HH:mm:ss} [%c] : %L - %n%m%n%n

 

通过此方法设置, log4j.properties能够读取变量ANT_LOG_FILE_HOME值. 此方案在UNIX和Windows中都测试成功.