Java开发日志分析工具Log4j使用详解

常用的日志控件有commons-logging、Log4j以及JDK1.4自带的Logging。

日志简介：

早期，java开发用System.out.println(),输出到屏幕，但是这种输出不可控制，日志的可读性差，而且输出到屏幕需要消耗资源，大量的IO操作会使程序运行变慢。

JKD1.4自带的Logging，从JDK1.4起，JDK开始自带一套日志系统。JDK Logging最大的优点是不需要任何类库的支持，只要java运行环境就可以运行。但是相对于其他日志控件，JDK自带的控件无论是易用性、功能还是扩展型都不如其他的好用，基本上不适用。

Log4j控件，目前使用最广泛的日志控件，它把日志分为ALL、TRACE、DEBUG、INFO、WARN、ERROR、FITAL、OFF(由低到高)。

ALL 是最低等级的，用于打开所有日志记录。

DEBUG 指出细粒度信息事件对调试应用程序是非常有帮助的。

INFO 表明 消息在粗粒度级别上突出强调应用程序的运行过程。 

WARN 表明会出现潜在错误的情形。

ERROR 指出虽然发生错误事件，但仍然不影响系统的继续运行。

FATAL 指出每个严重的错误事件将会导致应用程序的退出。

OFF 是最高等级的，用于关闭所有日志记录。 

commons-logging控件，是apache commons类库中的一员，Apache类库是一个通用的类库，提供了基础的功能，例如commons-fileupload，commons-httpclient，commons-io，commons-codec等。commons-logging不是一个日志控件，没有日志功能，它只是统一了JDK Logging与Log4j的API，并把日志功能交给JDK Logging或者Log4j。对于不能确定日志方式的系统，commons-logging是个不错的选择。Spring、Hibernate、Struts等都使用的是commons-logging。

第一、Logger.getLogger()和LogFactory.getLog()的区别
    1.Logger.getLogger()是使用log4j的方式记录日志；

    2.LogFactory.getLog()则来自apache的common-logging包。

common-logging组件： 
       Jakarta Commons Logging (JCL)提供的是一个日志(Log)接口(interface)，同时兼顾轻量级和不依赖于具体的日志实现工具。它提供给中间件/日志工具开发者一个简单的日志操作抽象，允许程序开发人员使用不同的具体日志实现工具。了解包里情况，可以查看它的API文档：http://www.oschina.net/uploads/doc/commons-logging-1.1.1/index.html , 其中Log(基本记录器)和LogFactory(负责创建Log实例)是两个基类。该API直接提供对下列底层日志记录工具的支持：Jdk14Logger，Log4JLogger，LogKitLogger，NoOpLogger （直接丢弃所有日志信息），还有一个SimpleLog。 有必要详细说明一下调用LogFactory.getLog()时发生的事情。调用该函数会启动一个发现过程，即找出必需的底层日志记录功能的实现，具体的发现过程在下面列出：  ( 换句话说就是， 有这么多工具，common-logging该使用哪一个呢？这取决于系统的设置，common-logging将按以下顺序决定使用哪个日志记录工具：)

        (1).common-logging首先在CLASSPATH中查找commons-logging.properties文件。这个属性文件至少定义org.apache.commons.logging.Log属性，它的值应该是上述任意Log接口实现的完整限定名称。如果找到 org.apache.commons.logging.Log属相，则使用该属相对应的日志组件。结束发现过程。

        (2).如果上面的步骤失败（文件不存在或属相不存在），common-logging接着检查系统属性org.apache.commons.logging.Log。如果找到org.apache.commons.logging.Log系统属性，则使用该系统属性对应的日志组件。结束发现过程。
        (3).如果找不到org.apache.commons.logging.Log系统属性，common-logging接着在CLASSPATH中寻找log4j的类。如果找到了就假定应用要使用的是log4j。不过这时log4j本身的属性仍要通过log4j.properties文件正确配置。结束发现过程。
        (4).如果上述查找均不能找到适当的Logging API，但应用程序正运行在JRE 1.4或更高版本上，则默认使用JRE 1.4的日志记录功能。结束发现过程。
        (5).最后，如果上述操作都失败（JRE 版本也低于1.4），则应用将使用内建的SimpleLog。SimpleLog把所有日志信息直接输出到System.err。结束发现过程。

        为了简化配置 commons-logging ，一般不使用 commons-logging 的配置文件，也不设置与 commons-logging 相关的系统环境变量，而只需将 Log4j 的 Jar 包放置到 classpash 中就可以了。这样就很简单地完成了 commons-logging 与 Log4j 的融合。

        根据不同的性质，日志信息通常被分成不同的级别，从低到高依次是：“调试（ DEBUG ）”“信息（ INFO ）”“警告（ WARN ）”“错误（ERROR ）”“致命错误（ FATAL ）”。

   举例说明：

   基于common-logging的运行方式：

package org;
import org.apache.commons.logging.Log;
import org.apache.log4j.Logger;
public class Test extends TagSupport{
public static Log log=LogFactory.getLog(Test.class);
public static void test()
{
log.debug("111");
log.info("125");
log.warn("485");
log.error("error");

}
public static void main(String[] a)
{
Test.test();
}
}

   基于log4j的运行方式

import org.apache.log4j.Logger;
import org.apache.log4j.PropertyConfigurator;
public class TestLog4j {


static Logger logger = Logger.getLogger(TestLog4j.class);
   public static void main(String args[]) {
   PropertyConfigurator.configure("log4j.properties");
   logger.debug("Here is some DEBUG");
   logger.info("Here is some INFO");
      logger.warn("Here is some WARN");
      logger.error("Here is some ERROR");
      logger.fatal("Here is some FATAL");
   }
}

第二、详细介绍Log4j

   ① Log4j的架构 
   Log4j系统的三大板块：日志写入器、日志输出终端、日志布局模式

        Logger类是日志包的核心，Logger的名称是大小写敏感的，并且名称之间有继承关系。子名由父名做前缀，用点号“.”分隔，如x.y是x.y.z的父亲Logger。Logger系统中有个根logger，是所有logger的祖先，它总是存在的，并且不可以通过名字获取，可以通过Logger.getRootLogger()来获取。获取Logger对象的方法很多，可以参考API文档，在某对象中，用该对象所属的类作为参数，调用Logger.getLogger(Class clazz)以获取logger对象被认为是目前所知最理智的命名logger方法。

   ②Log4j的日志级别（Level） 
       每个logger都有一个日志级别，用来控制日志的输出。未分配级别的logger将自动继承它最近的父logger的日志级别。Logger的由低到高级别如下： 
     ALL<DEBUG<INFO<WARN<ERROR<FATAL<OFF

   ③Log4j的输出终端（Appender接口） 

       Log4j提供了以下几个实现：

org.apache.log4j.ConsoleAppender(控制台)
org.apache.log4j.FileAppender(文件)
org.apache.log4j.DailyRollingFileAppender(每天都产生一个日志文件)
org.apache.log4j.RollingFileAppender(文件大小达到指定尺寸时产生一个新的日志文件，文件名称上会自动添加数字序号。)
org.apache.log4j.WriterAppender(将日志信息以流的格式发送到任意指定的地方)

 默认情况下，子logger将继承父logger的所有appenders。

    ④Log4j的输出布局模式（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：输出优先级。
%r：输入自应用启动到输出该log信息耗费的毫秒数。
%c：输出所属的类目，通常就是所在类的全名。
%t：输出产生该日志线程的线程名。
%n：输出一个回车换行符。Windows平台为“\r\n”，UNIX为“\n”。
%d：输出日志时间点的日期或时间，默认格式为ISO8601，推荐使用“%d{ABSOLUTE}”，这个输出格式形如：“2007-05-07 18:23:23,500”，符合中国人习惯。
%l：输出日志事件发生的位置，包括类名、线程名，以及所在代码的行数。

   ⑤Log4j的配置

    在实际使用中，Log4j一般是通过配置文件配置使用的。配置文件有两种，Java properties和XML文件。一般都选用properties文件来配置，因为简洁易读。下面只介绍Java properties的配置方式。 
对Log4j的配置就是对rootLogger和子Logger的配置。主要的配置项为：rootLogger、输出终端、输出布局模式，所有的配置项都必须以log4j开头。 
    配置文件的示例

##Log4J的配置之简单使它遍及于越来越多的应用中了

##Log4J配置文件实现了输出到控制台、文件、回滚文件、发送日志邮件、输出到数据库日志表、自定义标签等全套功能。择其一二使用就够用了。

##此文件（log4j.properties）内容来自网络，非本文作者liigo原创。
log4j.rootLogger = DEBUG, CONSOLE,A1
log4j.addivity.org.apache = true

# 应用于控制台
log4j.appender.CONSOLE = org.apache.log4j.ConsoleAppender
log4j.appender.Threshold = DEBUG
log4j.appender.CONSOLE.Target = System.out
log4j.appender.CONSOLE.layout = org.apache.log4j.PatternLayout
log4j.appender.CONSOLE.layout.ConversionPattern = [framework] % d - % c -%- 4r [ % t] %- 5p % c % x - % m % n
#log4j.appender.CONSOLE.layout.ConversionPattern = [start] % d {DATE} [DATE] % n % p[PRIORITY] % n % x[NDC] % n % t[THREAD] n % c[CATEGORY] % n % m[MESSAGE] % n % n

#应用于文件
log4j.appender.FILE = org.apache.log4j.FileAppender
log4j.appender.FILE.File = file.log
log4j.appender.FILE.Append = false
log4j.appender.FILE.layout = org.apache.log4j.PatternLayout
log4j.appender.FILE.layout.ConversionPattern = [framework] % d - % c -%- 4r [ % t] %- 5p % c % x - % m % n
# Use this layout for LogFactor 5 analysis

# 应用于文件回滚
log4j.appender.ROLLING_FILE = org.apache.log4j.RollingFileAppender
log4j.appender.ROLLING_FILE.Threshold = ERROR
log4j.appender.ROLLING_FILE.File = rolling.log
log4j.appender.ROLLING_FILE.Append = true
log4j.appender.ROLLING_FILE.MaxFileSize = 10KB
log4j.appender.ROLLING_FILE.MaxBackupIndex = 1
log4j.appender.ROLLING_FILE.layout = org.apache.log4j.PatternLayout
log4j.appender.ROLLING_FILE.layout.ConversionPattern = [framework] % d - % c -%- 4r [ % t] %- 5p % c % x - % m % n

#应用于socket
log4j.appender.SOCKET = org.apache.log4j.RollingFileAppender
log4j.appender.SOCKET.RemoteHost = localhost
log4j.appender.SOCKET.Port = 5001
log4j.appender.SOCKET.LocationInfo = true
# Set up for Log Facter 5
log4j.appender.SOCKET.layout = org.apache.log4j.PatternLayout
log4j.appender.SOCET.layout.ConversionPattern = [start] % d {DATE} [DATE] % n % p[PRIORITY] % n % x[NDC] % n % t[THREAD] % n % c[CATEGORY] % n % m[MESSAGE] % n % n

# Log Factor 5 Appender
log4j.appender.LF5_APPENDER = org.apache.log4j.lf5.LF5Appender
log4j.appender.LF5_APPENDER.MaxNumberOfRecords = 2000

# 发送日志给邮件
log4j.appender.MAIL = org.apache.log4j.net.SMTPAppender
log4j.appender.MAIL.Threshold = FATA
log4j.appender.MAIL.BufferSize = 10
log4j.appender.MAIL.From = web@www.wuset.com
log4j.appender.MAIL.SMTPHost = www.wusetu.com
log4j.appender.MAIL.Subject = Log4J Message
log4j.appender.MAIL.To = web@www.wusetu.com
log4j.appender.MAIL.layout = org.apache.log4j.PatternLayout
log4j.appender.MAIL.layout.ConversionPattern = [framework] % d - % c -%- 4r [ % t] %- 5p % c % x - % m % n


# 用于数据库
log4j.appender.DATABASE = org.apache.log4j.jdbc.JDBCAppender
log4j.appender.DATABASE.URL = jdbc:mysql: // localhost:3306/test
log4j.appender.DATABASE.driver = com.mysql.jdbc.Driver
log4j.appender.DATABASE.user = root
log4j.appender.DATABASE.password =
log4j.appender.DATABASE.sql = INSERT INTO LOG4J (Message) VALUES ( ' [framework] %d - %c -%-4r [%t] %-5p %c %x - %m%n ' )
log4j.appender.DATABASE.layout = org.apache.log4j.PatternLayout
log4j.appender.DATABASE.layout.ConversionPattern = [framework] % d - % c -%- 4r [ % t] %- 5p % c % x - % m % n
log4j.appender.A1 = org.apache.log4j.DailyRollingFileAppender
log4j.appender.A1.File = SampleMessages.log4j
log4j.appender.A1.DatePattern = yyyyMMdd - HH ' .log4j '
log4j.appender.A1.layout = org.apache.log4j.xml.XMLLayout

#自定义Appender
log4j.appender.im = net.cybercorlin.util.logger.appender.IMAppender
log4j.appender.im.host = mail.cybercorlin.net
log4j.appender.im.username = username
log4j.appender.im.password = password
log4j.appender.im.recipient = corlin@cybercorlin.net
log4j.appender.im.layout = org.apache.log4j.PatternLayout
log4j.appender.im.layout.ConversionPattern = [framework] % d - % c -%- 4r [ % t] %- 5p % c % x - % m % n

# 结束

Log4j控件：

Log4j的执行效率，Log4j只在初始化的时候打开文件，并保持对文件的写控制，直到在系统结束的时候才关闭文件。这样就是IO次数达到最小，提高效率。

Log4j.properties配置文件，默认的配置文件为log4j.properties。启动时会加载classpath下的log4j.properties初始化Log4j。如果文件不存在，Log4j会在控制台打印没有找到Log4j配置。如果不适用默认的文件名log4j.properties，可以使用PropertyConfigurator指定配置文件的路径。

log4j.properties配置文件：

log4j.xml配置文件：

日志记录器Logger：

负责记录日志。

输出地Appender：

负责输出到什么地方。

输出格式Layout：

负责以什么格式输出，输出哪些附加信息。

当使用.class获取logger对象的时候，查看当前类所处的路径可用如下方法，当时servlet类时候，log4j相对应的是tomcat的路径，产生的日志文件也是相对tomcat路径进行存放的

new File("").getAbsolutePath();

PS：内容来自资料的搜索总结，谢谢提供资料的网友