log4j配置笔记

log4j的作用:    
        在应用程序中添加日志记录总的来说基于三个目的：监视代码中变量的变化情况，周期性的记录到文件中供其他应用进行统计分析工作；跟踪代码运行时轨迹，作为日后审计的依据；担当集成开发环境中的调试器的作用，向文件或控制台打印代码的调试信息。

log4j的官方网址：http://logging.apache.org/log4j/docs/
 Log4j基本使用方法 
1.定义配置文件 

其实您也可以完全不使用配置文件，而是在代码中配置Log4j环境。但是，使用配置文件将使您的应用程序更加灵活。

Log4j支持两种配置文件格式，一种是XML格式的文件，一种是Java特性文件（键=值）。下面我们介绍使用Java特性文件做为配置文件的方法：

1. 配置根Logger，其语法为：
   

   log4j.rootLogger = [ level ] , appenderName, appenderName, …

   其中，level 是日志记录的优先级，分为OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL或者您定义的级别。Log4j建议只使用四个级别，优先级从高到低分别是ERROR、WARN、INFO、DEBUG。通过在这里定义的级别，您可以控制到应用程序中相应级别的日志信息的开关。比如在这里定义了INFO级别，则应用程序中所有DEBUG级别的日志信息将不被打印出来。
   appenderName就是指定日志信息输出到哪个地方。您可以同时指定多个输出目的地。
   -------
2. 配置非根logger,其语法为:
      log4j.logger.classpath=[ level ] , appenderName, appenderName, …
      其中,classpath是log4j能够作用到的类路径. 如果希望子的信息不再父中出现，可用additivity 参数。如 log4j.additivity.com.microsoft=false
   
3. 配置日志信息输出目的地Appender，其语法为
   

   log4j.appender.appenderName = fully.qualified.name.of.appender.class
   log4j.appender.appenderName.option1 = value1
   …
   log4j.appender.appenderName.option = valueN

   其中，Log4j提供的appender有以下几种：
   org.apache.log4j.ConsoleAppender（控制台），
   org.apache.log4j.FileAppender（文件），
   org.apache.log4j.DailyRollingFileAppender（每天产生一个日志文件），org.apache.log4j.RollingFileAppender（文件大小到达指定尺寸的时候产生一个新的文件），
   org.apache.log4j.WriterAppender（将日志信息以流格式发送到任意指定的地方）
   
4. 配置日志信息的格式（布局），其语法为：
   

   log4j.appender.appenderName.layout = fully.qualified.name.of.layout.class
   log4j.appender.appenderName.layout.option1 = value1
   …
   log4j.appender.appenderName.layout.option = valueN

   其中，Log4j提供的layout有以下几种：
   org.apache.log4j.HTMLLayout（以HTML表格形式布局），
   org.apache.log4j.PatternLayout（可以灵活地指定布局模式），
   org.apache.log4j.SimpleLayout（包含日志信息的级别和信息字符串），
   org.apache.log4j.TTCCLayout（包含日志产生的时间、线程、类别等等信息）

2.在代码中使用Log4j

 下面将讲述在程序代码中怎样使用Log4j。 
1.得到记录器 

使用Log4j，第一步就是获取日志记录器，这个记录器将负责控制日志信息。其语法为：

public static Logger getLogger( String name)，

通过指定的名字获得记录器，如果必要的话，则为这个名字创建一个新的记录器。Name一般取本类的名字，比如：

static Logger logger = Logger.getLogger ( ServerWithLog4j.class.getName () ) ;

 
  2.读取配置文件 

 
  当获得了日志记录器之后，第二步将配置Log4j环境，其语法为：
BasicConfigurator.configure ()： 自动快速地使用缺省Log4j环境。
PropertyConfigurator.configure ( String configFilename) ：读取使用Java的特性文件编写的配置文件。
DOMConfigurator.configure ( String filename ) ：读取XML形式的配置文件。 

 
  3.插入记录信息（格式化日志信息） 

 
  
当上两个必要步骤执行完毕，您就可以轻松地使用不同优先级别的日志记录语句插入到您想记录日志的任何地方，其语法如下：
Logger.debug ( Object message ) ;
Logger.info ( Object message ) ;
Logger.warn ( Object message ) ;
Logger.error ( Object message ) ;
log4j应用实例
先从asf(apache source forge)上下载包
地址为：http://logging.apache.org/log4j/docs/download.html
把dist目录下的log4j-1.2.9.jar放到你的classpath下让jdk加载。
现在先试一下非web程序的调用。
import org.apache.log4j.*;
public class Hello{
static Logger logger = Logger.getLogger(Hello.class);
public static void main(String[] args) {
int i,j;//BasicConfigurator.configure();
PropertyConfigurator.configure(args[0]);
logger.info("Entering application.");
for(i=1;i<10;i++){ 
logger.debug(""+i); 
for (j=1;j<=i;j++){ 
logger.warn(""+j); 
System.out.print(i*j); 
System.out.print("/t");
}
System.out.println("");
} 
logger.info("Exiting application.");
}
}
这个程序需要一个参数（arg[0]）,创建它的配置文件取名log4j.inf
参考如下：
log4j.rootLogger=WARN, stdout, R
log4j.appender.stdout=org.apache.log4j.ConsoleAppender
log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
log4j.appender.stdout.layout.ConversionPattern=%d [%t] %-5p %c - %m%n
log4j.appender.R=org.apache.log4j.RollingFileAppender
log4j.appender.R.File=${user.dir}example.log
log4j.appender.R.MaxFileSize=100KB
log4j.appender.R.MaxBackupIndex=1
log4j.appender.R.layout=org.apache.log4j.PatternLayout
log4j.appender.R.layout.ConversionPattern=%p %t %c - %m%n
log4j.logger.com.foo=WARN
现在运行java Hello log4j.inf
然后看看有没有一个example.log，ok,试验成功。
然后来看web的调用。由于log需要在整个应用程序中记录日至。因此它需要在项目加载时启动，具体内容

是加载它的配置参数。
首先编写一个servlet，让他在项目加载时加载，解析log4j.properties.
参考如下：
package com.mdcl.log4j;
import org.apache.log4j.*;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
public class Log4jInit extends HttpServlet {
public void init() {
String prefix = getServletContext().getRealPath("/");
String file = getInitParameter("log4j-init-file");
// if the log4j-init-file is not set, then no point in trying
System.out.println("................log4j start");
if(file != null) {
PropertyConfigurator.configure(prefix+file);
}
}
public void doGet(HttpServletRequest req, HttpServletResponse res) {
}
}
log4j.properties参考如下：
log4j.rootLogger=ERROR,R
# log4j.appender.A1=org.apache.log4j.ConsoleAppender 
# log4j.appender.A1.layout=org.apache.log4j.PatternLayout 
# log4j.appender.A1.layout.ConversionPattern=%-d{yyyy-MM-dd HH:mm:ss} [%c]-[%p] %m%n 
log4j.appender.R=org.apache.log4j.RollingFileAppender
log4j.appender.R.File=d:/Tomcat5/webapps/Six/logs/log4j.log
log4j.appender.R.MaxFileSize=100KB
log4j.appender.R.MaxBackupIndex=1
log4j.appender.R.layout=org.apache.log4j.PatternLayout
log4j.appender.R.layout.ConversionPattern=%p %t %c - %m%n

对web.xml作如下修改：

<servlet>
    <servlet-name>log4j-init</servlet-name>
    <servlet-class>com.mdcl.log.Log4jInit</servlet-class>
    <init-param>
      <param-name>log4j-init-file</param-name>
      <param-value>WEB-INF/log4j.properties</param-value>
    </init-param>
    <load-on-startup>1</load-on-startup>
  </servlet>
接下来，就可以在各程序里面跳用它了
在jsp中调用：
<% @page 
import org.apache.log4j.Logger;
%>
<body>
This is my JSP page. <br>
<%
Logger logger = Logger.getLogger("test.jsp");
logger.error("befor say hi");
%>
<h1> Hi</h1>
<%
logger.error("after say hi");
%>
</body>
在servlet中调用：
import org.apache.log4j.Logger;
private static Logger log=Logger.getLogger(servletTest.class);
log.info("........servletTest.doPost()....start");
 
下面是log4j的几个要点:
1.阶层式的命名:
      如果一个logger 的名字后面跟着一个点号（dot），它就是点号（dot）后面的那个logger的前辈（ ancestor），是这个晚辈（descendant） 的前缀。如果在它自己和这个晚辈之间没有其它的前辈，它和这个晚辈之间就是父子关系。
2.级别继承
   对于一个给定的logger C，它继承的级别等于logger阶层里，从C开始往root logger上去的第一个non-null级别。


3.执行规则
   在一个级别为q（被指定的或继承的）的logger里，一个级别为p的日志请求，只有在p >= q 时才能够被执行。

4.appender添加性的规则

  
  

   
   
Logger C的log输出信息将被输出到C的所有appenders和它的前辈的 appenders。这就是"appender additivity"的意思。但是，如果logger C的前辈，比如说P，P的additivity flag被设置为 false，那么，C的输出信息将被输出到C的所有appenders中去，以及它的前辈的——截止在P那里，包括P在内的，appenders中去，但是不会输出到P的前辈的 appenders中去。 默认情况下，Loggers的additivity flag设置为true。
关于日志格式:贴个样例:
   
   
log4j.appender.A1.layout.ConversionPattern=%d %-5p [%t] %-c (%13F:%L) %3x - %m%n
   
   

  
  
更多内容参见http://www.jaxwiki.org/zh/project/logging.apache.org/log4j/docs/manual.html