在java中使用log4j记录日志

原理：
Log4J的配置文件(Configuration File)就是用来设置记录器的级别、存放器和布局的，它可接key=value格式的设置或xml格式的设置信息。通过配置，可以创建出Log4J的运行环境。

步骤：
1. 配置文件
Log4J配置文件的基本格式如下：

#配置根Logger
log4j.rootLogger = [ level ] , appenderName1 , appenderName2 , …

#配置日志信息输出目的地Appender
log4j.appender.appenderName = fully.qualified.name.of.appender.class
　　log4j.appender.appenderName.option1 = value1
　　…
　　log4j.appender.appenderName.optionN = valueN

#配置日志信息的格式（布局）
log4j.appender.appenderName.layout = fully.qualified.name.of.layout.class
　　log4j.appender.appenderName.layout.option1 = value1
　　…
　　log4j.appender.appenderName.layout.optionN = valueN
其中 [level] 是日志输出级别，共有5级：
FATAL 0
ERROR 3
WARN 4
INFO 6
DEBUG 7

Appender 为日志输出目的地，Log4j提供的appender有以下几种：
org.apache.log4j.ConsoleAppender（控制台），
org.apache.log4j.FileAppender（文件），
org.apache.log4j.DailyRollingFileAppender（每天产生一个日志文件），
org.apache.log4j.RollingFileAppender（文件大小到达指定尺寸的时候产生一个新的文件），
org.apache.log4j.WriterAppender（将日志信息以流格式发送到任意指定的地方）
Layout：日志输出格式，Log4j提供的layout有以下几种：
org.apache.log4j.HTMLLayout（以HTML表格形式布局），
org.apache.log4j.PatternLayout（可以灵活地指定布局模式），
org.apache.log4j.SimpleLayout（包含日志信息的级别和信息字符串），
org.apache.log4j.TTCCLayout（包含日志产生的时间、线程、类别等等信息）
打印参数: Log4J采用类似C语言中的printf函数的打印格式格式化日志信息，如下:
　　%m 输出代码中指定的消息
　　%p 输出优先级，即DEBUG，INFO，WARN，ERROR，FATAL
　　%r 输出自应用启动到输出该log信息耗费的毫秒数
　　%c 输出所属的类目，通常就是所在类的全名
　　%t 输出产生该日志事件的线程名
　　%n 输出一个回车换行符，Windows平台为“\r\n”，Unix平台为“\n”
　　%d 输出日志时间点的日期或时间，默认格式为ISO8601，也可以在其后指定格式，比如：%d{yyy MMM dd HH:mm:ss , SSS}，输出类似：2002年10月18日 22 ： 10 ： 28 ， 921
　　%l 输出日志事件的发生位置，包括类目名、发生的线程，以及在代码中的行数。举例：Testlog4.main(TestLog4.java: 10 )
2. 在代码中初始化Logger:
1） 在程序中调用BasicConfigurator.configure()方法：给根记录器增加一个ConsoleAppender，输出格式通过 PatternLayout设为"%-4r [%t] %-5p %c %x - %m%n"，还有根记录器的默认级别是Level.DEBUG.
2）配置放在文件里，通过命令行参数传递文件名字，通过PropertyConfigurator.configure(args[x])解析并配置；
3）配置放在文件里，通过环境变量传递文件名等信息，利用log4j默认的初始化过程解析并配置；
4）配置放在文件里，通过应用服务器配置传递文件名等信息，利用一个特殊的servlet来完成配置。

3. 为不同的 Appender 设置日志输出级别：
当调试系统时，我们往往注意的只是异常级别的日志输出，但是通常所有级别的输出都是放在一个文件里的，如果日志输出的级别是BUG！？那就慢慢去找吧。
这时我们也许会想要是能把异常信息单独输出到一个文件里该多好啊。当然可以，Log4j已经提供了这样的功能，我们只需要在配置中修改Appender的Threshold 就能实现,比如下面的例子：

[配置文件]
### set log levels ###
log4j.rootLogger = debug , stdout , D , E

### 输出到控制台 ###
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 = %d{ABSOLUTE} %5p %c{ 1 }:%L - %m%n

### 输出到日志文件 ###
log4j.appender.D = org.apache.log4j.DailyRollingFileAppender
log4j.appender.D.File = logs/log.log
log4j.appender.D.Append = true
log4j.appender.D.Threshold = DEBUG ## 输出DEBUG级别以上的日志
log4j.appender.D.layout = org.apache.log4j.PatternLayout
log4j.appender.D.layout.ConversionPattern = %-d{yyyy-MM-dd HH:mm:ss} [ %t:%r ] - [ %p ] %m%n

### 保存异常信息到单独文件 ###
log4j.appender.E = org.apache.log4j.DailyRollingFileAppender
log4j.appender.E.File = logs/error.log ## 异常日志文件名
log4j.appender.E.Append = true
log4j.appender.E.Threshold = ERROR ## 只输出ERROR级别以上的日志!!!
log4j.appender.E.layout = org.apache.log4j.PatternLayout
log4j.appender.E.layout.ConversionPattern = %-d{yyyy-MM-dd HH:mm:ss} [ %t:%r ] - [ %p ] %m%n
[代码中使用]
public class TestLog4j {
public static void main(String[] args) {
PropertyConfigurator.configure( " D:/Code/conf/log4j.properties " );
Logger logger = Logger.getLogger(TestLog4j. class );
logger.debug( " debug " );
logger.error( " error " );
}
}
运行一下，看看异常信息是不是保存在了一个单独的文件error.log中。

 

 

log4j在web project中的应用

将log4j-1.2.8.jar放入WEB-INF/lib下，并在eclipse里log4j-1.2.8.jar这个包引入(在左边目录下上右键点击工程目录->属性->java build path->Libraries->add jars.. )

InitServlet的原代码如下：

package  servlets;

import  java.io.IOException;
import  javax.servlet.ServletContext;
import  javax.servlet.ServletException;
import  javax.servlet.http.HttpServlet;
import  javax.servlet.http.HttpServletRequest;
import  javax.servlet.http.HttpServletResponse;

import  org.apache.log4j.Logger;
import  org.apache.log4j.PropertyConfigurator ;     

public   class  InitServlet  extends  HttpServlet {

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

     /**
     * 
      */
     private   static   final   long  serialVersionUID  =   1L ;

     /**
     * Constructor of the object.
      */
     public  InitServlet() {

    }

     /**
     * Destruction of the servlet. <br>
      */
     public   void  destroy() {
         super .destroy();  //  Just puts "destroy" string in log
         //  Put your code here
    }

     /**
     * The doGet method of the servlet. <br>
     *
     * This method is called when a form has its tag value method equals to get.
     * 
     *  @param  request the request send by the client to the server
     *  @param  response the response send by the server to the client
     *  @throws  ServletException if an error occurred
     *  @throws  IOException if an error occurred
      */
     public   void  doGet(HttpServletRequest request, HttpServletResponse response)
             throws  ServletException, IOException {

    }

     /**
     * The doPost method of the servlet. <br>
     *
     * This method is called when a form has its tag value method equals to post.
     * 
     *  @param  request the request send by the client to the server
     *  @param  response the response send by the server to the client
     *  @throws  ServletException if an error occurred
     *  @throws  IOException if an error occurred
      */
     public   void  doPost(HttpServletRequest request, HttpServletResponse response)
             throws  ServletException, IOException {

    }

     /**
     * Initialization of the servlet. <br>
     *
     *  @throws  ServletException if an error occure
      */
     public   void  init()  throws  ServletException {
        ServletContext sct  =  getServletContext();
        String prefix  =  sct.getRealPath( " / " );
        String file  =  getInitParameter( " log4j " );
         if (file != null ){
            PropertyConfigurator.configure(prefix + file);
        }
         else {
            PropertyConfigurator.configure( " c:/log4j.properties " );
        }

        logger.info( " InitServlet初始化完成 " );
    }

}

在web.xml中加入：

  <servlet>
    <servlet-name>InitServlet</servlet-name>
    <servlet-class>com.prl.servlets.InitServlet</servlet-class>
    <init-param>
     <param-name>log4j</param-name>
     <param-value>log4j.properties</param-value>
    </init-param>
    <load-on-startup>1</load-on-startup>
  </servlet>

  <servlet-mapping>
    <servlet-name>InitServlet</servlet-name>
    <url-pattern>/servlet/InitServlet</url-pattern>
  </servlet-mapping>

 使用：

import org.apache.log4j.Logger ; 

在类里面：
static  Logger logger  =  Logger.getLogger(loginservlet. class .getName());

logger.info( " 开始验证 " ); 

 

log4j.properties内容如下：

#log4j.rootLogger = debug ,  stdout ,  R
log4j.rootLogger = debug ,  R

log4j.appender.stdout = org.apache.log4j.ConsoleAppender
log4j.appender.stdout.layout = org.apache.log4j.PatternLayout

# Pattern to output the caller's file name and line number.
log4j.appender.stdout.layout.ConversionPattern = %5p  [ %t ]  (%F:%L) - %m%n
#R Êä³öµ½Îļþ
log4j.appender.R = org.apache.log4j.RollingFileAppender
log4j.appender.R.File = c:/example.log

log4j.appender.R.MaxFileSize = 100KB
# Keep one backup file
log4j.appender.R.MaxBackupIndex = 1

log4j.appender.R.layout = org.apache.log4j.PatternLayout
log4j.appender.R.layout.ConversionPattern = %-d{yyyy-MM-dd HH:mm:ss} %c->%t:%-4r %p - %m%n