Log4j使用详解

    blog迁移至: http://www.micmiu.com

文中给出的配置输出文件、邮件、数据库等均自己测试成功
Log4j是Apache的一个开放源代码项目，通过使用Log4j，我们可以控制日志信息输送的目的地；也可以控制每一条日志的输出格式；通过定义每一条日志信息的级别，我们能够更加细致地控制日志的生成过程。所有的这些可以通过一个配置文件来灵活地进行配置，而不需要修改应用的代码。
官网： http://logging.apache.org/log4j/index.html
目前项目中推荐使用的1.2.x版本，截止2010/12/29的1.2.x的最新版本为1.2.16
本文主要介绍log4j的基本配置语法、代码中加载配置文件、实战配置详解
【一】：配置介绍
   log4j.propreties一般需要配置下面三方面：

• 配置rootLogger：级别和目的地
• 输出目的地：控制台、文件、邮件等等
• 定义输出样式

（1）配置rootLogger
   其语法为：log4j.rootLogger = [ level ] , appenderName, appenderName, ...
level 是日志记录的级别

• Level：OFF、FATAL、ERROR、WARN、INFO、DEBUG、TRACE、ALL或自定义
• 一般推荐使用的是：ERROR、WARN、INFO、DEBUG
• 优先级关系：FATAL>ERROR>WARN>INFO>DEBUG
• DEBUG：显示 ERROR、WARN、INFO、DEBUGE
• INFO：显示 ERROR、WARN、INFO
• WARN：显示 ERROR、WARN
• ERROR：显示 ERROR

appenderName ：是指定日志信息输出目的地，可以多个以逗号“，”隔开
范例：log4j.rootLogger=INFO,CONSOLE,A1,A2
根日志级别为INFO，DEBUG信息将被屏蔽，ERROR、WARN、INFO的信息将被输出
三个输出目的地：CONSOLE、A1、A2
（2）.Appender 支撑的输出目的地

• org.apache.log4j.ConsoleAppender 控制台
• org.apache.log4j.FileAppender 文件
• org.apache.log4j.DailyRollingFileAppender 每天产生一个日志文件
• org.apache.log4j.RollingFileAppender 固定文件大小，到达指定大小时产生一个新的文件
• org.apache.log4j.WriterAppender 将日志信息以流格式发送到指定的地方
• org.apache.log4j.net.SMTPAppender 邮件
• org.apache.log4j.jdbc.JDBCAppender 数据库
• 其他如：GUI组件、甚至是套接口服务器、NT的事件记录器、UNIX Syslog守护进程等

（3）.Layout 输出样式定义
   支持的输出端layout类型：

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

   ConversionPattern 格式定义的介绍：
doc地址： http://logging.apache.org/log4j/1.2/apidocs/index.html

• %c 输出日志所属的类的全名，比如类名：“alpha.beta.gamma”，%c{2}=alpha.beta，%c{-2}=gamma，%c{1.}=a.b.gamma
• %d 输出日志时间点，默认格式为ISO8601,也可以指定格式，比如：%d{yyyy-MM-dd HH:mm:ss }，输出为：2010-12-29 13:10:29
• %f 输出日志信息所属的类的类名
• %l 输出日志事件的发生位置，包括类目名、发生的线程，以及在代码中的行数
• %m 输出代码中指定的信息，如log(message)中的message
• %n 输出一个回车换行符，Windows平台为“\r\n”，Unix平台为“\n”
• %p 输出优先级，即DEBUG，INFO，WARN，ERROR，FATAL。如果是调用info()输出的，则为INFO
• %r 输出自应用启动到输出该日志信息所耗费的毫秒数
• %t 输出产生该日志事件的线程名

【二】：代码中加载配置文件
在代码中一般的加载配置文件的方法如下：

        // 使用缺省Log4j环境。
        BasicConfigurator.configure();
        // 绝对路径配置文件
        PropertyConfigurator
                .configure("D:\\huaxia\\log4j_demo\\src\\resources\\log4j.properties");
        // 项目相对路径配置文件
        PropertyConfigurator.configure(".\\src\\resources\\log4j.properties");

        // 读取项目classpath跟目录下配置文件
        PropertyConfigurator.configure(Log4jCfg.class
                .getResource("/log4j.properties"));
       // 读取当前类class同目录下配置文件
        PropertyConfigurator.configure(Log4jCfg.class
                .getResource("log4j.properties"));
        PropertyConfigurator.configure(Log4jCfg.class
                .getResource("./log4j.properties"));
        // 读取某个对应的package下的配置文件
        PropertyConfigurator.configure(Log4jCfg.class
                .getResource("/com/log4j/log4j.properties"));
        // 读取XML形式的配置文件。
        DOMConfigurator.configure(".\\src\\resources\\log4j.xml");

【三】：配置实例详解
  基础测试代码：HelloLog4j.java

package com.log4j;

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

/**
 * @author Michael
 * 
 */
public class HelloLog4j {

    private static final Logger logger = Logger.getLogger(HelloLog4j.class);

    /**
     * @param args
     */
    public static void main(String[] args) {

        // 项目相对路径配置文件
        PropertyConfigurator.configure(".\\src\\resources\\log4j.properties");

        // debug 级别的信息
        logger.debug("Test logger [ DEBUG ] message");

        // info 级别的信息
        logger.info("Test logger [ INFO ] message");

        // warn 级别的信息
        logger.warn("Test logger [ WARN  ] message");

        // error 级别的信息
        logger.error("Test logger [ ERROR ] message");
    }
}

properties的几种配置文件如下
#1 输出到控制台

log4j.rootLogger=DEBUG,console
log4j.appender.console=org.apache.log4j.ConsoleAppender
log4j.appender.console.layout=org.apache.log4j.PatternLayout
log4j.appender.console.layout.ConversionPattern=%5p | %c-%M [%d{yyyy-MM-dd HH:mm:ss}] - %m%n

输出结果：

DEBUG | com.log4j.HelloLog4j-main [2010-12-29 13:51:40] - Test logger [ DEBUG ] message
 INFO | com.log4j.HelloLog4j-main [2010-12-29 13:51:40] - Test logger [ INFO  ] message
 WARN | com.log4j.HelloLog4j-main [2010-12-29 13:51:40] - Test logger [ WARN  ] message
ERROR | com.log4j.HelloLog4j-main [2010-12-29 13:51:40] - Test logger [ ERROR ] message

#2 输出控制台、文件

#输出控制台、文件
log4j.rootLogger=DEBUG,console,A_FILE
#控制台配置
log4j.appender.console=org.apache.log4j.ConsoleAppender
log4j.appender.console.layout=org.apache.log4j.PatternLayout
log4j.appender.console.layout.ConversionPattern=%5p | %c{1}-%M [%d{yyyy-MM-dd HH:mm:ss}] - %m%n
#文件配置
log4j.appender.A_FILE=org.apache.log4j.FileAppender
log4j.appender.A_FILE.File=logs/a_file.log
log4j.appender.A_FILE.Append=true
log4j.appender.A_FILE.layout=org.apache.log4j.PatternLayout
log4j.appender.A_FILE.layout.ConversionPattern=%5p | %c{1}-%M [%d{yyyy-MM-dd HH:mm:ss}] - %m%n

#3 输出HTML文件

log4j.rootLogger=DEBUG,A_FILE_HTML
log4j.appender.A_FILE_HTML=org.apache.log4j.FileAppender
log4j.appender.A_FILE_HTML.File=logs/a_file.html
log4j.appender.A_FILE_HTML.Append=true
log4j.appender.A_FILE_HTML.layout=org.apache.log4j.HTMLLayout

#4 输出每天一个文件

log4j.rootLogger=INFO,A_FILE_D
log4j.appender.A_FILE_D=org.apache.log4j.DailyRollingFileAppender
log4j.appender.A_FILE_D.File=logs/a_file_day.log
log4j.appender.A_FILE_D.Append=true
log4j.appender.A_FILE_D.layout=org.apache.log4j.PatternLayout
log4j.appender.A_FILE_D.layout.ConversionPattern=%5p | %c{1}-%M [%d{yyyy-MM-dd HH:mm:ss}] - %m%n

#5 输出指定大小的文件

log4j.rootLogger=INFO,A_FILE_R
log4j.appender.A_FILE_R=org.apache.log4j.RollingFileAppender 
log4j.appender.A_FILE_R.File=logs/a_file_r.log 
log4j.appender.A_FILE_R.MaxFileSize=100KB 
log4j.appender.A_FILE_R.MaxBackupIndex=10 
log4j.appender.A_FILE_R.layout=org.apache.log4j.PatternLayout 
log4j.appender.A_FILE_R.layout.ConversionPattern=%5p | %c{1}-%M [%d{yyyy-MM-dd HH:mm:ss}] - %m%n

#6 输出到指定的mail

log4j.rootLogger=DEBUG,A_MAIL
log4j.appender.A_MAIL=org.apache.log4j.net.SMTPAppender
log4j.appender.A_MAIL.Threshold=ERROR
log4j.appender.A_MAIL.BufferSize=1
log4j.appender.A_MAIL.Subject=Log4J Message
[email protected]
[email protected]
log4j.appender.A_MAIL.SMTPDebug=false
log4j.appender.A_MAIL.SMTPHost=smtp.163.com
[email protected]
log4j.appender.A_MAIL.SMTPPassword=xxx
log4j.appender.A_MAIL.layout=org.apache.log4j.HTMLLayout

ps：gmail邮箱需要自己写SMTPAppender
#7 输出到指定的数据库
log4j.rootLogger=DEBUG,A_DB
log4j.appender.A_DB=org.apache.log4j.jdbc.JDBCAppender
log4j.appender.A_DB.BufferSize=1
log4j.appender.A_DB.URL=jdbc:mysql://localhost:3306/test
log4j.appender.A_DB.driver=com.mysql.jdbc.Driver
log4j.appender.A_DB.user=root
log4j.appender.A_DB.password=
log4j.appender.A_DB.sql=INSERT INTO LOG4J_INFO(LOG_TIME, THREAD, LOG_LEVEL, CLASS, MESSAGE) VALUES ('%d{yyyy-MM-dd HH:mm:ss}', '%t', '%p', '%l', '%m')
log4j.appender.A_DB.layout=org.apache.log4j.PatternLayout
log4j.appender.A_DB.layout.ConversionPattern=%5p | %c{1}-%M [%d{yyyy-MM-dd HH:mm:ss}] - %m%n

以上所有配置均在通过了自己的实际测试。

---------------------------------------------------------------------------------